3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Mailing_MailStore
{
36 // flag to decide whether to print debug messages
40 * Return the proper mail store implementation, based on config settings
42 * @param string $name name of the settings set from civimail_mail_settings to use (null for default)
44 * @return object mail store implementation for processing CiviMail-bound emails
46 function getStore($name = NULL) {
47 $dao = new CRM_Core_DAO_MailSettings
;
48 $dao->domain_id
= CRM_Core_Config
::domainID();
49 $name ?
$dao->name
= $name : $dao->is_default
= 1;
50 if (!$dao->find(TRUE)) {
51 throw new Exception("Could not find entry named $name in civicrm_mail_settings");
54 $protocols = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_MailSettings', 'protocol');
56 switch ($protocols[$dao->protocol
]) {
58 return new CRM_Mailing_MailStore_Imap($dao->server
, $dao->username
, $dao->password
, (bool) $dao->is_ssl
, $dao->source
);
61 return new CRM_Mailing_MailStore_Pop3($dao->server
, $dao->username
, $dao->password
, (bool) $dao->is_ssl
);
64 return new CRM_Mailing_MailStore_Maildir($dao->source
);
67 return new CRM_Mailing_MailStore_Localdir($dao->source
);
69 // DO NOT USE the mbox transport for anything other than testing
70 // in particular, it does not clear the mbox afterwards
73 return new CRM_Mailing_MailStore_Mbox($dao->source
);
76 throw new Exception("Unknown protocol {$dao->protocol}");
81 * Return all emails in the mail store
83 * @return array array of ezcMail objects
86 return $this->fetchNext(0);
90 * Expunge the messages marked for deletion; stub function to be redefined by IMAP store
95 * Return the next X messages from the mail store
97 * @param int $count number of messages to fetch (0 to fetch all)
99 * @return array array of ezcMail objects
101 function fetchNext($count = 1) {
102 if (isset($this->_transport
->options
->uidReferencing
) and $this->_transport
->options
->uidReferencing
) {
103 $offset = array_shift($this->_transport
->listUniqueIdentifiers());
109 $set = $this->_transport
->fetchFromOffset($offset, $count);
111 print "fetching $count messages\n";
114 catch(ezcMailOffsetOutOfRangeException
$e) {
116 print "got to the end of the mailbox\n";
121 $parser = new ezcMailParser
;
122 //set property text attachment as file CRM-5408
123 $parser->options
->parseTextAttachmentsAsFiles
= TRUE;
125 foreach ($set->getMessageNumbers() as $nr) {
127 print "retrieving message $nr\n";
129 $single = $parser->parseMail($this->_transport
->fetchByMessageNr($nr));
130 $mails[$nr] = $single[0];
136 * Point to (and create if needed) a local Maildir for storing retrieved mail
138 * @param string $name name of the Maildir
140 * @return string path to the Maildir's cur directory
142 function maildir($name) {
143 $config = CRM_Core_Config
::singleton();
144 $dir = $config->customFileUploadDir
. DIRECTORY_SEPARATOR
. $name;
146 'cur', 'new', 'tmp') as $sub) {
147 if (!file_exists($dir . DIRECTORY_SEPARATOR
. $sub)) {
149 print "creating $dir/$sub\n";
151 if (!mkdir($dir . DIRECTORY_SEPARATOR
. $sub, 0700, TRUE)) {
152 throw new Exception('Could not create ' . $dir . DIRECTORY_SEPARATOR
. $sub);
156 return $dir . DIRECTORY_SEPARATOR
. 'cur';