Struct Identity 

#[non_exhaustive]
pub struct Identity {
    pub id: Id,
    pub name: String,
    pub email: String,
    pub reply_to: Option<Vec<EmailAddress>>,
    pub bcc: Option<Vec<EmailAddress>>,
    pub text_signature: String,
    pub html_signature: String,
    pub may_delete: bool,
    pub extra: Map<String, Value>,
}

An RFC 8621 §6 Identity object.

Stores information about an email address or domain the user may send from.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Id

The id of the Identity (immutable; server-set).

name: String

The “From” name the client SHOULD use when creating a new Email from this Identity. Defaults to "".

email: String

The “From” email address the client MUST use (immutable).

reply_to: Option<Vec<EmailAddress>>

The Reply-To value the client SHOULD set. null if not set.

bcc: Option<Vec<EmailAddress>>

The Bcc value the client SHOULD set. null if not set.

text_signature: String

Plaintext signature. Defaults to "".

html_signature: String

HTML snippet signature. Defaults to "".

may_delete: bool

Whether the user may delete this Identity (server-set).

extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Implementations

impl Identity

pub fn new(id: Id, email: impl Into<String>, may_delete: bool) -> Self

Construct an Identity from its three identifying fields.

name, text_signature, and html_signature default to "". reply_to and bcc default to None.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Identity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Identity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Identity

impl GetObject for Identity

impl JmapObject for Identity

const TYPE_NAME: &'static str = "Identity"

The JMAP type name string (e.g. "Email", "Mailbox", "Chat").

type Property = IdentityProperty

The property selector enum for this type (server-side only, no serde).

impl PartialEq for Identity

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Identity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetObject for Identity

RFC 8621 §6 (rfc8621.txt:3988, 3997, 4039): id is “(immutable; server-set)”, email is “(immutable)”, mayDelete is “(server-set)”.

const SERVER_SET: &'static [&'static str]

Wire names of the properties the spec marks “server-set”: “Only the server can set the value for this property. The client MUST NOT send this property when creating a new object of this type.” (RFC 8620 §1.1). A property the type’s /set method text never accepts from a client, on create or update, is server-set too.

const CLIENT_SETTABLE: &'static [&'static str]

Wire names of every property that is not SERVER_SET: the ones a client may set through /set.

const IMMUTABLE: &'static [&'static str]

The CLIENT_SETTABLE properties the spec marks “immutable”: “The value MUST NOT change after the object is created.” (RFC 8620 §1.1). A property the /set method text accepts on create but not on update is immutable too.

type Patch = PatchObject

The patch type for update operations.

impl StructuralPartialEq for Identity