3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 contact and mailing functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_MailingContact
34 * @copyright CiviCRM LLC (c) 2004-2014
40 * Get all the mailings and details that a contact was involved with
42 * @param array $params input parameters
43 * - key: contact_id, value: int - required
44 * - key: type, value: Delivered | Bounced - optional, defaults to Delivered
45 * - Future extensions will include: Opened, Clicked, Forwarded
47 * @return array API result
50 * @example CRM/Mailing/BAO/Mailing.php
53 function civicrm_api3_mailing_contact_get($params) {
54 return civicrm_api3_create_success(_civicrm_api3_mailing_contact_getresults($params, FALSE));
57 * This is a wrapper for the functions that return the results from the 'quasi-entity'
59 * @param array $params
60 * @param Boolean $count
63 function _civicrm_api3_mailing_contact_getresults($params, $count){
64 if(empty($params['type'])){
65 //ie. because the api is an anomoly & passing in id is not valid
66 throw new Exception('This api call does not accept api as a parameter');
68 $options = _civicrm_api3_get_options_from_params($params, TRUE,'contribution','get');
69 $fnName = '_civicrm_api3_mailing_contact_get_' . strtolower($params['type']);
71 $params['contact_id'],
79 * Adjust Metadata for Get action
81 * @param array $params array or parameters determined by getfields
83 function _civicrm_api3_mailing_contact_get_spec(&$params) {
84 $params['contact_id']['api.required'] = 1;
85 $params['contact_id']['title'] = 'Contact ID';
86 $params['type'] = array(
87 'api.default' => 'Delivered',
88 'title' => 'Type',// doesn't really explain the field - but not sure I understand it to explain it better
89 'type' => CRM_Utils_Type
::T_STRING
,
91 'Delivered' => 'Delivered',
92 'Bounced' => 'Bounced',
99 * @param int $contactID
102 * @param $selectFields
104 * @param $whereClause
110 function _civicrm_api3_mailing_contact_query(
125 FROM civicrm_mailing m
126 INNER JOIN civicrm_contact c ON m.created_id = c.id
127 INNER JOIN civicrm_mailing_job j ON j.mailing_id = m.id
128 INNER JOIN civicrm_mailing_event_queue meq ON meq.job_id = j.id
131 AND meq.contact_id = %1
137 1 => array($contactID, 'Integer')
139 $dao = CRM_Core_DAO
::executeQuery($sql, $qParams);
143 'contact_id' => $contactID
149 $defaultFields = array(
150 'm.id' => 'mailing_id',
151 'm.subject' => 'subject',
152 'c.id' => 'creator_id',
153 'c.sort_name' => 'creator_name',
157 $fields = array_merge($selectFields, $defaultFields);
160 $fields = $defaultFields;
164 foreach ($fields as $n => $l) {
165 $select[] = "$n as $l";
167 $select = implode(', ', $select);
169 $orderBy = 'ORDER BY j.start_date DESC';
171 $orderBy = "ORDER BY $sort";
176 FROM civicrm_mailing m
177 INNER JOIN civicrm_contact c ON m.created_id = c.id
178 INNER JOIN civicrm_mailing_job j ON j.mailing_id = m.id
179 INNER JOIN civicrm_mailing_event_queue meq ON meq.job_id = j.id
182 AND meq.contact_id = %1
195 1 => array($contactID, 'Integer'),
196 2 => array($offset, 'Integer'),
197 3 => array($limit, 'Integer')
199 $dao = CRM_Core_DAO
::executeQuery($sql, $qParams);
202 while ($dao->fetch()) {
203 foreach ($fields as $n => $l) {
204 $results[$dao->mailing_id
][$l] = $dao->$l;
213 * @param int $contactID
221 function _civicrm_api3_mailing_contact_get_delivered(
228 $selectFields = array('med.time_stamp' => 'start_date');
231 INNER JOIN civicrm_mailing_event_delivered med ON med.event_queue_id = meq.id
232 LEFT JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id
239 return _civicrm_api3_mailing_contact_query(
253 * @param int $contactID
261 function _civicrm_api3_mailing_contact_get_bounced(
269 INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id
272 return _civicrm_api3_mailing_contact_query(
286 * Get count of all the mailings that a contact was involved with
288 * @param array $params input parameters
289 * - key: contact_id, value: int - required
290 * - key: type, value: Delivered | Bounced - optional, defaults to Delivered
291 * - Future extensions will include: Opened, Clicked, Forwarded
293 * @return array API result
296 * @example CRM/Mailing/BAO/Mailing.php
299 function civicrm_api3_mailing_contact_getcount($params) {
300 return _civicrm_api3_mailing_contact_getresults($params, TRUE);