mimemail.rules_forms.inc in Mime Mail 6

Rules actions for sending MIME-encoded e-mails (settings forms).

File

includes/mimemail.rules_forms.inc

<?php

/**
 * @file
 * Rules actions for sending MIME-encoded e-mails (settings forms).
 *
 * @addtogroup rules
 * @{
 */

/**
 * Action "Send an HTML mail to a user" configuration form.
 */
function mimemail_rules_action_mail_to_user_form($settings = array(), &$form) {
  $settings += array(
    'key' => '',
    'sender' => '',
    'from' => '',
    'reply_to' => '',
    'subject' => '',
    'message_html' => '',
    'message_html_filter' => FILTER_FORMAT_DEFAULT,
    'message_plaintext' => '',
    'attachments' => '',
  );
  $form['settings']['key'] = array(
    '#type' => 'textfield',
    '#title' => t('Key'),
    '#default_value' => $settings['key'],
    '#description' => t("An identifier for the message."),
    '#required' => TRUE,
  );
  $form['settings']['sender'] = array(
    '#type' => 'textfield',
    '#title' => t('Sender name'),
    '#default_value' => $settings['sender'],
    '#description' => t("The sender's name. Leave it empty to use the site-wide configured name."),
  );
  $form['settings']['from'] = array(
    '#type' => 'textfield',
    '#title' => t('Sender e-mail address'),
    '#default_value' => $settings['from'],
    '#description' => t("The sender's address. Leave it empty to use the site-wide configured address."),
  );
  $form['settings']['reply_to'] = array(
    '#type' => 'textfield',
    '#title' => t('Reply e-mail address'),
    '#default_value' => $settings['reply_to'],
    '#description' => t("The address to reply to. Leave it empty to use the sender's address."),
  );
  $form['settings']['subject'] = array(
    '#type' => 'textfield',
    '#title' => t('Subject'),
    '#default_value' => $settings['subject'],
    '#description' => t("The mail's subject."),
  );
  $form['settings']['message_html_filter']['message_html'] = array(
    '#type' => 'textarea',
    '#title' => t('HTML message'),
    '#default_value' => $settings['message_html'],
    '#description' => t("The message body in HTML format."),
  );
  $form['settings']['message_plaintext'] = array(
    '#type' => 'textarea',
    '#title' => t('Text message'),
    '#default_value' => $settings['message_plaintext'],
    '#description' => t("Optional plaintext portion of a multipart message."),
  );
  $form['settings']['attachments'] = array(
    '#type' => 'textarea',
    '#title' => t('Attachments'),
    '#default_value' => $settings['attachments'],
    '#description' => t('A list of attachments, one file per line like [mimetype]:[path] e.g. "image/png:/files/images/mypic.png" without quotes.'),
  );
  $form['settings']['message_html_filter']['format'] = filter_form($settings['message_html_filter']);
}

/**
 * Action "Send an HTML mail to an arbitrary mail address" configuration form.
 */
function mimemail_rules_action_mail_form($settings = array(), &$form) {
  $settings += array(
    'to' => '',
    'cc' => '',
    'bcc' => '',
  );
  $form['settings']['to'] = array(
    '#type' => 'textfield',
    '#title' => t('Recipient'),
    '#default_value' => $settings['to'],
    '#description' => t("The mail's recipient address. You may separate multiple addresses with comma."),
    '#required' => TRUE,
    '#weight' => -1,
  );
  $form['settings']['cc'] = array(
    '#type' => 'textfield',
    '#title' => t('CC Recipient'),
    '#default_value' => $settings['cc'],
    '#description' => t("The mail's carbon copy address. You may separate multiple addresses with comma."),
    '#required' => FALSE,
    '#weight' => 0,
  );
  $form['settings']['bcc'] = array(
    '#type' => 'textfield',
    '#title' => t('BCC Recipient'),
    '#default_value' => $settings['bcc'],
    '#description' => t("The mail's blind carbon copy address. You may separate multiple addresses with comma."),
    '#required' => FALSE,
    '#weight' => 0,
  );
  mimemail_rules_action_mail_to_user_form($settings, $form);
}

/**
 * Handle submission for action "Send an HTML mail to a user" configuration form.
 */
function mimemail_rules_action_mail_submit(&$settings, $form, $form_state) {
  mimemail_rules_action_form_submit($settings, $form, $form_state);
}

/**
 * Handle submission for action "Send an HTML mail to an arbitrary mail address" configuration form.
 */
function mimemail_rules_action_mail_to_user_submit(&$settings, $form, $form_state) {
  mimemail_rules_action_form_submit($settings, $form, $form_state);
}

/**
 * Handle submission for action "Send an HTML mail to all users of a role" configuration form.
 */
function mimemail_rules_action_mail_to_users_of_role_submit(&$settings, $form, $form_state) {
  mimemail_rules_action_form_submit($settings, $form, $form_state);
}

/**
 * Handle submission for action configuration forms.
 */
function mimemail_rules_action_form_submit(&$settings, $form, $form_state) {

  // Unwrap the HTML message from the input filter wrapper.
  $settings['message_html'] = $settings['message_html_filter']['message_html'];

  // Store the value of the choosen input format.
  $settings['message_html_filter'] = $form_state['values']['format'];
}

/**
 * Action "Send an HTML mail to users of a role" configuration form.
 */
function mimemail_rules_action_mail_to_users_of_role_form($settings = array(), &$form) {

  // Select only non-anonymous user roles because anonymous users won't have emails.
  $roles = array_map('filter_xss_admin', user_roles(TRUE));
  $form['settings']['recipients'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Recipient roles'),
    '#prefix' => t('<strong>WARNING!</strong> This may cause problems if there are too many users of these roles on your site, as your server may not be able to handle all the mail requests all at once.'),
    '#required' => TRUE,
    '#default_value' => isset($settings['recipients']) ? $settings['recipients'] : array(),
    '#options' => $roles,
    '#description' => t('Select the roles whose users should receive this mail.'),
  );
  mimemail_rules_action_mail_to_user_form($settings, $form);
}

/**
 * @}
 */

Functions

Name	Description
mimemail_rules_action_form_submit	Handle submission for action configuration forms.
mimemail_rules_action_mail_form	Action "Send an HTML mail to an arbitrary mail address" configuration form.
mimemail_rules_action_mail_submit	Handle submission for action "Send an HTML mail to a user" configuration form.
mimemail_rules_action_mail_to_users_of_role_form	Action "Send an HTML mail to users of a role" configuration form.
mimemail_rules_action_mail_to_users_of_role_submit	Handle submission for action "Send an HTML mail to all users of a role" configuration form.
mimemail_rules_action_mail_to_user_form	Action "Send an HTML mail to a user" configuration form.
mimemail_rules_action_mail_to_user_submit	Handle submission for action "Send an HTML mail to an arbitrary mail address" configuration form.