3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
33 class CRM_Mailing_MailStore
{
34 // flag to decide whether to print debug messages
38 * Return the proper mail store implementation, based on config settings.
41 * Name of the settings set from civimail_mail_settings to use (null for default).
45 * mail store implementation for processing CiviMail-bound emails
47 public static function getStore($name = NULL) {
48 $dao = new CRM_Core_DAO_MailSettings();
49 $dao->domain_id
= CRM_Core_Config
::domainID();
50 $name ?
$dao->name
= $name : $dao->is_default
= 1;
51 if (!$dao->find(TRUE)) {
52 throw new Exception("Could not find entry named $name in civicrm_mail_settings");
55 $protocols = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_MailSettings', 'protocol');
56 if (empty($protocols[$dao->protocol
])) {
57 throw new Exception("Empty mail protocol");
60 switch ($protocols[$dao->protocol
]) {
62 return new CRM_Mailing_MailStore_Imap($dao->server
, $dao->username
, $dao->password
, (bool) $dao->is_ssl
, $dao->source
);
65 return new CRM_Mailing_MailStore_Pop3($dao->server
, $dao->username
, $dao->password
, (bool) $dao->is_ssl
);
68 return new CRM_Mailing_MailStore_Maildir($dao->source
);
71 return new CRM_Mailing_MailStore_Localdir($dao->source
);
73 // DO NOT USE the mbox transport for anything other than testing
74 // in particular, it does not clear the mbox afterwards
77 return new CRM_Mailing_MailStore_Mbox($dao->source
);
80 throw new Exception("Unknown protocol {$dao->protocol}");
85 * Return all emails in the mail store.
88 * array of ezcMail objects
90 public function allMails() {
91 return $this->fetchNext(0);
95 * Expunge the messages marked for deletion; stub function to be redefined by IMAP store.
97 public function expunge() {
101 * Return the next X messages from the mail store.
104 * Number of messages to fetch (0 to fetch all).
107 * array of ezcMail objects
109 public function fetchNext($count = 1) {
111 if (isset($this->_transport
->options
->uidReferencing
) and $this->_transport
->options
->uidReferencing
) {
112 $offset = $this->_transport
->listUniqueIdentifiers();
113 $offset = array_shift($offset);
116 $set = $this->_transport
->fetchFromOffset($offset, $count);
118 print "fetching $count messages\n";
121 catch (ezcMailOffsetOutOfRangeException
$e) {
123 print "got to the end of the mailbox\n";
128 $parser = new ezcMailParser();
129 //set property text attachment as file CRM-5408
130 $parser->options
->parseTextAttachmentsAsFiles
= TRUE;
132 foreach ($set->getMessageNumbers() as $nr) {
134 print "retrieving message $nr\n";
136 $single = $parser->parseMail($this->_transport
->fetchByMessageNr($nr));
137 $mails[$nr] = $single[0];
143 * Point to (and create if needed) a local Maildir for storing retrieved mail
145 * @param string $name
146 * Name of the Maildir.
150 * path to the Maildir's cur directory
152 public function maildir($name) {
153 $config = CRM_Core_Config
::singleton();
154 $dir = $config->customFileUploadDir
. DIRECTORY_SEPARATOR
. $name;
160 if (!file_exists($dir . DIRECTORY_SEPARATOR
. $sub)) {
162 print "creating $dir/$sub\n";
164 if (!mkdir($dir . DIRECTORY_SEPARATOR
. $sub, 0700, TRUE)) {
165 throw new Exception('Could not create ' . $dir . DIRECTORY_SEPARATOR
. $sub);
169 return $dir . DIRECTORY_SEPARATOR
. 'cur';