X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FMailing%2FMailStore.php;h=f11c413f224aad4c0ffe3d13ecd1c537cdc0df6e;hb=f41a7de74d7f30125ad93e4b80561ac17038c002;hp=f093dc3cd7025c0c66af974d1312e944aff54b67;hpb=ef10e0b52408ba266239a859756d757a10348228;p=civicrm-core.git diff --git a/CRM/Mailing/MailStore.php b/CRM/Mailing/MailStore.php index f093dc3cd7..f11c413f22 100644 --- a/CRM/Mailing/MailStore.php +++ b/CRM/Mailing/MailStore.php @@ -39,14 +39,16 @@ class CRM_Mailing_MailStore { /** * Return the proper mail store implementation, based on config settings * - * @param string $name name of the settings set from civimail_mail_settings to use (null for default) + * @param string $name + * Name of the settings set from civimail_mail_settings to use (null for default). * * @throws Exception - * @return object mail store implementation for processing CiviMail-bound emails + * @return object + * mail store implementation for processing CiviMail-bound emails */ public static function getStore($name = NULL) { - $dao = new CRM_Core_DAO_MailSettings; - $dao->domain_id = CRM_Core_Config::domainID(); + $dao = new CRM_Core_DAO_MailSettings; + $dao->domain_id = CRM_Core_Config::domainID(); $name ? $dao->name = $name : $dao->is_default = 1; if (!$dao->find(TRUE)) { throw new Exception("Could not find entry named $name in civicrm_mail_settings"); @@ -84,7 +86,8 @@ class CRM_Mailing_MailStore { /** * Return all emails in the mail store * - * @return array array of ezcMail objects + * @return array + * array of ezcMail objects */ public function allMails() { return $this->fetchNext(0); @@ -93,14 +96,17 @@ class CRM_Mailing_MailStore { /** * Expunge the messages marked for deletion; stub function to be redefined by IMAP store */ - public function expunge() {} + public function expunge() { + } /** * Return the next X messages from the mail store * - * @param int $count number of messages to fetch (0 to fetch all) + * @param int $count + * Number of messages to fetch (0 to fetch all). * - * @return array array of ezcMail objects + * @return array + * array of ezcMail objects */ public function fetchNext($count = 1) { if (isset($this->_transport->options->uidReferencing) and $this->_transport->options->uidReferencing) { @@ -115,7 +121,7 @@ class CRM_Mailing_MailStore { print "fetching $count messages\n"; } } - catch(ezcMailOffsetOutOfRangeException$e) { + catch (ezcMailOffsetOutOfRangeException$e) { if ($this->_debug) { print "got to the end of the mailbox\n"; } @@ -139,16 +145,21 @@ class CRM_Mailing_MailStore { /** * Point to (and create if needed) a local Maildir for storing retrieved mail * - * @param string $name name of the Maildir + * @param string $name + * Name of the Maildir. * * @throws Exception - * @return string path to the Maildir's cur directory + * @return string + * path to the Maildir's cur directory */ public function maildir($name) { $config = CRM_Core_Config::singleton(); $dir = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $name; foreach (array( - 'cur', 'new', 'tmp') as $sub) { + 'cur', + 'new', + 'tmp' + ) as $sub) { if (!file_exists($dir . DIRECTORY_SEPARATOR . $sub)) { if ($this->_debug) { print "creating $dir/$sub\n";