MessageTemplate.php
This api exposes CiviCRM message_template.
Table of Contents
Functions
- civicrm_api3_message_template_create() : array<string|int, mixed>
- Create message template.
- _civicrm_api3_message_template_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_message_template_delete() : bool
- Delete message template.
- _civicrm_api3_message_template_get_spec() : mixed
- Adjust metadata for message_template get action.
- civicrm_api3_message_template_get() : array<string|int, mixed>
- Retrieve one or more message_template.
- civicrm_api3_message_template_send() : mixed
- Sends a template.
- _civicrm_api3_message_template_send_spec() : mixed
- Adjust Metadata for Create action.
Functions
civicrm_api3_message_template_create()
Create message template.
civicrm_api3_message_template_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_message_template_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_message_template_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_message_template_delete()
Delete message template.
civicrm_api3_message_template_delete(array<string|int, mixed> $params) : bool
Parameters
- $params : array<string|int, mixed>
Return values
bool —API result array
_civicrm_api3_message_template_get_spec()
Adjust metadata for message_template get action.
_civicrm_api3_message_template_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_message_template_get()
Retrieve one or more message_template.
civicrm_api3_message_template_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of name/value pairs.
Return values
array<string|int, mixed> —API result array.
civicrm_api3_message_template_send()
Sends a template.
civicrm_api3_message_template_send(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
Tags
_civicrm_api3_message_template_send_spec()
Adjust Metadata for Create action.
_civicrm_api3_message_template_send_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.