sudoemail/com.sudoplatform.sudoemail.types/EmailMessage

EmailMessage

data class EmailMessage(val id: String, val clientRefId: String? = null, val owner: String, val owners: List<Owner>, val emailAddressId: String, val folderId: String, val previousFolderId: String? = null, val seen: Boolean = false, val repliedTo: Boolean = false, val forwarded: Boolean = false, val direction: Direction, val state: State, val version: Int, val sortDate: Date, val createdAt: Date, val updatedAt: Date, val size: Double, val from: List<EmailMessage.EmailAddress>, val to: List<EmailMessage.EmailAddress>, val cc: List<EmailMessage.EmailAddress> = emptyList(), val bcc: List<EmailMessage.EmailAddress> = emptyList(), val replyTo: List<EmailMessage.EmailAddress> = emptyList(), val subject: String? = null, val sentAt: Date? = null, val receivedAt: Date? = null, val hasAttachments: Boolean, val encryptionStatus: EncryptionStatus, val date: Date? = null) : Parcelable

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

Constructors

EmailMessage

constructor(id: String, clientRefId: String? = null, owner: String, owners: List<Owner>, emailAddressId: String, folderId: String, previousFolderId: String? = null, seen: Boolean = false, repliedTo: Boolean = false, forwarded: Boolean = false, direction: Direction, state: State, version: Int, sortDate: Date, createdAt: Date, updatedAt: Date, size: Double, from: List<EmailMessage.EmailAddress>, to: List<EmailMessage.EmailAddress>, cc: List<EmailMessage.EmailAddress> = emptyList(), bcc: List<EmailMessage.EmailAddress> = emptyList(), replyTo: List<EmailMessage.EmailAddress> = emptyList(), subject: String? = null, sentAt: Date? = null, receivedAt: Date? = null, hasAttachments: Boolean, encryptionStatus: EncryptionStatus, date: Date? = null)

Types

EmailAddress

@Serializable

data class EmailAddress(val emailAddress: String, val displayName: String? = null) : Parcelable

A representation of an email address as used in an EmailMessage.

Properties

bcc

val bcc: List<EmailMessage.EmailAddress>

List List of blind carbon copy recipients of the email message.

val cc: List<EmailMessage.EmailAddress>

List List of carbon copy recipients of the email message.

clientRefId

val clientRefId: String? = null

String Unique client reference identifier.

createdAt

val createdAt: Date

Date When the email message was created.

date

val date: Date? = null

direction

val direction: Direction

Direction Direction of the email message.

emailAddressId

val emailAddressId: String

String Identifier of the email address that is associated with the email message - which address sent/received this message.

encryptionStatus

val encryptionStatus: EncryptionStatus

folderId

val folderId: String

String Unique identifier of the email folder which the message is assigned to.

forwarded

val forwarded: Boolean = false

Boolean True if the email message has been forwarded.

from

val from: List<EmailMessage.EmailAddress>

List List of recipients that the email message was sent from.

hasAttachments

val hasAttachments: Boolean

Boolean Whether or not the message has attachments. False if message was sent prior to this property being added.

val id: String

String Unique identifier of the email message.

owner

val owner: String

String Identifier of the user that owns the email message.

owners

val owners: List<Owner>

List List of identifiers of the user/sudo associated with this email message.

previousFolderId

val previousFolderId: String? = null

String Unique identifier of the previous email folder which the message was assigned to, if any.

receivedAt

val receivedAt: Date? = null

Date When the email message was received.

repliedTo

val repliedTo: Boolean = false

Boolean True if the email message has been replied to.

replyTo

val replyTo: List<EmailMessage.EmailAddress>

List List of recipients that a reply to this email message will be sent to.

seen

val seen: Boolean = false

Boolean True if the user has previously seen the email message.

sentAt

val sentAt: Date? = null

Date When the email message was sent.

size

val size: Double

Double The size of the encrypted RFC822 data stored in the backend in bytes. This value is used to calculate the total storage used by an email address or user and is used to enforce email storage related entitlements.

sortDate

val sortDate: Date

Date When the email message was processed by the service.

state

val state: State

State Current state of the email message.

subject

val subject: String? = null

String Subject header of the email message.