class MailhandlerCommandsHeaders in Mailhandler 6.2

@file MailhandlerCommandsHeaders class.

Hierarchy

• class \MailhandlerCommands
  • class \MailhandlerCommandsHeaders

3 string references to 'MailhandlerCommandsHeaders'

MailhandlerCommandsExtendedHeaders.inc in modules/mailhandler_extended/plugins/mailhandler/commands/MailhandlerCommandsExtendedHeaders.inc

MailhandlerCommandsHeaders.inc in plugins/mailhandler/commands/MailhandlerCommandsHeaders.inc

mailhandler_update_6202 in ./mailhandler.install

Adds new command plugins to existing Feeds importers.

File

plugins/mailhandler/commands/MailhandlerCommandsHeaders.class.php, line 7

MailhandlerCommandsHeaders class.

class MailhandlerCommandsHeaders extends MailhandlerCommands {

  /**
   * Set known sources and parse additional sources from body.
   */
  function process(&$message, $source) {

    // Populate $message with all values from 'header' object.
    $parts = (array) $message['header'];
    foreach ($parts as $key => $value) {

      // Some keys are already taken, so do not overwrite them.
      if (!in_array($key, array(
        'header',
        'body_text',
        'body_html',
        'mimeparts',
        'mailbox',
        'attachments',
      ))) {

        // Some headers are arrays of objects
        if (in_array($key, array(
          'to',
          'from',
          'reply_to',
          'sender',
          'cc',
          'bcc',
          'return_path',
        ))) {
          $message[$key . '-name'] = isset($value[0]->personal) ? iconv_mime_decode($value[0]->personal, 0, "UTF-8") : '';
          $message[$key . '-address'] = isset($value[0]->mailbox) && isset($value[0]->host) ? $value[0]->mailbox . '@' . $value[0]->host : '';
        }
        else {
          $message[$key] = iconv_mime_decode($value, 0, "UTF-8");
        }
      }
    }
  }
  function getMappingSources($config) {
    $sources = array();

    // Make all IMAP header keys available as selectable mapping sources.
    $sources['date'] = array(
      'name' => t('Date (date)'),
      'description' => t('The message date as found in its headers, e.g. Wed, 16 Nov 2011 09:12:29 -0600.'),
    );
    $sources['udate'] = array(
      'name' => t('Date (udate)'),
      'description' => t('The message date in Unix time, e.g. 12345678.'),
    );
    $sources['subject'] = array(
      'name' => t('Subject'),
      'description' => t('The message subject.'),
    );
    $sources['message_id'] = array(
      'name' => t('Message ID'),
      'description' => t('The message ID (message_id), e.g. <[e-mail]>.'),
    );
    $sources['Msgno'] = array(
      'name' => t('Message number'),
      'description' => t('The message number.'),
    );
    $sources['toaddress'] = array(
      'name' => t('To address line'),
      'description' => t('Full To: line, up to 1024 characters, e.g. Joe Smith <[e-mail]>.'),
    );
    $sources['fromaddress'] = array(
      'name' => t('From address line'),
      'description' => t('Full From: line, up to 1024 characters, e.g. Joe Smith <[e-mail]>.'),
    );
    $sources['reply_toaddress'] = array(
      'name' => t('Reply-To address line'),
      'description' => t('Full Reply-To: line, up to 1024 characters, e.g. Joe Smith <[e-mail]>.'),
    );
    $sources['senderaddress'] = array(
      'name' => t('Sender address line'),
      'description' => t('Full Sender: line, up to 1024 characters, e.g. Joe Smith <[e-mail]>.'),
    );
    $sources['ccaddress'] = array(
      'name' => t('CC address line'),
      'description' => t('Full CC: line, up to 1024 characters, e.g. Joe Smith <[e-mail]>.'),
    );
    $sources['bccaddress'] = array(
      'name' => t('BCC address line'),
      'description' => t('Full BCC: line, up to 1024 characters, e.g. Joe Smith <[e-mail]>.'),
    );
    $sources['Recent'] = array(
      'name' => t('Recent flag'),
      'description' => t('R if recent and seen, N if recent and not seen, \' \' if not recent.'),
    );
    $sources['Unseen'] = array(
      'name' => t('Unseen flag'),
      'description' => t('U if not seen AND not recent, \' \' if seen OR not seen and recent.'),
    );
    $sources['Flagged'] = array(
      'name' => t('Flagged flag'),
      'description' => t('F if flagged, \' \' if not flagged.'),
    );
    $sources['Answered'] = array(
      'name' => t('Answered flag'),
      'description' => t('A if answered, \' \' if unanswered.'),
    );
    $sources['Deleted'] = array(
      'name' => t('Deleted flag'),
      'description' => t('D if deleted, \' \' if not deleted.'),
    );
    $sources['Draft'] = array(
      'name' => t('Draft flag'),
      'description' => t('X if draft, \' \' if not draft.'),
    );
    $sources['Size'] = array(
      'name' => t('Message size'),
      'description' => t('Message size.'),
    );
    $parts = array(
      'to',
      'from',
      'reply_to',
      'sender',
      'cc',
      'bcc',
      'return_path',
    );
    foreach ($parts as $part) {
      $sources[$part . '-name'] = array(
        'name' => t($part . ' name'),
        'description' => t($part . ' header \'personal\' property, e.g. Joe Smith'),
      );
      $sources[$part . '-address'] = array(
        'name' => t($part . ' address'),
        'description' => t($part . ' header \'mailbox\' and \'host\' properties, e.g. [e-mail]'),
      );
    }
    return $sources;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MailhandlerCommands::$commands	protected	property
MailhandlerCommands::configForm	public	function	Build configuration form.	2
MailhandlerCommands::parse	public	function	Parse commands from email body.	1
MailhandlerCommands::sourceForm	public	function	Build source form.	1
MailhandlerCommandsHeaders::getMappingSources		function	Return mapping sources in the same manner as a Feeds Parser. Overrides MailhandlerCommands::getMappingSources	1
MailhandlerCommandsHeaders::process		function	Set known sources and parse additional sources from body. Overrides MailhandlerCommands::process