Retrieve messages using PHP IMAP library. More...

Inheritance diagram for MailinglistPop3Retrieve:

Collaboration diagram for MailinglistPop3Retrieve:

Public Member Functions
	__destruct ()
	Destructor. 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)
	Overrides/Implements Mailinglist:Retrieve::get_message_list Connect to mailbox and run message retrieval. More...

	get_message ($id)
	Overrides/Implements MailinglistRetrieve::get_message(). More...

	purge_message ($id)
	Overrides/Implements MailinglistRetrieve::purge_message();. More...

	close ()
	Overrides/Implements MailinglistRetrieve::close(). 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

Data Fields
const	DEFAULT_BUFFER_SIZE = 4096

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

Protected Member Functions
	connect ()
	connect() More...

	disconnect ()

	getOfficeStatus ($limit=0)
	Get the office status. More...

	get_uidls ()
	get_uidls() More...

	get_list ()
	get_list() More...

	get_stat ()
	Get the stats from the pop3 server This is only a string with the count of mails and their size in your mail drop. More...

	delete_msg ($msg_num)

	quit ()
	Send the quit command to the server. More...

	get_msg ($msg_num)
	Recieve a raw message. More...

	recv_string ($buff_size=self::DEFAULT_BUFFER_SIZE, $log=TRUE)
	recv_string More...

	recv_to_point ()
	recv_to_point More...

	send ($cmd)
	Send a string to the server. More...

	send_cmd ($cmd)
	This function send the command to the server and will get the response If the command goes failed, the function will throw the POP3_Exception with the ERR_SEND_CMD error code and the response as error message. More...

Private Attributes
	$connected = FALSE
	Are we currently connected/logged in. More...

	$socket
	Handle for Socket being used. More...

	$ipaddr
	String for ipaddr we are connecting to. More...

	$apop_banner = NULL
	Banner for APOP. More...

Detailed Description

Retrieve messages using PHP IMAP library.

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

Constructor & Destructor Documentation

__destruct ( )

Destructor.

Definition at line 225 of file MailinglistPop3Retrieve.class.php.

References disconnect().

                                {
     $this->disconnect();
   }

Here is the call graph for this function:

Member Function Documentation

close ( )

Overrides/Implements MailinglistRetrieve::close().

Implements MailinglistRetrieveInterface.

Definition at line 204 of file MailinglistPop3Retrieve.class.php.

References disconnect(), and quit().

                           {
     $this->quit();
     $this->disconnect();
   }

Here is the call graph for this function:

connect ( )

protected

connect()

Build connection/log in to Pop3 server.

Definition at line 235 of file MailinglistPop3Retrieve.class.php.

References $connected, _mailinglist_decode_password(), MailinglistExportable\log(), recv_string(), and send_cmd().

