Parameters to block email addresses
The results of the operation
Cancels a scheduled draft message. If no matching scheduled message is found, the operation completes successfully without error.
Parameters used to cancel a scheduled draft message
Check if an email address is available to be provisioned within a domain.
Parameters used to perform the email addresses check.
Returns the fully qualified email addresses, filtering out already used email addresses.
Create a custom email folder for the email address identified by emailAddressId.
Parameters used to create a custom email folder.
The created custom email folder.
Create a draft email message in RFC 6854 (supersedes RFC 822)(https://tools.ietf.org/html/rfc6854) format.
Parameters used to create a draft email message.
The metadata of the saved draft email message.
Delete a custom email folder for the email address identified by emailAddressId. When a custom folder is deleted, any messages in the folder will be moved to TRASH.
Parameters used to delete a custom email folder.
The deleted folder, or undefined if folder was not found.
Delete the draft email messages identified by the list of ids.
Any draft email message ids that do not exist will be marked as success. Any emailAddressId that is not owned or does not exist, will throw an error.
Parameters used to delete a draft email message.
The status of the delete: Success - All draft email messages succeeded to delete. Partial - Only a partial amount of draft email messages succeeded to delete. Includes a list of the identifiers of the draft email messages that failed and succeeded to delete. Failure - All draft email messages failed to delete.
Delete a single email message identified by id.
The identifier of the email message to be deleted.
Result object containing the identifier of the email message that was deleted, or undefined if the email message could not be deleted.
Delete the email messages identified by the list of ids.
Email messages can only be deleted in batches of 100. Anything greater will throw a LimitExceededError.
A list of one or more identifiers of the email messages to be deleted. There is a limit of 100 email message ids per API request. Exceeding this will cause an error to be thrown.
The status of the delete: Success - All email messages succeeded to delete. Partial - Only a partial amount of messages succeeded to delete. Includes a list of the identifiers of the email messages that failed and succeeded to delete. Failure - All email messages failed to delete.
Delete all messages for in an email folder. Deletion will be processed asynchronously since it may take a substantial amount of time. This method does not wait for deletion to complete. To check for completion, listen for subscriptions or check list endpoints.
Parameters used to delete messages from a folder
The id of the folder
Deprovision an email address.
The identifier of the email address to deprovision.
The deprovisioned email address.
Deprovisions an existing email mask, permanently removing it from the system.
The input parameters for deprovisioning the email mask
A promise that resolves to the deprovisioned email mask
Disables an active email mask, preventing it from forwarding emails.
The input parameters for disabling the email mask
A promise that resolves to the disabled email mask
Enables a previously disabled email mask, allowing it to forward emails again.
The input parameters for enabling the email mask
A promise that resolves to the enabled email mask
Export the cryptographic keys to a key archive.
Key archive data.
Flush all cached message bodies scoped to the given sudo or email address. Call this after deleting a sudo or deprovisioning an email address.
Parameters specifying the scope of the flush.
Get the configuration data for the email service.
The configuration data for the email service.
Get a draft email message that has been previously saved.
Parameters used to retrieve a draft email message.
The draft email message identified by id or undefined if not found.
Get an email address identified by id.
Parameters used to retrieve an email address.
The email address identified by id or undefined if the email address cannot be found.
Get email address blocklist for logged in user
The list of unsealed blocked addresses
Get an email message identified by id.
Parameters used to retrieve an email message.
The email message identified by id or undefined if the email message cannot be found.
Get the body and attachment data of an EmailMessage
Parameters used to retrieve the data of the email message.
The data associated with the email message or undefined if not found
Imports cryptographic keys from a key archive.
Key archive data to import the keys from.
An array of draft email message metadata or an empty array if no matching draft email messages can be found.
Lists the metadata of all draft email messages for the specified email address identifier. Supports pagination with limit and nextToken parameters. Supports pagination with limit and nextToken parameters.
Parameters for listing draft email message metadata including emailAddressId, optional limit (defaults to 10), and optional nextToken for pagination.
A list output containing draft email message metadata and pagination token.
An array of draft email messages or an empty array if no matching draft email messages can be found.
Lists the metadata and content of all draft messages for the specified email address identifier. Supports pagination with limit and nextToken parameters.
Parameters for listing draft email messages including emailAddressId, optional limit (defaults to 10), and optional nextToken for pagination.
A list output containing draft email messages and pagination token.
Get a list of all provisioned email addresses for the signed in user.
Optionalinput: PaginationParameters used to retrieve a list of provisioned email addresses.
List operation result.
Get a list of provisioned email addresses owned by the Sudo identified by sudoId.
Parameters used to retrieve a list of provisioned email addresses for a sudoId.
List operation result.
Get a list of email folders associated with the email address identified by emailAddressId.
Parameters used to retrieve a list of email folders for an emailAddressId.
An array of email folders or an empty array if no matching email folders can be found.
Lists email masks owned by the current user, with optional filtering and pagination.
Optionalinput: ListEmailMasksForOwnerInputThe input parameters for filtering and pagination
A promise that resolves to a list of email masks and pagination info
Get the list of all email messages for the user.
Parameters used to retrieve a list of all email messages for a user.
List operation result.
Get the list of email messages for the specified email address.
Parameters used to retrieve a list of email messages for an emailAddressId.
List operation result.
Get the list of email messages for the specified email folder.
Parameters used to retrieve a list of email messages for a folderId.
List operation result.
List scheduled draft messages associated with an email address.
Parameters ued to list scheduled draft messages for an email address
Get a list of public information objects associated with the provided email addresses.
Results can only be retrieved in batches of 50. Anything greater will throw a LimitExceededError.
Parameters used to retrieve a list of public information objects for a list of email addresses.
An array of public info objects, or an empty array if email addresses or their public keys cannot be found.
Provision an email address.
Parameters used to provision an email address. Email addresses must meet the following criteria:
.) must not exceed 63 characters.^[a-zA-Z0-9](\.?[-_a-zA-Z0-9])*@[a-zA-Z0-9](-*\.?[a-zA-Z0-9])*\.[a-zA-Z](-?[a-zA-Z0-9])+$.The provisioned email address.
Provisions a new email mask with the specified configuration.
The input parameters for provisioning the email mask
A promise that resolves to the newly created email mask
Removes any cached data maintained by this client.
Parameters used to schedule send a draft message.
Send an email message using RFC 6854 (supersedes RFC 822)(https://tools.ietf.org/html/rfc6854) data.
Email messages sent to in-network recipients (i.e. email addresses that exist within the Sudo Platform) will be sent end-to-end encrypted.
Parameters used to send an email message.
The identifier of the email message that is being sent.
Send a masked email message using RFC 6854 (supersedes RFC 822)(https://tools.ietf.org/html/rfc6854) data.
Email messages sent to in-network recipients (i.e. email addresses/masks that exist within the Sudo Platform) will be sent end-to-end encrypted.
Parameters used to send a masked email message.
The identifier of the masked email message that is being sent.
Update the maximum size of the local message body cache. The new limit is persisted and survives across client sessions. Set to 0 to disable caching; existing cached entries are evicted immediately when the limit is reduced.
New cache size limit in bytes. Must be >= 0.
Sets an optional callback to handle sign-in when operations are attempted while not signed in.
When set, all operations (exception subscriptions and initialization/reset) will check sign-in status before performing their normal behavior. If the client is not signed in, the callback will be invoked to allow the host app to perform sign-in. Once the callback completes, then the client will attempt the original operation that triggered the callback. If the callback throws an error, then the error will be propagated to the caller and the original operation will not be attempted. To clear the callback, call this method with no arguments or undefined.
Optionalcallback: SudoPlatformSignInCallbackSubscribe to email message events.
unique identifier to differentiate subscriptions; note that specifying a duplicate subscription id will replace the previous subscription.
implementation of callback to be invoked when email message event occurs
Unblock email address(es) for the given owner
Parameters to unblock email addresses
The results of the operation
Unblock email address(es) for the given owner
Parameters to unblock email addresses
The results of the operation
Unsubscribe from email message events.
unique identifier to differentiate subscription
Update the custom email folder identified by emailFolderId
Parameters used to update a custom email folder.
The updated email folder.
Update a draft email message in RFC 6854 (supersedes RFC 822)(https://tools.ietf.org/html/rfc6854) format.
Parameters used to update a draft email message.
The metadata of the updated draft email message.
Update the metadata of an email address.
Parameters used to update the metadata of an email address.
The id of the updated email address.
Updates the metadata or expiration date of an existing email mask.
The input parameters for updating the email mask
A promise that resolves to the updated email mask
Update the email messages identified by the list of ids.
Email messages can only be updated in batches of 100. Anything greater will throw a LimitExceededError.
Parameters used to update a list of email messages.
The status of the update: Success - All email messages succeeded to update. Partial - Only a partial amount of messages succeeded to update. Includes a list of the identifiers of the email messages that failed and succeeded to update. Failure - All email messages failed to update.
Sends an email verification code or verifies an external email address given a verification code.
The input parameters for verifying an external email address
A promise that resolves to a result if a verification code was provided in the request or undefined if a verification code was sent.
Block email address(es) for the given owner