MailingEventSubscribe.php
APIv3 functions for registering/processing mailing group events.
Table of Contents
Functions
- civicrm_api3_mailing_event_subscribe_get() : array<string|int, mixed>
- Get mailing event subscribe record.
- civicrm_api3_mailing_event_subscribe_create() : array<string|int, mixed>
- Subscribe from mailing group.
- _civicrm_api3_mailing_event_subscribe_create_spec() : mixed
- Adjust Metadata for Create action.
Functions
civicrm_api3_mailing_event_subscribe_get()
Get mailing event subscribe record.
civicrm_api3_mailing_event_subscribe_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_event_subscribe_create()
Subscribe from mailing group.
civicrm_api3_mailing_event_subscribe_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Tags
Return values
array<string|int, mixed> —api result array
_civicrm_api3_mailing_event_subscribe_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mailing_event_subscribe_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.