Skip to content

Commit 234faf6

Browse files
i-groui-grou
committed
CATL-1613: Add new field to the mail account form - Skip emails which do not have a Case ID or Case token
1 parent 4da9648 commit 234faf6

File tree

11 files changed

+301
-5
lines changed

11 files changed

+301
-5
lines changed

‎CRM/Admin/Form/MailSettings.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ public function buildQuickForm() {
7171
$this->add('select', 'is_default', ts('Used For?'), $usedfor);
7272
$this->addField('activity_status', ['placeholder' => FALSE]);
7373

74+
$this->add('checkbox', 'is_non_case_email_skipped', ts('Skip emails which do not have a Case ID or Case hash'));
7475
$this->add('checkbox', 'is_contact_creation_disabled_if_no_match', ts('Do not create new contacts when filing emails'));
7576
}
7677

@@ -148,6 +149,7 @@ public function postProcess() {
148149
'is_ssl',
149150
'is_default',
150151
'activity_status',
152+
'is_non_case_email_skipped',
151153
'is_contact_creation_disabled_if_no_match',
152154
];
153155

@@ -156,6 +158,7 @@ public function postProcess() {
156158
if (in_array($f, [
157159
'is_default',
158160
'is_ssl',
161+
'is_non_case_email_skipped',
159162
'is_contact_creation_disabled_if_no_match',
160163
])) {
161164
$params[$f] = CRM_Utils_Array::value($f, $formValues, FALSE);
@@ -168,7 +171,7 @@ public function postProcess() {
168171
$params['domain_id'] = CRM_Core_Config::domainID();
169172

170173
// assign id only in update mode
171-
$status = ts('Your New Email Settings have been saved.');
174+
$status = ts('Your New Email Settings have been saved.');
172175
if ($this->_action & CRM_Core_Action::UPDATE) {
173176
$params['id'] = $this->_id;
174177
$status = ts('Your Email Settings have been updated.');

‎CRM/Upgrade/Incremental/php/FiveThirtyOne.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ public function upgrade_5_31_alpha1($rev) {
7474
*/
7575
public function upgrade_5_31_0($rev) {
7676
$this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
77+
$this->addTask('Add is_non_case_email_skipped column to civicrm_mail_settings', 'addColumn',
78+
'civicrm_mail_settings', 'is_non_case_email_skipped', "TINYINT DEFAULT 0 NOT NULL COMMENT 'Skip emails which do not have a Case ID or Case hash'");
7779
$this->addTask('Add is_contact_creation_disabled_if_no_match column to civicrm_mail_settings', 'addColumn',
7880
'civicrm_mail_settings', 'is_contact_creation_disabled_if_no_match', "TINYINT DEFAULT 0 NOT NULL COMMENT 'If this option is enabled, CiviCRM will not create new contacts when filing emails'");
7981
}

‎CRM/Utils/Hook.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1271,6 +1271,28 @@ public static function caseTypes(&$caseTypes) {
12711271
->invoke(['caseTypes'], $caseTypes, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_caseTypes');
12721272
}
12731273

1274+
/**
1275+
* This hook is called when getting case email subject patterns.
1276+
*
1277+
* All emails related to cases have case hash/id in the subject, e.g:
1278+
* [case #ab12efg] Magic moment
1279+
* [case #1234] Magic is here
1280+
*
1281+
* Using this hook you can replace/enrich default list with some other
1282+
* patterns, e.g. include case type categories (see CiviCase extension) like:
1283+
* [(case|project|policy initiative) #hash]
1284+
* [(case|project|policy initiative) #id]
1285+
*
1286+
* @param array $subjectPatterns
1287+
* Cases related email subject regexp patterns.
1288+
*
1289+
* @return mixed
1290+
*/
1291+
public static function caseEmailSubjectPatterns(&$subjectPatterns) {
1292+
return self::singleton()
1293+
->invoke(['caseEmailSubjectPatterns'], $subjectPatterns, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_caseEmailSubjectPatterns');
1294+
}
1295+
12741296
/**
12751297
* This hook is called soon after the CRM_Core_Config object has ben initialized.
12761298
* You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.

‎CRM/Utils/Mail/CaseMail.php‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<?php
2+
/*
3+
+--------------------------------------------------------------------+
4+
| Copyright CiviCRM LLC. All rights reserved. |
5+
| |
6+
| This work is published under the GNU AGPLv3 license with some |
7+
| permitted exceptions and without any warranty. For full license |
8+
| and copyright information, see https://civicrm.org/licensing |
9+
+--------------------------------------------------------------------+
10+
*/
11+
12+
/**
13+
*
14+
* @package CRM
15+
* @copyright CiviCRM LLC https://civicrm.org/licensing
16+
*/
17+
18+
/**
19+
* Class CRM_Utils_Mail_CaseMail.
20+
*/
21+
class CRM_Utils_Mail_CaseMail {
22+
23+
/**
24+
* A word that is used for cases by default (in email subject).
25+
*
26+
* @var string
27+
*/
28+
private $caseLabel = 'case';
29+
30+
/**
31+
* Default cases related email subject regexp patterns.
32+
*
33+
* All emails related to cases have case hash/id in the subject, e.g:
34+
* [case #ab12efg] Magic moment
35+
* [case #1234] Magic is here
36+
* This variable is defined in constructor.
37+
*
38+
* @var array|string[]
39+
*/
40+
private $subjectPatterns = [];
41+
42+
/**
43+
* Cases related email subject regexp patterns extended by hooks.
44+
*
45+
* @var array|string[]
46+
*/
47+
private $subjectPatternsHooked = [];
48+
49+
/**
50+
* CRM_Utils_Mail_CaseMail constructor.
51+
*/
52+
public function __construct() {
53+
$this->subjectPatterns = [
54+
'/\[' . $this->caseLabel . ' #([0-9a-f]{7})\]/i',
55+
'/\[' . $this->caseLabel . ' #(\d+)\]/i',
56+
];
57+
}
58+
59+
/**
60+
* Checks if email is related to cases.
61+
*
62+
* @param string $subject
63+
* Email subject.
64+
*
65+
* @return bool
66+
* TRUE if email subject contains case ID or case hash, FALSE otherwise.
67+
*/
68+
public function isCaseEmail ($subject) {
69+
$subject = trim($subject);
70+
$patterns = $this->getSubjectPatterns();
71+
$res = FALSE;
72+
73+
for ($i = 0; !$res && $i < count($patterns); $i++) {
74+
$res = preg_match($patterns[$i], $subject) === 1;
75+
}
76+
77+
return $res;
78+
}
79+
80+
/**
81+
* Returns cases related email subject patterns.
82+
*
83+
* These patterns could be used to check if email is related to cases.
84+
*
85+
* @return array|string[]
86+
*/
87+
public function getSubjectPatterns() {
88+
// Allow others to change patterns using hook.
89+
if (empty($this->subjectPatternsHooked)) {
90+
$patterns = $this->subjectPatterns;
91+
CRM_Utils_Hook::caseEmailSubjectPatterns($patterns);
92+
$this->subjectPatternsHooked = $patterns;
93+
}
94+
95+
return !empty($this->subjectPatternsHooked)
96+
? $this->subjectPatternsHooked
97+
: $this->subjectPatterns;
98+
}
99+
100+
/**
101+
* Returns value of some class property.
102+
*
103+
* @param string $name
104+
* Property name.
105+
*
106+
* @return mixed|null
107+
* Property value or null if property does not exist.
108+
*/
109+
public function get($name) {
110+
return $this->{$name} ?? NULL;
111+
}
112+
113+
/**
114+
* Sets value of some class property.
115+
*
116+
* @param string $name
117+
* Property name.
118+
* @param mixed $value
119+
* New property value.
120+
*/
121+
public function set($name, $value) {
122+
if (isset($this->{$name})) {
123+
$this->{$name} = $value;
124+
}
125+
}
126+
127+
}

‎CRM/Utils/Mail/EmailProcessor.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,15 @@ public static function _process($civiMail, $dao, $is_create_activities) {
224224

225225
// preseve backward compatibility
226226
if ($usedfor == 0 || $is_create_activities) {
227+
// Mail account may have 'Skip emails which do not have a Case ID
228+
// or Case hash' option, if its enabled and email is not related
229+
// to cases - then we need to put email to ignored folder.
230+
$caseMailUtils = new CRM_Utils_Mail_CaseMail();
231+
if (!empty($dao->is_non_case_email_skipped) && !$caseMailUtils->isCaseEmail($mail->subject)) {
232+
$store->markIgnored($key);
233+
continue;
234+
}
235+
227236
// if its the activities that needs to be processed ..
228237
try {
229238
$createContact = !($dao->is_contact_creation_disabled_if_no_match ?? FALSE);

‎templates/CRM/Admin/Form/MailSettings.tpl‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@
5252
<tr class="crm-mail-settings-form-block-is_default"><td class="label">{$form.is_default.label}</td><td>{$form.is_default.html}</td></tr>
5353
<tr><td class="label">&nbsp;</td><td class="description">{ts}How this mail account will be used. Only one box may be used for bounce processing. It will also be used as the envelope email when sending mass mailings.{/ts}</td></tr>
5454

55-
<tr class="crm-mail-settings-form-block-is_contact_creation_disabled_if_no_match"><td class="label">&nbsp;</td><td>{$form.is_contact_creation_disabled_if_no_match.html}{$form.is_contact_creation_disabled_if_no_match.label}</td></tr>
55+
<tr class="crm-mail-settings-form-block-is_non_case_email_skipped"><td class="label">&nbsp;</td><td>{$form.is_non_case_email_skipped.html}{$form.is_non_case_email_skipped.label} {help id='is_non_case_email_skipped'}</td></tr>
56+
57+
<tr class="crm-mail-settings-form-block-is_contact_creation_disabled_if_no_match"><td class="label">&nbsp;</td><td>{$form.is_contact_creation_disabled_if_no_match.html}{$form.is_contact_creation_disabled_if_no_match.label} {help id='is_contact_creation_disabled_if_no_match'}</td></tr>
5658

5759
<tr class="crm-mail-settings-form-block-activity_status"><td class="label">&nbsp;</td><td>{$form.activity_status.label}<div>{$form.activity_status.html}</div></td></tr>
5860
</table>
@@ -68,9 +70,9 @@
6870
function showActivityFields() {
6971
var fields = [
7072
'.crm-mail-settings-form-block-activity_status',
73+
'.crm-mail-settings-form-block-is_non_case_email_skipped',
7174
'.crm-mail-settings-form-block-is_contact_creation_disabled_if_no_match',
7275
];
73-
7476
$(fields.join(', '), $form).toggle($(this).val() === '0');
7577
}
7678
$('select[name="is_default"]').each(showActivityFields).change(showActivityFields);

‎templates/CRM/Admin/Page/MailSettings.hlp‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{*
2+
+--------------------------------------------------------------------+
3+
| Copyright CiviCRM LLC. All rights reserved. |
4+
| |
5+
| This work is published under the GNU AGPLv3 license with some |
6+
| permitted exceptions and without any warranty. For full license |
7+
| and copyright information, see https://civicrm.org/licensing |
8+
+--------------------------------------------------------------------+
9+
*}
10+
11+
{htxt id="is_non_case_email_skipped-title"}
12+
{ts}Skip emails which do not have a Case ID or Case hash{/ts}
13+
{/htxt}
14+
15+
{htxt id="is_non_case_email_skipped"}
16+
<p>{ts}CiviCRM has functionality to file emails which contain the Case ID or Case Hash in the subject line in the format [case #1234] against a case record.{/ts}</p>
17+
<p>{ts}Where the Case ID or Case Hash is not included CiviCRM will file the email against the contact record, by matching the email addresses on the email with any email addresses of Contact records in CiviCRM.{/ts}</p>
18+
<p>{ts}Enabling this option will have CiviCRM skip any emails that do not have the Case ID or Case Hash so that the system will only process emails that can be placed on case records.{/ts}</p>
19+
<p>{ts}Any emails that are not processed will be moved to the ignored folder.{/ts}</p>
20+
<p>{ts}If email is skipped, no activities or contacts ("from"/"to"/"cc"/"bcc") will be created.{/ts}</p>
21+
{/htxt}
22+
23+
{htxt id="is_contact_creation_disabled_if_no_match-title"}
24+
{ts}Do not create new contacts when filing emails{/ts}
25+
{/htxt}
26+
27+
{htxt id="is_contact_creation_disabled_if_no_match"}
28+
<p>{ts}If this option is enabled, CiviCRM will not create new contacts ("from"/"to"/"cc"/"bcc") when filing emails.{/ts}</p>
29+
<p>{ts}If the email subject contains a valid Case ID or Case hash, the email will be filed against the case.{/ts}</p>
30+
{/htxt}

‎tests/phpunit/CRM/Utils/Mail/EmailProcessorTest.php‎

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,19 @@ public function setUp() {
3737
public function tearDown() {
3838
CRM_Utils_File::cleanDir(__DIR__ . '/data/mail');
3939
parent::tearDown();
40-
$this->quickCleanup(['civicrm_group', 'civicrm_group_contact', 'civicrm_mailing', 'civicrm_mailing_job', 'civicrm_mailing_event_bounce', 'civicrm_mailing_event_queue', 'civicrm_mailing_group', 'civicrm_mailing_recipients', 'civicrm_contact', 'civicrm_email']);
40+
$this->quickCleanup([
41+
'civicrm_group',
42+
'civicrm_group_contact',
43+
'civicrm_mailing',
44+
'civicrm_mailing_job',
45+
'civicrm_mailing_event_bounce',
46+
'civicrm_mailing_event_queue',
47+
'civicrm_mailing_group',
48+
'civicrm_mailing_recipients',
49+
'civicrm_contact',
50+
'civicrm_email',
51+
'civicrm_activity',
52+
]);
4153
}
4254

4355
/**
@@ -139,7 +151,6 @@ public function testBounceProcessingDeletedEmail() {
139151
}
140152

141153
/**
142-
*
143154
* Wrapper to check for mailing bounces.
144155
*
145156
* Normally we would call $this->callAPISuccessGetCount but there is not one & there is resistance to
@@ -169,6 +180,55 @@ public function setUpMailing() {
169180
$this->eventQueue = $this->callAPISuccess('MailingEventQueue', 'get', ['api.MailingEventQueue.create' => ['hash' => 'aaaaaaaaaaaaaaaa']]);
170181
}
171182

183+
/**
184+
* Set up mail account with 'Skip emails which do not have a Case ID or
185+
* Case hash' option enabled.
186+
*/
187+
public function setUpSkipNonCasesEmail() {
188+
$this->callAPISuccess('MailSettings', 'get', [
189+
'api.MailSettings.create' => [
190+
'name' => 'mailbox',
191+
'protocol' => 'Localdir',
192+
'source' => __DIR__ . '/data/mail',
193+
'domain' => 'example.com',
194+
'is_default' => '0',
195+
'is_non_case_email_skipped' => TRUE,
196+
],
197+
]);
198+
}
199+
200+
/**
201+
* Test case email processing when is_non_case_email_skipped is enabled.
202+
*/
203+
public function testInboundProcessingCaseEmail() {
204+
$this->setUpSkipNonCasesEmail();
205+
$mail = 'test_cases_email.eml';
206+
207+
copy(__DIR__ . '/data/inbound/' . $mail, __DIR__ . '/data/mail/' . $mail);
208+
$this->callAPISuccess('job', 'fetch_activities', []);
209+
$result = civicrm_api3('Activity', 'get', [
210+
'sequential' => 1,
211+
'subject' => ['LIKE' => "%[case #214bf6d]%"],
212+
]);
213+
$this->assertNotEmpty($result['values'][0]['id']);
214+
}
215+
216+
/**
217+
* Test non case email processing when is_non_case_email_skipped is enabled.
218+
*/
219+
public function testInboundProcessingNonCaseEmail() {
220+
$this->setUpSkipNonCasesEmail();
221+
$mail = 'test_non_cases_email.eml';
222+
223+
copy(__DIR__ . '/data/inbound/' . $mail, __DIR__ . '/data/mail/' . $mail);
224+
$this->callAPISuccess('job', 'fetch_activities', []);
225+
$result = civicrm_api3('Activity', 'get', [
226+
'sequential' => 1,
227+
'subject' => ['LIKE' => "%Love letter%"],
228+
]);
229+
$this->assertEmpty($result['values']);
230+
}
231+
172232
/**
173233
* Set up mail account with 'Do not create new contacts when filing emails'
174234
* option enabled.

‎tests/phpunit/CRM/Utils/Mail/data/inbound/test_cases_email.eml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Delivered-To: [email protected]
2+
Received: by 10.2.13.84 with SMTP id 1234567890;
3+
Wed, 19 Dec 2018 10:01:11 +0100 (CET)
4+
Return-Path: <>
5+
Message-ID: <[email protected]>
6+
Date: Wed, 19 Dec 2018 10:01:07 +0100
7+
MIME-Version: 1.0
8+
Content-Type: text/plain; charset="utf-8"
9+
Content-Transfer-Encoding: 8bit
10+
Content-Disposition: inline
11+
From: [email protected]
12+
To: [email protected]
13+
Subject: [case #214bf6d] Magic is here
14+
15+
This test case is full of fun.

‎tests/phpunit/CRM/Utils/Mail/data/inbound/test_non_cases_email.eml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Delivered-To: [email protected]
2+
Received: by 10.2.13.84 with SMTP id 1234567890;
3+
Wed, 19 Dec 2018 10:01:11 +0100 (CET)
4+
Return-Path: <>
5+
Message-ID: <[email protected]>
6+
Date: Wed, 19 Dec 2018 10:01:07 +0100
7+
MIME-Version: 1.0
8+
Content-Type: text/plain; charset="utf-8"
9+
Content-Transfer-Encoding: 8bit
10+
Content-Disposition: inline
11+
From: [email protected]
12+
To: [email protected]
13+
Subject: Love letter
14+
15+
I love you unit test, because you are not related to cases.

0 commit comments

Comments
 (0)