Documentation

SesV2Client extends AwsClient
in package

This client is used to interact with the **Amazon Simple Email Service** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
createConfigurationSet()  :
createConfigurationSetAsync()  :
createConfigurationSetEventDestination()  :
createConfigurationSetEventDestinationAsync()  :
createContact()  :
createContactAsync()  :
createContactList()  :
createContactListAsync()  :
createCustomVerificationEmailTemplate()  :
createCustomVerificationEmailTemplateAsync()  :
createDedicatedIpPool()  :
createDedicatedIpPoolAsync()  :
createDeliverabilityTestReport()  :
createDeliverabilityTestReportAsync()  :
createEmailIdentity()  :
createEmailIdentityAsync()  :
createEmailIdentityPolicy()  :
createEmailIdentityPolicyAsync()  :
createEmailTemplate()  :
createEmailTemplateAsync()  :
createImportJob()  :
createImportJobAsync()  :
deleteConfigurationSet()  :
deleteConfigurationSetAsync()  :
deleteConfigurationSetEventDestination()  :
deleteConfigurationSetEventDestinationAsync()  :
deleteContact()  :
deleteContactAsync()  :
deleteContactList()  :
deleteContactListAsync()  :
deleteCustomVerificationEmailTemplate()  :
deleteCustomVerificationEmailTemplateAsync()  :
deleteDedicatedIpPool()  :
deleteDedicatedIpPoolAsync()  :
deleteEmailIdentity()  :
deleteEmailIdentityAsync()  :
deleteEmailIdentityPolicy()  :
deleteEmailIdentityPolicyAsync()  :
deleteEmailTemplate()  :
deleteEmailTemplateAsync()  :
deleteSuppressedDestination()  :
deleteSuppressedDestinationAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAccount()  :
getAccountAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getBlacklistReports()  :
getBlacklistReportsAsync()  :
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getConfigurationSet()  :
getConfigurationSetAsync()  :
getConfigurationSetEventDestinations()  :
getConfigurationSetEventDestinationsAsync()  :
getContact()  :
getContactAsync()  :
getContactList()  :
getContactListAsync()  :
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getCustomVerificationEmailTemplate()  :
getCustomVerificationEmailTemplateAsync()  :
getDedicatedIp()  :
getDedicatedIpAsync()  :
getDedicatedIps()  :
getDedicatedIpsAsync()  :
getDeliverabilityDashboardOptions()  :
getDeliverabilityDashboardOptionsAsync()  :
getDeliverabilityTestReport()  :
getDeliverabilityTestReportAsync()  :
getDomainDeliverabilityCampaign()  :
getDomainDeliverabilityCampaignAsync()  :
getDomainStatisticsReport()  :
getDomainStatisticsReportAsync()  :
getEmailIdentity()  :
getEmailIdentityAsync()  :
getEmailIdentityPolicies()  :
getEmailIdentityPoliciesAsync()  :
getEmailTemplate()  :
getEmailTemplateAsync()  :
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getImportJob()  :
getImportJobAsync()  :
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSuppressedDestination()  :
getSuppressedDestinationAsync()  :
getWaiter()  : mixed
listConfigurationSets()  :
listConfigurationSetsAsync()  :
listContactLists()  :
listContactListsAsync()  :
listContacts()  :
listContactsAsync()  :
listCustomVerificationEmailTemplates()  :
listCustomVerificationEmailTemplatesAsync()  :
listDedicatedIpPools()  :
listDedicatedIpPoolsAsync()  :
listDeliverabilityTestReports()  :
listDeliverabilityTestReportsAsync()  :
listDomainDeliverabilityCampaigns()  :
listDomainDeliverabilityCampaignsAsync()  :
listEmailIdentities()  :
listEmailIdentitiesAsync()  :
listEmailTemplates()  :
listEmailTemplatesAsync()  :
listImportJobs()  :
listImportJobsAsync()  :
listSuppressedDestinations()  :
listSuppressedDestinationsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
putAccountDedicatedIpWarmupAttributes()  :
putAccountDedicatedIpWarmupAttributesAsync()  :
putAccountDetails()  :
putAccountDetailsAsync()  :
putAccountSendingAttributes()  :
putAccountSendingAttributesAsync()  :
putAccountSuppressionAttributes()  :
putAccountSuppressionAttributesAsync()  :
putConfigurationSetDeliveryOptions()  :
putConfigurationSetDeliveryOptionsAsync()  :
putConfigurationSetReputationOptions()  :
putConfigurationSetReputationOptionsAsync()  :
putConfigurationSetSendingOptions()  :
putConfigurationSetSendingOptionsAsync()  :
putConfigurationSetSuppressionOptions()  :
putConfigurationSetSuppressionOptionsAsync()  :
putConfigurationSetTrackingOptions()  :
putConfigurationSetTrackingOptionsAsync()  :
putDedicatedIpInPool()  :
putDedicatedIpInPoolAsync()  :
putDedicatedIpWarmupAttributes()  :
putDedicatedIpWarmupAttributesAsync()  :
putDeliverabilityDashboardOption()  :
putDeliverabilityDashboardOptionAsync()  :
putEmailIdentityDkimAttributes()  :
putEmailIdentityDkimAttributesAsync()  :
putEmailIdentityDkimSigningAttributes()  :
putEmailIdentityDkimSigningAttributesAsync()  :
putEmailIdentityFeedbackAttributes()  :
putEmailIdentityFeedbackAttributesAsync()  :
putEmailIdentityMailFromAttributes()  :
putEmailIdentityMailFromAttributesAsync()  :
putSuppressedDestination()  :
putSuppressedDestinationAsync()  :
sendBulkEmail()  :
sendBulkEmailAsync()  :
sendCustomVerificationEmail()  :
sendCustomVerificationEmailAsync()  :
sendEmail()  :
sendEmailAsync()  :
tagResource()  :
tagResourceAsync()  :
testRenderEmailTemplate()  :
testRenderEmailTemplateAsync()  :
untagResource()  :
untagResourceAsync()  :
updateConfigurationSetEventDestination()  :
updateConfigurationSetEventDestinationAsync()  :
updateContact()  :
updateContactAsync()  :
updateContactList()  :
updateContactListAsync()  :
updateCustomVerificationEmailTemplate()  :
updateCustomVerificationEmailTemplateAsync()  :
updateEmailIdentityPolicy()  :
updateEmailIdentityPolicyAsync()  :
updateEmailTemplate()  :
updateEmailTemplateAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
mixed —

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

