MailingEventQueue.php
APIv3 functions for registering/processing mailing group events.
Table of Contents
Functions
- civicrm_api3_mailing_event_queue_create() : array<string|int, mixed>
- Handle a queue event.
- civicrm_api3_mailing_event_queue_get() : array<string|int, mixed>
- Get mailing event queue record.
- civicrm_api3_mailing_event_queue_delete() : array<string|int, mixed>
- Delete mailing event queue record.
- _civicrm_api3_mailing_event_queue_create_spec() : mixed
- Adjust Metadata for Create action.
Functions
civicrm_api3_mailing_event_queue_create()
Handle a queue event.
civicrm_api3_mailing_event_queue_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of property.
Tags
Return values
array<string|int, mixed> —api result array
civicrm_api3_mailing_event_queue_get()
Get mailing event queue record.
civicrm_api3_mailing_event_queue_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_queue_delete()
Delete mailing event queue record.
civicrm_api3_mailing_event_queue_delete(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_event_queue_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mailing_event_queue_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.