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