MailinglistPhpImapRetrieve Class Reference

Retrieve messages using PHP IMAP library. More...

Inheritance diagram for MailinglistPhpImapRetrieve:

Collaboration diagram for MailinglistPhpImapRetrieve:

Public Member Functions
	retrieve ()
	test ()
	Test connection to a mailbox. More...
	purge_message ($message)
	mark message for deletion More...
	open_mailbox ()
	Establish IMAP stream connection to specified mailbox. More...
	mailbox_string ()
	Constructs a mailbox string based on mailbox object. More...
	get_part ($stream, $msg_number, $mime_type, $structure=FALSE, $part_number=FALSE, $encoding)
	Returns the first part with the specified mime_type. More...
	get_parts ($stream, $msg_number, $max_depth=10, $depth=0, $structure=FALSE, $part_number=1)
	Returns an array of parts as file objects. More...
	get_mime_type (&$structure)
	Retrieve MIME type of the message structure. More...
	get_unread_messages ($result)
	Obtain the number of unread messages for an imap stream. More...
	retrieve_message ($result, $msg_number)
	Retrieve individual messages from an IMAP result. More...
	close_mailbox ($result)
	Close a mailbox. More...
	fetch_uid ($msg_number)
	Fetch UID for a message in a POP mailbox. More...
