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
40 * Subscribe from mailing group
42 * @param array $params
43 * Associative array of property.
44 * name/value pairs to insert in new 'survey'
46 * @throws API_Exception
49 * {@getfields mailing_event_subscribe_create}
51 function civicrm_api3_mailing_event_subscribe_create($params) {
52 $email = $params['email'];
53 $group_id = $params['group_id'];
54 $contact_id = CRM_Utils_Array
::value('contact_id', $params);
56 $group = new CRM_Contact_DAO_Group();
57 $group->is_active
= 1;
58 $group->id
= (int) $group_id;
59 if (!$group->find(TRUE)) {
60 throw new API_Exception('Invalid Group id');
63 $subscribe = CRM_Mailing_Event_BAO_Subscribe
::subscribe($group_id, $email, $contact_id);
65 if ($subscribe !== NULL) {
66 /* Ask the contact for confirmation */
68 $subscribe->send_confirm_request($email);
71 $values[$subscribe->id
]['contact_id'] = $subscribe->contact_id
;
72 $values[$subscribe->id
]['subscribe_id'] = $subscribe->id
;
73 $values[$subscribe->id
]['hash'] = $subscribe->hash
;
75 return civicrm_api3_create_success($values);
77 return civicrm_api3_create_error('Subscription failed');
81 * Adjust Metadata for Create action.
83 * The metadata is used for setting defaults, documentation & validation.
85 * @param array $params
86 * Array or parameters determined by getfields.
88 function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) {
89 $params['email']['api.required'] = 1;
90 $params['email']['title'] = 'Unsubscribe Email';
91 $params['group_id']['api.required'] = 1;
92 $params['group_id']['title'] = 'Unsubscribe From Group';