MailingGroup.php
APIv3 functions for registering/processing mailing group events.
Table of Contents
Functions
- _civicrm_api3_mailing_group_deprecation() : string
- Declare deprecated functions.
- civicrm_api3_mailing_group_event_unsubscribe() : array<string|int, mixed>
- Handle an unsubscribe event.
- civicrm_api3_mailing_group_event_domain_unsubscribe() : array<string|int, mixed>
- Handle a site-level unsubscribe event.
- civicrm_api3_mailing_group_event_resubscribe() : array<string|int, mixed>
- Handle a re-subscription event.
- civicrm_api3_mailing_group_event_subscribe() : array<string|int, mixed>
- Handle a subscription event.
- civicrm_api3_mailing_group_create() : array<string|int, mixed>
- Create mailing group.
- civicrm_api3_mailing_group_get() : array<string|int, mixed>
- Get mailing group.
- civicrm_api3_mailing_group_delete() : array<string|int, mixed>
- Delete mailing group.
Functions
_civicrm_api3_mailing_group_deprecation()
Declare deprecated functions.
api notice
_civicrm_api3_mailing_group_deprecation() : string
Return values
string —to indicate this entire api entity is deprecated
civicrm_api3_mailing_group_event_unsubscribe()
Handle an unsubscribe event.
civicrm_api3_mailing_group_event_unsubscribe(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_mailing_group_event_domain_unsubscribe()
Handle a site-level unsubscribe event.
civicrm_api3_mailing_group_event_domain_unsubscribe(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_mailing_group_event_resubscribe()
Handle a re-subscription event.
civicrm_api3_mailing_group_event_resubscribe(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_mailing_group_event_subscribe()
Handle a subscription event.
civicrm_api3_mailing_group_event_subscribe(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_mailing_group_create()
Create mailing group.
civicrm_api3_mailing_group_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_mailing_group_get()
Get mailing group.
civicrm_api3_mailing_group_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_mailing_group_delete()
Delete mailing group.
civicrm_api3_mailing_group_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>