ctools_export_ui
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form(). More...
	edit_form_validate (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_validate(). More...
	edit_form_submit (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_submit(). More...
MailinglistRetrieveInterface
	get_message_list ($max=0)
	Returns a list of messages that are available. More...
Public Member Functions inherited from MailinglistRetrieve
	test ()
	Test connection. More...
	get_message_list ($max=0)
	Returns a list of messages that are available. More...
	get_message ($id)
	Get an email message by its id code (what is returned by get_message_list() More...
	purge_message ($id)
	mark message for deletion More...
	close ()
	delete marked messages and close connection More...
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form(). More...
	edit_form_validate (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_validate(). More...
	edit_form_submit (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_submit(). More...
Public Member Functions inherited from MailinglistExportable
	get_setting ($name, $def=NULL)
	get_settings() More...
	created ()
	created() More...
	edited ($old)
	edited() More...
	changedType (MailinglistPolymorpicExportableInterface $old)
	changedType() More...
	delete ()
	delete() More...
	baseName ()
	baseName() More...
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form() called via mailinglist_export_ui Build an edit form for our object. More...
	edit_form_validate (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_validate(). More...
	edit_form_submit (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_submit(). More...
	log ($str, $level=self::LOG_NOTICE, $parms=array())
	log() More...
	log_screen ($str, $parms=array(), $level=self::LOG_NOTICE)
	log_screen() More...
	log_db ($str, $parms=array(), $level=self::LOG_ERROR)
	log_db(). More...
	log_file ($str, $parms=array(), $level=self::LOG_INFO)
	log_file(). More...
MailinglistPolymorphicExportableInterface
MailinglistRetrieveInterface

Additional Inherited Members
Data Fields inherited from MailinglistExportable
	$object_type
	The type of object we are. More...
	$settings
	Generic Array to hold misc settings so all can use same schema. More...
	$export_type
	Needed by CTools. More...
const	LOG_OFF = 0
const	LOG_SCREEN = 1
const	LOG_DB = 2
const	LOG_DB_SCREEN = 3
const	LOG_FILE = 4
const	LOG_FILE_SCREEN = 5
const	LOG_DEBUG = WATCHDOG_DEBUG
const	LOG_INFO = WATCHDOG_INFO
const	LOG_NOTICE = WATCHDOG_NOTICE
const	LOG_WARNING = WATCHDOG_WARNING
const	LOG_ERROR = WATCHDOG_ERROR
const	LOG_CRITICAL = WATCHDOG_CRITICAL
const	LOG_ALERT = WATCHDOG_ALERT
const	LOG_EMERGENCY = WATCHDOG_EMERGENCY
	$logging_screen = self::LOG_DEBUG
	$logging_db = self::LOG_INFO
	$logging_file = self::LOG_DEBUG

Detailed Description

Retrieve messages using PHP IMAP library.

Definition at line 10 of file MailinglistPhpImapRetrieve.class.php.

Member Function Documentation

close_mailbox

(

$result

)

Close a mailbox.

Definition at line 539 of file MailinglistPhpImapRetrieve.class.php.

Referenced by purge_message(), retrieve(), and test().

                                  {
    imap_errors();
    imap_close($result, CL_EXPUNGE);
  }

Here is the caller graph for this function:

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form().

called via mailinglist_export_ui

Definition at line 20 of file MailinglistPhpImapRetrieve.class.php.

References _mailinglist_decode_password(), and MailinglistExportable\get_setting().

                                           {
    parent::edit_form($form, $form_state);
    global $cookie_domain;

      $form['connection']['settings']['box_type'] = array(
      '#type' => 'select',
      '#title' => t('Protocol'),
      '#options' => array('imap' => 'IMAP', 'pop3' => 'POP3', 'local' => 'Local mbox file'),
      '#default_value' => $this->get_setting('box_type', 'imap'),
      '#description' => t('You can use the IMAP/POP3 protocols, or retrieve from an mbox file on the local file system.'),
      '#required' => TRUE,
  );
    $ajax_settings = array(
      'callback' => '_mailinglist_mailbox_test',
      'wrapper' => 'mailinglist_test_results',
      'event' => 'change',
      'progress' => array(
        'type' => 'throbber',
        'message' => t('Please wait - testing connection settings...'),
      ),
    );
    $form['connection']['settings']['folder'] = array(
      '#type' => 'textfield',
      '#title' => t('Folder'),
      '#default_value' => $this->get_setting('folder'),
      '#description' => t('The folder where the mail is stored. If you want this mailbox to read from a local mbox file, give the path relative to the Drupal installation directory.'),
      '#ajax' => $ajax_settings,
      '#required' => TRUE,
  );
    $form['connection']['settings']['domain'] = array(
      '#type' => 'textfield',
      '#title' => t('Domain'),
      '#default_value' => $this->get_setting('domain'),
      '#description' => t('The domain of the server used to collect mail.'),
      '#ajax' => $ajax_settings,
      '#required' => TRUE,
  );
    $form['connection']['settings']['port'] = array(
      '#type' => 'textfield',
      '#title' => t('Port'),
      '#size' => 5,
      '#maxlength' => 5,
      '#default_value' => $this->get_setting('port'),
      '#description' => t('The mailbox port number (usually 110 for POP3, 143 for IMAP).'),
      '#element_validate' => array('element_validate_integer_positive'),
      '#ajax' => $ajax_settings,
      '#required' => TRUE,
  );
    $form['connection']['settings']['name'] = array(
      '#type' => 'textfield',
      '#title' => t('Username'),
      '#default_value' => $this->get_setting('name'),
      '#description' => t('This username is used while logging into this mailbox during mail retrieval.'),
      '#ajax' => $ajax_settings,
    );
    $form['connection']['settings']['pass'] = array(
      '#type' => 'textfield',
      '#title' => t('Password'),
      '#default_value' => _mailinglist_decode_password($this->get_setting('pass')),
      '#description' => t('The mailbox password corresponding to the username above. Consider using a non-vital password, since this field is stored with minimal encryption in the database and displayed here.'),
      '#ajax' => $ajax_settings,
    );
    // Allow administrators to configure the mailbox with extra IMAP commands (notls, novalidate-cert etc.)
    $form['connection']['settings']['extraimap'] = array(
      '#type' => 'textfield',
      '#title' => t('Extra commands'),
      '#default_value' => $this->get_setting('extraimap'),
      '#description' => t('In some circumstances you need to issue extra commands to connect to your mail server (for example "/notls", "/novalidate-cert" etc.). See documentation for <a href="@imap-open">imap_open</a>.', array('@imap-open' => url('http://php.net/imap_open'))),
      '#ajax' => $ajax_settings,
    );
    $form['connection']['settings']['results'] = array(
      '#type' => 'container',
      '#attributes' => array(
        'id' => 'mailinglist_test_results',
      ),
    );

    $form['extra']['settings']['flag_after_read'] = array(
      '#type' => 'checkbox',
      '#title' => t('Mark messages as seen/read after they are processed?'),
      '#default_value' => $this->get_setting('flag_after_read', TRUE),
      '#description' => t('Note that messages cannot be marked as seen/read for POP3 accounts.'),
    );
    $form['extra']['settings']['delete_after_read'] = array(
      '#type' => 'checkbox',
      '#title' => t('Delete messages after they are processed?'),
      '#default_value' => $this->get_setting('delete_after_read', TRUE),
      '#description' => t('Uncheck this box to leave read messages in the mailbox. They will not be processed again unless they become marked as unread.  If you selected "POP3" as your mailbox type, you must check this box.'),
    );
  }

Here is the call graph for this function:

edit_form_submit	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_submit().

Called via mailinglist_export_ui.

Definition at line 131 of file MailinglistPhpImapRetrieve.class.php.

                                                         {
    parent::edit_form_submit($form, $form_state);
  }

edit_form_validate	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_validate().

Called via mailinglist_export_ui.

Definition at line 115 of file MailinglistPhpImapRetrieve.class.php.

                                                           {
    parent::edit_form_validate($form, $form_state);

    // If POP3 mailbox is chosen, messages should be deleted after processing.
    // Do not set an actual error because this is helpful for testing purposes.
    if ($form_state['values']['settings']['box_type'] == 'pop3' && $form_state['values']['settings']['delete_after_read'] == 0) {
      drupal_set_message(t('Unless you check off "Delete messages after they are processed" when using a POP3 mailbox, old emails will be re-imported each time the mailbox is processed. You can partially prevent this by mapping Message ID to a unique target in the processor configuration - see INSTALL.txt or advanced help for more information'), 'warning');
    }
    if (($form_state['values']['settings']['box_type'] == 'pop3' && $form_state['values']['settings']['port'] != 110) || ($form_state['values']['settings']['box_type'] == 'imap' && $form_state['values']['settings']['port'] != 143)) {
      drupal_set_message(t('Non-standard Port:') . ' ' . $form_state['values']['settings']['port'] . ' (' . $form_state['values']['settings']['box_type'] . ')', 'warning');
    }
  }

fetch_uid

(

$msg_number

)

Fetch UID for a message in a POP mailbox.

Taken from PHP.net.

Definition at line 549 of file MailinglistPhpImapRetrieve.class.php.

Referenced by retrieve_message().

                                  {
    extract($this->settings);
    $retval = 0;
    $fp = fsockopen($domain, $port);
    if ($fp > 0) {
      $buf = fgets($fp, 1024);
      fwrite($fp, "USER $name\r\n");
      $buf = fgets($fp, 1024);
      fwrite($fp, "PASS $pass\r\n");
      $buf = fgets($fp, 1024);
      fwrite($fp, "UIDL $msg_number\r\n");
      $retval=fgets($fp, 1024);
      fwrite($fp, "QUIT\r\n");
      $buf = fgets($fp, 1024);
      fclose($fp);
    }
    return drupal_substr($retval, 6, 30);
  }

Here is the caller graph for this function:

get_message_list

(

$max = 0

)

Returns a list of messages that are available.

Implements MailinglistRetrieveInterface.

Definition at line 147 of file MailinglistPhpImapRetrieve.class.php.

                                             {
    dpm($this->settings);
    extract($this->settings);
    $new = array();
    /*
    if ($result = $this->open_mailbox()) {
      $new = $this->get_unread_messages($result);
    }
    else {
      imap_errors();
      throw new Exception(t('Unable to connect to %mail. Please check the <a href="@mailbox-edit">connection settings</a> for this mailbox.', array('%mail' => $this->mail, '@mailbox-edit' => url('admin/structure/mailinglist/list/' . $this->mail . '/edit'))));
    }
    */
    return $new;
  }

get_mime_type

(

&

$structure

)

Retrieve MIME type of the message structure.

Definition at line 462 of file MailinglistPhpImapRetrieve.class.php.

Referenced by get_part().

                                      {
    static $primary_mime_type = array('text', 'multipart', 'message', 'application', 'audio', 'image', 'video', 'other');
    $type_id = (int) $structure->type;
    if (isset($primary_mime_type[$type_id]) && !empty($structure->subtype)) {
      return $primary_mime_type[$type_id] . '/' . drupal_strtolower($structure->subtype);
    }
    return 'text/plain';
  }

Here is the caller graph for this function:

get_part	(		$stream,
			$msg_number,
			$mime_type,
			$structure = FALSE,
			$part_number = FALSE,
			$encoding
	)

Returns the first part with the specified mime_type.

USAGE EXAMPLES - from php manual: imap_fetch_structure() comments $data = get_part($stream, $msg_number, "TEXT/PLAIN"); // get plain text $data = get_part($stream, $msg_number, "TEXT/HTML"); // get HTML text

Definition at line 300 of file MailinglistPhpImapRetrieve.class.php.

References get_mime_type().

Referenced by retrieve_message().

                                                                                                           {
    if (!$structure) {
      $structure = imap_fetchstructure($stream, $msg_number);
    }
    if ($structure) {
      foreach ($structure->parameters as $parameter) {
        if (drupal_strtoupper($parameter->attribute) == 'CHARSET') {
          $encoding = $parameter->value;
        }
      }
      if ($mime_type == $this->get_mime_type($structure)) {
        if (!$part_number) {
          $part_number = '1';
        }
        $text = imap_fetchbody($stream, $msg_number, $part_number, FT_PEEK);
        if ($structure->encoding == ENCBASE64) {
          return drupal_convert_to_utf8(imap_base64($text), $encoding);
        }
        elseif ($structure->encoding == ENCQUOTEDPRINTABLE) {
          return drupal_convert_to_utf8(quoted_printable_decode($text), $encoding);
        }
        else {
          return drupal_convert_to_utf8($text, $encoding);
        }
      }
      if ($structure->type == TYPEMULTIPART) { /* multipart */
        $prefix = '';
        while (list($index, $sub_structure) = each($structure->parts)) {
          if ($part_number) {
            $prefix = $part_number . '.';
          }
          $data = $this->get_part($stream, $msg_number, $mime_type, $sub_structure, $prefix . ($index + 1), $encoding);
          if ($data) {
            return $data;
          }
        }
      }
    }
    return FALSE;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

get_parts	(		$stream,
			$msg_number,
			$max_depth = 10,
			$depth = 0,
			$structure = FALSE,
			$part_number = 1
	)

Returns an array of parts as file objects.

Parameters

$stream	Handle to stream to fetch the message from
$msg_number	message number to retreive.
$max_depth	Maximum Depth to recurse into parts.
$depth	The current recursion depth.
$structure	A message structure, usually used to recurse into specific parts
$part_number	A message part number to track position in a message during recursion.

Returns

An array of file objects.

Definition at line 359 of file MailinglistPhpImapRetrieve.class.php.

Referenced by retrieve_message().

                                                                                                              {
    $parts = array();

    // Load Structure.
    if (!$structure) {
      $structure = imap_fetchstructure($stream, $msg_number);
      if (!$structure)
        watchdog('mailinglist', 'Could not fetch structure for message number %msg_number', array('%msg_number' => $msg_number), WATCHDOG_NOTICE);
        return $parts;
    }
    // Recurse into multipart messages.
    if ($structure->type == TYPEMULTIPART) {
      // Restrict recursion depth.
      if ($depth >= $max_depth) {
        watchdog('mailinglist', 'Maximum recursion depths met in mailhander_get_structure_part for message number %msg_number.',   array('%msg_number' => $msg_number), WATCHDOG_NOTICE);
        return $parts;
      }
      $prefix = '';
      foreach ($structure->parts as $index => $sub_structure) {
        // If a part number was passed in and we are a multitype message, prefix the
        // the part number for the recursive call to match the imap4 dot seperated part indexing.
        if ($part_number) {
          $prefix = $part_number . '.';
        }
        $sub_parts = $this->get_parts($stream, $msg_number, $max_depth, $depth + 1,
          $sub_structure, $prefix . ($index + 1));
        $parts = array_merge($parts, $sub_parts);
      }
      return $parts;
    }

    // Per Part Parsing.

    // Initalize file object like part structure.
    $part = new stdClass();
    $part->attributes = array();
    $part->filename = 'unnamed_attachment';
    if (!$part->filemime = $this->get_mime_type($structure)) {
      watchdog('mailinglist', 'Could not fetch mime type for message part. Defaulting to application/octet-stream.', array(), WATCHDOG_NOTICE);
      $part->filemime = 'application/octet-stream';
    }

    if ($structure->ifparameters) {
      foreach ($structure->parameters as $parameter) {
        switch (drupal_strtoupper($parameter->attribute)) {
          case 'NAME':
          case 'FILENAME':
            $part->filename = $parameter->value;
            break;
          default:
            // put every thing else in the attributes array;
            $part->attributes[$parameter->attribute] = $parameter->value;
        }
      }
    }

    // Handle Content-Disposition parameters for non-text types.
    if ($structure->type != TYPETEXT && $structure->ifdparameters) {
      foreach ($structure->dparameters as $parameter) {
        switch (drupal_strtoupper($parameter->attribute)) {
          case 'NAME':
          case 'FILENAME':
            $part->filename = $parameter->value;
            break;
          // put every thing else in the attributes array;
          default:
            $part->attributes[$parameter->attribute] = $parameter->value;
        }
      }
    }

    // Store part id for reference.
    if (!empty($structure->id)) {
      $part->id = $structure->id;
    }

    // Retrieve part and convert MIME encoding to UTF-8
    if (!$part->data = imap_fetchbody($stream, $msg_number, $part_number, FT_PEEK)) {
      watchdog('mailinglist', 'No Data!!', array(), WATCHDOG_ERROR);
      return $parts;
    }

    // Decode as necessary.
    if ($structure->encoding == ENCBASE64) {
      $part->data = imap_base64($part->data);
    }
    elseif ($structure->encoding == ENCQUOTEDPRINTABLE) {
      $part->data = quoted_printable_decode($part->data);
    }
    // Convert text attachment to UTF-8.
    elseif ($structure->type == TYPETEXT) {
      $part->data = imap_utf8($part->data);
    }

    // Always return an array to satisfy array_merge in recursion catch, and
    // array return value.
    $parts[] = $part;
    return $parts;
  }

Here is the caller graph for this function:

get_unread_messages

(

$result

)

Obtain the number of unread messages for an imap stream.

Parameters

$result

IMAP stream - as opened by imap_open

Returns

array IMAP message numbers of unread messages.

Definition at line 479 of file MailinglistPhpImapRetrieve.class.php.

Referenced by retrieve().

                                        {
    $unread_messages = array();
    $number_of_messages = imap_num_msg($result);
    for ($i = 1; $i <= $number_of_messages; $i++) {
      $header = imap_header($result, $i);
      if ($header->Unseen == 'U' || $header->Recent == 'N') {
        $unread_messages[] = $i;
      }
    }
    return $unread_messages;
  }

Here is the caller graph for this function:

mailbox_string

(

)

Constructs a mailbox string based on mailbox object.

Definition at line 280 of file MailinglistPhpImapRetrieve.class.php.

Referenced by open_mailbox(), and test().

                            {
    extract($this->settings);

    switch ($type) {
      case 'imap':
        return '{' . $domain . ':' . $port . $extraimap . '}' . $folder;
      case 'pop3':
        return '{' . $domain . ':' . $port . '/pop3' . $extraimap . '}' . $folder;
      case 'local':
        return $folder;
    }
  }

Here is the caller graph for this function:

open_mailbox

(

)

Establish IMAP stream connection to specified mailbox.

Returns

IMAP stream.

Definition at line 254 of file MailinglistPhpImapRetrieve.class.php.

References mailbox_string().

Referenced by purge_message(), retrieve(), and test().

                          {
    extract($this->settings);

    if (!function_exists('imap_open')) {
      throw new Exception(t('The PHP IMAP extension must be enabled in order to use Mailinglist.'));
    }
    $box = $this->mailbox_string();
    if ($type != 'local') {
      $result = imap_open($box, $name, $pass, NULL, 1);
    }
    else {
      $orig_home = getenv('HOME');
      // This is hackish, but better than using $_SERVER['DOCUMENT_ROOT']
      $new_home = realpath(drupal_get_path('module', 'node') . '/../../');
      if (!putenv("HOME=$new_home")) {
        throw new Exception(t('Could not set home directory to %home.', array('%home' => $new_home)));
      }
      $result = imap_open($box, '', '', NULL, 1);
      putenv("HOME=$orig_home");
    }
    return $result;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

purge_message

(

$id

)

mark message for deletion

Implements MailinglistRetrieveInterface.

Definition at line 228 of file MailinglistPhpImapRetrieve.class.php.

References close_mailbox(), MailinglistExportable\log(), and open_mailbox().

                                   {
    $this->log("Purge Message: " . $message);
    if (isset($message['imap_uid'])) {
      $result = $this->open_mailbox();
      if ($result) {
        if ($this->settings['delete_after_read']) {
          imap_delete($result, $message['imap_uid'], FT_UID);
        }
        elseif (!isset($this->settings['flag_after_read']) || ($this->settings['flag_after_read'])) {
          imap_setflag_full($result, (string)$message['imap_uid'], '\Seen', FT_UID);
        }
        $this->close_mailbox($result);
      }
      else {
        drupal_set_message(t('Unable to connect to mailbox.'));
        watchdog('mailinglist', 'Unable to connect to %mail', array('%mail' => $this->mail), WATCHDOG_ERROR);
      }
    }
  }

Here is the call graph for this function:

retrieve

(

)

Definition at line 166 of file MailinglistPhpImapRetrieve.class.php.

References close_mailbox(), get_unread_messages(), open_mailbox(), and retrieve_message().

                      {
    extract($this->settings);
    $result = $this->open_mailbox();
    if ($result) {
      $new = $this->get_unread_messages($result);
    }
    else {
      imap_errors();
      throw new Exception(t('Unable to connect to %mail. Please check the <a href="@mailbox-edit">connection settings</a> for this mailbox.', array('%mail' => $this->mail, '@mailbox-edit' => url('admin/structure/mailinglist/list/' . $this->mail . '/edit'))));
    }
    $messages = array();
    $retrieved = 0;
    while ($new && (!$limit || $retrieved < $limit)) {
      $message = $this->retrieve_message($result, array_shift($new));
      if ($message) {
        $messages[] = $message;
      }
      ++$retrieved;
    }
    watchdog('mailinglist', 'Mailbox %mail was checked and contained %retrieved messages.', array('%mail' => $this->admin_title, '%retrieved' => $retrieved), WATCHDOG_INFO);
    $this->close_mailbox($result);
    return $messages;
  }

Here is the call graph for this function:

retrieve_message	(		$result,
			$msg_number
	)

Retrieve individual messages from an IMAP result.

Parameters

$result	IMAP stream.
$msg_number	IMAP message number.

Returns

array Retrieved message, or FALSE if message cannot / should not be retrieved.

Todo:

parse raw_headers

Definition at line 501 of file MailinglistPhpImapRetrieve.class.php.

References fetch_uid(), get_part(), and get_parts().

Referenced by retrieve().

                                                  {
    extract($this->settings);
    dpm("MailinglistPhpImapRetreive::retreive_message");
    $raw_headers = imap_fetchheader($result, $msg_number, FT_PREFETCHTEXT);
    $header = imap_headerinfo($result, $msg_number);

    // Initialize the subject in case it's missing.
    if (!isset($header->subject)) {
      $header->subject = '';
    }
    // Parse MIME parts, so all mailinglist modules have access to
    // the full array of mime parts without having to process the email.
    $mimeparts = $this->get_parts($result, $msg_number);

    $body_text = $this->get_part($result, $msg_number, 'text/plain', FALSE, FALSE, $encoding);
    $body_html = $this->get_part($result, $msg_number, 'text/html', FALSE, FALSE, $encoding);
    if (!$body_text && $body_html) {
      $body_text = $body_html;
    }
    elseif ($body_text && !$body_html) {
      $body_html = $body_text;
    }
    // Is this an empty message with no body and no mimeparts?
    if (!$body_text && !$body_html && !$mimeparts) {
      $message = FALSE;
    }
    else {
      $imap_uid = ($type == 'pop3') ? $this->fetch_uid($msg_number) : imap_uid($result, $msg_number);
      $message = compact('header', 'raw_headers', 'body_text', 'body_html', 'mimeparts', 'imap_uid');
    }
    dpm($message);
    return $message;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

test

(

)

Test connection to a mailbox.

Returns

array Test results.

Implements MailinglistRetrieveInterface.

Definition at line 196 of file MailinglistPhpImapRetrieve.class.php.

References close_mailbox(), mailbox_string(), and open_mailbox().

                  {
    extract($this->settings);
    $ret = array();

    $is_local = ($type == 'local');
    $folder_is_set = (!empty($folder) && $folder != 'INBOX');
    $connect_is_set = !empty($domain) && !empty($port) && !empty($name) && !empty($pass);

    if (($is_local && $folder_is_set) || (!$is_local && $connect_is_set)) {
      $result = $this->open_mailbox();
      if ($result) {
        $ret[] = array('severity' => 'status', 'message' => t('Mailinglist was able to connect to the mailbox.'));
        $box = $this->mailbox_string();
        $status = imap_status($result, $box, SA_MESSAGES);
        if ($status) {
          $ret[] = array('severity' => 'status', 'message' => t('There are @messages messages in the mailbox folder.', array('@messages' => $status->messages)));
        }
        else {
          $ret[] = array('severity' => 'warning', 'message' => t('Mailinglist could not open the specified folder'));
        }
        $this->close_mailbox($result);
      }
      else {
        imap_errors();
        $ret[] = array('severity' => 'error', 'message' => t('Mailinglist could not access the mailbox using these settings'));
      }
    }
    return $ret;
  }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• mailinglist/plugins/mailinglist/retrieve/MailinglistPhpImapRetrieve.class.php