Email.php
This api exposes CiviCRM email records.
Table of Contents
Functions
- civicrm_api3_email_create() : array<string|int, mixed>
- Add an Email for a contact.
- _civicrm_api3_email_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_email_delete() : array<string|int, mixed>
- Deletes an existing Email.
- civicrm_api3_email_get() : array<string|int, mixed>
- Retrieve one or more emails.
- _civicrm_api3_email_getlist_defaults() : array<string|int, mixed>
- Set default getlist parameters.
Functions
civicrm_api3_email_create()
Add an Email for a contact.
civicrm_api3_email_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_email_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_email_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_email_delete()
Deletes an existing Email.
civicrm_api3_email_delete(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_email_get()
Retrieve one or more emails.
civicrm_api3_email_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —api result array
_civicrm_api3_email_getlist_defaults()
Set default getlist parameters.
_civicrm_api3_email_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>
Parameters
- $request : array<string|int, mixed>