Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
39de6fd5 | 5 | | CiviCRM version 4.6 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * $Id$ |
37 | * | |
38 | */ | |
39 | ||
40 | /** | |
41 | * Unsubscribe from mailing group | |
42 | * | |
cf470720 TO |
43 | * @param array $params |
44 | * Associative array of property. | |
6a488035 TO |
45 | * name/value pairs to insert in new 'survey' |
46 | * | |
a6c01b45 CW |
47 | * @return array |
48 | * api result array | |
6a488035 TO |
49 | * {@getfields mailing_event_unsubscribe_create} |
50 | * @access public | |
51 | */ | |
52 | function civicrm_api3_mailing_event_unsubscribe_create($params) { | |
53 | ||
ef170fe0 | 54 | $job = $params['job_id']; |
6a488035 | 55 | $queue = $params['event_queue_id']; |
ef170fe0 | 56 | $hash = $params['hash']; |
6a488035 TO |
57 | if (empty($params['org_unsubscribe'])) { |
58 | $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job, $queue, $hash); | |
59 | if (count($groups)) { | |
60 | CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, $groups, FALSE, $job); | |
61 | return civicrm_api3_create_success($params); | |
62 | } | |
6a488035 TO |
63 | } |
64 | else { | |
65 | $unsubs = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_domain($job, $queue, $hash); | |
66 | if (!$unsubs) { | |
67 | return civicrm_api3_create_error('Domain Queue event could not be found'); | |
68 | } | |
69 | ||
70 | CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, NULL, TRUE, $job); | |
71 | return civicrm_api3_create_success($params); | |
72 | } | |
73 | ||
74 | ||
75 | return civicrm_api3_create_error('Queue event could not be found'); | |
76 | } | |
11e09c59 TO |
77 | |
78 | /** | |
6a488035 | 79 | * Adjust Metadata for Create action |
1c88e578 | 80 | * |
6a488035 | 81 | * The metadata is used for setting defaults, documentation & validation |
cf470720 TO |
82 | * @param array $params |
83 | * Array or parameters determined by getfields. | |
6a488035 TO |
84 | */ |
85 | function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) { | |
86 | $params['job_id']['api.required'] = 1; | |
a6aeb992 | 87 | $params['job_id']['title'] = 'Mailing Job ID'; |
6a488035 | 88 | $params['hash']['api.required'] = 1; |
a6aeb992 | 89 | $params['hash']['title'] = 'Mailing Hash'; |
6a488035 | 90 | $params['event_queue_id']['api.required'] = 1; |
a6aeb992 | 91 | $params['event_queue_id']['title'] = 'Mailing Queue ID'; |
6a488035 | 92 | } |