MailingJob.php
APIv3 functions for registering/processing mailing jobs.
Table of Contents
Functions
- civicrm_api3_mailing_job_create() : array<string|int, mixed>
- Handle creation of a MailingJob for a Mailing.
- _civicrm_api3_mailing_job_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_mailing_job_get() : array<string|int, mixed>
- Returns array of Mailing Jobs matching a set of one or more group properties.
- civicrm_api3_mailing_job_delete() : array<string|int, mixed>
- Handle deletion of a Mailing Job for a Mailing.
Functions
civicrm_api3_mailing_job_create()
Handle creation of a MailingJob for a Mailing.
civicrm_api3_mailing_job_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_job_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mailing_job_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.
civicrm_api3_mailing_job_get()
Returns array of Mailing Jobs matching a set of one or more group properties.
civicrm_api3_mailing_job_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API return Array of matching mailing jobs.
civicrm_api3_mailing_job_delete()
Handle deletion of a Mailing Job for a Mailing.
civicrm_api3_mailing_job_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>