SesClient
extends AwsClient
in package
This client is used to interact with the **Amazon Simple Email Service (Amazon SES)**.
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
- cloneReceiptRuleSet() :
- cloneReceiptRuleSetAsync() :
- createConfigurationSet() :
- createConfigurationSetAsync() :
- createConfigurationSetEventDestination() :
- createConfigurationSetEventDestinationAsync() :
- createConfigurationSetTrackingOptions() :
- createConfigurationSetTrackingOptionsAsync() :
- createCustomVerificationEmailTemplate() :
- createCustomVerificationEmailTemplateAsync() :
- createReceiptFilter() :
- createReceiptFilterAsync() :
- createReceiptRule() :
- createReceiptRuleAsync() :
- createReceiptRuleSet() :
- createReceiptRuleSetAsync() :
- createTemplate() :
- createTemplateAsync() :
- deleteConfigurationSet() :
- deleteConfigurationSetAsync() :
- deleteConfigurationSetEventDestination() :
- deleteConfigurationSetEventDestinationAsync() :
- deleteConfigurationSetTrackingOptions() :
- deleteConfigurationSetTrackingOptionsAsync() :
- deleteCustomVerificationEmailTemplate() :
- deleteCustomVerificationEmailTemplateAsync() :
- deleteIdentity() :
- deleteIdentityAsync() :
- deleteIdentityPolicy() :
- deleteIdentityPolicyAsync() :
- deleteReceiptFilter() :
- deleteReceiptFilterAsync() :
- deleteReceiptRule() :
- deleteReceiptRuleAsync() :
- deleteReceiptRuleSet() :
- deleteReceiptRuleSetAsync() :
- deleteTemplate() :
- deleteTemplateAsync() :
- deleteVerifiedEmailAddress() :
- deleteVerifiedEmailAddressAsync() :
- describeActiveReceiptRuleSet() :
- describeActiveReceiptRuleSetAsync() :
- describeConfigurationSet() :
- describeConfigurationSetAsync() :
- describeReceiptRule() :
- describeReceiptRuleAsync() :
- describeReceiptRuleSet() :
- describeReceiptRuleSetAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- generateSmtpPassword() : string
- Create an SMTP password for a given IAM user's credentials.
- getAccountSendingEnabled() :
- getAccountSendingEnabledAsync() :
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getCustomVerificationEmailTemplate() :
- getCustomVerificationEmailTemplateAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIdentityDkimAttributes() :
- getIdentityDkimAttributesAsync() :
- getIdentityMailFromDomainAttributes() :
- getIdentityMailFromDomainAttributesAsync() :
- getIdentityNotificationAttributes() :
- getIdentityNotificationAttributesAsync() :
- getIdentityPolicies() :
- getIdentityPoliciesAsync() :
- getIdentityVerificationAttributes() :
- getIdentityVerificationAttributesAsync() :
- getIterator() : mixed
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSendQuota() :
- getSendQuotaAsync() :
- getSendStatistics() :
- getSendStatisticsAsync() :
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getTemplate() :
- getTemplateAsync() :
- getWaiter() : mixed
- listConfigurationSets() :
- listConfigurationSetsAsync() :
- listCustomVerificationEmailTemplates() :
- listCustomVerificationEmailTemplatesAsync() :
- listIdentities() :
- listIdentitiesAsync() :
- listIdentityPolicies() :
- listIdentityPoliciesAsync() :
- listReceiptFilters() :
- listReceiptFiltersAsync() :
- listReceiptRuleSets() :
- listReceiptRuleSetsAsync() :
- listTemplates() :
- listTemplatesAsync() :
- listVerifiedEmailAddresses() :
- listVerifiedEmailAddressesAsync() :
- putConfigurationSetDeliveryOptions() :
- putConfigurationSetDeliveryOptionsAsync() :
- putIdentityPolicy() :
- putIdentityPolicyAsync() :
- reorderReceiptRuleSet() :
- reorderReceiptRuleSetAsync() :
- sendBounce() :
- sendBounceAsync() :
- sendBulkTemplatedEmail() :
- sendBulkTemplatedEmailAsync() :
- sendCustomVerificationEmail() :
- sendCustomVerificationEmailAsync() :
- sendEmail() :
- sendEmailAsync() :
- sendRawEmail() :
- sendRawEmailAsync() :
- sendTemplatedEmail() :
- sendTemplatedEmailAsync() :
- setActiveReceiptRuleSet() :
- setActiveReceiptRuleSetAsync() :
- setIdentityDkimEnabled() :
- setIdentityDkimEnabledAsync() :
- setIdentityFeedbackForwardingEnabled() :
- setIdentityFeedbackForwardingEnabledAsync() :
- setIdentityHeadersInNotificationsEnabled() :
- setIdentityHeadersInNotificationsEnabledAsync() :
- setIdentityMailFromDomain() :
- setIdentityMailFromDomainAsync() :
- setIdentityNotificationTopic() :
- setIdentityNotificationTopicAsync() :
- setReceiptRulePosition() :
- setReceiptRulePositionAsync() :
- testRenderTemplate() :
- testRenderTemplateAsync() :
- updateAccountSendingEnabled() :
- updateAccountSendingEnabledAsync() :
- updateConfigurationSetEventDestination() :
- updateConfigurationSetEventDestinationAsync() :
- updateConfigurationSetReputationMetricsEnabled() :
- updateConfigurationSetReputationMetricsEnabledAsync() :
- updateConfigurationSetSendingEnabled() :
- updateConfigurationSetSendingEnabledAsync() :
- updateConfigurationSetTrackingOptions() :
- updateConfigurationSetTrackingOptionsAsync() :
- updateCustomVerificationEmailTemplate() :
- updateCustomVerificationEmailTemplateAsync() :
- updateReceiptRule() :
- updateReceiptRuleAsync() :
- updateTemplate() :
- updateTemplateAsync() :
- verifyDomainDkim() :
- verifyDomainDkimAsync() :
- verifyDomainIdentity() :
- verifyDomainIdentityAsync() :
- verifyEmailAddress() :
- verifyEmailAddressAsync() :
- verifyEmailIdentity() :
- verifyEmailIdentityAsync() :
- 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
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$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,
falseto 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,
falseto 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_receiveroption 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
schemeto "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
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —cloneReceiptRuleSet()
public
cloneReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—cloneReceiptRuleSetAsync()
public
cloneReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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
—createConfigurationSetTrackingOptions()
public
createConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createConfigurationSetTrackingOptionsAsync()
public
createConfigurationSetTrackingOptionsAsync(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
—createReceiptFilter()
public
createReceiptFilter(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReceiptFilterAsync()
public
createReceiptFilterAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReceiptRule()
public
createReceiptRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReceiptRuleAsync()
public
createReceiptRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReceiptRuleSet()
public
createReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReceiptRuleSetAsync()
public
createReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTemplate()
public
createTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTemplateAsync()
public
createTemplateAsync(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
—deleteConfigurationSetTrackingOptions()
public
deleteConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteConfigurationSetTrackingOptionsAsync()
public
deleteConfigurationSetTrackingOptionsAsync(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
—deleteIdentity()
public
deleteIdentity(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIdentityAsync()
public
deleteIdentityAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIdentityPolicy()
public
deleteIdentityPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIdentityPolicyAsync()
public
deleteIdentityPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReceiptFilter()
public
deleteReceiptFilter(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReceiptFilterAsync()
public
deleteReceiptFilterAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReceiptRule()
public
deleteReceiptRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReceiptRuleAsync()
public
deleteReceiptRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReceiptRuleSet()
public
deleteReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReceiptRuleSetAsync()
public
deleteReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteTemplate()
public
deleteTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteTemplateAsync()
public
deleteTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteVerifiedEmailAddress()
public
deleteVerifiedEmailAddress(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteVerifiedEmailAddressAsync()
public
deleteVerifiedEmailAddressAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeActiveReceiptRuleSet()
public
describeActiveReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeActiveReceiptRuleSetAsync()
public
describeActiveReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeConfigurationSet()
public
describeConfigurationSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeConfigurationSetAsync()
public
describeConfigurationSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeReceiptRule()
public
describeReceiptRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeReceiptRuleAsync()
public
describeReceiptRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeReceiptRuleSet()
public
describeReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeReceiptRuleSetAsync()
public
describeReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —generateSmtpPassword()
Create an SMTP password for a given IAM user's credentials.
public
static generateSmtpPassword(CredentialsInterface $creds) : string
The SMTP username is the Access Key ID for the provided credentials.
Parameters
- $creds : CredentialsInterface
Tags
Return values
string —getAccountSendingEnabled()
public
getAccountSendingEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccountSendingEnabledAsync()
public
getAccountSendingEnabledAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getApi()
public
abstract getApi() : Service
Return values
Service —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> —getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterface —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 —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
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —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 —getIdentityDkimAttributes()
public
getIdentityDkimAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityDkimAttributesAsync()
public
getIdentityDkimAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityMailFromDomainAttributes()
public
getIdentityMailFromDomainAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityMailFromDomainAttributesAsync()
public
getIdentityMailFromDomainAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityNotificationAttributes()
public
getIdentityNotificationAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityNotificationAttributesAsync()
public
getIdentityNotificationAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityPolicies()
public
getIdentityPolicies(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityPoliciesAsync()
public
getIdentityPoliciesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityVerificationAttributes()
public
getIdentityVerificationAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityVerificationAttributesAsync()
public
getIdentityVerificationAttributesAsync(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 —getSendQuota()
public
getSendQuota(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getSendQuotaAsync()
public
getSendQuotaAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getSendStatistics()
public
getSendStatistics(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getSendStatisticsAsync()
public
getSendStatisticsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callable —getTemplate()
public
getTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getTemplateAsync()
public
getTemplateAsync(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
—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
—listIdentities()
public
listIdentities(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIdentitiesAsync()
public
listIdentitiesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIdentityPolicies()
public
listIdentityPolicies(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIdentityPoliciesAsync()
public
listIdentityPoliciesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listReceiptFilters()
public
listReceiptFilters(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listReceiptFiltersAsync()
public
listReceiptFiltersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listReceiptRuleSets()
public
listReceiptRuleSets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listReceiptRuleSetsAsync()
public
listReceiptRuleSetsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTemplates()
public
listTemplates(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTemplatesAsync()
public
listTemplatesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listVerifiedEmailAddresses()
public
listVerifiedEmailAddresses(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listVerifiedEmailAddressesAsync()
public
listVerifiedEmailAddressesAsync(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
—putIdentityPolicy()
public
putIdentityPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putIdentityPolicyAsync()
public
putIdentityPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—reorderReceiptRuleSet()
public
reorderReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—reorderReceiptRuleSetAsync()
public
reorderReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendBounce()
public
sendBounce(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendBounceAsync()
public
sendBounceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendBulkTemplatedEmail()
public
sendBulkTemplatedEmail(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendBulkTemplatedEmailAsync()
public
sendBulkTemplatedEmailAsync(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
—sendRawEmail()
public
sendRawEmail(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendRawEmailAsync()
public
sendRawEmailAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendTemplatedEmail()
public
sendTemplatedEmail(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—sendTemplatedEmailAsync()
public
sendTemplatedEmailAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setActiveReceiptRuleSet()
public
setActiveReceiptRuleSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setActiveReceiptRuleSetAsync()
public
setActiveReceiptRuleSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityDkimEnabled()
public
setIdentityDkimEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityDkimEnabledAsync()
public
setIdentityDkimEnabledAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityFeedbackForwardingEnabled()
public
setIdentityFeedbackForwardingEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityFeedbackForwardingEnabledAsync()
public
setIdentityFeedbackForwardingEnabledAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityHeadersInNotificationsEnabled()
public
setIdentityHeadersInNotificationsEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityHeadersInNotificationsEnabledAsync()
public
setIdentityHeadersInNotificationsEnabledAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityMailFromDomain()
public
setIdentityMailFromDomain(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityMailFromDomainAsync()
public
setIdentityMailFromDomainAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityNotificationTopic()
public
setIdentityNotificationTopic(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setIdentityNotificationTopicAsync()
public
setIdentityNotificationTopicAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setReceiptRulePosition()
public
setReceiptRulePosition(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setReceiptRulePositionAsync()
public
setReceiptRulePositionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—testRenderTemplate()
public
testRenderTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—testRenderTemplateAsync()
public
testRenderTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateAccountSendingEnabled()
public
updateAccountSendingEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateAccountSendingEnabledAsync()
public
updateAccountSendingEnabledAsync(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
—updateConfigurationSetReputationMetricsEnabled()
public
updateConfigurationSetReputationMetricsEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationSetReputationMetricsEnabledAsync()
public
updateConfigurationSetReputationMetricsEnabledAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationSetSendingEnabled()
public
updateConfigurationSetSendingEnabled(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationSetSendingEnabledAsync()
public
updateConfigurationSetSendingEnabledAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationSetTrackingOptions()
public
updateConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationSetTrackingOptionsAsync()
public
updateConfigurationSetTrackingOptionsAsync(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
—updateReceiptRule()
public
updateReceiptRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateReceiptRuleAsync()
public
updateReceiptRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTemplate()
public
updateTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTemplateAsync()
public
updateTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyDomainDkim()
public
verifyDomainDkim(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyDomainDkimAsync()
public
verifyDomainDkimAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyDomainIdentity()
public
verifyDomainIdentity(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyDomainIdentityAsync()
public
verifyDomainIdentityAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyEmailAddress()
public
verifyEmailAddress(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyEmailAddressAsync()
public
verifyEmailAddressAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyEmailIdentity()
public
verifyEmailIdentity(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyEmailIdentityAsync()
public
verifyEmailIdentityAsync(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>