CRM-15856 - Mailing BAO - Only validate tokens when calling through API
[civicrm-core.git] / api / v3 / MailingEventResubscribe.php
CommitLineData
6a488035 1<?php
6a488035
TO
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035 5 +--------------------------------------------------------------------+
731a0992 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * APIv3 functions for registering/processing mailing group events.
31 *
32 * @package CiviCRM_APIv3
6a488035
TO
33 */
34
35/**
0965e988 36 * Subscribe from mailing group.
6a488035 37 *
cf470720 38 * @param array $params
6a488035 39 *
a6c01b45 40 * @return array
72b3a70c 41 * api result array
6a488035
TO
42 */
43function civicrm_api3_mailing_event_resubscribe_create($params) {
44
45 $groups = CRM_Mailing_Event_BAO_Resubscribe::resub_to_mailing(
46 $params['job_id'],
47 $params['event_queue_id'],
48 $params['hash']
49 );
50
51 if (count($groups)) {
52 CRM_Mailing_Event_BAO_Resubscribe::send_resub_response(
53 $params['event_queue_id'],
54 $groups, FALSE,
55 $params['job_id']
56 );
57 return civicrm_api3_create_success($params);
58 }
59 return civicrm_api3_create_error('Queue event could not be found');
60}
11e09c59
TO
61
62/**
0965e988
EM
63 * Adjust Metadata for Create action.
64 *
65 * The metadata is used for setting defaults, documentation & validation.
1c88e578 66 *
cf470720 67 * @param array $params
b081365f 68 * Array of parameters determined by getfields.
6a488035
TO
69 */
70function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
71 $params['event_queue_id']['api.required'] = 1;
a6aeb992 72 $params['event_queue_id']['title'] = 'Event Queue ID';
6a488035 73 $params['job_id']['api.required'] = 1;
a6aeb992 74 $params['job_id']['title'] = 'Job ID';
6a488035 75 $params['hash']['api.required'] = 1;
a6aeb992 76 $params['hash']['title'] = 'Hash';
6a488035 77}