3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * APIv3 functions for registering/processing mailing group events.
16 * @package CiviCRM_APIv3
20 * Declare deprecated functions.
22 * @deprecated api notice
24 * to indicate this entire api entity is deprecated
26 function _civicrm_api3_mailing_group_deprecation() {
27 $message = 'This action is deprecated. Use the mailing_event API instead.';
29 'event_unsubscribe' => $message,
30 'event_domain_unsubscribe' => $message,
31 'event_resubscribe' => $message,
32 'event_subscribe' => $message,
37 * Handle an unsubscribe event.
41 * @param array $params
45 function civicrm_api3_mailing_group_event_unsubscribe($params) {
46 return civicrm_api('mailing_event_unsubscribe', 'create', $params);
50 * Handle a site-level unsubscribe event.
54 * @param array $params
58 function civicrm_api3_mailing_group_event_domain_unsubscribe($params) {
59 $params['org_unsubscribe'] = 1;
60 return civicrm_api('mailing_event_unsubscribe', 'create', $params);
64 * Handle a re-subscription event.
68 * @param array $params
72 function civicrm_api3_mailing_group_event_resubscribe($params) {
73 return civicrm_api('mailing_event_resubscribe', 'create', $params);
77 * Handle a subscription event.
81 * @param array $params
85 function civicrm_api3_mailing_group_event_subscribe($params) {
86 return civicrm_api('mailing_event_subscribe', 'create', $params);
90 * Create mailing group.
92 * @param array $params
95 * @throws \API_Exception
97 function civicrm_api3_mailing_group_create($params) {
98 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
104 * @param array $params
108 function civicrm_api3_mailing_group_get($params) {
109 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
113 * Delete mailing group.
115 * @param array $params
118 * @throws \API_Exception
120 function civicrm_api3_mailing_group_delete($params) {
121 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);