MailingContact.php
This api exposes CiviCRM contact and mailing.
Table of Contents
Functions
- civicrm_api3_mailing_contact_get() : array<string|int, mixed>
- Get all the mailings and details that a contact was involved with.
- _civicrm_api3_mailing_contact_getresults() : mixed
- This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact.
- _civicrm_api3_mailing_contact_get_spec() : mixed
- Adjust Metadata for Get action.
- _civicrm_api3_mailing_contact_query() : array<string|int, mixed>
- Helper function for mailing contact queries.
- _civicrm_api3_mailing_contact_get_delivered() : array<string|int, mixed>
- Get delivered mailing contacts.
- _civicrm_api3_mailing_contact_get_bounced() : array<string|int, mixed>
- Get bounced mailing contact records.
- civicrm_api3_mailing_contact_getcount() : array<string|int, mixed>
- Get count of all the mailings that a contact was involved with.
Functions
civicrm_api3_mailing_contact_get()
Get all the mailings and details that a contact was involved with.
civicrm_api3_mailing_contact_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters - see _spec for details (returned by getfields)
Return values
array<string|int, mixed> —API result
_civicrm_api3_mailing_contact_getresults()
This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact.
_civicrm_api3_mailing_contact_getresults(array<string|int, mixed> $params, bool $count) : mixed
Parameters
- $params : array<string|int, mixed>
- $count : bool
Tags
_civicrm_api3_mailing_contact_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_mailing_contact_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
_civicrm_api3_mailing_contact_query()
Helper function for mailing contact queries.
_civicrm_api3_mailing_contact_query(int $contactID, int $offset, int $limit, array<string|int, mixed>|null $selectFields, string|null $fromClause, string|null $whereClause, string|null $sort, bool $getCount) : array<string|int, mixed>
Parameters
- $contactID : int
- $offset : int
- $limit : int
- $selectFields : array<string|int, mixed>|null
- $fromClause : string|null
- $whereClause : string|null
- $sort : string|null
- $getCount : bool
Return values
array<string|int, mixed>_civicrm_api3_mailing_contact_get_delivered()
Get delivered mailing contacts.
_civicrm_api3_mailing_contact_get_delivered(int $contactID, int $offset, int $limit, string|null $sort, bool $getCount) : array<string|int, mixed>
Parameters
- $contactID : int
- $offset : int
- $limit : int
- $sort : string|null
- $getCount : bool
Return values
array<string|int, mixed>_civicrm_api3_mailing_contact_get_bounced()
Get bounced mailing contact records.
_civicrm_api3_mailing_contact_get_bounced(int $contactID, int $offset, int $limit, string|null $sort, bool $getCount) : array<string|int, mixed>
Parameters
- $contactID : int
- $offset : int
- $limit : int
- $sort : string|null
- $getCount : bool
Return values
array<string|int, mixed>civicrm_api3_mailing_contact_getcount()
Get count of all the mailings that a contact was involved with.
civicrm_api3_mailing_contact_getcount(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters per getfields
Return values
array<string|int, mixed> —API result