MailingComponent.php
This api exposes CiviCRM MailingComponent (header and footer).
Table of Contents
Functions
- civicrm_api3_mailing_component_create() : array<string|int, mixed>
- Save a MailingComponent.
- _civicrm_api3_mailing_component_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_mailing_component_get() : array<string|int, mixed>
- Get a MailingComponent.
- _civicrm_api3_mailing_component_get_spec() : mixed
- Adjust metadata for get.
- civicrm_api3_mailing_component_delete() : array<string|int, mixed>
- Delete a MailingComponent.
Functions
civicrm_api3_mailing_component_create()
Save a MailingComponent.
civicrm_api3_mailing_component_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_mailing_component_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mailing_component_create_spec(array<string|int, mixed> &$spec) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $spec : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_mailing_component_get()
Get a MailingComponent.
civicrm_api3_mailing_component_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_mailing_component_get_spec()
Adjust metadata for get.
_civicrm_api3_mailing_component_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_mailing_component_delete()
Delete a MailingComponent.
civicrm_api3_mailing_component_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array.