sudoemail/com.sudoplatform.sudoemail.types.inputs

Package-level declarations

Types

CancelScheduledDraftMessageInput

data class CancelScheduledDraftMessageInput(val id: String, val emailAddressId: String)

Input object containing the parameters needed to cancel a scheduled draft message

CheckEmailAddressAvailabilityInput

data class CheckEmailAddressAvailabilityInput(val localParts: List<String>, val domains: List<String>?)

Input object containing a list of local parts and domains used to check for email address availability.

CreateCustomEmailFolderInput

data class CreateCustomEmailFolderInput(val emailAddressId: String, val customFolderName: String)

Input object containing the properties needed to create a custom email folder.

CreateDraftEmailMessageInput

data class CreateDraftEmailMessageInput(val rfc822Data: ByteArray, val senderEmailAddressId: String)

Input object containing information required to save a draft email message.

DeleteCustomEmailFolderInput

data class DeleteCustomEmailFolderInput(val emailFolderId: String, val emailAddressId: String)

Input object containing the properties needed to delete a custom email folder.

DeleteDraftEmailMessagesInput

data class DeleteDraftEmailMessagesInput(val ids: List<String>, val emailAddressId: String)

Input object containing an email address identifier and a list of draft email message ids to be deleted.

DeleteMessagesForFolderIdInput

data class DeleteMessagesForFolderIdInput(val emailFolderId: String, val emailAddressId: String, val hardDelete: Boolean? = null)

Input object containing the properties needed to delete messages for an email folder.

DeprovisionEmailMaskInput

data class DeprovisionEmailMaskInput(val emailMaskId: String)

Input object containing the properties needed to deprovision an email mask.

DisableEmailMaskInput

data class DisableEmailMaskInput(val emailMaskId: String)

Input object containing the properties needed to disable an email mask.

EmailMaskFilterInput

data class EmailMaskFilterInput(val status: EmailMaskStatusFilterInput? = null, val realAddressType: EmailMaskRealAddressTypeFilterInput? = null)

EmailMaskRealAddressTypeFilterInput

sealed interface EmailMaskRealAddressTypeFilterInput

EmailMaskStatusFilterInput

sealed interface EmailMaskStatusFilterInput

EnableEmailMaskInput

data class EnableEmailMaskInput(val emailMaskId: String)

Input object containing the properties needed to enable an email mask.

EqualRealAddressTypeFilter

data class EqualRealAddressTypeFilter(val equal: EmailMaskRealAddressType) : EmailMaskRealAddressTypeFilterInput

EqualStateFilter

data class EqualStateFilter(val equal: ScheduledDraftMessageState) : ScheduledDraftMessageStateFilterInput

EqualStatusFilter

data class EqualStatusFilter(val equal: EmailMaskStatus) : EmailMaskStatusFilterInput

GetDraftEmailMessageInput

data class GetDraftEmailMessageInput(val id: String, val emailAddressId: String)

Input object containing a draft email message id and email address id to retrieve a draft email message

GetEmailAddressInput

data class GetEmailAddressInput(val id: String)

Input object containing an email address identifier used to retrieve an email address.

GetEmailMessageInput

data class GetEmailMessageInput(val id: String)

Input object containing an email message identifier and cache policy used to retrieve an email message.

GetEmailMessageRfc822DataInput

data class GetEmailMessageRfc822DataInput(val id: String, val emailAddressId: String)

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

GetEmailMessageWithBodyInput

data class GetEmailMessageWithBodyInput(val id: String, val emailAddressId: String)

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

ListDraftEmailMessageMetadataForEmailAddressIdInput

data class ListDraftEmailMessageMetadataForEmailAddressIdInput(val emailAddressId: String, val limit: Int? = 10, val nextToken: String? = null)

Input object containing information required to list draft email message metadata for a specific email address with pagination support.

ListDraftEmailMessagesForEmailAddressIdInput

data class ListDraftEmailMessagesForEmailAddressIdInput(val emailAddressId: String, val limit: Int? = null, val nextToken: String? = null)

Input object containing information required to list draft email messages with content for a specific email address with pagination support.

ListEmailAddressesForSudoIdInput

data class ListEmailAddressesForSudoIdInput(val sudoId: String, val limit: Int? = SudoEmailClient.DEFAULT_EMAIL_ADDRESS_LIMIT, val nextToken: String? = null)

Input object containing a Sudo identifier and other properties used to list email addresses for a Sudo.

ListEmailAddressesInput

data class ListEmailAddressesInput(val limit: Int? = SudoEmailClient.DEFAULT_EMAIL_ADDRESS_LIMIT, val nextToken: String? = null)

Input object containing properties used to list provisioned email addresses.

ListEmailFoldersForEmailAddressIdInput

data class ListEmailFoldersForEmailAddressIdInput(val emailAddressId: String, val limit: Int? = SudoEmailClient.DEFAULT_EMAIL_FOLDER_LIMIT, val nextToken: String? = null)

Input object containing an email address identifier and other properties used to list email folders for an email address.

ListEmailMasksForOwnerInput

data class ListEmailMasksForOwnerInput(val limit: Int? = null, val nextToken: String? = null, val filter: EmailMaskFilterInput? = null)

Input object containing email address id and other parameters used to list scheduled draft messages for an email address.

ListEmailMessagesForEmailAddressIdInput

data class ListEmailMessagesForEmailAddressIdInput(val emailAddressId: String, val dateRange: EmailMessageDateRange? = null, val limit: Int? = SudoEmailClient.DEFAULT_EMAIL_MESSAGE_LIMIT, val nextToken: String? = null, val sortOrder: SortOrder = SortOrder.DESC, val includeDeletedMessages: Boolean = false)

