Enum NotifyEvent 

#[non_exhaustive]
pub enum NotifyEvent {
    MessageNew {
        fetch_attrs: Vec<String>,
    },
    MessageExpunge,
    FlagChange,
    AnnotationChange,
    MailboxName,
    SubscriptionChange,
    MailboxMetadataChange,
    ServerMetadataChange,
    Other(String),
}

An event type that can be requested in a NOTIFY command (RFC 5465 Section 5, RFC 5423 Section 4).

RFC 5465 Section 8 ABNF:

event         = message-event / mailbox-event / user-event / event-ext
message-event = ("MessageNew" [SP "(" fetch-att *(SP fetch-att) ")"])
              / "MessageExpunge" / "FlagChange" / "AnnotationChange"
mailbox-event = "MailboxName" / "SubscriptionChange" / "MailboxMetadataChange"
user-event    = "ServerMetadataChange"

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MessageNew

MessageNew — new message delivered or appended (RFC 5465 Section 5.2, RFC 5423 Section 4.1).

For the selected mailbox: server sends EXISTS then FETCH with the requested attributes. For other mailboxes: server sends STATUS with UIDNEXT and MESSAGES.

The optional fetch attributes are only valid with selected or selected-delayed mailbox filters (RFC 5465 Section 5.2).

Fields

fetch_attrs: Vec<String>

Optional FETCH attributes to include with new-message notifications (RFC 5465 Section 5.2). Only valid for selected/selected-delayed. Each string is a raw FETCH attribute (e.g. "UID", "FLAGS", "BODY.PEEK[HEADER.FIELDS (From To Subject)]").

MessageExpunge

MessageExpunge — message expunged or expired (RFC 5465 Section 5.3, RFC 5423 Section 4.1).

MUST always be specified together with MessageNew (RFC 5465 Section 5.2).

FlagChange

FlagChange — message flags changed (RFC 5465 Section 5.1, RFC 5423 Section 4.2).

Requires both MessageNew and MessageExpunge to also be specified (RFC 5465 Section 5.1).

AnnotationChange

AnnotationChange — per-message annotation changed (RFC 5465 Section 5.1).

Requires both MessageNew and MessageExpunge to also be specified (RFC 5465 Section 5.1).

MailboxName

MailboxName — mailbox created, deleted, or renamed (RFC 5465 Section 5.4, RFC 5423 Section 4.4).

Server sends unsolicited LIST responses. On rename, the LIST includes an OLDNAME extended data item.

SubscriptionChange

SubscriptionChange — mailbox subscribed or unsubscribed (RFC 5465 Section 5.5, RFC 5423 Section 4.4).

Server sends unsolicited LIST response with accurate \Subscribed attribute presence.

MailboxMetadataChange

MailboxMetadataChange — per-mailbox metadata annotation changed (RFC 5465 Section 5.6).

Server sends unsolicited METADATA response per RFC 5464 Section 4.4.2. Optional unless the server implements METADATA (RFC 5464).

ServerMetadataChange

ServerMetadataChange — server-level metadata annotation changed (RFC 5465 Section 5.7).

Server sends unsolicited METADATA response with empty mailbox name. Optional unless the server implements METADATA or METADATA-SERVER.

Other(String)

Unrecognized event type — preserved verbatim for forward compatibility (RFC 5465 Section 8: event-ext = atom).

Trait Implementations

impl Clone for NotifyEvent

fn clone(&self) -> NotifyEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotifyEvent

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

Formats the value using the given formatter.

impl Hash for NotifyEvent

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 NotifyEvent

fn eq(&self, other: &NotifyEvent) -> 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 Eq for NotifyEvent

impl StructuralPartialEq for NotifyEvent