Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * APIv3 functions for registering/processing mailing events. | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
6a488035 TO |
33 | */ |
34 | ||
6a488035 TO |
35 | /** |
36 | * Handle a create event. | |
37 | * | |
38 | * @param array $params | |
22242c87 | 39 | * |
1747ab99 | 40 | * @return array |
7c550ca0 | 41 | * API Success Array |
c23f45d3 EM |
42 | * @throws \API_Exception |
43 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 | 44 | */ |
c23f45d3 | 45 | function civicrm_api3_mailing_create($params) { |
6bc3944a | 46 | if (isset($params['template_options']) && is_array($params['template_options'])) { |
fb840482 | 47 | $params['template_options'] = ($params['template_options'] === array()) ? '{}' : json_encode($params['template_options']); |
6bc3944a | 48 | } |
6818346a | 49 | if (CRM_Mailing_Info::workflowEnabled()) { |
360d6097 TO |
50 | // Note: 'schedule mailings' and 'approve mailings' can update certain fields, but can't create. |
51 | ||
52 | if (empty($params['id'])) { | |
53 | if (!CRM_Core_Permission::check('access CiviMail') && !CRM_Core_Permission::check('create mailings')) { | |
54 | throw new \Civi\API\Exception\UnauthorizedException("Cannot create new mailing. Required permission: 'access CiviMail' or 'create mailings'"); | |
55 | } | |
56 | } | |
57 | ||
3efe22a0 TO |
58 | $safeParams = array(); |
59 | $fieldPerms = CRM_Mailing_BAO_Mailing::getWorkflowFieldPerms(); | |
60 | foreach (array_keys($params) as $field) { | |
61 | if (CRM_Core_Permission::check($fieldPerms[$field])) { | |
62 | $safeParams[$field] = $params[$field]; | |
63 | } | |
6818346a TO |
64 | } |
65 | } | |
3efe22a0 TO |
66 | else { |
67 | $safeParams = $params; | |
68 | } | |
69 | $safeParams['_evil_bao_validator_'] = 'CRM_Mailing_BAO_Mailing::checkSendable'; | |
6bc3944a TO |
70 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $safeParams); |
71 | return _civicrm_api3_mailing_get_formatResult($result); | |
e81bac46 | 72 | |
6a488035 TO |
73 | } |
74 | ||
c23f45d3 | 75 | /** |
9950a1c9 CW |
76 | * Get tokens for one or more entity type |
77 | * | |
78 | * Output will be formatted either as a flat list, | |
79 | * or pass sequential=1 to retrieve as a hierarchy formatted for select2. | |
22242c87 | 80 | * |
c23f45d3 | 81 | * @param array $params |
9950a1c9 | 82 | * Should contain an array of entities to retrieve tokens for. |
22242c87 | 83 | * |
c23f45d3 EM |
84 | * @return array |
85 | * @throws \API_Exception | |
86 | */ | |
1d280e03 CW |
87 | function civicrm_api3_mailing_gettokens($params) { |
88 | $tokens = array(); | |
89 | foreach ((array) $params['entity'] as $ent) { | |
9950a1c9 | 90 | $func = lcfirst($ent) . 'Tokens'; |
1d280e03 CW |
91 | if (!method_exists('CRM_Core_SelectValues', $func)) { |
92 | throw new API_Exception('Unknown token entity: ' . $ent); | |
93 | } | |
94 | $tokens = array_merge(CRM_Core_SelectValues::$func(), $tokens); | |
7e6e8bd6 | 95 | } |
1d280e03 CW |
96 | if (!empty($params['sequential'])) { |
97 | $tokens = CRM_Utils_Token::formatTokensForDisplay($tokens); | |
7e6e8bd6 | 98 | } |
1d280e03 CW |
99 | return civicrm_api3_create_success($tokens, $params, 'Mailing', 'gettokens'); |
100 | } | |
a95acf21 | 101 | |
1d280e03 CW |
102 | /** |
103 | * Adjust Metadata for Create action. | |
104 | * | |
105 | * The metadata is used for setting defaults, documentation & validation. | |
106 | * | |
107 | * @param array $params | |
108 | * Array of parameters determined by getfields. | |
109 | */ | |
110 | function _civicrm_api3_mailing_gettokens_spec(&$params) { | |
111 | $params['entity'] = array( | |
112 | 'api.default' => array('contact'), | |
113 | 'api.required' => 1, | |
7b6c5043 | 114 | 'api.multiple' => 1, |
1d280e03 CW |
115 | 'title' => 'Entity', |
116 | 'options' => array(), | |
117 | ); | |
9950a1c9 | 118 | // Fetch a list of token functions and format to look like entity names |
1d280e03 CW |
119 | foreach (get_class_methods('CRM_Core_SelectValues') as $func) { |
120 | if (strpos($func, 'Tokens')) { | |
9950a1c9 | 121 | $ent = ucfirst(str_replace('Tokens', '', $func)); |
1d280e03 CW |
122 | $params['entity']['options'][$ent] = $ent; |
123 | } | |
124 | } | |
7e6e8bd6 | 125 | } |
2b5e4108 | 126 | |
11e09c59 | 127 | /** |
0aa0303c EM |
128 | * Adjust Metadata for Create action. |
129 | * | |
130 | * The metadata is used for setting defaults, documentation & validation. | |
11e09c59 | 131 | * |
cf470720 | 132 | * @param array $params |
b081365f | 133 | * Array of parameters determined by getfields. |
11e09c59 | 134 | */ |
6a488035 | 135 | function _civicrm_api3_mailing_create_spec(&$params) { |
fddd185d | 136 | $params['created_id']['api.default'] = 'user_contact_id'; |
b0a31714 | 137 | |
1a574627 | 138 | $params['override_verp']['api.default'] = !CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'track_civimail_replies'); |
b0a31714 | 139 | $params['visibility']['api.default'] = 'Public Pages'; |
1a574627 | 140 | $params['dedupe_email']['api.default'] = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'dedupe_email_default'); |
b0a31714 TO |
141 | |
142 | $params['forward_replies']['api.default'] = FALSE; | |
143 | $params['auto_responder']['api.default'] = FALSE; | |
144 | $params['open_tracking']['api.default'] = TRUE; | |
145 | $params['url_tracking']['api.default'] = TRUE; | |
146 | ||
147 | $params['header_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Header', ''); | |
148 | $params['footer_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Footer', ''); | |
149 | $params['optout_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('OptOut', ''); | |
150 | $params['reply_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Reply', ''); | |
151 | $params['resubscribe_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Resubscribe', ''); | |
152 | $params['unsubscribe_id']['api.default'] = CRM_Mailing_PseudoConstant::defaultComponent('Unsubscribe', ''); | |
f72b68c0 | 153 | $params['mailing_type']['api.default'] = 'standalone'; |
b0a31714 | 154 | $defaultAddress = CRM_Core_OptionGroup::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1'); |
a98504a7 | 155 | foreach ($defaultAddress as $value) { |
b0a31714 TO |
156 | if (preg_match('/"(.*)" <(.*)>/', $value, $match)) { |
157 | $params['from_email']['api.default'] = $match[2]; | |
158 | $params['from_name']['api.default'] = $match[1]; | |
159 | } | |
160 | } | |
6a488035 TO |
161 | } |
162 | ||
70599df6 | 163 | /** |
164 | * Adjust metadata for clone spec action. | |
165 | * | |
166 | * @param array $spec | |
167 | */ | |
00dc999a TO |
168 | function _civicrm_api3_mailing_clone_spec(&$spec) { |
169 | $mailingFields = CRM_Mailing_DAO_Mailing::fields(); | |
170 | $spec['id'] = $mailingFields['id']; | |
171 | $spec['id']['api.required'] = 1; | |
172 | } | |
173 | ||
70599df6 | 174 | /** |
175 | * Clone mailing. | |
176 | * | |
177 | * @param array $params | |
178 | * | |
179 | * @return array | |
180 | * @throws \CiviCRM_API3_Exception | |
181 | */ | |
00dc999a TO |
182 | function civicrm_api3_mailing_clone($params) { |
183 | $BLACKLIST = array( | |
184 | 'id', | |
185 | 'is_completed', | |
186 | 'created_id', | |
187 | 'created_date', | |
188 | 'scheduled_id', | |
189 | 'scheduled_date', | |
190 | 'approver_id', | |
191 | 'approval_date', | |
192 | 'approval_status_id', | |
193 | 'approval_note', | |
194 | 'is_archived', | |
195 | 'hash', | |
a18a5128 | 196 | 'mailing_type', |
00dc999a TO |
197 | ); |
198 | ||
199 | $get = civicrm_api3('Mailing', 'getsingle', array('id' => $params['id'])); | |
200 | ||
201 | $newParams = array(); | |
202 | $newParams['debug'] = CRM_Utils_Array::value('debug', $params); | |
203 | $newParams['groups']['include'] = array(); | |
204 | $newParams['groups']['exclude'] = array(); | |
205 | $newParams['mailings']['include'] = array(); | |
206 | $newParams['mailings']['exclude'] = array(); | |
207 | foreach ($get as $field => $value) { | |
208 | if (!in_array($field, $BLACKLIST)) { | |
209 | $newParams[$field] = $value; | |
210 | } | |
211 | } | |
212 | ||
213 | $dao = new CRM_Mailing_DAO_MailingGroup(); | |
214 | $dao->mailing_id = $params['id']; | |
215 | $dao->find(); | |
216 | while ($dao->fetch()) { | |
217 | // CRM-11431; account for multi-lingual | |
218 | $entity = (substr($dao->entity_table, 0, 15) == 'civicrm_mailing') ? 'mailings' : 'groups'; | |
219 | $newParams[$entity][strtolower($dao->group_type)][] = $dao->entity_id; | |
220 | } | |
221 | ||
222 | return civicrm_api3('Mailing', 'create', $newParams); | |
223 | } | |
224 | ||
e37b4b04 | 225 | /** |
eb1823ac | 226 | * Handle a delete event. |
e37b4b04 | 227 | * |
228 | * @param array $params | |
77b97be7 | 229 | * |
a6c01b45 | 230 | * @return array |
72b3a70c | 231 | * API Success Array |
e37b4b04 | 232 | */ |
906e6120 | 233 | function civicrm_api3_mailing_delete($params) { |
7e6e8bd6 | 234 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
e37b4b04 | 235 | } |
236 | ||
6a488035 TO |
237 | /** |
238 | * Handle a get event. | |
239 | * | |
240 | * @param array $params | |
d1b0d05e | 241 | * |
6a488035 TO |
242 | * @return array |
243 | */ | |
e37b4b04 | 244 | function civicrm_api3_mailing_get($params) { |
6bc3944a TO |
245 | $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
246 | return _civicrm_api3_mailing_get_formatResult($result); | |
247 | } | |
248 | ||
249 | /** | |
250 | * Format definition. | |
251 | * | |
252 | * @param array $result | |
253 | * | |
254 | * @return array | |
255 | * @throws \CRM_Core_Exception | |
256 | */ | |
257 | function _civicrm_api3_mailing_get_formatResult($result) { | |
258 | if (isset($result['values']) && is_array($result['values'])) { | |
259 | foreach ($result['values'] as $key => $caseType) { | |
260 | if (isset($result['values'][$key]['template_options']) && is_string($result['values'][$key]['template_options'])) { | |
261 | $result['values'][$key]['template_options'] = json_decode($result['values'][$key]['template_options'], TRUE); | |
262 | } | |
263 | } | |
264 | } | |
265 | return $result; | |
6a488035 TO |
266 | } |
267 | ||
c23f45d3 | 268 | /** |
22242c87 EM |
269 | * Adjust metadata for mailing submit api function. |
270 | * | |
c23f45d3 EM |
271 | * @param array $spec |
272 | */ | |
6818346a TO |
273 | function _civicrm_api3_mailing_submit_spec(&$spec) { |
274 | $mailingFields = CRM_Mailing_DAO_Mailing::fields(); | |
275 | $spec['id'] = $mailingFields['id']; | |
276 | $spec['scheduled_date'] = $mailingFields['scheduled_date']; | |
277 | $spec['approval_date'] = $mailingFields['approval_date']; | |
2c1e4dc1 TO |
278 | $spec['approval_status_id'] = $mailingFields['approval_status_id']; |
279 | $spec['approval_note'] = $mailingFields['approval_note']; | |
768c558c | 280 | // _skip_evil_bao_auto_recipients_: bool |
6818346a TO |
281 | } |
282 | ||
283 | /** | |
22242c87 EM |
284 | * Mailing submit. |
285 | * | |
6818346a | 286 | * @param array $params |
22242c87 | 287 | * |
768c558c TO |
288 | * @return array |
289 | * @throws API_Exception | |
6818346a TO |
290 | */ |
291 | function civicrm_api3_mailing_submit($params) { | |
292 | civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_Mailing', array('id')); | |
293 | ||
294 | if (!isset($params['scheduled_date']) && !isset($updateParams['approval_date'])) { | |
295 | throw new API_Exception("Missing parameter scheduled_date and/or approval_date"); | |
296 | } | |
297 | if (!is_numeric(CRM_Core_Session::getLoggedInContactID())) { | |
298 | throw new API_Exception("Failed to determine current user"); | |
299 | } | |
300 | ||
301 | $updateParams = array(); | |
302 | $updateParams['id'] = $params['id']; | |
303 | ||
dc64d047 EM |
304 | // Note: we'll pass along scheduling/approval fields, but they may get ignored |
305 | // if we don't have permission. | |
6818346a TO |
306 | if (isset($params['scheduled_date'])) { |
307 | $updateParams['scheduled_date'] = $params['scheduled_date']; | |
308 | $updateParams['scheduled_id'] = CRM_Core_Session::getLoggedInContactID(); | |
309 | } | |
768c558c | 310 | if (isset($params['approval_date'])) { |
6818346a TO |
311 | $updateParams['approval_date'] = $params['approval_date']; |
312 | $updateParams['approver_id'] = CRM_Core_Session::getLoggedInContactID(); | |
313 | $updateParams['approval_status_id'] = CRM_Utils_Array::value('approval_status_id', $updateParams, CRM_Core_OptionGroup::getDefaultValue('mail_approval_status')); | |
314 | } | |
2c1e4dc1 TO |
315 | if (isset($params['approval_note'])) { |
316 | $updateParams['approval_note'] = $params['approval_note']; | |
317 | } | |
768c558c TO |
318 | if (isset($params['_skip_evil_bao_auto_recipients_'])) { |
319 | $updateParams['_skip_evil_bao_auto_recipients_'] = $params['_skip_evil_bao_auto_recipients_']; | |
320 | } | |
6818346a TO |
321 | |
322 | $updateParams['options']['reload'] = 1; | |
323 | return civicrm_api3('Mailing', 'create', $updateParams); | |
324 | } | |
325 | ||
6a488035 TO |
326 | /** |
327 | * Process a bounce event by passing through to the BAOs. | |
328 | * | |
329 | * @param array $params | |
330 | * | |
77b97be7 | 331 | * @throws API_Exception |
6a488035 TO |
332 | * @return array |
333 | */ | |
334 | function civicrm_api3_mailing_event_bounce($params) { | |
7e6e8bd6 TO |
335 | $body = $params['body']; |
336 | unset($params['body']); | |
6a488035 | 337 | |
7e6e8bd6 | 338 | $params += CRM_Mailing_BAO_BouncePattern::match($body); |
6a488035 | 339 | |
7e6e8bd6 TO |
340 | if (CRM_Mailing_Event_BAO_Bounce::create($params)) { |
341 | return civicrm_api3_create_success($params); | |
342 | } | |
343 | else { | |
244bbdd8 | 344 | throw new API_Exception(ts('Queue event could not be found'), 'no_queue_event'); |
7e6e8bd6 | 345 | } |
6a488035 TO |
346 | } |
347 | ||
11e09c59 | 348 | /** |
22242c87 | 349 | * Adjust Metadata for bounce_spec action. |
11e09c59 | 350 | * |
0aa0303c EM |
351 | * The metadata is used for setting defaults, documentation & validation. |
352 | * | |
cf470720 | 353 | * @param array $params |
b081365f | 354 | * Array of parameters determined by getfields. |
11e09c59 | 355 | */ |
6a488035 TO |
356 | function _civicrm_api3_mailing_event_bounce_spec(&$params) { |
357 | $params['job_id']['api.required'] = 1; | |
4c41ecb2 | 358 | $params['job_id']['title'] = 'Job ID'; |
6a488035 | 359 | $params['event_queue_id']['api.required'] = 1; |
4c41ecb2 | 360 | $params['event_queue_id']['title'] = 'Event Queue ID'; |
6a488035 | 361 | $params['hash']['api.required'] = 1; |
4c41ecb2 | 362 | $params['hash']['title'] = 'Hash'; |
6a488035 | 363 | $params['body']['api.required'] = 1; |
4c41ecb2 | 364 | $params['body']['title'] = 'Body'; |
6a488035 TO |
365 | } |
366 | ||
367 | /** | |
22242c87 EM |
368 | * Handle a confirm event. |
369 | * | |
6a488035 TO |
370 | * @deprecated |
371 | * | |
372 | * @param array $params | |
373 | * | |
374 | * @return array | |
375 | */ | |
376 | function civicrm_api3_mailing_event_confirm($params) { | |
244bbdd8 | 377 | return civicrm_api('MailingEventConfirm', 'create', $params); |
6a488035 TO |
378 | } |
379 | ||
a14e9d08 | 380 | /** |
d1b0d05e EM |
381 | * Declare deprecated functions. |
382 | * | |
a14e9d08 | 383 | * @deprecated api notice |
a6c01b45 | 384 | * @return array |
16b10e64 | 385 | * Array of deprecated actions |
a14e9d08 CW |
386 | */ |
387 | function _civicrm_api3_mailing_deprecation() { | |
388 | return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.'); | |
389 | } | |
390 | ||
6a488035 | 391 | /** |
22242c87 | 392 | * Handle a reply event. |
6a488035 TO |
393 | * |
394 | * @param array $params | |
395 | * | |
396 | * @return array | |
397 | */ | |
398 | function civicrm_api3_mailing_event_reply($params) { | |
7e6e8bd6 TO |
399 | $job = $params['job_id']; |
400 | $queue = $params['event_queue_id']; | |
401 | $hash = $params['hash']; | |
402 | $replyto = $params['replyTo']; | |
403 | $bodyTxt = CRM_Utils_Array::value('bodyTxt', $params); | |
404 | $bodyHTML = CRM_Utils_Array::value('bodyHTML', $params); | |
405 | $fullEmail = CRM_Utils_Array::value('fullEmail', $params); | |
406 | ||
407 | $mailing = CRM_Mailing_Event_BAO_Reply::reply($job, $queue, $hash, $replyto); | |
408 | ||
409 | if (empty($mailing)) { | |
410 | return civicrm_api3_create_error('Queue event could not be found'); | |
411 | } | |
6a488035 | 412 | |
7e6e8bd6 | 413 | CRM_Mailing_Event_BAO_Reply::send($queue, $mailing, $bodyTxt, $replyto, $bodyHTML, $fullEmail); |
6a488035 | 414 | |
7e6e8bd6 | 415 | return civicrm_api3_create_success($params); |
6a488035 TO |
416 | } |
417 | ||
11e09c59 | 418 | /** |
22242c87 | 419 | * Adjust Metadata for event_reply action. |
11e09c59 | 420 | * |
0aa0303c EM |
421 | * The metadata is used for setting defaults, documentation & validation. |
422 | * | |
cf470720 | 423 | * @param array $params |
b081365f | 424 | * Array of parameters determined by getfields. |
11e09c59 | 425 | */ |
6a488035 TO |
426 | function _civicrm_api3_mailing_event_reply_spec(&$params) { |
427 | $params['job_id']['api.required'] = 1; | |
4c41ecb2 | 428 | $params['job_id']['title'] = 'Job ID'; |
6a488035 | 429 | $params['event_queue_id']['api.required'] = 1; |
4c41ecb2 | 430 | $params['event_queue_id']['title'] = 'Event Queue ID'; |
6a488035 | 431 | $params['hash']['api.required'] = 1; |
4c41ecb2 | 432 | $params['hash']['title'] = 'Hash'; |
fb18363b | 433 | $params['replyTo']['api.required'] = 0; |
4c41ecb2 | 434 | $params['replyTo']['title'] = 'Reply To';//doesn't really explain adequately |
6a488035 TO |
435 | } |
436 | ||
437 | /** | |
22242c87 | 438 | * Handle a forward event. |
6a488035 TO |
439 | * |
440 | * @param array $params | |
441 | * | |
442 | * @return array | |
443 | */ | |
444 | function civicrm_api3_mailing_event_forward($params) { | |
7e6e8bd6 TO |
445 | $job = $params['job_id']; |
446 | $queue = $params['event_queue_id']; | |
447 | $hash = $params['hash']; | |
448 | $email = $params['email']; | |
449 | $fromEmail = CRM_Utils_Array::value('fromEmail', $params); | |
450 | $params = CRM_Utils_Array::value('params', $params); | |
6a488035 | 451 | |
7e6e8bd6 | 452 | $forward = CRM_Mailing_Event_BAO_Forward::forward($job, $queue, $hash, $email, $fromEmail, $params); |
6a488035 | 453 | |
7e6e8bd6 TO |
454 | if ($forward) { |
455 | return civicrm_api3_create_success($params); | |
456 | } | |
6a488035 | 457 | |
7e6e8bd6 | 458 | return civicrm_api3_create_error('Queue event could not be found'); |
6a488035 TO |
459 | } |
460 | ||
11e09c59 | 461 | /** |
22242c87 | 462 | * Adjust Metadata for event_forward action. |
11e09c59 | 463 | * |
0aa0303c EM |
464 | * The metadata is used for setting defaults, documentation & validation. |
465 | * | |
cf470720 | 466 | * @param array $params |
b081365f | 467 | * Array of parameters determined by getfields. |
11e09c59 | 468 | */ |
6a488035 TO |
469 | function _civicrm_api3_mailing_event_forward_spec(&$params) { |
470 | $params['job_id']['api.required'] = 1; | |
48280907 | 471 | $params['job_id']['title'] = 'Job ID'; |
6a488035 | 472 | $params['event_queue_id']['api.required'] = 1; |
4c41ecb2 | 473 | $params['event_queue_id']['title'] = 'Event Queue ID'; |
6a488035 | 474 | $params['hash']['api.required'] = 1; |
4c41ecb2 | 475 | $params['hash']['title'] = 'Hash'; |
6a488035 | 476 | $params['email']['api.required'] = 1; |
4c41ecb2 | 477 | $params['email']['title'] = 'Forwarded to Email'; |
6a488035 TO |
478 | } |
479 | ||
480 | /** | |
22242c87 | 481 | * Handle a click event. |
6a488035 TO |
482 | * |
483 | * @param array $params | |
484 | * | |
485 | * @return array | |
486 | */ | |
487 | function civicrm_api3_mailing_event_click($params) { | |
7e6e8bd6 TO |
488 | civicrm_api3_verify_mandatory($params, |
489 | 'CRM_Mailing_Event_DAO_TrackableURLOpen', | |
490 | array('event_queue_id', 'url_id'), | |
491 | FALSE | |
492 | ); | |
6a488035 | 493 | |
7e6e8bd6 TO |
494 | $url_id = $params['url_id']; |
495 | $queue = $params['event_queue_id']; | |
6a488035 | 496 | |
7e6e8bd6 | 497 | $url = CRM_Mailing_Event_BAO_TrackableURLOpen::track($queue, $url_id); |
6a488035 | 498 | |
7e6e8bd6 TO |
499 | $values = array(); |
500 | $values['url'] = $url; | |
501 | $values['is_error'] = 0; | |
6a488035 | 502 | |
7e6e8bd6 | 503 | return civicrm_api3_create_success($values); |
6a488035 TO |
504 | } |
505 | ||
506 | /** | |
22242c87 | 507 | * Handle an open event. |
6a488035 TO |
508 | * |
509 | * @param array $params | |
510 | * | |
511 | * @return array | |
512 | */ | |
513 | function civicrm_api3_mailing_event_open($params) { | |
514 | ||
7e6e8bd6 TO |
515 | civicrm_api3_verify_mandatory($params, |
516 | 'CRM_Mailing_Event_DAO_Opened', | |
517 | array('event_queue_id'), | |
518 | FALSE | |
519 | ); | |
6a488035 | 520 | |
7e6e8bd6 TO |
521 | $queue = $params['event_queue_id']; |
522 | $success = CRM_Mailing_Event_BAO_Opened::open($queue); | |
6a488035 | 523 | |
7e6e8bd6 TO |
524 | if (!$success) { |
525 | return civicrm_api3_create_error('mailing open event failed'); | |
526 | } | |
6a488035 | 527 | |
7e6e8bd6 | 528 | return civicrm_api3_create_success($params); |
6a488035 TO |
529 | } |
530 | ||
c23f45d3 | 531 | /** |
22242c87 EM |
532 | * Preview mailing. |
533 | * | |
c23f45d3 | 534 | * @param array $params |
22242c87 EM |
535 | * Array per getfields metadata. |
536 | * | |
c23f45d3 EM |
537 | * @return array |
538 | * @throws \API_Exception | |
539 | */ | |
7811a84b | 540 | function civicrm_api3_mailing_preview($params) { |
541 | civicrm_api3_verify_mandatory($params, | |
542 | 'CRM_Mailing_DAO_Mailing', | |
543 | array('id'), | |
544 | FALSE | |
6a488035 | 545 | ); |
7811a84b | 546 | |
547 | $fromEmail = NULL; | |
548 | if (!empty($params['from_email'])) { | |
549 | $fromEmail = $params['from_email']; | |
550 | } | |
551 | ||
552 | $session = CRM_Core_Session::singleton(); | |
553 | $mailing = new CRM_Mailing_BAO_Mailing(); | |
554 | $mailing->id = $params['id']; | |
555 | $mailing->find(TRUE); | |
556 | ||
557 | CRM_Mailing_BAO_Mailing::tokenReplace($mailing); | |
558 | ||
559 | // get and format attachments | |
560 | $attachments = CRM_Core_BAO_File::getEntityFile('civicrm_mailing', $mailing->id); | |
561 | ||
562 | $returnProperties = $mailing->getReturnProperties(); | |
563 | $contactID = CRM_Utils_Array::value('contact_id', $params); | |
564 | if (!$contactID) { | |
565 | $contactID = $session->get('userID'); | |
566 | } | |
567 | $mailingParams = array('contact_id' => $contactID); | |
568 | ||
6bea4a47 | 569 | $details = CRM_Utils_Token::getTokenDetails($mailingParams, $returnProperties, TRUE, TRUE, NULL, $mailing->getFlattenedTokens()); |
7811a84b | 570 | |
73cc3546 | 571 | $mime = $mailing->compose(NULL, NULL, NULL, $session->get('userID'), $fromEmail, $fromEmail, |
7811a84b | 572 | TRUE, $details[0][$contactID], $attachments |
573 | ); | |
574 | ||
bd6658bd TO |
575 | return civicrm_api3_create_success(array( |
576 | 'id' => $params['id'], | |
577 | 'contact_id' => $contactID, | |
578 | 'subject' => $mime->_headers['Subject'], | |
51ae62c4 TO |
579 | 'body_html' => $mime->getHTMLBody(), |
580 | 'body_text' => $mime->getTXTBody(), | |
bd6658bd | 581 | )); |
6a488035 TO |
582 | } |
583 | ||
c23f45d3 | 584 | /** |
22242c87 EM |
585 | * Adjust metadata for send test function. |
586 | * | |
c23f45d3 EM |
587 | * @param array $spec |
588 | */ | |
7ada2376 TO |
589 | function _civicrm_api3_mailing_send_test_spec(&$spec) { |
590 | $spec['test_group']['title'] = 'Test Group ID'; | |
591 | $spec['test_email']['title'] = 'Test Email Address'; | |
592 | } | |
593 | ||
c23f45d3 | 594 | /** |
22242c87 EM |
595 | * Send test mailing. |
596 | * | |
c23f45d3 | 597 | * @param array $params |
22242c87 | 598 | * |
c23f45d3 EM |
599 | * @return array |
600 | * @throws \API_Exception | |
601 | * @throws \CiviCRM_API3_Exception | |
602 | */ | |
425723d9 | 603 | function civicrm_api3_mailing_send_test($params) { |
604 | if (!array_key_exists('test_group', $params) && !array_key_exists('test_email', $params)) { | |
481a74f4 | 605 | throw new API_Exception("Mandatory key(s) missing from params array: test_group and/or test_email field are required"); |
425723d9 | 606 | } |
607 | civicrm_api3_verify_mandatory($params, | |
608 | 'CRM_Mailing_DAO_MailingJob', | |
609 | array('mailing_id'), | |
610 | FALSE | |
611 | ); | |
7811a84b | 612 | |
425723d9 | 613 | $testEmailParams = _civicrm_api3_generic_replace_base_params($params); |
7811a84b | 614 | $testEmailParams['is_test'] = 1; |
a49b32a6 | 615 | $testEmailParams['status'] = 'Scheduled'; |
38001e70 | 616 | $testEmailParams['scheduled_date'] = CRM_Utils_Date::processDate(date('Y-m-d'), date('H:i:s')); |
7811a84b | 617 | $job = civicrm_api3('MailingJob', 'create', $testEmailParams); |
425723d9 | 618 | $testEmailParams['job_id'] = $job['id']; |
a49b32a6 | 619 | $testEmailParams['emails'] = array_key_exists('test_email', $testEmailParams) ? explode(',', $testEmailParams['test_email']) : NULL; |
425723d9 | 620 | if (!empty($params['test_email'])) { |
932c73e7 TO |
621 | $query = CRM_Utils_SQL_Select::from('civicrm_email e') |
622 | ->select(array('e.id', 'e.contact_id', 'e.email')) | |
623 | ->join('c', 'INNER JOIN civicrm_contact c ON e.contact_id = c.id') | |
624 | ->where('e.email IN (@emails)', array('@emails' => $testEmailParams['emails'])) | |
625 | ->where('e.on_hold = 0') | |
626 | ->where('c.is_opt_out = 0') | |
627 | ->where('c.do_not_email = 0') | |
628 | ->where('c.is_deceased = 0') | |
196c4f47 | 629 | ->where('c.is_deleted = 0') |
932c73e7 TO |
630 | ->groupBy('e.id') |
631 | ->orderBy(array('e.is_bulkmail DESC', 'e.is_primary DESC')) | |
632 | ->toSQL(); | |
425723d9 | 633 | $dao = CRM_Core_DAO::executeQuery($query); |
634 | $emailDetail = array(); | |
635 | // fetch contact_id and email id for all existing emails | |
636 | while ($dao->fetch()) { | |
637 | $emailDetail[$dao->email] = array( | |
638 | 'contact_id' => $dao->contact_id, | |
639 | 'email_id' => $dao->id, | |
640 | ); | |
641 | } | |
642 | $dao->free(); | |
643 | foreach ($testEmailParams['emails'] as $key => $email) { | |
644 | $email = trim($email); | |
645 | $contactId = $emailId = NULL; | |
646 | if (array_key_exists($email, $emailDetail)) { | |
647 | $emailId = $emailDetail[$email]['email_id']; | |
648 | $contactId = $emailDetail[$email]['contact_id']; | |
649 | } | |
650 | if (!$contactId) { | |
651 | //create new contact. | |
652 | $contact = civicrm_api3('Contact', 'create', | |
6ea503d4 TO |
653 | array( |
654 | 'contact_type' => 'Individual', | |
425723d9 | 655 | 'email' => $email, |
21dfd5f5 | 656 | 'api.Email.get' => array('return' => 'id'), |
425723d9 | 657 | ) |
658 | ); | |
659 | $contactId = $contact['id']; | |
660 | $emailId = $contact['values'][$contactId]['api.Email.get']['id']; | |
661 | } | |
662 | civicrm_api3('MailingEventQueue', 'create', | |
6ea503d4 TO |
663 | array( |
664 | 'job_id' => $job['id'], | |
425723d9 | 665 | 'email_id' => $emailId, |
21dfd5f5 | 666 | 'contact_id' => $contactId, |
425723d9 | 667 | ) |
668 | ); | |
669 | } | |
670 | } | |
7811a84b | 671 | |
425723d9 | 672 | $isComplete = FALSE; |
97b7d4a0 | 673 | $config = CRM_Core_Config::singleton(); |
dc00ac6d | 674 | $mailerJobSize = Civi::settings()->get('mailerJobSize'); |
425723d9 | 675 | while (!$isComplete) { |
97b7d4a0 TO |
676 | // Q: In CRM_Mailing_BAO_Mailing::processQueue(), the three runJobs*() |
677 | // functions are all called. Why does Mailing.send_test only call one? | |
678 | // CRM_Mailing_BAO_MailingJob::runJobs_pre($mailerJobSize, NULL); | |
425723d9 | 679 | $isComplete = CRM_Mailing_BAO_MailingJob::runJobs($testEmailParams); |
97b7d4a0 | 680 | // CRM_Mailing_BAO_MailingJob::runJobs_post(NULL); |
425723d9 | 681 | } |
7811a84b | 682 | |
683 | //return delivered mail info | |
684 | $mailDelivered = CRM_Mailing_Event_BAO_Delivered::getRows($params['mailing_id'], $job['id'], TRUE, NULL, NULL, NULL, TRUE); | |
685 | ||
686 | return civicrm_api3_create_success($mailDelivered); | |
425723d9 | 687 | } |
688 | ||
7811a84b | 689 | /** |
22242c87 | 690 | * Adjust Metadata for send_mail action. |
7811a84b | 691 | * |
0aa0303c EM |
692 | * The metadata is used for setting defaults, documentation & validation. |
693 | * | |
cf470720 | 694 | * @param array $params |
b081365f | 695 | * Array of parameters determined by getfields. |
7811a84b | 696 | */ |
697 | function _civicrm_api3_mailing_stats_spec(&$params) { | |
698 | $params['date']['api.default'] = 'now'; | |
bd6658bd | 699 | $params['date']['title'] = 'Date'; |
5f5e0ad6 | 700 | $params['is_distinct']['api.default'] = FALSE; |
fe38c896 | 701 | $params['is_distinct']['title'] = 'Is Distinct'; |
7811a84b | 702 | } |
6a488035 | 703 | |
c23f45d3 | 704 | /** |
22242c87 EM |
705 | * Function which needs to be explained. |
706 | * | |
c23f45d3 | 707 | * @param array $params |
22242c87 | 708 | * |
c23f45d3 EM |
709 | * @return array |
710 | * @throws \API_Exception | |
711 | */ | |
7811a84b | 712 | function civicrm_api3_mailing_stats($params) { |
713 | civicrm_api3_verify_mandatory($params, | |
714 | 'CRM_Mailing_DAO_MailingJob', | |
715 | array('mailing_id'), | |
716 | FALSE | |
717 | ); | |
718 | ||
719 | if ($params['date'] == 'now') { | |
720 | $params['date'] = date('YmdHis'); | |
721 | } | |
722 | else { | |
723 | $params['date'] = CRM_Utils_Date::processDate($params['date'] . ' ' . $params['date_time']); | |
724 | } | |
725 | ||
726 | $stats[$params['mailing_id']] = array(); | |
727 | if (empty($params['job_id'])) { | |
728 | $params['job_id'] = NULL; | |
729 | } | |
730 | foreach (array('Delivered', 'Bounces', 'Unsubscribers', 'Unique Clicks', 'Opened') as $detail) { | |
731 | switch ($detail) { | |
732 | case 'Delivered': | |
733 | $stats[$params['mailing_id']] += array( | |
5861634e | 734 | $detail => CRM_Mailing_Event_BAO_Delivered::getTotalCount($params['mailing_id'], $params['job_id'], (bool) $params['is_distinct'], $params['date']), |
7811a84b | 735 | ); |
736 | break; | |
ea100cb5 | 737 | |
7811a84b | 738 | case 'Bounces': |
739 | $stats[$params['mailing_id']] += array( | |
5861634e | 740 | $detail => CRM_Mailing_Event_BAO_Bounce::getTotalCount($params['mailing_id'], $params['job_id'], (bool) $params['is_distinct'], $params['date']), |
7811a84b | 741 | ); |
742 | break; | |
ea100cb5 | 743 | |
7811a84b | 744 | case 'Unsubscribers': |
745 | $stats[$params['mailing_id']] += array( | |
5861634e | 746 | $detail => CRM_Mailing_Event_BAO_Unsubscribe::getTotalCount($params['mailing_id'], $params['job_id'], (bool) $params['is_distinct'], NULL, $params['date']), |
7811a84b | 747 | ); |
748 | break; | |
ea100cb5 | 749 | |
7811a84b | 750 | case 'Unique Clicks': |
751 | $stats[$params['mailing_id']] += array( | |
5861634e | 752 | $detail => CRM_Mailing_Event_BAO_TrackableURLOpen::getTotalCount($params['mailing_id'], $params['job_id'], (bool) $params['is_distinct'], NULL, $params['date']), |
7811a84b | 753 | ); |
754 | break; | |
ea100cb5 | 755 | |
7811a84b | 756 | case 'Opened': |
757 | $stats[$params['mailing_id']] += array( | |
5861634e | 758 | $detail => CRM_Mailing_Event_BAO_Opened::getTotalCount($params['mailing_id'], $params['job_id'], (bool) $params['is_distinct'], $params['date']), |
7811a84b | 759 | ); |
760 | break; | |
761 | } | |
762 | } | |
763 | return civicrm_api3_create_success($stats); | |
764 | } | |
765 | ||
6a488035 | 766 | /** |
22242c87 EM |
767 | * Fix the reset dates on the email record based on when a mail was last delivered. |
768 | * | |
6a488035 TO |
769 | * We only consider mailings that were completed and finished in the last 3 to 7 days |
770 | * Both the min and max days can be set via the params | |
22242c87 | 771 | * |
d0997921 | 772 | * @param array $params |
22242c87 | 773 | * |
645ee340 | 774 | * @return array |
6a488035 TO |
775 | */ |
776 | function civicrm_api3_mailing_update_email_resetdate($params) { | |
7e6e8bd6 TO |
777 | CRM_Mailing_Event_BAO_Delivered::updateEmailResetDate( |
778 | CRM_Utils_Array::value('minDays', $params, 3), | |
779 | CRM_Utils_Array::value('maxDays', $params, 3) | |
780 | ); | |
781 | return civicrm_api3_create_success(); | |
6a488035 | 782 | } |