Input object containing an email address identifier and other properties used to list email messages for an email address.

ListEmailMessagesForEmailFolderIdInput

data class ListEmailMessagesForEmailFolderIdInput(val folderId: String, val dateRange: EmailMessageDateRange? = null, val limit: Int? = SudoEmailClient.DEFAULT_EMAIL_MESSAGE_LIMIT, val nextToken: String? = null, val sortOrder: SortOrder = SortOrder.DESC, val includeDeletedMessages: Boolean = false)

Input object containing an email address identifier and other properties used to list email messages for an email address.

ListEmailMessagesInput

data class ListEmailMessagesInput(val dateRange: EmailMessageDateRange? = null, val limit: Int? = SudoEmailClient.DEFAULT_EMAIL_MESSAGE_LIMIT, val nextToken: String? = null, val sortOrder: SortOrder = SortOrder.DESC, val includeDeletedMessages: Boolean = false)

Input object containing properties used to list all email messages for a user.

ListScheduledDraftMessagesForEmailAddressIdInput

data class ListScheduledDraftMessagesForEmailAddressIdInput(val emailAddressId: String, val limit: Int? = null, val nextToken: String? = null, val filter: ScheduledDraftMessageFilterInput? = null)

Input object containing email address id and other parameters used to list scheduled draft messages for an email address.

LookupEmailAddressesPublicInfoInput

data class LookupEmailAddressesPublicInfoInput(val emailAddresses: List<String>)

Input object containing a list of email addresses used to retrieve public info for email addresses.

NotEqualRealAddressTypeFilter

data class NotEqualRealAddressTypeFilter(val notEqual: EmailMaskRealAddressType) : EmailMaskRealAddressTypeFilterInput

NotEqualStateFilter

data class NotEqualStateFilter(val notEqual: ScheduledDraftMessageState) : ScheduledDraftMessageStateFilterInput

NotEqualStatusFilter

data class NotEqualStatusFilter(val notEqual: EmailMaskStatus) : EmailMaskStatusFilterInput

NotOneOfRealAddressTypeFilter

data class NotOneOfRealAddressTypeFilter(val notOneOf: List<EmailMaskRealAddressType>) : EmailMaskRealAddressTypeFilterInput

NotOneOfStateFilter

data class NotOneOfStateFilter(val notOneOf: List<ScheduledDraftMessageState>) : ScheduledDraftMessageStateFilterInput

NotOneOfStatusFilter

data class NotOneOfStatusFilter(val notOneOf: List<EmailMaskStatus>) : EmailMaskStatusFilterInput

OneOfRealAddressTypeFilter

data class OneOfRealAddressTypeFilter(val oneOf: List<EmailMaskRealAddressType>) : EmailMaskRealAddressTypeFilterInput

OneOfStateFilter

data class OneOfStateFilter(val oneOf: List<ScheduledDraftMessageState>) : ScheduledDraftMessageStateFilterInput

OneOfStatusFilter

data class OneOfStatusFilter(val oneOf: List<EmailMaskStatus>) : EmailMaskStatusFilterInput

ProvisionEmailAddressInput

data class ProvisionEmailAddressInput(val emailAddress: String, val ownershipProofToken: String, val alias: String? = null, val keyId: String? = null)

Input object containing information required to provision an email address.

ProvisionEmailMaskInput

data class ProvisionEmailMaskInput(val maskAddress: String, val realAddress: String, val ownershipProofToken: String, val metadata: Map<String, String>? = null, val expiresAt: Date? = null, val keyId: String? = null)

Input object containing the properties needed to provision an email mask.

ScheduledDraftMessageFilterInput

data class ScheduledDraftMessageFilterInput(val state: ScheduledDraftMessageStateFilterInput? = null)

ScheduledDraftMessageStateFilterInput

sealed interface ScheduledDraftMessageStateFilterInput

ScheduleSendDraftMessageInput

data class ScheduleSendDraftMessageInput(val id: String, val emailAddressId: String, val sendAt: Date)

Input object containing the parameters needed to schedule send a draft message

SendEmailMessageInput

data class SendEmailMessageInput(val senderEmailAddressId: String, val emailMessageHeader: InternetMessageFormatHeader, val body: String, val attachments: List<EmailAttachment> = emptyList(), val inlineAttachment: List<EmailAttachment> = emptyList(), var replyingMessageId: String? = null, val forwardingMessageId: String? = null)

Input object containing information required to send an email message.

UpdateCustomEmailFolderInput

data class UpdateCustomEmailFolderInput(val emailAddressId: String, val emailFolderId: String, val customFolderName: String? = null)

Input object containing information required to update a custom email folder.

UpdateDraftEmailMessageInput

data class UpdateDraftEmailMessageInput(val id: String, val rfc822Data: ByteArray, val senderEmailAddressId: String)

Input object containing information required to update a draft email message.

UpdateEmailAddressMetadataInput

data class UpdateEmailAddressMetadataInput(val id: String, val alias: String? = null)

Input object containing information required to update an email address.

UpdateEmailMaskInput

data class UpdateEmailMaskInput(val emailMaskId: String, val metadata: Map<String, String>? = null, val expiresAt: Date? = null)

Input object containing the properties needed to update an email mask.

UpdateEmailMessagesInput

data class UpdateEmailMessagesInput(val ids: List<String>, val values: UpdateEmailMessagesInput.UpdatableValues)

Input object containing information required to update an email message.