4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
31 * APIv3 functions for registering/processing mailing events.
33 * @package CiviCRM_APIv3
34 * @subpackage API_Mailing
35 * @copyright CiviCRM LLC (c) 2004-2014
41 * Files required for this package
45 * Handle a create event.
47 * @param array $params
50 * @return array API Success Array
52 function civicrm_api3_mailing_create($params, $ids = array()) {
53 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
56 function civicrm_api3_mailing_get_token($params) {
57 if (!array_key_exists("usage", $params)) {
58 throw new API_Exception('Mandatory keys missing from params array: entity');
61 $tokens = CRM_Core_SelectValues
::contactTokens();
62 switch ($params['usage']) {
64 $tokens = array_merge(CRM_Core_SelectValues
::mailingTokens(), $tokens);
66 case 'ScheduleEventReminder' :
67 $tokens = array_merge(CRM_Core_SelectValues
::activityTokens(), $tokens);
68 $tokens = array_merge(CRM_Core_SelectValues
::eventTokens(), $tokens);
69 $tokens = array_merge(CRM_Core_SelectValues
::membershipTokens(), $tokens);
71 case 'ManageEventScheduleReminder' :
72 $tokens = array_merge(CRM_Core_SelectValues
::eventTokens(), $tokens);
76 return CRM_Utils_Token
::formatTokensForDisplay($tokens);
80 * Adjust Metadata for Create action
82 * The metadata is used for setting defaults, documentation & validation
83 * @param array $params array or parameters determined by getfields
85 function _civicrm_api3_mailing_create_spec(&$params) {
86 $params['name']['api.required'] = 1;
87 $params['subject']['api.required'] = 1;
88 $params['created_id']['api.required'] = 1;
89 $params['created_id']['api.default'] = 'user_contact_id';
90 $params['api.mailing_job.create']['api.default'] = 1;
91 $params['api.mailing_job.create']['title'] = 'Schedule Mailing?';
95 * Handle a delete event.
97 * @param array $params
100 * @return array API Success Array
102 function civicrm_api3_mailing_delete($params, $ids = array()) {
103 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
108 * Handle a get event.
110 * @param array $params
113 function civicrm_api3_mailing_get($params) {
114 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
118 * Process a bounce event by passing through to the BAOs.
120 * @param array $params
122 * @throws API_Exception
125 function civicrm_api3_mailing_event_bounce($params) {
126 $body = $params['body'];
127 unset($params['body']);
129 $params +
= CRM_Mailing_BAO_BouncePattern
::match($body);
131 if (CRM_Mailing_Event_BAO_Bounce
::create($params)) {
132 return civicrm_api3_create_success($params);
135 throw new API_Exception(ts('Queue event could not be found'),'no_queue_event
141 * Adjust Metadata for bounce_spec action
143 * The metadata is used for setting defaults, documentation & validation
144 * @param array $params array or parameters determined by getfields
146 function _civicrm_api3_mailing_event_bounce_spec(&$params) {
147 $params['job_id']['api.required'] = 1;
148 $params['job_id']['title'] = 'Job ID';
149 $params['event_queue_id']['api.required'] = 1;
150 $params['event_queue_id']['title'] = 'Event Queue ID';
151 $params['hash']['api.required'] = 1;
152 $params['hash']['title'] = 'Hash';
153 $params['body']['api.required'] = 1;
154 $params['body']['title'] = 'Body';
158 * Handle a confirm event
161 * @param array $params
165 function civicrm_api3_mailing_event_confirm($params) {
166 return civicrm_api('mailing_event_confirm', 'create', $params);
170 * @deprecated api notice
171 * @return array of deprecated actions
173 function _civicrm_api3_mailing_deprecation() {
174 return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.');
178 * Handle a reply event
180 * @param array $params
184 function civicrm_api3_mailing_event_reply($params) {
185 $job = $params['job_id'];
186 $queue = $params['event_queue_id'];
187 $hash = $params['hash'];
188 $replyto = $params['replyTo'];
189 $bodyTxt = CRM_Utils_Array
::value('bodyTxt', $params);
190 $bodyHTML = CRM_Utils_Array
::value('bodyHTML', $params);
191 $fullEmail = CRM_Utils_Array
::value('fullEmail', $params);
193 $mailing = CRM_Mailing_Event_BAO_Reply
::reply($job, $queue, $hash, $replyto);
195 if (empty($mailing)) {
196 return civicrm_api3_create_error('Queue event could not be found');
199 CRM_Mailing_Event_BAO_Reply
::send($queue, $mailing, $bodyTxt, $replyto, $bodyHTML, $fullEmail);
201 return civicrm_api3_create_success($params);
205 * Adjust Metadata for event_reply action
207 * The metadata is used for setting defaults, documentation & validation
208 * @param array $params array or parameters determined by getfields
210 function _civicrm_api3_mailing_event_reply_spec(&$params) {
211 $params['job_id']['api.required'] = 1;
212 $params['job_id']['title'] = 'Job ID';
213 $params['event_queue_id']['api.required'] = 1;
214 $params['event_queue_id']['title'] = 'Event Queue ID';
215 $params['hash']['api.required'] = 1;
216 $params['hash']['title'] = 'Hash';
217 $params['replyTo']['api.required'] = 0;
218 $params['replyTo']['title'] = 'Reply To';//doesn't really explain adequately
222 * Handle a forward event
224 * @param array $params
228 function civicrm_api3_mailing_event_forward($params) {
229 $job = $params['job_id'];
230 $queue = $params['event_queue_id'];
231 $hash = $params['hash'];
232 $email = $params['email'];
233 $fromEmail = CRM_Utils_Array
::value('fromEmail', $params);
234 $params = CRM_Utils_Array
::value('params', $params);
236 $forward = CRM_Mailing_Event_BAO_Forward
::forward($job, $queue, $hash, $email, $fromEmail, $params);
239 return civicrm_api3_create_success($params);
242 return civicrm_api3_create_error('Queue event could not be found');
246 * Adjust Metadata for event_forward action
248 * The metadata is used for setting defaults, documentation & validation
249 * @param array $params array or parameters determined by getfields
251 function _civicrm_api3_mailing_event_forward_spec(&$params) {
252 $params['job_id']['api.required'] = 1;
253 $params['job_id']['title'] = 'Job ID';
254 $params['event_queue_id']['api.required'] = 1;
255 $params['event_queue_id']['title'] = 'Event Queue ID';
256 $params['hash']['api.required'] = 1;
257 $params['hash']['title'] = 'Hash';
258 $params['email']['api.required'] = 1;
259 $params['email']['title'] = 'Forwarded to Email';
263 * Handle a click event
265 * @param array $params
269 function civicrm_api3_mailing_event_click($params) {
270 civicrm_api3_verify_mandatory($params,
271 'CRM_Mailing_Event_DAO_TrackableURLOpen',
272 array('event_queue_id', 'url_id'),
276 $url_id = $params['url_id'];
277 $queue = $params['event_queue_id'];
279 $url = CRM_Mailing_Event_BAO_TrackableURLOpen
::track($queue, $url_id);
282 $values['url'] = $url;
283 $values['is_error'] = 0;
285 return civicrm_api3_create_success($values);
289 * Handle an open event
291 * @param array $params
295 function civicrm_api3_mailing_event_open($params) {
297 civicrm_api3_verify_mandatory($params,
298 'CRM_Mailing_Event_DAO_Opened',
299 array('event_queue_id'),
303 $queue = $params['event_queue_id'];
304 $success = CRM_Mailing_Event_BAO_Opened
::open($queue);
307 return civicrm_api3_create_error('mailing open event failed');
310 return civicrm_api3_create_success($params);
313 function civicrm_api3_mailing_preview($params) {
314 civicrm_api3_verify_mandatory($params,
315 'CRM_Mailing_DAO_Mailing',
321 if (!empty($params['from_email'])) {
322 $fromEmail = $params['from_email'];
325 $session = CRM_Core_Session
::singleton();
326 $mailing = new CRM_Mailing_BAO_Mailing();
327 $mailing->id
= $params['id'];
328 $mailing->find(TRUE);
330 CRM_Mailing_BAO_Mailing
::tokenReplace($mailing);
332 // get and format attachments
333 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_mailing', $mailing->id
);
335 $returnProperties = $mailing->getReturnProperties();
336 $contactID = CRM_Utils_Array
::value('contact_id', $params);
338 $contactID = $session->get('userID');
340 $mailingParams = array('contact_id' => $contactID);
342 $details = CRM_Utils_Token
::getTokenDetails($mailingParams, $returnProperties, TRUE, TRUE, NULL, $mailing->getFlattenedTokens());
344 $mime = &$mailing->compose(NULL, NULL, NULL, $session->get('userID'), $fromEmail, $fromEmail,
345 TRUE, $details[0][$contactID], $attachments
348 return civicrm_api3_create_success(array(
349 'id' => $params['id'],
350 'contact_id' => $contactID,
351 'subject' => $mime->_headers
['Subject'],
352 'body_html' => $mime->getHTMLBody(),
353 'body_text' => $mime->getTXTBody(),
357 function _civicrm_api3_mailing_send_test_spec(&$spec) {
358 $spec['test_group']['title'] = 'Test Group ID';
359 $spec['test_email']['title'] = 'Test Email Address';
362 function civicrm_api3_mailing_send_test($params) {
363 if (!array_key_exists('test_group', $params) && !array_key_exists('test_email', $params)) {
364 throw new API_Exception("Mandatory key(s) missing from params array: test_group and/or test_email field are required" );
366 civicrm_api3_verify_mandatory($params,
367 'CRM_Mailing_DAO_MailingJob',
372 $testEmailParams = _civicrm_api3_generic_replace_base_params($params);
373 $testEmailParams['is_test'] = 1;
374 $job = civicrm_api3('MailingJob', 'create', $testEmailParams);
375 $testEmailParams['job_id'] = $job['id'];
376 $testEmailParams['emails'] = explode(',', $testEmailParams['test_email']);
377 if (!empty($params['test_email'])) {
378 $query = CRM_Utils_SQL_Select
::from('civicrm_email e')
379 ->select(array('e.id', 'e.contact_id', 'e.email'))
380 ->join('c', 'INNER JOIN civicrm_contact c ON e.contact_id = c.id')
381 ->where('e.email IN (@emails)', array('@emails' => $testEmailParams['emails']))
382 ->where('e.on_hold = 0')
383 ->where('c.is_opt_out = 0')
384 ->where('c.do_not_email = 0')
385 ->where('c.is_deceased = 0')
387 ->orderBy(array('e.is_bulkmail DESC', 'e.is_primary DESC'))
389 $dao = CRM_Core_DAO
::executeQuery($query);
390 $emailDetail = array();
391 // fetch contact_id and email id for all existing emails
392 while ($dao->fetch()) {
393 $emailDetail[$dao->email
] = array(
394 'contact_id' => $dao->contact_id
,
395 'email_id' => $dao->id
,
399 foreach ($testEmailParams['emails'] as $key => $email) {
400 $email = trim($email);
401 $contactId = $emailId = NULL;
402 if (array_key_exists($email, $emailDetail)) {
403 $emailId = $emailDetail[$email]['email_id'];
404 $contactId = $emailDetail[$email]['contact_id'];
407 //create new contact.
408 $contact = civicrm_api3('Contact', 'create',
409 array('contact_type' => 'Individual',
411 'api.Email.get' => array('return' => 'id')
414 $contactId = $contact['id'];
415 $emailId = $contact['values'][$contactId]['api.Email.get']['id'];
417 civicrm_api3('MailingEventQueue', 'create',
418 array('job_id' => $job['id'],
419 'email_id' => $emailId,
420 'contact_id' => $contactId
427 $config = CRM_Core_Config
::singleton();
428 $mailerJobSize = (property_exists($config, 'mailerJobSize')) ?
$config->mailerJobSize
: NULL;
429 while (!$isComplete) {
430 // Q: In CRM_Mailing_BAO_Mailing::processQueue(), the three runJobs*()
431 // functions are all called. Why does Mailing.send_test only call one?
432 // CRM_Mailing_BAO_MailingJob::runJobs_pre($mailerJobSize, NULL);
433 $isComplete = CRM_Mailing_BAO_MailingJob
::runJobs($testEmailParams);
434 // CRM_Mailing_BAO_MailingJob::runJobs_post(NULL);
437 //return delivered mail info
438 $mailDelivered = CRM_Mailing_Event_BAO_Delivered
::getRows($params['mailing_id'], $job['id'], TRUE, NULL, NULL, NULL, TRUE);
440 return civicrm_api3_create_success($mailDelivered);
444 * Adjust Metadata for send_mail action
446 * The metadata is used for setting defaults, documentation & validation
447 * @param array $params array or parameters determined by getfields
449 function _civicrm_api3_mailing_stats_spec(&$params) {
450 $params['date']['api.default'] = 'now';
451 $params['date']['title'] = 'Date';
454 function civicrm_api3_mailing_stats($params) {
455 civicrm_api3_verify_mandatory($params,
456 'CRM_Mailing_DAO_MailingJob',
461 if ($params['date'] == 'now') {
462 $params['date'] = date('YmdHis');
465 $params['date'] = CRM_Utils_Date
::processDate($params['date'] . ' ' . $params['date_time']);
468 $stats[$params['mailing_id']] = array();
469 if (empty($params['job_id'])) {
470 $params['job_id'] = NULL;
472 foreach (array('Delivered', 'Bounces', 'Unsubscribers', 'Unique Clicks', 'Opened') as $detail) {
475 $stats[$params['mailing_id']] +
= array(
476 $detail => CRM_Mailing_Event_BAO_Delivered
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date'])
480 $stats[$params['mailing_id']] +
= array(
481 $detail => CRM_Mailing_Event_BAO_Bounce
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date'])
484 case 'Unsubscribers':
485 $stats[$params['mailing_id']] +
= array(
486 $detail => CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, NULL, $params['date'])
489 case 'Unique Clicks':
490 $stats[$params['mailing_id']] +
= array(
491 $detail => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, NULL, $params['date'])
495 $stats[$params['mailing_id']] +
= array(
496 $detail => CRM_Mailing_Event_BAO_Opened
::getTotalCount($params['mailing_id'], $params['job_id'], FALSE, $params['date'])
501 return civicrm_api3_create_success($stats);
505 * Fix the reset dates on the email record based on when a mail was last delivered
506 * We only consider mailings that were completed and finished in the last 3 to 7 days
507 * Both the min and max days can be set via the params
509 function civicrm_api3_mailing_update_email_resetdate($params) {
510 CRM_Mailing_Event_BAO_Delivered
::updateEmailResetDate(
511 CRM_Utils_Array
::value('minDays', $params, 3),
512 CRM_Utils_Array
::value('maxDays', $params, 3)
514 return civicrm_api3_create_success();