4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.3 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * APIv3 functions for registering/processing mailing group events.
33 * @package CiviCRM_APIv3
34 * @subpackage API_MailerGroup
35 * @copyright CiviCRM LLC (c) 2004-2013
41 * Subscribe from mailing group
43 * @param array $params Associative array of property
44 * name/value pairs to insert in new 'survey'
46 * @return array api result array
47 * {@getfields mailing_event_subscribe_create}
50 function civicrm_api3_mailing_event_subscribe_create($params) {
51 $email = $params['email'];
52 $group_id = $params['group_id'];
53 $contact_id = CRM_Utils_Array
::value('contact_id', $params);
55 $group = new CRM_Contact_DAO_Group();
56 $group->is_active
= 1;
57 $group->id
= (int)$group_id;
58 if (!$group->find(TRUE)) {
59 return civicrm_api3_create_error('Invalid Group id');
62 $subscribe = CRM_Mailing_Event_BAO_Subscribe
::subscribe($group_id, $email, $contact_id);
64 if ($subscribe !== NULL) {
65 /* Ask the contact for confirmation */
68 $subscribe->send_confirm_request($email);
71 $values['contact_id'] = $subscribe->contact_id
;
72 $values['subscribe_id'] = $subscribe->id
;
73 $values['hash'] = $subscribe->hash
;
74 $values['is_error'] = 0;
76 return civicrm_api3_create_success($values);
78 return civicrm_api3_create_error('Subscription failed');
82 * Adjust Metadata for Create action
84 * The metadata is used for setting defaults, documentation & validation
85 * @param array $params array or parameters determined by getfields
87 function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) {
88 $params['email']['api.required'] = 1;
89 $params['group_id']['api.required'] = 1;