3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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 +--------------------------------------------------------------------+
30 * APIv3 functions for registering/processing mailing events.
32 * @package CiviCRM_APIv3
36 * Handle a create event.
38 * @param array $params
42 * @throws \API_Exception
43 * @throws \Civi\API\Exception\UnauthorizedException
45 function civicrm_api3_mailing_create($params) {
46 if (CRM_Mailing_Info
::workflowEnabled()) {
47 // Note: 'schedule mailings' and 'approve mailings' can update certain fields, but can't create.
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'");
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];
64 $safeParams = $params;
66 $safeParams['_evil_bao_validator_'] = 'CRM_Mailing_BAO_Mailing::checkSendable';
67 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $safeParams);
72 * Get tokens for one or more entity type
74 * Output will be formatted either as a flat list,
75 * or pass sequential=1 to retrieve as a hierarchy formatted for select2.
77 * @param array $params
78 * Should contain an array of entities to retrieve tokens for.
81 * @throws \API_Exception
83 function civicrm_api3_mailing_gettokens($params) {
85 foreach ((array) $params['entity'] as $ent) {
86 $func = lcfirst($ent) . 'Tokens';
87 if (!method_exists('CRM_Core_SelectValues', $func)) {
88 throw new API_Exception('Unknown token entity: ' . $ent);
90 $tokens = array_merge(CRM_Core_SelectValues
::$func(), $tokens);
92 if (!empty($params['sequential'])) {
93 $tokens = CRM_Utils_Token
::formatTokensForDisplay($tokens);
95 return civicrm_api3_create_success($tokens, $params, 'Mailing', 'gettokens');
99 * Adjust Metadata for Create action.
101 * The metadata is used for setting defaults, documentation & validation.
103 * @param array $params
104 * Array of parameters determined by getfields.
106 function _civicrm_api3_mailing_gettokens_spec(&$params) {
107 $params['entity'] = array(
108 'api.default' => array('contact'),
112 'options' => array(),
114 // Fetch a list of token functions and format to look like entity names
115 foreach (get_class_methods('CRM_Core_SelectValues') as $func) {
116 if (strpos($func, 'Tokens')) {
117 $ent = ucfirst(str_replace('Tokens', '', $func));
118 $params['entity']['options'][$ent] = $ent;
124 * Adjust Metadata for Create action.
126 * The metadata is used for setting defaults, documentation & validation.
128 * @param array $params
129 * Array of parameters determined by getfields.
131 function _civicrm_api3_mailing_create_spec(&$params) {
132 $params['created_id']['api.required'] = 1;
133 $params['created_id']['api.default'] = 'user_contact_id';
135 $params['override_verp']['api.default'] = !CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
136 'track_civimail_replies', NULL, FALSE
138 $params['visibility']['api.default'] = 'Public Pages';
139 $params['dedupe_email']['api.default'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
140 'dedupe_email_default', NULL, FALSE
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;
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', '');
154 $params['mailing_type']['api.default'] = 'standalone';
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];
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;
170 function civicrm_api3_mailing_clone($params) {
180 'approval_status_id',
186 $get = civicrm_api3('Mailing', 'getsingle', array('id' => $params['id']));
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;
200 $dao = new CRM_Mailing_DAO_MailingGroup();
201 $dao->mailing_id
= $params['id'];
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
;
209 return civicrm_api3('Mailing', 'create', $newParams);
213 * Handle a delete event.
215 * @param array $params
220 function civicrm_api3_mailing_delete($params) {
221 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
225 * Handle a get event.
227 * @param array $params
231 function civicrm_api3_mailing_get($params) {
232 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
236 * Adjust metadata for mailing submit api function.
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'];
245 $spec['approval_status_id'] = $mailingFields['approval_status_id'];
246 $spec['approval_note'] = $mailingFields['approval_note'];
247 // _skip_evil_bao_auto_recipients_: bool
253 * @param array $params
256 * @throws API_Exception
258 function civicrm_api3_mailing_submit($params) {
259 civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_Mailing', array('id'));
261 if (!isset($params['scheduled_date']) && !isset($updateParams['approval_date'])) {
262 throw new API_Exception("Missing parameter scheduled_date and/or approval_date");
264 if (!is_numeric(CRM_Core_Session
::getLoggedInContactID())) {
265 throw new API_Exception("Failed to determine current user");
268 $updateParams = array();
269 $updateParams['id'] = $params['id'];
271 // Note: we'll pass along scheduling/approval fields, but they may get ignored
272 // if we don't have permission.
273 if (isset($params['scheduled_date'])) {
274 $updateParams['scheduled_date'] = $params['scheduled_date'];
275 $updateParams['scheduled_id'] = CRM_Core_Session
::getLoggedInContactID();
277 if (isset($params['approval_date'])) {
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'));
282 if (isset($params['approval_note'])) {
283 $updateParams['approval_note'] = $params['approval_note'];
285 if (isset($params['_skip_evil_bao_auto_recipients_'])) {
286 $updateParams['_skip_evil_bao_auto_recipients_'] = $params['_skip_evil_bao_auto_recipients_'];
289 $updateParams['options']['reload'] = 1;
290 return civicrm_api3('Mailing', 'create', $updateParams);
294 * Process a bounce event by passing through to the BAOs.
296 * @param array $params
298 * @throws API_Exception
301 function civicrm_api3_mailing_event_bounce($params) {
302 $body = $params['body'];
303 unset($params['body']);
305 $params +
= CRM_Mailing_BAO_BouncePattern
::match($body);
307 if (CRM_Mailing_Event_BAO_Bounce
::create($params)) {
308 return civicrm_api3_create_success($params);
311 throw new API_Exception(ts('Queue event could not be found'), 'no_queue_event');
316 * Adjust Metadata for bounce_spec action.
318 * The metadata is used for setting defaults, documentation & validation.
320 * @param array $params
321 * Array of parameters determined by getfields.
323 function _civicrm_api3_mailing_event_bounce_spec(&$params) {
324 $params['job_id']['api.required'] = 1;
325 $params['job_id']['title'] = 'Job ID';
326 $params['event_queue_id']['api.required'] = 1;
327 $params['event_queue_id']['title'] = 'Event Queue ID';
328 $params['hash']['api.required'] = 1;
329 $params['hash']['title'] = 'Hash';
330 $params['body']['api.required'] = 1;
331 $params['body']['title'] = 'Body';
335 * Handle a confirm event.
339 * @param array $params
343 function civicrm_api3_mailing_event_confirm($params) {
344 return civicrm_api('MailingEventConfirm', 'create', $params);
348 * Declare deprecated functions.
350 * @deprecated api notice
352 * Array of deprecated actions
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.');
359 * Handle a reply event.
361 * @param array $params
365 function civicrm_api3_mailing_event_reply($params) {
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);
374 $mailing = CRM_Mailing_Event_BAO_Reply
::reply($job, $queue, $hash, $replyto);
376 if (empty($mailing)) {
377 return civicrm_api3_create_error('Queue event could not be found');
380 CRM_Mailing_Event_BAO_Reply
::send($queue, $mailing, $bodyTxt, $replyto, $bodyHTML, $fullEmail);
382 return civicrm_api3_create_success($params);
386 * Adjust Metadata for event_reply action.
388 * The metadata is used for setting defaults, documentation & validation.
390 * @param array $params
391 * Array of parameters determined by getfields.
393 function _civicrm_api3_mailing_event_reply_spec(&$params) {
394 $params['job_id']['api.required'] = 1;
395 $params['job_id']['title'] = 'Job ID';
396 $params['event_queue_id']['api.required'] = 1;
397 $params['event_queue_id']['title'] = 'Event Queue ID';
398 $params['hash']['api.required'] = 1;
399 $params['hash']['title'] = 'Hash';
400 $params['replyTo']['api.required'] = 0;
401 $params['replyTo']['title'] = 'Reply To';//doesn't really explain adequately
405 * Handle a forward event.
407 * @param array $params
411 function civicrm_api3_mailing_event_forward($params) {
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);
419 $forward = CRM_Mailing_Event_BAO_Forward
::forward($job, $queue, $hash, $email, $fromEmail, $params);
422 return civicrm_api3_create_success($params);
425 return civicrm_api3_create_error('Queue event could not be found');
429 * Adjust Metadata for event_forward action.
431 * The metadata is used for setting defaults, documentation & validation.
433 * @param array $params
434 * Array of parameters determined by getfields.
436 function _civicrm_api3_mailing_event_forward_spec(&$params) {
437 $params['job_id']['api.required'] = 1;
438 $params['job_id']['title'] = 'Job ID';
439 $params['event_queue_id']['api.required'] = 1;
440 $params['event_queue_id']['title'] = 'Event Queue ID';
441 $params['hash']['api.required'] = 1;
442 $params['hash']['title'] = 'Hash';
443 $params['email']['api.required'] = 1;
444 $params['email']['title'] = 'Forwarded to Email';
448 * Handle a click event.
450 * @param array $params
454 function civicrm_api3_mailing_event_click($params) {
455 civicrm_api3_verify_mandatory($params,
456 'CRM_Mailing_Event_DAO_TrackableURLOpen',
457 array('event_queue_id', 'url_id'),
461 $url_id = $params['url_id'];
462 $queue = $params['event_queue_id'];
464 $url = CRM_Mailing_Event_BAO_TrackableURLOpen
::track($queue, $url_id);
467 $values['url'] = $url;
468 $values['is_error'] = 0;
470 return civicrm_api3_create_success($values);
474 * Handle an open event.
476 * @param array $params
480 function civicrm_api3_mailing_event_open($params) {
482 civicrm_api3_verify_mandatory($params,
483 'CRM_Mailing_Event_DAO_Opened',
484 array('event_queue_id'),
488 $queue = $params['event_queue_id'];
489 $success = CRM_Mailing_Event_BAO_Opened
::open($queue);
492 return civicrm_api3_create_error('mailing open event failed');
495 return civicrm_api3_create_success($params);
501 * @param array $params
502 * Array per getfields metadata.
505 * @throws \API_Exception
507 function civicrm_api3_mailing_preview($params) {
508 civicrm_api3_verify_mandatory($params,
509 'CRM_Mailing_DAO_Mailing',
515 if (!empty($params['from_email'])) {
516 $fromEmail = $params['from_email'];
519 $session = CRM_Core_Session
::singleton();
520 $mailing = new CRM_Mailing_BAO_Mailing();
521 $mailing->id
= $params['id'];
522 $mailing->find(TRUE);
524 CRM_Mailing_BAO_Mailing
::tokenReplace($mailing);
526 // get and format attachments
527 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_mailing', $mailing->id
);
529 $returnProperties = $mailing->getReturnProperties();
530 $contactID = CRM_Utils_Array
::value('contact_id', $params);
532 $contactID = $session->get('userID');
534 $mailingParams = array('contact_id' => $contactID);
536 $details = CRM_Utils_Token
::getTokenDetails($mailingParams, $returnProperties, TRUE, TRUE, NULL, $mailing->getFlattenedTokens());
538 $mime = &$mailing->compose(NULL, NULL, NULL, $session->get('userID'), $fromEmail, $fromEmail,
539 TRUE, $details[0][$contactID], $attachments
542 return civicrm_api3_create_success(array(
543 'id' => $params['id'],
544 'contact_id' => $contactID,
545 'subject' => $mime->_headers
['Subject'],
546 'body_html' => $mime->getHTMLBody(),
547 'body_text' => $mime->getTXTBody(),
552 * Adjust metadata for send test function.
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';
564 * @param array $params
567 * @throws \API_Exception
568 * @throws \CiviCRM_API3_Exception
570 function civicrm_api3_mailing_send_test($params) {
571 if (!array_key_exists('test_group', $params) && !array_key_exists('test_email', $params)) {
572 throw new API_Exception("Mandatory key(s) missing from params array: test_group and/or test_email field are required");
574 civicrm_api3_verify_mandatory($params,
575 'CRM_Mailing_DAO_MailingJob',
580 $testEmailParams = _civicrm_api3_generic_replace_base_params($params);
581 $testEmailParams['is_test'] = 1;
582 $job = civicrm_api3('MailingJob', 'create', $testEmailParams);
583 $testEmailParams['job_id'] = $job['id'];
584 $testEmailParams['emails'] = explode(',', $testEmailParams['test_email']);
585 if (!empty($params['test_email'])) {
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 ->where('c.is_deleted = 0')
596 ->orderBy(array('e.is_bulkmail DESC', 'e.is_primary DESC'))
598 $dao = CRM_Core_DAO
::executeQuery($query);
599 $emailDetail = array();
600 // fetch contact_id and email id for all existing emails
601 while ($dao->fetch()) {
602 $emailDetail[$dao->email
] = array(
603 'contact_id' => $dao->contact_id
,
604 'email_id' => $dao->id
,
608 foreach ($testEmailParams['emails'] as $key => $email) {
609 $email = trim($email);
610 $contactId = $emailId = NULL;
611 if (array_key_exists($email, $emailDetail)) {
612 $emailId = $emailDetail[$email]['email_id'];
613 $contactId = $emailDetail[$email]['contact_id'];
616 //create new contact.
617 $contact = civicrm_api3('Contact', 'create',
619 'contact_type' => 'Individual',
621 'api.Email.get' => array('return' => 'id'),
624 $contactId = $contact['id'];
625 $emailId = $contact['values'][$contactId]['api.Email.get']['id'];
627 civicrm_api3('MailingEventQueue', 'create',
629 'job_id' => $job['id'],
630 'email_id' => $emailId,
631 'contact_id' => $contactId,
638 $config = CRM_Core_Config
::singleton();
639 $mailerJobSize = (property_exists($config, 'mailerJobSize')) ?
$config->mailerJobSize
: NULL;
640 while (!$isComplete) {
641 // Q: In CRM_Mailing_BAO_Mailing::processQueue(), the three runJobs*()
642 // functions are all called. Why does Mailing.send_test only call one?
643 // CRM_Mailing_BAO_MailingJob::runJobs_pre($mailerJobSize, NULL);
644 $isComplete = CRM_Mailing_BAO_MailingJob
::runJobs($testEmailParams);
645 // CRM_Mailing_BAO_MailingJob::runJobs_post(NULL);
648 //return delivered mail info
649 $mailDelivered = CRM_Mailing_Event_BAO_Delivered
::getRows($params['mailing_id'], $job['id'], TRUE, NULL, NULL, NULL, TRUE);
651 return civicrm_api3_create_success($mailDelivered);
655 * Adjust Metadata for send_mail action.
657 * The metadata is used for setting defaults, documentation & validation.
659 * @param array $params
660 * Array of parameters determined by getfields.
662 function _civicrm_api3_mailing_stats_spec(&$params) {
663 $params['date']['api.default'] = 'now';
664 $params['date']['title'] = 'Date';
668 * Function which needs to be explained.
670 * @param array $params
673 * @throws \API_Exception
675 function civicrm_api3_mailing_stats($params) {
676 civicrm_api3_verify_mandatory($params,
677 'CRM_Mailing_DAO_MailingJob',
682 if ($params['date'] == 'now') {
683 $params['date'] = date('YmdHis');
686 $params['date'] = CRM_Utils_Date
::processDate($params['date'] . ' ' . $params['date_time']);
689 $stats[$params['mailing_id']] = array();
690 if (empty($params['job_id'])) {
691 $params['job_id'] = NULL;
693 foreach (array('Delivered', 'Bounces', 'Unsubscribers', 'Unique Clicks', 'Opened') as $detail) {
696 $stats[$params['mailing_id']] +
= array(
697 $detail => CRM_Mailing_Event_BAO_Delivered
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date']),
702 $stats[$params['mailing_id']] +
= array(
703 $detail => CRM_Mailing_Event_BAO_Bounce
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date']),
707 case 'Unsubscribers':
708 $stats[$params['mailing_id']] +
= array(
709 $detail => CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, NULL, $params['date']),
713 case 'Unique Clicks':
714 $stats[$params['mailing_id']] +
= array(
715 $detail => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, NULL, $params['date']),
720 $stats[$params['mailing_id']] +
= array(
721 $detail => CRM_Mailing_Event_BAO_Opened
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date']),
726 return civicrm_api3_create_success($stats);
730 * Fix the reset dates on the email record based on when a mail was last delivered.
732 * We only consider mailings that were completed and finished in the last 3 to 7 days
733 * Both the min and max days can be set via the params
735 * @param array $params
739 function civicrm_api3_mailing_update_email_resetdate($params) {
740 CRM_Mailing_Event_BAO_Delivered
::updateEmailResetDate(
741 CRM_Utils_Array
::value('minDays', $params, 3),
742 CRM_Utils_Array
::value('maxDays', $params, 3)
744 return civicrm_api3_create_success();