4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
41 * Subscribe from mailing group
43 * @param array $params
44 * Associative array of property.
45 * name/value pairs to insert in new 'survey'
47 * @return array api result array
48 * {@getfields mailing_event_subscribe_create}
51 function civicrm_api3_mailing_event_resubscribe_create($params) {
53 $groups = CRM_Mailing_Event_BAO_Resubscribe
::resub_to_mailing(
55 $params['event_queue_id'],
60 CRM_Mailing_Event_BAO_Resubscribe
::send_resub_response(
61 $params['event_queue_id'],
65 return civicrm_api3_create_success($params);
67 return civicrm_api3_create_error('Queue event could not be found');
71 * Adjust Metadata for Create action
73 * The metadata is used for setting defaults, documentation & validation
74 * @param array $params
75 * Array or parameters determined by getfields.
77 function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
78 $params['event_queue_id']['api.required'] = 1;
79 $params['event_queue_id']['title'] = 'Event Queue ID';
80 $params['job_id']['api.required'] = 1;
81 $params['job_id']['title'] = 'Job ID';
82 $params['hash']['api.required'] = 1;
83 $params['hash']['title'] = 'Hash';