EmailsInterface
in
Interface EmailsInterface.
Table of Contents
- createProvider() : ResponseInterface
- Create the email provider.
- deleteProvider() : ResponseInterface
- Delete the email provider.
- getProvider() : ResponseInterface
- Retrieve email provider details.
- updateProvider() : ResponseInterface
- Update the email provider.
Methods
createProvider()
Create the email provider.
public
createProvider(string $name, array<string|int, string> $credentials[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: create:email_provider.
Parameters
- $name : string
-
name of the email provider to use
- $credentials : array<string|int, string>
-
Credentials required to use the provider. See @see for supported options.
- $body : array<string|int, mixed>|null = null
-
Optional. Additional body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Tags
Return values
ResponseInterface —deleteProvider()
Delete the email provider.
public
deleteProvider([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: delete:email_provider.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Tags
Return values
ResponseInterface —getProvider()
Retrieve email provider details.
public
getProvider([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:email_provider.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Tags
Return values
ResponseInterface —updateProvider()
Update the email provider.
public
updateProvider(string $name, array<string|int, string> $credentials[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:email_provider.
Parameters
- $name : string
-
name of the email provider to use
- $credentials : array<string|int, string>
-
Credentials required to use the provider. See @see for supported options.
- $body : array<string|int, mixed>|null = null
-
Additional body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)