Enum imap_codec::message::Mailbox

pub enum Mailbox<'a> {
    Inbox,
    Other(MailboxOther<'a>),
}

5.1. Mailbox Naming

Mailbox names are 7-bit. Client implementations MUST NOT attempt to create 8-bit mailbox names, and SHOULD interpret any 8-bit mailbox names returned by LIST or LSUB as UTF-8. Server implementations SHOULD prohibit the creation of 8-bit mailbox names, and SHOULD NOT return 8-bit mailbox names in LIST or LSUB. See section 5.1.3 for more information on how to represent non-ASCII mailbox names.

Note: 8-bit mailbox names were undefined in earlier versions of this protocol. Some sites used a local 8-bit character set to represent non-ASCII mailbox names. Such usage is not interoperable, and is now formally deprecated.

The case-insensitive mailbox name INBOX is a special name reserved to mean “the primary mailbox for this user on this server”. The interpretation of all other names is implementation-dependent.

In particular, this specification takes no position on case sensitivity in non-INBOX mailbox names. Some server implementations are fully case-sensitive; others preserve case of a newly-created name but otherwise are case-insensitive; and yet others coerce names to a particular case. Client implementations MUST interact with any of these. If a server implementation interprets non-INBOX mailbox names as case-insensitive, it MUST treat names using the international naming convention specially as described in section 5.1.3.

There are certain client considerations when creating a new mailbox name:

1. Any character which is one of the atom-specials (see the Formal Syntax) will require that the mailbox name be represented as a quoted string or literal.
2. CTL and other non-graphic characters are difficult to represent in a user interface and are best avoided.
3. Although the list-wildcard characters (“%” and “*”) are valid in a mailbox name, it is difficult to use such mailbox names with the LIST and LSUB commands due to the conflict with wildcard interpretation.
4. Usually, a character (determined by the server implementation) is reserved to delimit levels of hierarchy.
5. Two characters, “#” and “&”, have meanings by convention, and should be avoided except when used in that convention.

Variants

Inbox

Other(MailboxOther<'a>)

Trait Implementations

impl<'a> Clone for Mailbox<'a>

fn clone(&self) -> Mailbox<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Mailbox<'a>

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

Formats the value using the given formatter.

impl<'a> Encode for Mailbox<'a>

fn encode(&self, writer: &mut impl Write) -> Result<(), Error>

fn encode_detached(&self) -> Result<Vec<u8, Global>, Error>

impl<'a> From<AString<'a>> for Mailbox<'a>

fn from(value: AString<'a>) -> Mailbox<'a>

Converts to this type from the input type.

impl<'a> Hash for Mailbox<'a>

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

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<'a> PartialEq<Mailbox<'a>> for Mailbox<'a>

fn eq(&self, other: &Mailbox<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> TryFrom<&'a [u8]> for Mailbox<'a>

type Error = <AString<'a> as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.

fn try_from( value: &'a [u8] ) -> Result<Mailbox<'a>, <Mailbox<'a> as TryFrom<&'a [u8]>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for Mailbox<'a>

type Error = <AString<'a> as TryFrom<&'a str>>::Error

The type returned in the event of a conversion error.

fn try_from( value: &'a str ) -> Result<Mailbox<'a>, <Mailbox<'a> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'a> TryFrom<String> for Mailbox<'a>

type Error = <AString<'a> as TryFrom<String>>::Error

The type returned in the event of a conversion error.

fn try_from( value: String ) -> Result<Mailbox<'a>, <Mailbox<'a> as TryFrom<String>>::Error>

Performs the conversion.

impl<'a> TryFrom<Vec<u8, Global>> for Mailbox<'a>

type Error = <AString<'a> as TryFrom<Vec<u8, Global>>>::Error

The type returned in the event of a conversion error.

fn try_from( value: Vec<u8, Global> ) -> Result<Mailbox<'a>, <Mailbox<'a> as TryFrom<Vec<u8, Global>>>::Error>

Performs the conversion.

impl<'a> Eq for Mailbox<'a>

impl<'a> StructuralEq for Mailbox<'a>

impl<'a> StructuralPartialEq for Mailbox<'a>