getSupportedEmailDomains
method provides a list of supported domains for provisioning an email address.CachePolicy
set to RemoteOnly
be used before CacheOnly
for at least one successful call to the service.checkEmailAddressAvailability
method.localParts
, takes in a set of local parts to validate and check if they are available. If any of the local parts are invalid or the input contains more than five local parts to check, an invalid argument error will be returned.domains
, should be a set of email domains exclusively supported by the email service. It is recommended to use the getSupportedEmailDomains
method to retrieve this set. If an unsupported domain is supplied, an invalid email domain error will be returned.JoHnDoE
would be returned as johndoe...
.provisionEmailAddress
method and will return the newly provisioned email address object.ownershipProofToken
is required as part of the input. This ties together the Sudo and email address such that the Sudo becomes the owner of the email address. Use the getOwnershipProof
method on the SudoProfilesClient
in the Sudo Profiles SDK in order to obtain an ownershipProofToken
. See the Sudo section for more information.alias
can also be provided as part of the input to provision an email address. The alias can be updated after initially provisioning the email address as discussed in the Updating Metadata of an Email Address section.sudoplatform.sudo.max
entitlement.sudoplatform.email.provisionEmailUserEntitled
entitlement.sudoplatform.email.maxEmailAddressesPerSudo
entitlement to consume.provisionEmailAddress
API fails with an insufficient entitlements error.sudoplatform.sudo.max
entitlement.sudoplatform.email.provisionEmailUserEntitled
entitlement.sudoplatform.email.maxEmailAddressesPerSudo
entitlement to consume.provisionEmailAddress
API fails with an insufficient entitlements error.deprovisionEmailAddress
method by passing in the id
of an existing email address object. The email address object that was deprovisioned will be returned and will no longer be usable for provisioning another email address.updateEmailAddressMetadata
method. Currently, the only attribute that can be updated on an email address object is the alias
. The alias
is an encrypted optional attribute on the email address object which can be modified by the user.id
, use the getEmailAddress
method. This method will return the record if it exists.ListEmailAddressesResult
with a status
and depending on the status, a list of matching items
and a nextToken
to support pagination. If no results matching the input are found, the result will contain empty items. There can be three possible statuses returned:listEmailAddresses
method.listEmailAddressesForSudoId
method by passing in the id
of the Sudo to query.