3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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['type'] = array(
86 'api.default' => 'Delivered',
87 'type' => CRM_Utils_Type
::T_STRING
,
89 'Delivered' => 'Delivered',
90 'Bounced' => 'Bounced',
95 function _civicrm_api3_mailing_contact_query(
110 FROM civicrm_mailing m
111 INNER JOIN civicrm_contact c ON m.created_id = c.id
112 INNER JOIN civicrm_mailing_job j ON j.mailing_id = m.id
113 INNER JOIN civicrm_mailing_event_queue meq ON meq.job_id = j.id
116 AND meq.contact_id = %1
122 1 => array($contactID, 'Integer')
124 $dao = CRM_Core_DAO
::executeQuery($sql, $qParams);
128 'contact_id' => $contactID
134 $defaultFields = array(
135 'm.id' => 'mailing_id',
136 'm.subject' => 'subject',
137 'c.id' => 'creator_id',
138 'c.sort_name' => 'creator_name',
142 $fields = array_merge($selectFields, $defaultFields);
145 $fields = $defaultFields;
149 foreach ($fields as $n => $l) {
150 $select[] = "$n as $l";
152 $select = implode(', ', $select);
154 $orderBy = 'ORDER BY j.start_date DESC';
156 $orderBy = "ORDER BY $sort";
161 FROM civicrm_mailing m
162 INNER JOIN civicrm_contact c ON m.created_id = c.id
163 INNER JOIN civicrm_mailing_job j ON j.mailing_id = m.id
164 INNER JOIN civicrm_mailing_event_queue meq ON meq.job_id = j.id
167 AND meq.contact_id = %1
180 1 => array($contactID, 'Integer'),
181 2 => array($offset, 'Integer'),
182 3 => array($limit, 'Integer')
184 $dao = CRM_Core_DAO
::executeQuery($sql, $qParams);
187 while ($dao->fetch()) {
188 foreach ($fields as $n => $l) {
189 $results[$dao->mailing_id
][$l] = $dao->$l;
197 function _civicrm_api3_mailing_contact_get_delivered(
204 $selectFields = array('med.time_stamp' => 'start_date');
207 INNER JOIN civicrm_mailing_event_delivered med ON med.event_queue_id = meq.id
208 LEFT JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id
215 return _civicrm_api3_mailing_contact_query(
228 function _civicrm_api3_mailing_contact_get_bounced(
236 INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id
239 return _civicrm_api3_mailing_contact_query(
253 * Get count of all the mailings that a contact was involved with
255 * @param array $params input parameters
256 * - key: contact_id, value: int - required
257 * - key: type, value: Delivered | Bounced - optional, defaults to Delivered
258 * - Future extensions will include: Opened, Clicked, Forwarded
260 * @return array API result
263 * @example CRM/Mailing/BAO/Mailing.php
266 function civicrm_api3_mailing_contact_getcount($params) {
267 return _civicrm_api3_mailing_contact_getresults($params, TRUE);