Struct AddressGroup 

#[non_exhaustive]
pub struct AddressGroup {
    pub name: Option<String>,
    pub addresses: Vec<EmailAddress>,
}

A group of EmailAddress values, optionally named.

Mirrors the JMAP EmailAddressGroup object defined in RFC 8621 §4.1.2.4.

Per RFC 8621 §4.1.2.4, consecutive mailboxes that are not part of a declared RFC 5322 group are still collected under an AddressGroup whose name is None, “to provide a uniform type”.

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.

name: Option<String>

Display name of the group, or None for ungrouped mailboxes.

Parser-produced values follow the same normalisation as EmailAddress::name: surrounding ASCII whitespace trimmed; an empty result is mapped to None, not Some(String::new()).

addresses: Vec<EmailAddress>

Mailboxes belonging to this group.

Implementations

impl AddressGroup

pub fn new(name: Option<String>, addresses: Vec<EmailAddress>) -> Self

Construct an AddressGroup from an optional group name and a vector of mailboxes.

AddressGroup is #[non_exhaustive] so external callers cannot use struct expression syntax. Use this constructor — or Default::default() followed by field assignment — instead.

Trait Implementations

impl Clone for AddressGroup

fn clone(&self) -> AddressGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressGroup

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

Formats the value using the given formatter.

impl Default for AddressGroup

fn default() -> AddressGroup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddressGroup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AddressGroup

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

Render in RFC 5322 §3.4 group form: name: mb1, mb2;.

• Named group: Friends: alice@example.com, bob@example.com;.
• Anonymous group (name == None): just the comma-joined mailbox list, no : and no terminating ;.
• Empty group: just name:; (or empty string for an anonymous empty group).

Same caveat as EmailAddress Display: prioritises human readability; not guaranteed RFC 5322 round-trippable.

impl Eq for AddressGroup

impl Hash for AddressGroup

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AddressGroup

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AddressGroup

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AddressGroup