sudoemail/com.sudoplatform.sudoemail.types.inputs/ListEmailMessagesForEmailAddressIdInput

ListEmailMessagesForEmailAddressIdInput

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

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

Constructors

constructor(emailAddressId: String, dateRange: EmailMessageDateRange? = null, cachePolicy: CachePolicy = CachePolicy.REMOTE_ONLY, limit: Int? = SudoEmailClient.DEFAULT_EMAIL_MESSAGE_LIMIT, nextToken: String? = null, sortOrder: SortOrder = SortOrder.DESC)

Properties

cachePolicy

val cachePolicy: CachePolicy

CachePolicy Determines how the data will be fetched. When using CachePolicy.CACHE_ONLY, be aware that this will only return cached results of identical API calls.

dateRange

val dateRange: EmailMessageDateRange? = null

EmailMessageDateRange Email messages matching the specified date range inclusive will be fetched.

emailAddressId

val emailAddressId: String

String The identifier of the email address associated with the email messages.

limit

val limit: Int?

Int Number of email messages to return. If omitted the limit defaults to 10.

nextToken

val nextToken: String? = null

String A token generated from previous calls to SudoEmailClient.listEmailMessagesForEmailAddressId. This is to allow for pagination. This value should be generated from a previous pagination call, otherwise it will throw an exception. The same arguments should be supplied to this method if using a previously generated nextToken.

sortOrder

val sortOrder: SortOrder

SortOrder The direction in which the email messages are sorted. Defaults to descending.