createConfigurationSet()

public createConfigurationSet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createConfigurationSetAsync()

public createConfigurationSetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createConfigurationSetEventDestination()

public createConfigurationSetEventDestination(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createConfigurationSetEventDestinationAsync()

public createConfigurationSetEventDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createContact()

public createContact(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createContactAsync()

public createContactAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createContactList()

public createContactList(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createContactListAsync()

public createContactListAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCustomVerificationEmailTemplate()

public createCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createCustomVerificationEmailTemplateAsync()

public createCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDedicatedIpPool()

public createDedicatedIpPool(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDedicatedIpPoolAsync()

public createDedicatedIpPoolAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDeliverabilityTestReport()

public createDeliverabilityTestReport(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDeliverabilityTestReportAsync()

public createDeliverabilityTestReportAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createEmailIdentity()

public createEmailIdentity(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createEmailIdentityAsync()

public createEmailIdentityAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createEmailIdentityPolicy()

public createEmailIdentityPolicy(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createEmailIdentityPolicyAsync()

public createEmailIdentityPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createEmailTemplate()

public createEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createEmailTemplateAsync()

public createEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createImportJob()

public createImportJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createImportJobAsync()

public createImportJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationSet()

public deleteConfigurationSet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationSetAsync()

public deleteConfigurationSetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationSetEventDestination()

public deleteConfigurationSetEventDestination(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationSetEventDestinationAsync()

public deleteConfigurationSetEventDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteContact()

public deleteContact(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteContactAsync()

public deleteContactAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteContactList()

public deleteContactList(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteContactListAsync()

public deleteContactListAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCustomVerificationEmailTemplate()

public deleteCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteCustomVerificationEmailTemplateAsync()

public deleteCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDedicatedIpPool()

public deleteDedicatedIpPool(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDedicatedIpPoolAsync()

public deleteDedicatedIpPoolAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEmailIdentity()

public deleteEmailIdentity(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEmailIdentityAsync()

public deleteEmailIdentityAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEmailIdentityPolicy()

public deleteEmailIdentityPolicy(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEmailIdentityPolicyAsync()

public deleteEmailIdentityPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEmailTemplate()

public deleteEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEmailTemplateAsync()

public deleteEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteSuppressedDestination()

public deleteSuppressedDestination(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteSuppressedDestinationAsync()

public deleteSuppressedDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

getAccount()

public getAccount(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAccountAsync()

public getAccountAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getBlacklistReports()

public getBlacklistReports(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getBlacklistReportsAsync()

public getBlacklistReportsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null —

getConfigurationSet()

public getConfigurationSet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConfigurationSetAsync()

public getConfigurationSetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConfigurationSetEventDestinations()

public getConfigurationSetEventDestinations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConfigurationSetEventDestinationsAsync()

public getConfigurationSetEventDestinationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getContact()

public getContact(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getContactAsync()

public getContactAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getContactList()

public getContactList(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getContactListAsync()

public getContactListAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface —

getCustomVerificationEmailTemplate()

public getCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getCustomVerificationEmailTemplateAsync()

public getCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDedicatedIp()

public getDedicatedIp(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDedicatedIpAsync()

public getDedicatedIpAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDedicatedIps()

public getDedicatedIps(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDedicatedIpsAsync()

public getDedicatedIpsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDeliverabilityDashboardOptions()

public getDeliverabilityDashboardOptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDeliverabilityDashboardOptionsAsync()

public getDeliverabilityDashboardOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDeliverabilityTestReport()

public getDeliverabilityTestReport(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDeliverabilityTestReportAsync()

public getDeliverabilityTestReportAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDomainDeliverabilityCampaign()

public getDomainDeliverabilityCampaign(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDomainDeliverabilityCampaignAsync()

public getDomainDeliverabilityCampaignAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDomainStatisticsReport()

public getDomainStatisticsReport(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDomainStatisticsReportAsync()

public getDomainStatisticsReportAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getEmailIdentity()

public getEmailIdentity(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getEmailIdentityAsync()

public getEmailIdentityAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getEmailIdentityPolicies()

public getEmailIdentityPolicies(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getEmailIdentityPoliciesAsync()

public getEmailIdentityPoliciesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getEmailTemplate()

public getEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getEmailTemplateAsync()

public getEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList —

getImportJob()

public getImportJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getImportJobAsync()

public getImportJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getSuppressedDestination()

public getSuppressedDestination(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getSuppressedDestinationAsync()

public getSuppressedDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

listConfigurationSets()

public listConfigurationSets(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listConfigurationSetsAsync()

public listConfigurationSetsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listContactLists()

public listContactLists(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listContactListsAsync()

public listContactListsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listContacts()

public listContacts(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listContactsAsync()

public listContactsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listCustomVerificationEmailTemplates()

public listCustomVerificationEmailTemplates(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listCustomVerificationEmailTemplatesAsync()

public listCustomVerificationEmailTemplatesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDedicatedIpPools()

public listDedicatedIpPools(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDedicatedIpPoolsAsync()

public listDedicatedIpPoolsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDeliverabilityTestReports()

public listDeliverabilityTestReports(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDeliverabilityTestReportsAsync()

public listDeliverabilityTestReportsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDomainDeliverabilityCampaigns()

public listDomainDeliverabilityCampaigns(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDomainDeliverabilityCampaignsAsync()

public listDomainDeliverabilityCampaignsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listEmailIdentities()

public listEmailIdentities(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listEmailIdentitiesAsync()

public listEmailIdentitiesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listEmailTemplates()

public listEmailTemplates(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listEmailTemplatesAsync()

public listEmailTemplatesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listImportJobs()

public listImportJobs(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listImportJobsAsync()

public listImportJobsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSuppressedDestinations()

public listSuppressedDestinations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSuppressedDestinationsAsync()

public listSuppressedDestinationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountDedicatedIpWarmupAttributes()

public putAccountDedicatedIpWarmupAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountDedicatedIpWarmupAttributesAsync()

public putAccountDedicatedIpWarmupAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountDetails()

public putAccountDetails(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountDetailsAsync()

public putAccountDetailsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountSendingAttributes()

public putAccountSendingAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountSendingAttributesAsync()

public putAccountSendingAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountSuppressionAttributes()

public putAccountSuppressionAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAccountSuppressionAttributesAsync()

public putAccountSuppressionAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetDeliveryOptions()

public putConfigurationSetDeliveryOptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetDeliveryOptionsAsync()

public putConfigurationSetDeliveryOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetReputationOptions()

public putConfigurationSetReputationOptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetReputationOptionsAsync()

public putConfigurationSetReputationOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetSendingOptions()

public putConfigurationSetSendingOptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetSendingOptionsAsync()

public putConfigurationSetSendingOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetSuppressionOptions()

public putConfigurationSetSuppressionOptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetSuppressionOptionsAsync()

public putConfigurationSetSuppressionOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetTrackingOptions()

public putConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationSetTrackingOptionsAsync()

public putConfigurationSetTrackingOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDedicatedIpInPool()

public putDedicatedIpInPool(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDedicatedIpInPoolAsync()

public putDedicatedIpInPoolAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDedicatedIpWarmupAttributes()

public putDedicatedIpWarmupAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDedicatedIpWarmupAttributesAsync()

public putDedicatedIpWarmupAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDeliverabilityDashboardOption()

public putDeliverabilityDashboardOption(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDeliverabilityDashboardOptionAsync()

public putDeliverabilityDashboardOptionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityDkimAttributes()

public putEmailIdentityDkimAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityDkimAttributesAsync()

public putEmailIdentityDkimAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityDkimSigningAttributes()

public putEmailIdentityDkimSigningAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityDkimSigningAttributesAsync()

public putEmailIdentityDkimSigningAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityFeedbackAttributes()

public putEmailIdentityFeedbackAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityFeedbackAttributesAsync()

public putEmailIdentityFeedbackAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityMailFromAttributes()

public putEmailIdentityMailFromAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEmailIdentityMailFromAttributesAsync()

public putEmailIdentityMailFromAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putSuppressedDestination()

public putSuppressedDestination(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putSuppressedDestinationAsync()

public putSuppressedDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

sendBulkEmail()

public sendBulkEmail(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

sendBulkEmailAsync()

public sendBulkEmailAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

sendCustomVerificationEmail()

public sendCustomVerificationEmail(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

sendCustomVerificationEmailAsync()

public sendCustomVerificationEmailAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

sendEmail()

public sendEmail(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

sendEmailAsync()

public sendEmailAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResource()

public tagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

testRenderEmailTemplate()

public testRenderEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

testRenderEmailTemplateAsync()

public testRenderEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResource()

public untagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateConfigurationSetEventDestination()

public updateConfigurationSetEventDestination(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateConfigurationSetEventDestinationAsync()

public updateConfigurationSetEventDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContact()

public updateContact(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContactAsync()

public updateContactAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContactList()

public updateContactList(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContactListAsync()

public updateContactListAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateCustomVerificationEmailTemplate()

public updateCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateCustomVerificationEmailTemplateAsync()

public updateCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateEmailIdentityPolicy()

public updateEmailIdentityPolicy(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateEmailIdentityPolicyAsync()

public updateEmailIdentityPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateEmailTemplate()

public updateEmailTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateEmailTemplateAsync()

public updateEmailTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results