pub enum Flag<'a> {
Seen,
Answered,
Flagged,
Deleted,
Draft,
Recent,
MayCreate,
Custom(Cow<'a, str>),
}
Expand description
With the exception of Flag::Custom
, these flags are system flags that are pre-defined in
RFC 3501 section 2.3.2. All system flags
begin with \
in the IMAP protocol. Certain system flags (\Deleted
and \Seen
) have
special semantics described elsewhere.
A flag can be permanent or session-only on a per-flag basis. Permanent flags are those which the client can add or remove from the message flags permanently; that is, concurrent and subsequent sessions will see any change in permanent flags. Changes to session flags are valid only in that session.
Note: The
\Recent
system flag is a special case of a session flag.\Recent
can not be used as an argument in aSTORE
orAPPEND
command, and thus can not be changed at all.
Variants
Seen
Message has been read
Answered
Message has been answered
Flagged
Message is “flagged” for urgent/special attention
Deleted
Message is “deleted” for removal by later EXPUNGE
Draft
Message has not completed composition (marked as a draft).
Recent
Message is “recently” arrived in this mailbox. This session is the first session to have
been notified about this message; if the session is read-write, subsequent sessions will
not see \Recent
set for this message. This flag can not be altered by the client.
If it is not possible to determine whether or not this session is the first session to be notified about a message, then that message will generally be considered recent.
If multiple connections have the same mailbox selected simultaneously, it is undefined
which of these connections will see newly-arrived messages with \Recent
set and which
will see it without \Recent
set.
MayCreate
The Mailbox::permanent_flags
can include this special flag (\*
), which indicates that
it is possible to create new keywords by attempting to store those flags in the mailbox.
Custom(Cow<'a, str>)
A non-standard user- or server-defined flag.