3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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
36 * Handle a confirm event.
38 * @param array $params
39 * name/value pairs to insert in new 'survey'
45 function civicrm_api3_mailing_event_confirm_create($params) {
47 $contact_id = $params['contact_id'];
48 $subscribe_id = $params['subscribe_id'];
49 $hash = $params['hash'];
51 $confirm = CRM_Mailing_Event_BAO_Confirm
::confirm($contact_id, $subscribe_id, $hash) !== FALSE;
54 throw new Exception('Confirmation failed');
56 return civicrm_api3_create_success($params);
60 * Adjust Metadata for Create action.
62 * The metadata is used for setting defaults, documentation & validation.
64 * @param array $params
65 * Array of parameters determined by getfields.
67 function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
68 $params['contact_id'] = array(
70 'title' => 'Contact ID',
71 'type' => CRM_Utils_Type
::T_INT
,
73 $params['subscribe_id'] = array(
75 'title' => 'Subscribe Event ID',
76 'type' => CRM_Utils_Type
::T_INT
,
78 $params['hash'] = array(
81 'type' => CRM_Utils_Type
::T_STRING
,