sudoemail/com.sudoplatform.sudoemail.types/EmailMask

EmailMask

data class EmailMask(val id: String, val owner: String, val owners: List<Owner>, val identityId: String, val maskAddress: String, val realAddress: String, val realAddressType: EmailMaskRealAddressType, val status: EmailMaskStatus, val inboundReceived: Int, val inboundDelivered: Int, val outboundReceived: Int, val outboundDelivered: Int, val spamCount: Int, val virusCount: Int, val expiresAt: Date?, val createdAt: Date, val updatedAt: Date, val version: Int, val metadata: Map<String, String>?) : Parcelable

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

An email mask provides a privacy layer by allowing users to create temporary or permanent email addresses that forward messages to their real email address. This enables users to protect their real email address from spam, tracking, and unwanted communications while maintaining the ability to receive and send emails.

Constructors

constructor(id: String, owner: String, owners: List<Owner>, identityId: String, maskAddress: String, realAddress: String, realAddressType: EmailMaskRealAddressType, status: EmailMaskStatus, inboundReceived: Int, inboundDelivered: Int, outboundReceived: Int, outboundDelivered: Int, spamCount: Int, virusCount: Int, expiresAt: Date?, createdAt: Date, updatedAt: Date, version: Int, metadata: Map<String, String>?)

Properties

val createdAt: Date

The date and time when this email mask was created

val expiresAt: Date?

The date and time when this email mask expires, if applicable

The unique identifier of the email mask

val identityId: String

The identity identifier associated with this email mask

inboundDelivered

val inboundDelivered: Int

The total number of inbound messages successfully delivered

inboundReceived

val inboundReceived: Int

The total number of inbound messages received by this mask

val maskAddress: String

The publicly visible email address that serves as the mask

val metadata: Map<String, String>?

Optional key-value pairs for storing additional information about the mask

outboundDelivered

val outboundDelivered: Int

The total number of outbound messages successfully delivered

outboundReceived

val outboundReceived: Int

The total number of outbound messages received from this mask

val owner: String

The identifier of the user who owns this email mask

val owners: List<Owner>

List of ownership information for this email mask

val realAddress: String

The actual email address that receives forwarded messages

realAddressType

val realAddressType: EmailMaskRealAddressType

The type of real address (INTERNAL or EXTERNAL)

val spamCount: Int

The number of messages identified as spam

val status: EmailMaskStatus

The current status of the email mask (ENABLED, DISABLED, LOCKED)

val updatedAt: Date

The date and time when this email mask was last updated

val version: Int

The version number

val virusCount: Int

The number of messages identified as containing viruses

Functions

describeContents

abstract fun describeContents(): Int

abstract fun writeToParcel(p0: Parcel, p1: Int)