SDK for PHP 3.x

SesClient extends AwsClient
in package

This client is used to interact with the Amazon Simple Email Service (Amazon SES).

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
cloneReceiptRuleSet()  : Result
cloneReceiptRuleSetAsync()  : Promise
createConfigurationSet()  : Result
createConfigurationSetAsync()  : Promise
createConfigurationSetEventDestination()  : Result
createConfigurationSetEventDestinationAsync()  : Promise
createConfigurationSetTrackingOptions()  : Result
createConfigurationSetTrackingOptionsAsync()  : Promise
createCustomVerificationEmailTemplate()  : Result
createCustomVerificationEmailTemplateAsync()  : Promise
createReceiptFilter()  : Result
createReceiptFilterAsync()  : Promise
createReceiptRule()  : Result
createReceiptRuleAsync()  : Promise
createReceiptRuleSet()  : Result
createReceiptRuleSetAsync()  : Promise
createTemplate()  : Result
createTemplateAsync()  : Promise
deleteConfigurationSet()  : Result
deleteConfigurationSetAsync()  : Promise
deleteConfigurationSetEventDestination()  : Result
deleteConfigurationSetEventDestinationAsync()  : Promise
deleteConfigurationSetTrackingOptions()  : Result
deleteConfigurationSetTrackingOptionsAsync()  : Promise
deleteCustomVerificationEmailTemplate()  : Result
deleteCustomVerificationEmailTemplateAsync()  : Promise
deleteIdentity()  : Result
deleteIdentityAsync()  : Promise
deleteIdentityPolicy()  : Result
deleteIdentityPolicyAsync()  : Promise
deleteReceiptFilter()  : Result
deleteReceiptFilterAsync()  : Promise
deleteReceiptRule()  : Result
deleteReceiptRuleAsync()  : Promise
deleteReceiptRuleSet()  : Result
deleteReceiptRuleSetAsync()  : Promise
deleteTemplate()  : Result
deleteTemplateAsync()  : Promise
deleteVerifiedEmailAddress()  : Result
deleteVerifiedEmailAddressAsync()  : Promise
describeActiveReceiptRuleSet()  : Result
describeActiveReceiptRuleSetAsync()  : Promise
describeConfigurationSet()  : Result
describeConfigurationSetAsync()  : Promise
describeReceiptRule()  : Result
describeReceiptRuleAsync()  : Promise
describeReceiptRuleSet()  : Result
describeReceiptRuleSetAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
generateSmtpPassword()  : string
generateSmtpPasswordV4()  : string
Create an SMTP password for a given IAM user's credentials.
getAccountSendingEnabled()  : Result
getAccountSendingEnabledAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
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()  : Result
getCustomVerificationEmailTemplateAsync()  : Promise
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIdentityDkimAttributes()  : Result
getIdentityDkimAttributesAsync()  : Promise
getIdentityMailFromDomainAttributes()  : Result
getIdentityMailFromDomainAttributesAsync()  : Promise
getIdentityNotificationAttributes()  : Result
getIdentityNotificationAttributesAsync()  : Promise
getIdentityPolicies()  : Result
getIdentityPoliciesAsync()  : Promise
getIdentityVerificationAttributes()  : Result
getIdentityVerificationAttributesAsync()  : Promise
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSendQuota()  : Result
getSendQuotaAsync()  : Promise
getSendStatistics()  : Result
getSendStatisticsAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getTemplate()  : Result
getTemplateAsync()  : Promise
getWaiter()  : mixed
listConfigurationSets()  : Result
listConfigurationSetsAsync()  : Promise
listCustomVerificationEmailTemplates()  : Result
listCustomVerificationEmailTemplatesAsync()  : Promise
listIdentities()  : Result
listIdentitiesAsync()  : Promise
listIdentityPolicies()  : Result
listIdentityPoliciesAsync()  : Promise
listReceiptFilters()  : Result
listReceiptFiltersAsync()  : Promise
listReceiptRuleSets()  : Result
listReceiptRuleSetsAsync()  : Promise
listTemplates()  : Result
listTemplatesAsync()  : Promise
listVerifiedEmailAddresses()  : Result
listVerifiedEmailAddressesAsync()  : Promise
putConfigurationSetDeliveryOptions()  : Result
putConfigurationSetDeliveryOptionsAsync()  : Promise
putIdentityPolicy()  : Result
putIdentityPolicyAsync()  : Promise
reorderReceiptRuleSet()  : Result
reorderReceiptRuleSetAsync()  : Promise
sendBounce()  : Result
sendBounceAsync()  : Promise
sendBulkTemplatedEmail()  : Result
sendBulkTemplatedEmailAsync()  : Promise
sendCustomVerificationEmail()  : Result
sendCustomVerificationEmailAsync()  : Promise
sendEmail()  : Result
sendEmailAsync()  : Promise
sendRawEmail()  : Result
sendRawEmailAsync()  : Promise
sendTemplatedEmail()  : Result
sendTemplatedEmailAsync()  : Promise
setActiveReceiptRuleSet()  : Result
setActiveReceiptRuleSetAsync()  : Promise
setIdentityDkimEnabled()  : Result
setIdentityDkimEnabledAsync()  : Promise
setIdentityFeedbackForwardingEnabled()  : Result
setIdentityFeedbackForwardingEnabledAsync()  : Promise
setIdentityHeadersInNotificationsEnabled()  : Result
setIdentityHeadersInNotificationsEnabledAsync()  : Promise
setIdentityMailFromDomain()  : Result
setIdentityMailFromDomainAsync()  : Promise
setIdentityNotificationTopic()  : Result
setIdentityNotificationTopicAsync()  : Promise
setReceiptRulePosition()  : Result
setReceiptRulePositionAsync()  : Promise
testRenderTemplate()  : Result
testRenderTemplateAsync()  : Promise
updateAccountSendingEnabled()  : Result
updateAccountSendingEnabledAsync()  : Promise
updateConfigurationSetEventDestination()  : Result
updateConfigurationSetEventDestinationAsync()  : Promise
updateConfigurationSetReputationMetricsEnabled()  : Result
updateConfigurationSetReputationMetricsEnabledAsync()  : Promise
updateConfigurationSetSendingEnabled()  : Result
updateConfigurationSetSendingEnabledAsync()  : Promise
updateConfigurationSetTrackingOptions()  : Result
updateConfigurationSetTrackingOptionsAsync()  : Promise
updateCustomVerificationEmailTemplate()  : Result
updateCustomVerificationEmailTemplateAsync()  : Promise
updateReceiptRule()  : Result
updateReceiptRuleAsync()  : Promise
updateTemplate()  : Result
updateTemplateAsync()  : Promise
verifyDomainDkim()  : Result
verifyDomainDkimAsync()  : Promise
verifyDomainIdentity()  : Result
verifyDomainIdentityAsync()  : Promise
verifyEmailAddress()  : Result
verifyEmailAddressAsync()  : Promise
verifyEmailIdentity()  : Result
verifyEmailIdentityAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, 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.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one 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).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

