3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 +--------------------------------------------------------------------+
30 * APIv3 functions for registering/processing mailing group events.
32 * @package CiviCRM_APIv3
33 * @subpackage API_MailerGroup
34 * @copyright CiviCRM LLC (c) 2004-2014
39 * Handle a confirm event
41 * @param array $params
42 * Associative array of property.
43 * name/value pairs to insert in new 'survey'
48 * {@getfields mailing_event_confirm_create}
50 function civicrm_api3_mailing_event_confirm_create($params) {
52 $contact_id = $params['contact_id'];
53 $subscribe_id = $params['subscribe_id'];
54 $hash = $params['hash'];
56 $confirm = CRM_Mailing_Event_BAO_Confirm
::confirm($contact_id, $subscribe_id, $hash) !== FALSE;
59 throw new Exception('Confirmation failed');
61 return civicrm_api3_create_success($params);
65 * Adjust Metadata for Create action.
67 * The metadata is used for setting defaults, documentation & validation.
69 * @param array $params
70 * Array or parameters determined by getfields.
72 function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
73 $params['contact_id']['api.required'] = 1;
74 $params['contact_id']['title'] = 'Contact ID';
75 $params['subscribe_id']['api.required'] = 1;
76 $params['subscribe_id']['title'] = 'Subscribe Event ID';
77 $params['hash']['api.required'] = 1;
78 $params['hash']['title'] = 'Hash';