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.

Constructors

Link copied to clipboard
constructor(maskAddress: String, realAddress: String, ownershipProofToken: String, metadata: Map<String, String>? = null, expiresAt: Date? = null, keyId: String? = null)

Properties

Link copied to clipboard
val expiresAt: Date? = null

Optional expiration date for the email mask. If not provided, the mask will not expire.

Link copied to clipboard
val keyId: String? = null
Link copied to clipboard

String The email mask address to be provisioned in the local-part@domain format.

Link copied to clipboard
val metadata: Map<String, String>? = null

Optional metadata to associate with the email mask.

Link copied to clipboard

String The signed ownership proof of the Sudo to be associated with the provisioned email mask. The ownership proof must contain an audience of "sudoplatform".

Link copied to clipboard

String The real email address that the mask will forward to in the local-part@domain format.