Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
232624b1 | 5 | | CiviCRM version 4.4 | |
6a488035 TO |
6 | +--------------------------------------------------------------------+ |
7 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
8 | +--------------------------------------------------------------------+ | |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
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. | | |
14 | | | | |
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. | | |
19 | | | | |
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 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * | |
31 | * APIv3 functions for registering/processing mailing group events. | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_MailerGroup | |
35 | * @copyright CiviCRM LLC (c) 2004-2013 | |
36 | * $Id$ | |
37 | * | |
38 | */ | |
39 | ||
40 | /** | |
41 | * Unsubscribe from mailing group | |
42 | * | |
43 | * @param array $params Associative array of property | |
44 | * name/value pairs to insert in new 'survey' | |
45 | * | |
46 | * @return array api result array | |
47 | * {@getfields mailing_event_unsubscribe_create} | |
48 | * @access public | |
49 | */ | |
50 | function civicrm_api3_mailing_event_unsubscribe_create($params) { | |
51 | ||
ef170fe0 | 52 | $job = $params['job_id']; |
6a488035 | 53 | $queue = $params['event_queue_id']; |
ef170fe0 | 54 | $hash = $params['hash']; |
6a488035 TO |
55 | if (empty($params['org_unsubscribe'])) { |
56 | $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job, $queue, $hash); | |
57 | if (count($groups)) { | |
58 | CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, $groups, FALSE, $job); | |
59 | return civicrm_api3_create_success($params); | |
60 | } | |
6a488035 TO |
61 | } |
62 | else { | |
63 | $unsubs = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_domain($job, $queue, $hash); | |
64 | if (!$unsubs) { | |
65 | return civicrm_api3_create_error('Domain Queue event could not be found'); | |
66 | } | |
67 | ||
68 | CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, NULL, TRUE, $job); | |
69 | return civicrm_api3_create_success($params); | |
70 | } | |
71 | ||
72 | ||
73 | return civicrm_api3_create_error('Queue event could not be found'); | |
74 | } | |
11e09c59 TO |
75 | |
76 | /** | |
6a488035 | 77 | * Adjust Metadata for Create action |
1c88e578 | 78 | * |
6a488035 TO |
79 | * The metadata is used for setting defaults, documentation & validation |
80 | * @param array $params array or parameters determined by getfields | |
81 | */ | |
82 | function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) { | |
83 | $params['job_id']['api.required'] = 1; | |
84 | $params['hash']['api.required'] = 1; | |
85 | $params['event_queue_id']['api.required'] = 1; | |
86 | } | |
87 |