Emails
extends ManagementEndpoint
in package
implements
EmailsInterface
Class Emails.
Handles requests to the Emails endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- EmailsInterface
- Interface EmailsInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- createProvider() : ResponseInterface
- Create the email provider.
- deleteProvider() : ResponseInterface
- Delete the email provider.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getProvider() : ResponseInterface
- Retrieve email provider details.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- instance() : static
- updateProvider() : ResponseInterface
- Update the email provider.
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —createProvider()
Create the email provider.
public
createProvider(string $name, array<string|int, mixed> $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, mixed>
-
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.)
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.)
Return values
ResponseInterface —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —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.)
Return values
ResponseInterface —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient
Return values
static —updateProvider()
Update the email provider.
public
updateProvider(string $name, array<string|int, mixed> $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, mixed>
-
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.)