cloneReceiptRuleSet()

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

cloneReceiptRuleSetAsync()

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

createConfigurationSet()

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

createConfigurationSetAsync()

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

createConfigurationSetEventDestination()

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

createConfigurationSetEventDestinationAsync()

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

createConfigurationSetTrackingOptions()

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

createConfigurationSetTrackingOptionsAsync()

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

createCustomVerificationEmailTemplate()

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

createCustomVerificationEmailTemplateAsync()

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

createReceiptFilter()

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

createReceiptFilterAsync()

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

createReceiptRule()

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

createReceiptRuleAsync()

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

createReceiptRuleSet()

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

createReceiptRuleSetAsync()

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

createTemplate()

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

createTemplateAsync()

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

deleteConfigurationSet()

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

deleteConfigurationSetAsync()

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

deleteConfigurationSetEventDestination()

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

deleteConfigurationSetEventDestinationAsync()

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

deleteConfigurationSetTrackingOptions()

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

deleteConfigurationSetTrackingOptionsAsync()

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

deleteCustomVerificationEmailTemplate()

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

deleteCustomVerificationEmailTemplateAsync()

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

deleteIdentity()

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

deleteIdentityAsync()

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

deleteIdentityPolicy()

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

deleteIdentityPolicyAsync()

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

deleteReceiptFilter()

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

deleteReceiptFilterAsync()

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

deleteReceiptRule()

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

deleteReceiptRuleAsync()

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

deleteReceiptRuleSet()

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

deleteReceiptRuleSetAsync()

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

deleteTemplate()

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

deleteTemplateAsync()

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

deleteVerifiedEmailAddress()

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

deleteVerifiedEmailAddressAsync()

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

describeActiveReceiptRuleSet()

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

describeActiveReceiptRuleSetAsync()

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

describeConfigurationSet()

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

describeConfigurationSetAsync()

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

describeReceiptRule()

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

describeReceiptRuleAsync()

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

describeReceiptRuleSet()

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

describeReceiptRuleSetAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

generateSmtpPassword()

public static generateSmtpPassword(CredentialsInterface $creds) : string
Parameters
$creds : CredentialsInterface
Tags
deprecated