Referenced by get_list(), get_message_list(), get_stat(), get_uidls(), and getOfficeStatus().

                                {
     // Make sure all needed parms are defined so we don't need to test everywhere
     if (!isset($this->settings['apop'])) {
       $this->settings['apop'] = FALSE;
     }
 
     if (!isset($this->settings['use_sockets']) || !extension_loaded("sockets")) {
       $this->settings['use_sockets'] = FALSE;
     }
 
     if (!isset($this->settings['ipv6'])) $this->settings['ipv6'] = FALSE;
 
     $timeout = (double)$this->settings['timeout'];
     $timeout_sec = (int)floor($timeout);
     $timeout_usec = (int)(1000000*($timeout-$timeout_sec));
     $timeout_array = array('sec' => $timeout_sec, 'usec' => $timeout_usec);
     $host = $this->settings['domain'];
     $port = $this->settings['port'];
 
     if ($this->settings['use_sockets']) {
       $this->socket = socket_create(($this->settings['ipv6'] ? AF_INET6 : AF_INET), SOCK_STREAM, SOL_TCP );
       if (!$this->socket) {
         $this->log('Error creating Socket', this::LOG_ERROR);
         return;
       }
       if (!socket_set_option($this->socket, SOL_SOCKET, SO_RCVTIMEO, $timeout_array) || !socket_set_option($this->socket, SOL_SOCKET, SO_SNDTIMEO, $timeout_array)) {
         $this->log('Error setting socket timeout', this::LOG_ERROR);
         return FALSE;
       }
       if (!socket_connect($this->socket, $host, $port) || !socket_getpeername($this->socket, $this->ipaddr)) {
         $this->log("Error connecting to server", this::LOG_ERROR);
         return FALSE;
       }
     }
     else {
       $url = 'tcp://' . $host . ':' . $port;
       $intErrno = 0;
       $strError = "";
       $this->socket = fsockopen($url, $intErrno, $strError, $timeout);
       if (!stream_set_timeout($this->socket, $timeout_sec, $timeout_usec)) {
         $this->log('Error setting socket timeout', this::LOG_ERROR);
       }
       $this->ipaddr = gethostbyname($host);
     }
     $this->log("Connected to " . $this->ipaddr . ':' . $port . ' [' . $host . ']');
 
     // Get the first response with, if APOP support avalible, the apop banner.
     $buff = "";
     $buff = $this->recv_string();
 
     // Check for APOP banner
     $start = strpos($buff, '<');
     if ($start !== FALSE) {
       $stop = strpos($buff, '>', $start);
       if ($stop != FALSE) {
         $this->apop_banner = substr($buff, $start+1, $stop-$start-1);
       }
     }
     // Now we can Login to the server
     $apop = FALSE;
 
     if ($this->settings['apop'] && !is_null($this->apop_banner)) {
       $apop = TRUE;
     }
 
     if ($apop) {
       // APOP Auth
       $ans = $this->send_cmd("APOP " . $this->settings['name'] . " " . hash("md5", $this->strAPOPBanner . _mailinglist_decode_password($this->settings['pass']), FALSE));
     }
     else {
       // POP3 Auth
       $this->send_cmd( "USER " . $this->settings['name']);
       $ans = $this->send_cmd( "PASS " . _mailinglist_decode_password($this->settings['pass']));
     }
     if ($ans[0] == '+') {
       $this->connected = TRUE;
     }
     return $this->connected;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

delete_msg ( $msg_num )

protected

Definition at line 434 of file MailinglistPop3Retrieve.class.php.

References send_cmd().

Referenced by purge_message().

                                             {
     $this->send_cmd("DELE " . $msg_num);
     return;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect ( )

protected

Definition at line 322 of file MailinglistPop3Retrieve.class.php.

References MailinglistExportable\log().

Referenced by __destruct(), and close().

                                   {
     if ($this->connected ) {
       if ($this->settings['use_sockets']) {
         if (socket_close($this->socket) === FALSE ) {
           $this->log("Error On Socket Disconnect", this::LOG_ERROR);
         }
       }
       else {
         if (!fclose($this->socket)) {
           $this->log("Error On Socket Disconnect", this::LOG_ERROR);
         }
       }
       $this->connected = FALSE;
     }
   }

Here is the call graph for this function:

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 21 of file MailinglistPop3Retrieve.class.php.

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

                                            {
     parent::edit_form($form, $form_state);
     global $cookie_domain;
 
     /* Parameters that we need:
     Base:
     Hostname:
     Port:
     Timeout:
     UseSocket
     Username:
     Password:
 
     Extra:
     APOPDetect:
     Delete when done:
     Logging: No, Yes, Yes-ShowPasswords
     */
 
     $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']['domain'] = array(
       '#type' => 'textfield',
       '#title' => t('Domain'),
       '#default_value' => $this->get_setting('domain'),
       '#required' => TRUE,
       '#description' => t('The domain of the server used to collect mail.'),
       '#ajax' => $ajax_settings,
     );
     $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).'),
       '#element_validate' => array('element_validate_integer_positive'),
       '#required' => TRUE,
       '#ajax' => $ajax_settings,
     );
     $form['connection']['settings']['name'] = array(
       '#type' => 'textfield',
       '#title' => t('Username'),
       '#default_value' => $this->get_setting('name'),
       '#required' => TRUE,
       '#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,
     );
 
     $form['connection']['settings']['results'] = array(
       '#type' => 'container',
       '#attributes' => array(
         'id' => 'mailinglist_test_results',
       ),
     );
 
     $form['connection']['settings']['timeout'] = array(
       '#type' => 'textfield',
       '#title' => t('Timeout'),
       '#size' => 5,
       '#maxlength' => 5,
       '#default_value' => $this->get_setting('timeout', 10),
       '#description' => t('Timeout (in Sec) to connect to server'),
       '#element_validate' => array('element_validate_number'),
       '#required' => TRUE,
       '#ajax' => $ajax_settings,
     );
 
     $form['extra']['settings']['apop'] = array(
       '#type' => 'checkbox',
       '#title' => t('Detect APOP?'),
       '#default_value' => $this->get_setting('apop', FALSE),
       '#description' => t('Check to enable APOP protocal detection'),
     );
 
     $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. You normallys should check this box.'),
     );
 
     $form['extra']['settings']['ipv6'] = array(
       '#type' => 'checkbox',
       '#title' => t('IPv6'),
       '#default_value' => $this->get_setting('ipv6', FALSE),
       '#description' => t('Use IPv6'),
     );
 
   }

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 151 of file MailinglistPop3Retrieve.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 130 of file MailinglistPop3Retrieve.class.php.

                                                     {
     parent::edit_form_validate($form, $form_state);
     if ($form_state['values']['settings']['port'] < 1 || 65535 < $form_state['values']['settings']['port']) {
       form_set_error('port', t('Port must be between 1 and 65535'));
     }
 
     if ($form_state['values']['settings']['port'] != 110) {
       drupal_set_message(t('Non-standard Pop3 Port: @port', array('@port' => (int)$form_state['values']['settings']['port'])), 'warning');
     }
 
     // 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']['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.'), 'warning');
     }
   }

