MailSettings.php
This api exposes CiviCRM mail settings.
Table of Contents
Functions
- civicrm_api3_mail_settings_create() : array<string|int, mixed>
- Create or update a MailSettings.
- _civicrm_api3_mail_settings_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_mail_settings_get() : array<string|int, mixed>
- Returns array of MailSettings matching a set of one or more properties.
- civicrm_api3_mail_settings_delete() : array<string|int, mixed>
- Delete an existing MailSettings.
Functions
civicrm_api3_mail_settings_create()
Create or update a MailSettings.
civicrm_api3_mail_settings_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
name/value pairs to insert in new 'MailSettings'
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_mail_settings_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mail_settings_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_mail_settings_get()
Returns array of MailSettings matching a set of one or more properties.
civicrm_api3_mail_settings_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of one or more property_name=>value pairs. If $params is set as null, all MailSettings will be returned.
Return values
array<string|int, mixed> —API result array.
civicrm_api3_mail_settings_delete()
Delete an existing MailSettings.
civicrm_api3_mail_settings_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
[id]
Return values
array<string|int, mixed> —API result array.