Enum ImapCommand 

pub enum ImapCommand {
    Capability,
    Login {
        username: String,
        password: String,
    },
    Logout,
    List {
        reference: String,
        pattern: String,
    },
    Select {
        mailbox: String,
    },
    Examine {
        mailbox: String,
    },
    Fetch {
        sequence: String,
        attributes: String,
    },
    Store {
        sequence: String,
        action: String,
        flags: String,
    },
    Search {
        criteria: String,
    },
    Expunge,
    Noop,
    Close,
    Idle,
    Append {
        mailbox: String,
        flags: Option<String>,
        literal_size: u32,
    },
    Copy {
        sequence: String,
        mailbox: String,
    },
    Move {
        sequence: String,
        mailbox: String,
    },
    Uid {
        subcommand: Box<ImapCommand>,
    },
    Status {
        mailbox: String,
        items: String,
    },
    GetQuota {
        quotaroot: String,
    },
    GetQuotaRoot {
        mailbox: String,
    },
    Create {
        mailbox: String,
    },
    Delete {
        mailbox: String,
    },
    Rename {
        from: String,
        to: String,
    },
    Subscribe {
        mailbox: String,
    },
    Unsubscribe {
        mailbox: String,
    },
    Lsub {
        reference: String,
        pattern: String,
    },
    Namespace,
    Sort {
        criteria: String,
        charset: String,
        search_criteria: String,
    },
    Enable(Vec<String>),
    Unselect,
}

A parsed IMAP4rev1 command. Each variant owns its argument strings (commands cross network boundaries, so we don’t borrow).

Variants

Capability

CAPABILITY — list supported extensions.

Login

LOGIN <user> <pass> — authenticate with plain credentials.

Fields

username: String

Username argument.

password: String

Password argument (plaintext per RFC 3501; clients should use STARTTLS).

Logout

LOGOUT — close the connection.

List

LIST <reference> <pattern> — enumerate matching mailbox names.

Fields

reference: String

Reference name (usually empty string).

pattern: String

Pattern with % (single-level) and * (recursive) wildcards.

Select

SELECT <mailbox> — open a mailbox for read/write.

Fields

mailbox: String

Mailbox name.

Examine

EXAMINE <mailbox> — open a mailbox read-only.

Fields

mailbox: String

Mailbox name.

Fetch

FETCH <seq> <attrs> — retrieve message attributes / parts.

Fields

sequence: String

Sequence set (1:10, *, 1,3,5, etc).

attributes: String

Attribute spec (FLAGS, BODY[], (FLAGS BODY.PEEK[HEADER]), …).

Store

STORE <seq> <action> <flags> — set/add/remove flags.

Fields

sequence: String

Sequence set.

action: String

One of FLAGS / +FLAGS / -FLAGS (+.SILENT variant).

flags: String

Flag list (e.g. (\Seen)).

Search

SEARCH <criteria> — return UIDs matching the search keys.

Fields

criteria: String

Search criteria string (UNSEEN FROM alice@x, etc).

Expunge

EXPUNGE — purge messages with the \Deleted flag.

Noop

NOOP — no-op (kept for keepalive + STATUS-update side effect).

Close

CLOSE — close the current mailbox (expunge implicit).

Idle

IDLE — push notifications until DONE (RFC 2177).

Append

APPEND <mailbox> [flags] {n}<CRLF>... — upload a new message.

Fields

mailbox: String

Target mailbox.

flags: Option<String>

Optional initial flag list (e.g. (\Seen \Flagged)).

literal_size: u32

Literal byte count for the message body that follows.

Copy

COPY <seq> <mailbox> — copy messages to another mailbox.

Fields

sequence: String

Sequence set in the source mailbox.

mailbox: String

Destination mailbox name.

Move

MOVE <seq> <mailbox> (RFC 6851) — move messages.

Fields

sequence: String

Sequence set in the source mailbox.

mailbox: String

Destination mailbox name.

Uid

UID <subcommand> — re-interpret the subcommand’s sequence set as UIDs.

Fields

subcommand: Box<ImapCommand>

The nested IMAP command operating on UIDs.

Status

STATUS <mailbox> <items> — read mailbox-level counts.

Fields

mailbox: String

Mailbox name to inspect.

items: String

Item list (e.g. (MESSAGES UNSEEN UIDNEXT UIDVALIDITY HIGHESTMODSEQ)).

GetQuota

GETQUOTA <quotaroot> — read a quota resource (RFC 2087).

Fields

quotaroot: String

Quota root identifier.

GetQuotaRoot

GETQUOTAROOT <mailbox> — list quota roots applying to a mailbox.

Fields

mailbox: String

Mailbox name.

Create

CREATE <mailbox> — create a mailbox.

Fields

mailbox: String

New mailbox name.

Delete

DELETE <mailbox> — delete a mailbox.

Fields

mailbox: String

Mailbox to delete.

Rename

RENAME <from> <to> — rename a mailbox.

Fields

from: String

Existing mailbox name.

to: String

New mailbox name.

Subscribe

SUBSCRIBE <mailbox> — add a mailbox to the user’s active list.

Fields

mailbox: String

Mailbox to subscribe to.

Unsubscribe

UNSUBSCRIBE <mailbox> — remove from subscription list.

Fields

mailbox: String

Mailbox to unsubscribe.

Lsub

LSUB <reference> <pattern> — list subscribed mailboxes.

Fields

reference: String

Reference name (usually empty).

pattern: String

Pattern.

Namespace

NAMESPACE — return per-user / per-shared / per-other namespace prefixes.

Sort

SORT <criteria> <charset> <search> — server-side sorted SEARCH (RFC 5256).

Fields

criteria: String

Sort criteria (e.g. (DATE) / (REVERSE ARRIVAL)).

charset: String

Charset for text values in search criteria.

search_criteria: String

Search criteria (filter applied before sort).

Enable(Vec<String>)

ENABLE <ext>+ (RFC 5161) — opt into named extensions.

Unselect

UNSELECT (RFC 3691) — close mailbox without expunging.

Trait Implementations

impl Clone for ImapCommand

fn clone(&self) -> ImapCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImapCommand

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

Formats the value using the given formatter.

impl PartialEq for ImapCommand

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

impl StructuralPartialEq for ImapCommand