get_list ( )

protected

get_list()

Get list of messages on server, and their size

Definition at line 398 of file MailinglistPop3Retrieve.class.php.

References connect(), recv_to_point(), and send_cmd().

Referenced by getOfficeStatus().

                                 {
     if (!$this->connected) {
       $this->connect();
     }
     $this->send_cmd("LIST");
     $lists = $this->recv_to_point();
     $lists = explode("\r\n", trim($lists));
     return $lists;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_message ( $id )

Overrides/Implements MailinglistRetrieve::get_message().

Implements MailinglistRetrieveInterface.

Definition at line 188 of file MailinglistPop3Retrieve.class.php.

References get_msg().

                                    {
     $msg = $this->get_msg($id);
     return new MailinglistMessage($msg);
   }

Here is the call graph for this function:

get_message_list ( $max = 0 )

Overrides/Implements Mailinglist:Retrieve::get_message_list Connect to mailbox and run message retrieval.

Returns: array Retrieved messages.

Implements MailinglistRetrieveInterface.

Definition at line 170 of file MailinglistPop3Retrieve.class.php.

References connect(), and get_stat().

                                            {
     if (!$this->connected) {
       if (!$this->connect()) return FALSE;
     }
 
     $stat = $this->get_stat();
     $limit = $stat['count'];
     if ($max > 0 && $max < $limit) $limit = $max;
     $res = array();
     for ($i=1; $i<=$limit; $i++) {
       $res[] = $i;
     }
     return $res;
   }

Here is the call graph for this function:

get_msg ( $msg_num )

protected

Recieve a raw message.

Parameters

$msg_num The message number on the pop3 server.

Returns: string Complete message

Definition at line 457 of file MailinglistPop3Retrieve.class.php.

References recv_to_point(), and send_cmd().

Referenced by get_message().

                                          {
     $this->send_cmd("RETR " . $msg_num);
     return $this->recv_to_point();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_stat ( )

protected

Get the stats from the pop3 server This is only a string with the count of mails and their size in your mail drop.

Returns: string example: "+OK 2 3467"

Exceptions

POP3_Exception

Definition at line 415 of file MailinglistPop3Retrieve.class.php.

References connect(), and send_cmd().

Referenced by get_message_list(), and getOfficeStatus().

                                 {
     if (!$this->connected) {
       $this->connect();
     }
     $stat = $this->send_cmd("STAT");
     $stat = explode(" ", trim($stat));
     $res['count'] = (int) $stat[1];
     $res['octets'] = (int) $stat[2];
     return $res;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_uidls ( )

protected

get_uidls()

Get list of message uidls

Definition at line 383 of file MailinglistPop3Retrieve.class.php.

References connect(), recv_to_point(), and send_cmd().

Referenced by getOfficeStatus().

                                  {
     if (!$this->connected) {
       $this->connect();
     }
     $this->send_cmd("UIDL");
     $uidls = $this->recv_to_point();
     $uidls = explode("\r\n", trim($uidls));
     return $uidls;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

getOfficeStatus ( $limit = 0 )

protected

Get the office status.

That means that you will get an array with all needed informations about your mail drop. The array is build up like discribed here.

$result = array( "count" => "Count of messages in your mail drop", "octets" => "Size of your mail drop in bytes",

"msg_number" => array("uid" => "The unique id of the message on the pop3 server", "octets" => "The size of the message in bytes" ), "and soon" );

Returns: array

Definition at line 354 of file MailinglistPop3Retrieve.class.php.

References connect(), get_list(), get_stat(), and get_uidls().

                                                  {
     if (!$this->connected) {
       $this->connect();
     }
     $res = array();
 
     $res = $this->get_stat();
 
     if ($res["count"] > 0) {
       $uidls = $this->get_uidls();
       $lists = $this->get_list();
 
       if ($limit == 0 || $limit > $res['count']) $limit = $res['count'];
       for ($i=1; $i<=$limit; $i++) {
         list(, $uidl) = explode(" ", trim($uidls[$i-1]));
         list(, $list) = explode(" ", trim($lists[$i-1]));
         $res[$i]["uid"] = (int) $uidl;
         $res[$i]["octets"] = (int) $list;
       }
     }
     return $res;
   }

Here is the call graph for this function:

purge_message ( $id )

Overrides/Implements MailinglistRetrieve::purge_message();.

Implements MailinglistRetrieveInterface.

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

References delete_msg().

                                      {
     $this->delete_msg($id);
 
   }

Here is the call graph for this function:

quit ( )

protected

Send the quit command to the server.

All as delete marked messages will remove from the mail drop.

Definition at line 444 of file MailinglistPop3Retrieve.class.php.

References send_cmd().

Referenced by close().

                             {
     if ($this->connected) {
       $this->send_cmd("QUIT");
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

recv_string	(	$buff_size = `self::DEFAULT_BUFFER_SIZE`,
		$log = `TRUE`
	)

protected

recv_string

Receive a string from the socket.

Parameters

$buff_size	[int] the size of the buffer to read.
$log	[bool] should the data received be logged.

Definition at line 470 of file MailinglistPop3Retrieve.class.php.

References MailinglistExportable\log().

Referenced by connect(), recv_to_point(), and send_cmd().

                                                                                     {
     $buff = "";
     if ($this->settings['use_sockets']) {
       $buff = socket_read($this->socket, $buff_size , PHP_NORMAL_READ);
       if ($buff === FALSE ) {
         $this->log("Socket Error", this::LOG_ERROR);
       }
       $len = strlen($buff);
       if ($buff[$len-1] != "\r") {
         $this->log('Line too long', this::LOG_ERROR);
       }
       else {
         $buff = substr($buff, 0, $len-1);
         // Workaround because socket_read with PHP_NORMAL_READ stop at "\r" but the network string ends with "\r\n"
         // so we need to call the socket_read function again to get the "\n"
         $buff2 = socket_read($this->socket, 1 , PHP_NORMAL_READ);
         if ($buff2 === FALSE ) {
           $this->log("Socket Error", this::LOG_ERROR);
         }
         if ($buff2 != "\n") {
           $this->log('Bad Line Ends', this::LOG_ERROR);
         }
       }
     }
     else {
       $buff = fgets($this->socket, $buff_size);
       if (!$buff) {
         $this->log("fgets(): Couldn't recieve the string from socket", this::LOG_ERROR);
       }
       $buff = substr($buff, 0, strlen($buff)-2);
     }
     if ($log) $this->log($buff);
     return $buff;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

recv_to_point ( )

protected

recv_to_point

Read from socket until we reach a line with just a period on it. Return all the lines (but the .) with new-line between each.

Definition at line 511 of file MailinglistPop3Retrieve.class.php.

References recv_string().

Referenced by get_list(), get_msg(), and get_uidls().

                                      {
     $buff = "";
     while (TRUE) {
       $buffer = $this->recv_string(self::DEFAULT_BUFFER_SIZE, FALSE);
       if ($buffer == '.') {
         break;
       }
       $buff .= $buffer . "\n";
     }
     return $buff;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

send ( $cmd )

protected

Send a string to the server.

Will append the network lineend "\r\n".

Parameters

$cmd	[string] The string that should send to the pop3 server

Returns: void

Definition at line 531 of file MailinglistPop3Retrieve.class.php.

References MailinglistExportable\log().

Referenced by send_cmd().

                                   {
     $cmd .= "\r\n";
     if ($this->settings['use_sockets']) {
       if (socket_send($this->socket, $cmd, strlen($cmd), 0) === FALSE ) {
         $this->log("Pop3 Send Error", this::LOG_ERROR);
       }
     }
     else {
       if (!fwrite($this->socket, $cmd, strlen($cmd))) {
         $this->log("fwrite(): Failed to write string to socket", this::LOG_ERROR);
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

send_cmd ( $cmd )

protected

This function send the command to the server and will get the response If the command goes failed, the function will throw the POP3_Exception with the ERR_SEND_CMD error code and the response as error message.

Parameters

$cmd	[string] The string with the command for the pop3 server

Returns: [string] Server response if it was successfull

Definition at line 554 of file MailinglistPop3Retrieve.class.php.

References MailinglistExportable\log(), recv_string(), and send().

Referenced by connect(), delete_msg(), get_list(), get_msg(), get_stat(), get_uidls(), and quit().

                                     {
     $this->log($cmd);
     $this->send($cmd);
     $res = $this->recv_string();
     // 1. the check for the strlen of the result is a workaround for some server who don't send something after the quit command
     // 2. should run with qmailer too...qmailer bug (pop3.class.inc) "." instead of "+OK" after RETR command
     if (strlen($res) > 0 && $res[0] == '-') {
       $this->log("Response Error " . $res, this::LOG_ERROR);
     }
     return $res;
   }