Structures

Core entity representation of an email folder business rule. Depicts the information of a user’s email folder and related information.

Result type of an API that returns multiple records. Supports partial results.

Representation of the result of an unsuccessful operation performed on an email message

Representation of email configuration data in Platform SDK.

The result of a successful email message delete

Representation of a draft email message object associated with a draft email message in Platform SDK.

Representation of a draft email message metadata object associated with a draft email message in Platform SDK.

Representation of email address public information associated with an email address in the Platform SDK.

Representation of public key details associated with an email address in the Platform SDK.

Representation of an email domain object associated with an email address in Platform SDK.

The EmailDomain struct represents an email domain that may be associated with an email address. It contains the domain name, a flag indicating whether it is a mask domain, and metadata about the domain.

Representation of an Email Mask used in Sudo Email SDK.

Representation of a email message object associated with a email message in Platform SDK.

Representation of an email message object without any unsealed attributes associated with a email message in Platform SDK.

Representation of an email message date range used in the Sudo Platform Email SDK.

Note that both timestamps cannot be specified otherwise an InvalidArgumentError will occur.

Representation of an email message with body attachments used in the Sudo Platform Email SDK.

Filter for matching email messages by mailbox ID.

Input object for cancelling a scheduled draft message

input object for Provisioning an email address using SudoEmailClient

Input object for creating a custom EmailFolder

input object for creating a draft email message using SudoEmailClient The email address in the From field of the RFC6854 data must match either the maskAddress of the Email Mask associated with the emailMaskId property, if provided, otherwise the emailAddress of the Email Address associated with the senderEmailAddressId property.

Input object for deleting a custom EmailFolder

input object for deleting draft email messages using SudoEmailClient

Input object for deleting all messages in a folder

Input object for deprovisioning an email mask using SudoEmailClient

Input object for disabling an email mask using SudoEmailClient

Input object for enabling an email mask using SudoEmailClient

Input for the flushMessageBodyCache operation.

input object for getting a draft email message using SudoEmailClient

input object for getting an email address using SudoEmailClient

input object for getting an email message using SudoEmailClient

Input object containing an email message identifier and email address identifier used to retrieve the email message data.

Input object for listing draft email message metadata for an email address using SudoEmailClient.

Input object for listing draft email message metadata using SudoEmailClient.

input object for getting a email addresses associated with a sudo using SudoEmailClient

input object for getting an email address using SudoEmailClient

input object for listing email folders for an email address using SudoEmailClient

Input object for listing email masks for owner using SudoEmailClient

input object for listing email messages for an email address using SudoEmailClient

input object for listing email messages for an email folder using SudoEmailClient

Input object for listing email messages using SudoEmailClient

Input object for listing scheduled draft messages for an email address

Input object for retrieving public info for email addresses using SudoEmailClient.

input object for Provisioning an email address using SudoEmailClient

Input object for provisioning an email mask using SudoEmailClient

Input object for scheduling a draft message to be sent at a specified poit in the future

Input object containing information required to send an email message.

object defining the values to be set when updating a custom email address using SudoEmailClient

input object for updating a custom email folder using SudoEmailClient

input object for updating a draft email message using SudoEmailClient The email address in the From field of the RFC6854 data must match either the maskAddress of the Email Mask associated with the emailMaskId property, if provided, otherwise the emailAddress of the Email Address associated with the senderEmailAddressId property.

object defining the values to be set when updating email address metadata using SudoEmailClient

input object for updating an email address’ metadata using SudoEmailClient

Input object for updating an email mask using SudoEmailClient

object defining the values to be set when updating a list of email messages using SudoEmailClient

input object for updating a list of email messages using SudoEmailClient

Input object for verifying an external email address using SudoEmailClient

Representation of the email headers formatted under the RFC-6854 (supersedes RFC 822) standard. Some further rules (beyond RFC 6854) must also be applied to the data:

• At least one recipient must exist (to, cc, bcc).
• For all email addresses:
  • Total length (including both local part and domain) must not exceed 256 characters.
  • Local part must not exceed more than 64 characters.
  • Input domain parts (domain separated by .) must not exceed 63 characters.
  • Address must match standard email address pattern: ^[a-zA-Z0-9](\.?[-_a-zA-Z0-9])*@[a-zA-Z0-9](-*\.?[a-zA-Z0-9])*\.[a-zA-Z](-?[a-zA-Z0-9])+$.

Generic Type to wrap around an Output SudoEmail type from a List result.

This is useful for pagination requests and can use its nextToken to call the next paginated results.

Representation of an Owner object from the Email Service.

This represents the relationship of a unique identifier (id) with the issuer.

Result type of an API call to send an email message

Representation of an unsealed blocked email address in Platform SDK

The result of a successful email message update

Result of verifying an external email address

Representation of an Sudo Platform Email service messageReceived notification

Catch all notification in case new Sudo Platform Email Service notifications are emitted before an application has updated its Sudo Platform Email Notification Extension SDK