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.
- CloneReceiptRuleSet
- CreateConfigurationSet
- CreateConfigurationSetEventDestination
- CreateConfigurationSetTrackingOptions
- CreateCustomVerificationEmailTemplate
- CreateReceiptFilter
- CreateReceiptRule
- CreateReceiptRuleSet
- CreateTemplate
- DeleteConfigurationSet
- DeleteConfigurationSetEventDestination
- DeleteConfigurationSetTrackingOptions
- DeleteCustomVerificationEmailTemplate
- DeleteIdentity
- DeleteIdentityPolicy
- DeleteReceiptFilter
- DeleteReceiptRule
- DeleteReceiptRuleSet
- DeleteTemplate
- DeleteVerifiedEmailAddress
- DescribeActiveReceiptRuleSet
- DescribeConfigurationSet
- DescribeReceiptRule
- DescribeReceiptRuleSet
- GetAccountSendingEnabled
- GetCustomVerificationEmailTemplate
- GetIdentityDkimAttributes
- GetIdentityMailFromDomainAttributes
- GetIdentityNotificationAttributes
- GetIdentityPolicies
- GetIdentityVerificationAttributes
- GetSendQuota
- GetSendStatistics
- GetTemplate
- ListConfigurationSets
- ListCustomVerificationEmailTemplates
- ListIdentities
- ListIdentityPolicies
- ListReceiptFilters
- ListReceiptRuleSets
- ListTemplates
- ListVerifiedEmailAddresses
- PutConfigurationSetDeliveryOptions
- PutIdentityPolicy
- ReorderReceiptRuleSet
- SendBounce
- SendBulkTemplatedEmail
- SendCustomVerificationEmail
- SendEmail
- SendRawEmail
- SendTemplatedEmail
- SetActiveReceiptRuleSet
- SetIdentityDkimEnabled
- SetIdentityFeedbackForwardingEnabled
- SetIdentityHeadersInNotificationsEnabled
- SetIdentityMailFromDomain
- SetIdentityNotificationTopic
- SetReceiptRulePosition
- TestRenderTemplate
- UpdateAccountSendingEnabled
- UpdateConfigurationSetEventDestination
- UpdateConfigurationSetReputationMetricsEnabled
- UpdateConfigurationSetSendingEnabled
- UpdateConfigurationSetTrackingOptions
- UpdateCustomVerificationEmailTemplate
- UpdateReceiptRule
- UpdateTemplate
- VerifyDomainDkim
- VerifyDomainIdentity
- VerifyEmailAddress
- VerifyEmailIdentity
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
__sleep()
public
__sleep() : mixed
cloneReceiptRuleSet()
public
cloneReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcloneReceiptRuleSetAsync()
public
cloneReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfigurationSet()
public
createConfigurationSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfigurationSetAsync()
public
createConfigurationSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfigurationSetEventDestination()
public
createConfigurationSetEventDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfigurationSetEventDestinationAsync()
public
createConfigurationSetEventDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfigurationSetTrackingOptions()
public
createConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfigurationSetTrackingOptionsAsync()
public
createConfigurationSetTrackingOptionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCustomVerificationEmailTemplate()
public
createCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCustomVerificationEmailTemplateAsync()
public
createCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateReceiptFilter()
public
createReceiptFilter(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateReceiptFilterAsync()
public
createReceiptFilterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateReceiptRule()
public
createReceiptRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateReceiptRuleAsync()
public
createReceiptRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateReceiptRuleSet()
public
createReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateReceiptRuleSetAsync()
public
createReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTemplate()
public
createTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTemplateAsync()
public
createTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfigurationSet()
public
deleteConfigurationSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfigurationSetAsync()
public
deleteConfigurationSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfigurationSetEventDestination()
public
deleteConfigurationSetEventDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfigurationSetEventDestinationAsync()
public
deleteConfigurationSetEventDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfigurationSetTrackingOptions()
public
deleteConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfigurationSetTrackingOptionsAsync()
public
deleteConfigurationSetTrackingOptionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCustomVerificationEmailTemplate()
public
deleteCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCustomVerificationEmailTemplateAsync()
public
deleteCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteIdentity()
public
deleteIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteIdentityAsync()
public
deleteIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteIdentityPolicy()
public
deleteIdentityPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteIdentityPolicyAsync()
public
deleteIdentityPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteReceiptFilter()
public
deleteReceiptFilter(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteReceiptFilterAsync()
public
deleteReceiptFilterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteReceiptRule()
public
deleteReceiptRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteReceiptRuleAsync()
public
deleteReceiptRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteReceiptRuleSet()
public
deleteReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteReceiptRuleSetAsync()
public
deleteReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTemplate()
public
deleteTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTemplateAsync()
public
deleteTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVerifiedEmailAddress()
public
deleteVerifiedEmailAddress(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVerifiedEmailAddressAsync()
public
deleteVerifiedEmailAddressAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeActiveReceiptRuleSet()
public
describeActiveReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeActiveReceiptRuleSetAsync()
public
describeActiveReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConfigurationSet()
public
describeConfigurationSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConfigurationSetAsync()
public
describeConfigurationSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeReceiptRule()
public
describeReceiptRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeReceiptRuleAsync()
public
describeReceiptRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeReceiptRuleSet()
public
describeReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeReceiptRuleSetAsync()
public
describeReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgenerateSmtpPassword()
public
static generateSmtpPassword(CredentialsInterface $creds) : string
Parameters
- $creds : CredentialsInterface
Tags
Return values
stringgenerateSmtpPasswordV4()
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
Return values
stringgetAccountSendingEnabled()
public
getAccountSendingEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountSendingEnabledAsync()
public
getAccountSendingEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
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
CommandInterfacegetConfig()
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|nullgetCredentials()
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
PromiseInterfacegetCustomVerificationEmailTemplate()
public
getCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCustomVerificationEmailTemplateAsync()
public
getCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
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
HandlerListgetIdentityDkimAttributes()
public
getIdentityDkimAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIdentityDkimAttributesAsync()
public
getIdentityDkimAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIdentityMailFromDomainAttributes()
public
getIdentityMailFromDomainAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIdentityMailFromDomainAttributesAsync()
public
getIdentityMailFromDomainAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIdentityNotificationAttributes()
public
getIdentityNotificationAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIdentityNotificationAttributesAsync()
public
getIdentityNotificationAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIdentityPolicies()
public
getIdentityPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIdentityPoliciesAsync()
public
getIdentityPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIdentityVerificationAttributes()
public
getIdentityVerificationAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIdentityVerificationAttributesAsync()
public
getIdentityVerificationAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
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
stringgetSendQuota()
public
getSendQuota(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSendQuotaAsync()
public
getSendQuotaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSendStatistics()
public
getSendStatistics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSendStatisticsAsync()
public
getSendStatisticsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetTemplate()
public
getTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTemplateAsync()
public
getTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
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
ResultlistConfigurationSetsAsync()
public
listConfigurationSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCustomVerificationEmailTemplates()
public
listCustomVerificationEmailTemplates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCustomVerificationEmailTemplatesAsync()
public
listCustomVerificationEmailTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIdentities()
public
listIdentities(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIdentitiesAsync()
public
listIdentitiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIdentityPolicies()
public
listIdentityPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIdentityPoliciesAsync()
public
listIdentityPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistReceiptFilters()
public
listReceiptFilters(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistReceiptFiltersAsync()
public
listReceiptFiltersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistReceiptRuleSets()
public
listReceiptRuleSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistReceiptRuleSetsAsync()
public
listReceiptRuleSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTemplates()
public
listTemplates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTemplatesAsync()
public
listTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistVerifiedEmailAddresses()
public
listVerifiedEmailAddresses(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistVerifiedEmailAddressesAsync()
public
listVerifiedEmailAddressesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputConfigurationSetDeliveryOptions()
public
putConfigurationSetDeliveryOptions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputConfigurationSetDeliveryOptionsAsync()
public
putConfigurationSetDeliveryOptionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputIdentityPolicy()
public
putIdentityPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputIdentityPolicyAsync()
public
putIdentityPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisereorderReceiptRuleSet()
public
reorderReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultreorderReceiptRuleSetAsync()
public
reorderReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendBounce()
public
sendBounce(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendBounceAsync()
public
sendBounceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendBulkTemplatedEmail()
public
sendBulkTemplatedEmail(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendBulkTemplatedEmailAsync()
public
sendBulkTemplatedEmailAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendCustomVerificationEmail()
public
sendCustomVerificationEmail(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendCustomVerificationEmailAsync()
public
sendCustomVerificationEmailAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendEmail()
public
sendEmail(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendEmailAsync()
public
sendEmailAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendRawEmail()
public
sendRawEmail(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendRawEmailAsync()
public
sendRawEmailAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendTemplatedEmail()
public
sendTemplatedEmail(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendTemplatedEmailAsync()
public
sendTemplatedEmailAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetActiveReceiptRuleSet()
public
setActiveReceiptRuleSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetActiveReceiptRuleSetAsync()
public
setActiveReceiptRuleSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetIdentityDkimEnabled()
public
setIdentityDkimEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetIdentityDkimEnabledAsync()
public
setIdentityDkimEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetIdentityFeedbackForwardingEnabled()
public
setIdentityFeedbackForwardingEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetIdentityFeedbackForwardingEnabledAsync()
public
setIdentityFeedbackForwardingEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetIdentityHeadersInNotificationsEnabled()
public
setIdentityHeadersInNotificationsEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetIdentityHeadersInNotificationsEnabledAsync()
public
setIdentityHeadersInNotificationsEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetIdentityMailFromDomain()
public
setIdentityMailFromDomain(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetIdentityMailFromDomainAsync()
public
setIdentityMailFromDomainAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetIdentityNotificationTopic()
public
setIdentityNotificationTopic(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetIdentityNotificationTopicAsync()
public
setIdentityNotificationTopicAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetReceiptRulePosition()
public
setReceiptRulePosition(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetReceiptRulePositionAsync()
public
setReceiptRulePositionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetestRenderTemplate()
public
testRenderTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttestRenderTemplateAsync()
public
testRenderTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAccountSendingEnabled()
public
updateAccountSendingEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAccountSendingEnabledAsync()
public
updateAccountSendingEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfigurationSetEventDestination()
public
updateConfigurationSetEventDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfigurationSetEventDestinationAsync()
public
updateConfigurationSetEventDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfigurationSetReputationMetricsEnabled()
public
updateConfigurationSetReputationMetricsEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfigurationSetReputationMetricsEnabledAsync()
public
updateConfigurationSetReputationMetricsEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfigurationSetSendingEnabled()
public
updateConfigurationSetSendingEnabled(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfigurationSetSendingEnabledAsync()
public
updateConfigurationSetSendingEnabledAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfigurationSetTrackingOptions()
public
updateConfigurationSetTrackingOptions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfigurationSetTrackingOptionsAsync()
public
updateConfigurationSetTrackingOptionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateCustomVerificationEmailTemplate()
public
updateCustomVerificationEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateCustomVerificationEmailTemplateAsync()
public
updateCustomVerificationEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateReceiptRule()
public
updateReceiptRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateReceiptRuleAsync()
public
updateReceiptRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTemplate()
public
updateTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTemplateAsync()
public
updateTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifyDomainDkim()
public
verifyDomainDkim(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifyDomainDkimAsync()
public
verifyDomainDkimAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifyDomainIdentity()
public
verifyDomainIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifyDomainIdentityAsync()
public
verifyDomainIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifyEmailAddress()
public
verifyEmailAddress(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifyEmailAddressAsync()
public
verifyEmailAddressAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifyEmailIdentity()
public
verifyEmailIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifyEmailIdentityAsync()
public
verifyEmailIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []