Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | require_once 'ezc/Base/src/ezc_bootstrap.php'; | |
37 | require_once 'ezc/autoload/mail_autoload.php'; | |
28518c90 EM |
38 | |
39 | /** | |
40 | * Class CRM_Mailing_MailStore_Imap | |
41 | */ | |
6a488035 TO |
42 | class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { |
43 | ||
44 | /** | |
45 | * Connect to the supplied IMAP server and make sure the two mailboxes exist | |
46 | * | |
dd244018 EM |
47 | * @param string $host host to connect to |
48 | * @param string $username authentication username | |
49 | * @param string $password authentication password | |
50 | * @param bool $ssl whether to use IMAP or IMAPS | |
51 | * @param string $folder name of the inbox folder | |
6a488035 | 52 | * |
dd244018 | 53 | * @return \CRM_Mailing_MailStore_Imap |
6a488035 TO |
54 | */ |
55 | function __construct($host, $username, $password, $ssl = TRUE, $folder = 'INBOX') { | |
56 | // default to INBOX if an empty string | |
57 | if (!$folder) { | |
58 | $folder = 'INBOX'; | |
59 | } | |
60 | ||
61 | if ($this->_debug) { | |
62 | ||
63 | print "connecting to $host, authenticating as $username and selecting $folder\n"; | |
64 | ||
65 | } | |
66 | ||
67 | $options = array('ssl' => $ssl, 'uidReferencing' => TRUE); | |
68 | $this->_transport = new ezcMailImapTransport($host, NULL, $options); | |
69 | $this->_transport->authenticate($username, $password); | |
70 | $this->_transport->selectMailbox($folder); | |
71 | ||
72 | $this->_ignored = implode($this->_transport->getHierarchyDelimiter(), array($folder, 'CiviMail', 'ignored')); | |
73 | $this->_processed = implode($this->_transport->getHierarchyDelimiter(), array($folder, 'CiviMail', 'processed')); | |
74 | $boxes = $this->_transport->listMailboxes(); | |
75 | ||
76 | if ($this->_debug) { | |
77 | print 'mailboxes found: ' . implode(', ', $boxes) . "\n"; | |
78 | } | |
79 | ||
80 | if (!in_array(strtolower($this->_ignored), array_map('strtolower', $boxes))) { | |
81 | $this->_transport->createMailbox($this->_ignored); | |
82 | } | |
83 | ||
84 | if (!in_array(strtolower($this->_processed), array_map('strtolower', $boxes))) { | |
85 | $this->_transport->createMailbox($this->_processed); | |
86 | } | |
87 | } | |
88 | ||
89 | /** | |
90 | * Expunge the messages marked for deletion, CRM-7356 | |
91 | */ | |
92 | function expunge() { | |
93 | $this->_transport->expunge(); | |
94 | } | |
95 | ||
96 | /** | |
97 | * Move the specified message to the ignored folder | |
98 | * | |
99 | * @param integer $nr number of the message to move | |
100 | * | |
101 | * @return void | |
102 | */ | |
103 | function markIgnored($nr) { | |
104 | if ($this->_debug) { | |
105 | print "setting $nr as seen and moving it to the ignored mailbox\n"; | |
106 | } | |
107 | $this->_transport->setFlag($nr, 'SEEN'); | |
108 | $this->_transport->copyMessages($nr, $this->_ignored); | |
109 | $this->_transport->delete($nr); | |
110 | } | |
111 | ||
112 | /** | |
113 | * Move the specified message to the processed folder | |
114 | * | |
115 | * @param integer $nr number of the message to move | |
116 | * | |
117 | * @return void | |
118 | */ | |
119 | function markProcessed($nr) { | |
120 | if ($this->_debug) { | |
121 | print "setting $nr as seen and moving it to the processed mailbox\n"; | |
122 | } | |
123 | $this->_transport->setFlag($nr, 'SEEN'); | |
124 | $this->_transport->copyMessages($nr, $this->_processed); | |
125 | $this->_transport->delete($nr); | |
126 | } | |
127 | } | |
128 |