3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
36 // we should consider moving these to the settings table
37 // before the 4.1 release
38 define('EMAIL_ACTIVITY_TYPE_ID', NULL);
39 define('MAIL_BATCH_SIZE', 50);
42 * Class CRM_Utils_Mail_EmailProcessor
44 class CRM_Utils_Mail_EmailProcessor
{
47 * Process the default mailbox (ie. that is used by civiMail for the bounce)
50 * Always returns true (for the api). at a later stage we should
51 * fix this to return true on success / false on failure etc.
53 public static function processBounces() {
54 $dao = new CRM_Core_DAO_MailSettings();
55 $dao->domain_id
= CRM_Core_Config
::domainID();
56 $dao->is_default
= TRUE;
59 while ($dao->fetch()) {
60 self
::_process(TRUE, $dao);
63 // always returns true, i.e. never fails :)
68 * Delete old files from a given directory (recursively)
71 * Directory to cleanup.
73 * Files older than this many seconds will be deleted (default: 60 days).
77 public static function cleanupDir($dir, $age = 5184000) {
78 // return early if we can’t read/write the dir
79 if (!is_writable($dir) or !is_readable($dir) or !is_dir($dir)) {
83 foreach (scandir($dir) as $file) {
85 // don’t go up the directory stack and skip new files/dirs
86 if ($file == '.' or $file == '..') {
89 if (filemtime("$dir/$file") > time() - $age) {
93 // it’s an old file/dir, so delete/recurse
94 is_dir("$dir/$file") ? self
::cleanupDir("$dir/$file", $age) : unlink("$dir/$file");
99 * Process the mailboxes that aren't default (ie. that aren't used by civiMail for the bounce)
103 public static function processActivities() {
104 $dao = new CRM_Core_DAO_MailSettings();
105 $dao->domain_id
= CRM_Core_Config
::domainID();
106 $dao->is_default
= FALSE;
109 while ($dao->fetch()) {
111 self
::_process(FALSE, $dao);
114 CRM_Core_Error
::fatal(ts('No mailboxes have been configured for Email to Activity Processing'));
120 * Process the mailbox for all the settings from civicrm_mail_settings.
122 * @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise.
126 public static function process($civiMail = TRUE) {
127 $dao = new CRM_Core_DAO_MailSettings();
128 $dao->domain_id
= CRM_Core_Config
::domainID();
131 while ($dao->fetch()) {
132 self
::_process($civiMail, $dao);
138 * @param CRM_Core_DAO $dao
142 public static function _process($civiMail, $dao) {
143 // 0 = activities; 1 = bounce;
144 $usedfor = $dao->is_default
;
147 = (defined('EMAIL_ACTIVITY_TYPE_ID') && EMAIL_ACTIVITY_TYPE_ID
) ? EMAIL_ACTIVITY_TYPE_ID
: CRM_Core_OptionGroup
::getValue(
153 if (!$emailActivityTypeId) {
154 CRM_Core_Error
::fatal(ts('Could not find a valid Activity Type ID for Inbound Email'));
157 $config = CRM_Core_Config
::singleton();
158 $verpSeperator = preg_quote($config->verpSeparator
);
159 $twoDigitStringMin = $verpSeperator . '(\d+)' . $verpSeperator . '(\d+)';
160 $twoDigitString = $twoDigitStringMin . $verpSeperator;
161 $threeDigitString = $twoDigitString . '(\d+)' . $verpSeperator;
163 // FIXME: legacy regexen to handle CiviCRM 2.1 address patterns, with domain id and possible VERP part
164 $commonRegex = '/^' . preg_quote($dao->localpart
) . '(b|bounce|c|confirm|o|optOut|r|reply|re|e|resubscribe|u|unsubscribe)' . $threeDigitString . '([0-9a-f]{16})(-.*)?@' . preg_quote($dao->domain
) . '$/';
165 $subscrRegex = '/^' . preg_quote($dao->localpart
) . '(s|subscribe)' . $twoDigitStringMin . '@' . preg_quote($dao->domain
) . '$/';
167 // a common-for-all-actions regex to handle CiviCRM 2.2 address patterns
168 $regex = '/^' . preg_quote($dao->localpart
) . '(b|c|e|o|r|u)' . $twoDigitString . '([0-9a-f]{16})@' . preg_quote($dao->domain
) . '$/';
170 // a tighter regex for finding bounce info in soft bounces’ mail bodies
171 $rpRegex = '/Return-Path: ' . preg_quote($dao->localpart
) . '(b)' . $twoDigitString . '([0-9a-f]{16})@' . preg_quote($dao->domain
) . '/';
173 // a regex for finding bound info X-Header
174 $rpXheaderRegex = '/X-CiviMail-Bounce: ' . preg_quote($dao->localpart
) . '(b)' . $twoDigitString . '([0-9a-f]{16})@' . preg_quote($dao->domain
) . '/i';
175 // CiviMail in regex and Civimail in header !!!
177 // retrieve the emails
179 $store = CRM_Mailing_MailStore
::getStore($dao->name
);
181 catch (Exception
$e) {
182 $message = ts('Could not connect to MailStore for ') . $dao->username
. '@' . $dao->server
. '<p>';
183 $message .= ts('Error message: ');
184 $message .= '<pre>' . $e->getMessage() . '</pre><p>';
185 CRM_Core_Error
::fatal($message);
188 // process fifty at a time, CRM-4002
189 while ($mails = $store->fetchNext(MAIL_BATCH_SIZE
)) {
190 foreach ($mails as $key => $mail) {
192 // for every addressee: match address elements if it's to CiviMail
197 foreach ($mail->to
as $address) {
198 if (preg_match($regex, $address->email
, $matches)) {
199 list($match, $action, $job, $queue, $hash) = $matches;
201 // FIXME: the below elseifs should be dropped when we drop legacy support
203 elseif (preg_match($commonRegex, $address->email
, $matches)) {
204 list($match, $action, $_, $job, $queue, $hash) = $matches;
207 elseif (preg_match($subscrRegex, $address->email
, $matches)) {
208 list($match, $action, $_, $job) = $matches;
213 // CRM-5471: if $matches is empty, it still might be a soft bounce sent
214 // to another address, so scan the body for ‘Return-Path: …bounce-pattern…’
215 if (!$matches and preg_match($rpRegex, $mail->generateBody(), $matches)) {
216 list($match, $action, $job, $queue, $hash) = $matches;
219 // if $matches is still empty, look for the X-CiviMail-Bounce header
221 if (!$matches and preg_match($rpXheaderRegex, $mail->generateBody(), $matches)) {
222 list($match, $action, $job, $queue, $hash) = $matches;
224 // With Mandrilla, the X-CiviMail-Bounce header is produced by generateBody
228 $all_parts = $mail->fetchParts();
229 foreach ($all_parts as $k_part => $v_part) {
230 if ($v_part instanceof ezcMailFile
) {
231 $p_file = $v_part->__get('fileName');
232 $c_file = file_get_contents($p_file);
233 if (preg_match($rpXheaderRegex, $c_file, $matches)) {
234 self
::_log("file match rpXheaderRegex", $matches);
235 list($match, $action, $job, $queue, $hash) = $matches;
241 // if all else fails, check Delivered-To for possible pattern
242 if (!$matches and preg_match($regex, $mail->getHeader('Delivered-To'), $matches)) {
243 list($match, $action, $job, $queue, $hash) = $matches;
247 // preseve backward compatibility
248 if ($usedfor == 0 ||
!$civiMail) {
249 // if its the activities that needs to be processed ..
250 $mailParams = CRM_Utils_Mail_Incoming
::parseMailingObject($mail);
252 require_once 'CRM/Utils/DeprecatedUtils.php';
253 $params = _civicrm_api3_deprecated_activity_buildmailparams($mailParams, $emailActivityTypeId);
255 $params['version'] = 3;
256 $result = civicrm_api('activity', 'create', $params);
258 if ($result['is_error']) {
260 echo "Failed Processing: {$mail->subject}. Reason: {$result['error_message']}\n";
264 echo "Processed as Activity: {$mail->subject}\n";
267 CRM_Utils_Hook
::emailProcessor('activity', $params, $mail, $result);
270 // if $matches is empty, this email is not CiviMail-bound
272 $store->markIgnored($key);
276 // get $replyTo from either the Reply-To header or from From
277 // FIXME: make sure it works with Reply-Tos containing non-email stuff
278 $replyTo = $mail->getHeader('Reply-To') ?
$mail->getHeader('Reply-To') : $mail->from
->email
;
280 // handle the action by passing it to the proper API call
281 // FIXME: leave only one-letter cases when dropping legacy support
282 if (!empty($action)) {
289 if ($mail->body
instanceof ezcMailText
) {
290 $text = $mail->body
->text
;
292 elseif ($mail->body
instanceof ezcMailMultipart
) {
293 if ($mail->body
instanceof ezcMailMultipartRelated
) {
294 foreach ($mail->body
->getRelatedParts() as $part) {
295 if (isset($part->subType
) and $part->subType
== 'plain') {
302 foreach ($mail->body
->getParts() as $part) {
303 if (isset($part->subType
) and $part->subType
== 'plain') {
313 $mail->subject
== "Delivery Status Notification (Failure)"
315 // Exchange error - CRM-9361
316 foreach ($mail->body
->getParts() as $part) {
317 if ($part instanceof ezcMailDeliveryStatus
) {
318 foreach ($part->recipients
as $rec) {
319 if ($rec["Status"] == "5.1.1") {
320 $text = "Delivery to the following recipients failed";
329 // If bounce processing fails, just take the raw body. Cf. CRM-11046
330 $text = $mail->generateBody();
332 // if text is still empty, lets fudge a blank text so the api call below will succeed
334 $text = ts('We could not extract the mail body from this bounce message.');
340 'event_queue_id' => $queue,
345 $result = civicrm_api('Mailing', 'event_bounce', $params);
352 'contact_id' => $job,
353 'subscribe_id' => $queue,
357 $result = civicrm_api('Mailing', 'event_confirm', $params);
364 'event_queue_id' => $queue,
368 $result = civicrm_api('MailingGroup', 'event_domain_unsubscribe', $params);
373 // instead of text and HTML parts (4th and 6th params) send the whole email as the last param
376 'event_queue_id' => $queue,
379 'replyTo' => $replyTo,
381 'fullEmail' => $mail->generate(),
384 $result = civicrm_api('Mailing', 'event_reply', $params);
392 'event_queue_id' => $queue,
396 $result = civicrm_api('MailingGroup', 'event_resubscribe', $params);
402 'email' => $mail->from
->email
,
406 $result = civicrm_api('MailingGroup', 'event_subscribe', $params);
413 'event_queue_id' => $queue,
417 $result = civicrm_api('MailingGroup', 'event_unsubscribe', $params);
421 if ($result['is_error']) {
422 echo "Failed Processing: {$mail->subject}, Action: $action, Job ID: $job, Queue ID: $queue, Hash: $hash. Reason: {$result['error_message']}\n";
425 CRM_Utils_Hook
::emailProcessor('mailing', $params, $mail, $result, $action);
429 $store->markProcessed($key);
431 // CRM-7356 – used by IMAP only