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;
72 * Handle a delete event.
74 * @param array $params
77 * @return array API Success Array
79 function civicrm_api3_mailing_delete($params, $ids = array()) {
80 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
87 * @param array $params
90 function civicrm_api3_mailing_get($params) {
91 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
95 * Process a bounce event by passing through to the BAOs.
97 * @param array $params
99 * @throws API_Exception
102 function civicrm_api3_mailing_event_bounce($params) {
104 $body = $params['body'];
105 unset($params['body']);
107 $params +
= CRM_Mailing_BAO_BouncePattern
::match($body);
109 if (CRM_Mailing_Event_BAO_Bounce
::create($params)) {
110 return civicrm_api3_create_success($params);
113 throw new API_Exception(ts('Queue event could not be found'),'no_queue_event
119 * Adjust Metadata for bounce_spec action
121 * The metadata is used for setting defaults, documentation & validation
122 * @param array $params array or parameters determined by getfields
124 function _civicrm_api3_mailing_event_bounce_spec(&$params) {
125 $params['job_id']['api.required'] = 1;
126 $params['event_queue_id']['api.required'] = 1;
127 $params['hash']['api.required'] = 1;
128 $params['body']['api.required'] = 1;
132 * Handle a confirm event
135 * @param array $params
139 function civicrm_api3_mailing_event_confirm($params) {
140 return civicrm_api('mailing_event_confirm', 'create', $params);
144 * Handle a reply event
146 * @param array $params
150 function civicrm_api3_mailing_event_reply($params) {
151 $job = $params['job_id'];
152 $queue = $params['event_queue_id'];
153 $hash = $params['hash'];
154 $replyto = $params['replyTo'];
155 $bodyTxt = CRM_Utils_Array
::value('bodyTxt', $params);
156 $bodyHTML = CRM_Utils_Array
::value('bodyHTML', $params);
157 $fullEmail = CRM_Utils_Array
::value('fullEmail', $params);
159 $mailing = CRM_Mailing_Event_BAO_Reply
::reply($job, $queue, $hash, $replyto);
161 if (empty($mailing)) {
162 return civicrm_api3_create_error('Queue event could not be found');
165 CRM_Mailing_Event_BAO_Reply
::send($queue, $mailing, $bodyTxt, $replyto, $bodyHTML, $fullEmail);
167 return civicrm_api3_create_success($params);
171 * Adjust Metadata for event_reply action
173 * The metadata is used for setting defaults, documentation & validation
174 * @param array $params array or parameters determined by getfields
176 function _civicrm_api3_mailing_event_reply_spec(&$params) {
177 $params['job_id']['api.required'] = 1;
178 $params['event_queue_id']['api.required'] = 1;
179 $params['hash']['api.required'] = 1;
180 $params['replyTo']['api.required'] = 0;
184 * Handle a forward event
186 * @param array $params
190 function civicrm_api3_mailing_event_forward($params) {
191 $job = $params['job_id'];
192 $queue = $params['event_queue_id'];
193 $hash = $params['hash'];
194 $email = $params['email'];
195 $fromEmail = CRM_Utils_Array
::value('fromEmail', $params);
196 $params = CRM_Utils_Array
::value('params', $params);
198 $forward = CRM_Mailing_Event_BAO_Forward
::forward($job, $queue, $hash, $email, $fromEmail, $params);
201 return civicrm_api3_create_success($params);
204 return civicrm_api3_create_error('Queue event could not be found');
208 * Adjust Metadata for event_forward action
210 * The metadata is used for setting defaults, documentation & validation
211 * @param array $params array or parameters determined by getfields
213 function _civicrm_api3_mailing_event_forward_spec(&$params) {
214 $params['job_id']['api.required'] = 1;
215 $params['event_queue_id']['api.required'] = 1;
216 $params['hash']['api.required'] = 1;
217 $params['email']['api.required'] = 1;
221 * Handle a click event
223 * @param array $params
227 function civicrm_api3_mailing_event_click($params) {
229 civicrm_api3_verify_mandatory($params,
230 'CRM_Mailing_Event_DAO_TrackableURLOpen',
231 array('event_queue_id', 'url_id'),
235 $url_id = $params['url_id'];
236 $queue = $params['event_queue_id'];
238 $url = CRM_Mailing_Event_BAO_TrackableURLOpen
::track($queue, $url_id);
241 $values['url'] = $url;
242 $values['is_error'] = 0;
244 return civicrm_api3_create_success($values);
248 * Handle an open event
250 * @param array $params
254 function civicrm_api3_mailing_event_open($params) {
256 civicrm_api3_verify_mandatory($params,
257 'CRM_Mailing_Event_DAO_Opened',
258 array('event_queue_id'),
262 $queue = $params['event_queue_id'];
263 $success = CRM_Mailing_Event_BAO_Opened
::open($queue);
266 return civicrm_api3_create_error('mailing open event failed');
269 return civicrm_api3_create_success($params);
273 * Fix the reset dates on the email record based on when a mail was last delivered
274 * We only consider mailings that were completed and finished in the last 3 to 7 days
275 * Both the min and max days can be set via the params
277 function civicrm_api3_mailing_update_email_resetdate($params) {
278 CRM_Mailing_Event_BAO_Delivered
::updateEmailResetDate(
279 CRM_Utils_Array
::value('minDays', $params, 3),
280 CRM_Utils_Array
::value('maxDays', $params, 3)
282 return civicrm_api3_create_success();