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);
57 * Adjust Metadata for Create action
59 * The metadata is used for setting defaults, documentation & validation
60 * @param array $params array or parameters determined by getfields
62 function _civicrm_api3_mailing_create_spec(&$params) {
63 $params['name']['api.required'] = 1;
64 $params['subject']['api.required'] = 1;
65 // should be able to default to 'user_contact_id' & have it work but it didn't work in test so
66 // making required for simplicity
67 $params['created_id']['api.required'] = 1;
68 $params['api.mailing_job.create']['api.default'] = 1;
69 $params['api.mailing_job.create']['title'] = 'Schedule Mailing?';
73 * Handle a delete event.
75 * @param array $params
78 * @return array API Success Array
80 function civicrm_api3_mailing_delete($params, $ids = array()) {
81 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
88 * @param array $params
91 function civicrm_api3_mailing_get($params) {
92 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
96 * Process a bounce event by passing through to the BAOs.
98 * @param array $params
100 * @throws API_Exception
103 function civicrm_api3_mailing_event_bounce($params) {
105 $body = $params['body'];
106 unset($params['body']);
108 $params +
= CRM_Mailing_BAO_BouncePattern
::match($body);
110 if (CRM_Mailing_Event_BAO_Bounce
::create($params)) {
111 return civicrm_api3_create_success($params);
114 throw new API_Exception(ts('Queue event could not be found'),'no_queue_event
120 * Adjust Metadata for bounce_spec action
122 * The metadata is used for setting defaults, documentation & validation
123 * @param array $params array or parameters determined by getfields
125 function _civicrm_api3_mailing_event_bounce_spec(&$params) {
126 $params['job_id']['api.required'] = 1;
127 $params['job_id']['title'] = 'Job ID';
128 $params['event_queue_id']['api.required'] = 1;
129 $params['event_queue_id']['title'] = 'Event Queue ID';
130 $params['hash']['api.required'] = 1;
131 $params['hash']['title'] = 'Hash';
132 $params['body']['api.required'] = 1;
133 $params['body']['title'] = 'Body';
137 * Handle a confirm event
140 * @param array $params
144 function civicrm_api3_mailing_event_confirm($params) {
145 return civicrm_api('mailing_event_confirm', 'create', $params);
149 * Handle a reply event
151 * @param array $params
155 function civicrm_api3_mailing_event_reply($params) {
156 $job = $params['job_id'];
157 $queue = $params['event_queue_id'];
158 $hash = $params['hash'];
159 $replyto = $params['replyTo'];
160 $bodyTxt = CRM_Utils_Array
::value('bodyTxt', $params);
161 $bodyHTML = CRM_Utils_Array
::value('bodyHTML', $params);
162 $fullEmail = CRM_Utils_Array
::value('fullEmail', $params);
164 $mailing = CRM_Mailing_Event_BAO_Reply
::reply($job, $queue, $hash, $replyto);
166 if (empty($mailing)) {
167 return civicrm_api3_create_error('Queue event could not be found');
170 CRM_Mailing_Event_BAO_Reply
::send($queue, $mailing, $bodyTxt, $replyto, $bodyHTML, $fullEmail);
172 return civicrm_api3_create_success($params);
176 * Adjust Metadata for event_reply action
178 * The metadata is used for setting defaults, documentation & validation
179 * @param array $params array or parameters determined by getfields
181 function _civicrm_api3_mailing_event_reply_spec(&$params) {
182 $params['job_id']['api.required'] = 1;
183 $params['job_id']['title'] = 'Job ID';
184 $params['event_queue_id']['api.required'] = 1;
185 $params['event_queue_id']['title'] = 'Event Queue ID';
186 $params['hash']['api.required'] = 1;
187 $params['hash']['title'] = 'Hash';
188 $params['replyTo']['api.required'] = 0;
189 $params['replyTo']['title'] = 'Reply To';//doesn't really explain adequately
193 * Handle a forward event
195 * @param array $params
199 function civicrm_api3_mailing_event_forward($params) {
200 $job = $params['job_id'];
201 $queue = $params['event_queue_id'];
202 $hash = $params['hash'];
203 $email = $params['email'];
204 $fromEmail = CRM_Utils_Array
::value('fromEmail', $params);
205 $params = CRM_Utils_Array
::value('params', $params);
207 $forward = CRM_Mailing_Event_BAO_Forward
::forward($job, $queue, $hash, $email, $fromEmail, $params);
210 return civicrm_api3_create_success($params);
213 return civicrm_api3_create_error('Queue event could not be found');
217 * Adjust Metadata for event_forward action
219 * The metadata is used for setting defaults, documentation & validation
220 * @param array $params array or parameters determined by getfields
222 function _civicrm_api3_mailing_event_forward_spec(&$params) {
223 $params['job_id']['api.required'] = 1;
224 $params['job_id']['title'] = 'Job ID';
225 $params['event_queue_id']['api.required'] = 1;
226 $params['event_queue_id']['title'] = 'Event Queue ID';
227 $params['hash']['api.required'] = 1;
228 $params['hash']['title'] = 'Hash';
229 $params['email']['api.required'] = 1;
230 $params['email']['title'] = 'Forwarded to Email';
234 * Handle a click event
236 * @param array $params
240 function civicrm_api3_mailing_event_click($params) {
242 civicrm_api3_verify_mandatory($params,
243 'CRM_Mailing_Event_DAO_TrackableURLOpen',
244 array('event_queue_id', 'url_id'),
248 $url_id = $params['url_id'];
249 $queue = $params['event_queue_id'];
251 $url = CRM_Mailing_Event_BAO_TrackableURLOpen
::track($queue, $url_id);
254 $values['url'] = $url;
255 $values['is_error'] = 0;
257 return civicrm_api3_create_success($values);
261 * Handle an open event
263 * @param array $params
267 function civicrm_api3_mailing_event_open($params) {
269 civicrm_api3_verify_mandatory($params,
270 'CRM_Mailing_Event_DAO_Opened',
271 array('event_queue_id'),
275 $queue = $params['event_queue_id'];
276 $success = CRM_Mailing_Event_BAO_Opened
::open($queue);
279 return civicrm_api3_create_error('mailing open event failed');
282 return civicrm_api3_create_success($params);
286 * Fix the reset dates on the email record based on when a mail was last delivered
287 * We only consider mailings that were completed and finished in the last 3 to 7 days
288 * Both the min and max days can be set via the params
290 function civicrm_api3_mailing_update_email_resetdate($params) {
291 CRM_Mailing_Event_BAO_Delivered
::updateEmailResetDate(
292 CRM_Utils_Array
::value('minDays', $params, 3),
293 CRM_Utils_Array
::value('maxDays', $params, 3)
295 return civicrm_api3_create_success();