WorkMailClient
extends AwsClient
in package
This client is used to interact with the **Amazon WorkMail** service.
Table of Contents
- $aliases : array<string|int, mixed>
- $api : Service
- $config : array<string|int, mixed>
- $credentialProvider : callable
- $defaultRequestOptions : array<string|int, mixed>
- $endpoint : string
- $handlerList : HandlerList
- $region : string
- $signatureProvider : callable
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- associateDelegateToResource() :
- associateDelegateToResourceAsync() :
- associateMemberToGroup() :
- associateMemberToGroupAsync() :
- cancelMailboxExportJob() :
- cancelMailboxExportJobAsync() :
- createAlias() :
- createAliasAsync() :
- createGroup() :
- createGroupAsync() :
- createOrganization() :
- createOrganizationAsync() :
- createResource() :
- createResourceAsync() :
- createUser() :
- createUserAsync() :
- deleteAccessControlRule() :
- deleteAccessControlRuleAsync() :
- deleteAlias() :
- deleteAliasAsync() :
- deleteGroup() :
- deleteGroupAsync() :
- deleteMailboxPermissions() :
- deleteMailboxPermissionsAsync() :
- deleteOrganization() :
- deleteOrganizationAsync() :
- deleteResource() :
- deleteResourceAsync() :
- deleteRetentionPolicy() :
- deleteRetentionPolicyAsync() :
- deleteUser() :
- deleteUserAsync() :
- deregisterFromWorkMail() :
- deregisterFromWorkMailAsync() :
- describeGroup() :
- describeGroupAsync() :
- describeMailboxExportJob() :
- describeMailboxExportJobAsync() :
- describeOrganization() :
- describeOrganizationAsync() :
- describeResource() :
- describeResourceAsync() :
- describeUser() :
- describeUserAsync() :
- disassociateDelegateFromResource() :
- disassociateDelegateFromResourceAsync() :
- disassociateMemberFromGroup() :
- disassociateMemberFromGroupAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getAccessControlEffect() :
- getAccessControlEffectAsync() :
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDefaultRetentionPolicy() :
- getDefaultRetentionPolicyAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getMailboxDetails() :
- getMailboxDetailsAsync() :
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- listAccessControlRules() :
- listAccessControlRulesAsync() :
- listAliases() :
- listAliasesAsync() :
- listGroupMembers() :
- listGroupMembersAsync() :
- listGroups() :
- listGroupsAsync() :
- listMailboxExportJobs() :
- listMailboxExportJobsAsync() :
- listMailboxPermissions() :
- listMailboxPermissionsAsync() :
- listOrganizations() :
- listOrganizationsAsync() :
- listResourceDelegates() :
- listResourceDelegatesAsync() :
- listResources() :
- listResourcesAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- listUsers() :
- listUsersAsync() :
- putAccessControlRule() :
- putAccessControlRuleAsync() :
- putMailboxPermissions() :
- putMailboxPermissionsAsync() :
- putRetentionPolicy() :
- putRetentionPolicyAsync() :
- registerToWorkMail() :
- registerToWorkMailAsync() :
- resetPassword() :
- resetPasswordAsync() :
- startMailboxExportJob() :
- startMailboxExportJobAsync() :
- tagResource() :
- tagResourceAsync() :
- untagResource() :
- untagResourceAsync() :
- updateMailboxQuota() :
- updateMailboxQuotaAsync() :
- updatePrimaryEmailAddress() :
- updatePrimaryEmailAddressAsync() :
- updateResource() :
- updateResourceAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- loadAliases() : mixed
- parseClass() : array<string|int, mixed>
- Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
Properties
$aliases
private
array<string|int, mixed>
$aliases
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$signatureProvider
private
callable
$signatureProvider
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
Return values
mixed —__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
falseto use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
falseto disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiveroption for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
schemeto "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —associateDelegateToResource()
public
associateDelegateToResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateDelegateToResourceAsync()
public
associateDelegateToResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateMemberToGroup()
public
associateMemberToGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateMemberToGroupAsync()
public
associateMemberToGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—cancelMailboxExportJob()
public
cancelMailboxExportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—cancelMailboxExportJobAsync()
public
cancelMailboxExportJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createAlias()
public
createAlias(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createAliasAsync()
public
createAliasAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createGroup()
public
createGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createGroupAsync()
public
createGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createOrganization()
public
createOrganization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createOrganizationAsync()
public
createOrganizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createResource()
public
createResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createResourceAsync()
public
createResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUser()
public
createUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserAsync()
public
createUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAccessControlRule()
public
deleteAccessControlRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAccessControlRuleAsync()
public
deleteAccessControlRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAlias()
public
deleteAlias(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAliasAsync()
public
deleteAliasAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteGroup()
public
deleteGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteGroupAsync()
public
deleteGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteMailboxPermissions()
public
deleteMailboxPermissions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteMailboxPermissionsAsync()
public
deleteMailboxPermissionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteOrganization()
public
deleteOrganization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteOrganizationAsync()
public
deleteOrganizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteResource()
public
deleteResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteResourceAsync()
public
deleteResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteRetentionPolicy()
public
deleteRetentionPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteRetentionPolicyAsync()
public
deleteRetentionPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUser()
public
deleteUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserAsync()
public
deleteUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deregisterFromWorkMail()
public
deregisterFromWorkMail(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deregisterFromWorkMailAsync()
public
deregisterFromWorkMailAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeGroup()
public
describeGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeGroupAsync()
public
describeGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeMailboxExportJob()
public
describeMailboxExportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeMailboxExportJobAsync()
public
describeMailboxExportJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeOrganization()
public
describeOrganization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeOrganizationAsync()
public
describeOrganizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeResource()
public
describeResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeResourceAsync()
public
describeResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUser()
public
describeUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserAsync()
public
describeUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateDelegateFromResource()
public
disassociateDelegateFromResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateDelegateFromResourceAsync()
public
disassociateDelegateFromResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateMemberFromGroup()
public
disassociateMemberFromGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateMemberFromGroupAsync()
public
disassociateMemberFromGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getAccessControlEffect()
public
getAccessControlEffect(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccessControlEffectAsync()
public
getAccessControlEffectAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getApi()
public
abstract getApi() : Service
Return values
Service —getArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterface —getConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|null —getCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterface —getDefaultRetentionPolicy()
public
getDefaultRetentionPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getDefaultRetentionPolicyAsync()
public
getDefaultRetentionPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerList —getIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getMailboxDetails()
public
getMailboxDetails(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMailboxDetailsAsync()
public
getMailboxDetailsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
string —getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callable —getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —listAccessControlRules()
public
listAccessControlRules(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAccessControlRulesAsync()
public
listAccessControlRulesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAliases()
public
listAliases(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAliasesAsync()
public
listAliasesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGroupMembers()
public
listGroupMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGroupMembersAsync()
public
listGroupMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGroups()
public
listGroups(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGroupsAsync()
public
listGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listMailboxExportJobs()
public
listMailboxExportJobs(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listMailboxExportJobsAsync()
public
listMailboxExportJobsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listMailboxPermissions()
public
listMailboxPermissions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listMailboxPermissionsAsync()
public
listMailboxPermissionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listOrganizations()
public
listOrganizations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listOrganizationsAsync()
public
listOrganizationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourceDelegates()
public
listResourceDelegates(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourceDelegatesAsync()
public
listResourceDelegatesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResources()
public
listResources(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourcesAsync()
public
listResourcesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUsers()
public
listUsers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUsersAsync()
public
listUsersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putAccessControlRule()
public
putAccessControlRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putAccessControlRuleAsync()
public
putAccessControlRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putMailboxPermissions()
public
putMailboxPermissions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putMailboxPermissionsAsync()
public
putMailboxPermissionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putRetentionPolicy()
public
putRetentionPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putRetentionPolicyAsync()
public
putRetentionPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—registerToWorkMail()
public
registerToWorkMail(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—registerToWorkMailAsync()
public
registerToWorkMailAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—resetPassword()
public
resetPassword(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—resetPasswordAsync()
public
resetPasswordAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startMailboxExportJob()
public
startMailboxExportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startMailboxExportJobAsync()
public
startMailboxExportJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResource()
public
tagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResource()
public
untagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateMailboxQuota()
public
updateMailboxQuota(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateMailboxQuotaAsync()
public
updateMailboxQuotaAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePrimaryEmailAddress()
public
updatePrimaryEmailAddress(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePrimaryEmailAddressAsync()
public
updatePrimaryEmailAddressAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateResource()
public
updateResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateResourceAsync()
public
updateResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —addEndpointDiscoveryMiddleware()
private
addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
- $config : mixed
- $args : mixed
Return values
mixed —addEndpointParameterMiddleware()
private
addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —addInvocationId()
private
addInvocationId() : mixed
Return values
mixed —addSignatureMiddleware()
private
addSignatureMiddleware() : mixed
Return values
mixed —addStreamRequestPayload()
private
addStreamRequestPayload() : mixed
Return values
mixed —loadAliases()
private
loadAliases([mixed $file = null ]) : mixed
Parameters
- $file : mixed = null
Return values
mixed —parseClass()
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
private
parseClass() : array<string|int, mixed>