This method will no longer work due to the deprecation of V2 credentials with SES as of 03/25/2021 Create an SMTP password for a given IAM user's credentials.

The SMTP username is the Access Key ID for the provided credentials.

link
http://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html#smtp-credentials-convert
Return values
string

generateSmtpPasswordV4()

Create an SMTP password for a given IAM user's credentials.

public static generateSmtpPasswordV4(CredentialsInterface $creds, string $region) : string

The SMTP username is the Access Key ID for the provided credentials. This utility method is not guaranteed to work indefinitely and is provided as a convenience to customers using the generateSmtpPassword method. It is not recommended for use in production

Parameters
$creds : CredentialsInterface
$region : string
Tags
link
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html#smtp-credentials-convert
Return values
string

getAccountSendingEnabled()

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

getAccountSendingEnabledAsync()

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

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>

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : 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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getCustomVerificationEmailTemplateAsync()

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getIdentityDkimAttributesAsync()

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

getIdentityMailFromDomainAttributes()

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

getIdentityMailFromDomainAttributesAsync()

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

getIdentityNotificationAttributes()

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

getIdentityNotificationAttributesAsync()

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

getIdentityPolicies()

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

getIdentityPoliciesAsync()

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

getIdentityVerificationAttributes()

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

getIdentityVerificationAttributesAsync()

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

getIterator()

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

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, 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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getSendQuotaAsync()

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

getSendStatistics()

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

getSendStatisticsAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getTemplate()

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

getTemplateAsync()

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

getWaiter()

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

listConfigurationSets()

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

listConfigurationSetsAsync()

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

listCustomVerificationEmailTemplates()

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

listCustomVerificationEmailTemplatesAsync()

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

listIdentities()

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

listIdentitiesAsync()

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

listIdentityPolicies()

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

listIdentityPoliciesAsync()

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

listReceiptFilters()

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

listReceiptFiltersAsync()

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

listReceiptRuleSets()

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

listReceiptRuleSetsAsync()

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

listTemplates()

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

listTemplatesAsync()

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

listVerifiedEmailAddresses()

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

listVerifiedEmailAddressesAsync()

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

putConfigurationSetDeliveryOptions()

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

putConfigurationSetDeliveryOptionsAsync()

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

putIdentityPolicy()

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

putIdentityPolicyAsync()

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

reorderReceiptRuleSet()

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

reorderReceiptRuleSetAsync()

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

sendBounce()

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

sendBounceAsync()

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

sendBulkTemplatedEmail()

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

sendBulkTemplatedEmailAsync()

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

sendCustomVerificationEmail()

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

sendCustomVerificationEmailAsync()

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

sendEmail()

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

sendEmailAsync()

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

sendRawEmail()

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

sendRawEmailAsync()

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

sendTemplatedEmail()

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

sendTemplatedEmailAsync()

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

setActiveReceiptRuleSet()

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

setActiveReceiptRuleSetAsync()

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

setIdentityDkimEnabled()

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

setIdentityDkimEnabledAsync()

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

setIdentityFeedbackForwardingEnabled()

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

setIdentityFeedbackForwardingEnabledAsync()

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

setIdentityHeadersInNotificationsEnabled()

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

setIdentityHeadersInNotificationsEnabledAsync()

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

setIdentityMailFromDomain()

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

setIdentityMailFromDomainAsync()

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

setIdentityNotificationTopic()

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

setIdentityNotificationTopicAsync()

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

setReceiptRulePosition()

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

setReceiptRulePositionAsync()

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

testRenderTemplate()

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

testRenderTemplateAsync()

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

updateAccountSendingEnabled()

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

updateAccountSendingEnabledAsync()

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

updateConfigurationSetEventDestination()

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

updateConfigurationSetEventDestinationAsync()

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

updateConfigurationSetReputationMetricsEnabled()

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

updateConfigurationSetReputationMetricsEnabledAsync()

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

updateConfigurationSetSendingEnabled()

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

updateConfigurationSetSendingEnabledAsync()

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

updateConfigurationSetTrackingOptions()

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

updateConfigurationSetTrackingOptionsAsync()

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

updateCustomVerificationEmailTemplate()

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

updateCustomVerificationEmailTemplateAsync()

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

updateReceiptRule()

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

updateReceiptRuleAsync()

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

updateTemplate()

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

updateTemplateAsync()

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

verifyDomainDkim()

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

verifyDomainDkimAsync()

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

verifyDomainIdentity()

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

verifyDomainIdentityAsync()

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

verifyEmailAddress()

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

verifyEmailAddressAsync()

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

verifyEmailIdentity()

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

verifyEmailIdentityAsync()

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

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page