Enum imap_codec::types::response::Status

pub enum Status {
    Ok {
        tag: Option<Tag>,
        code: Option<Code>,
        text: Text,
    },
    No {
        tag: Option<Tag>,
        code: Option<Code>,
        text: Text,
    },
    Bad {
        tag: Option<Tag>,
        code: Option<Code>,
        text: Text,
    },
    PreAuth {
        code: Option<Code>,
        text: Text,
    },
    Bye {
        code: Option<Code>,
        text: Text,
    },
}

7.1. Server Responses - Status Responses

Status responses are OK, NO, BAD, PREAUTH and BYE. OK, NO, and BAD can be tagged or untagged. PREAUTH and BYE are always untagged. Status responses MAY include an OPTIONAL “response code” (see ResponseCode.)

Variants

Ok

7.1.1. OK Response

The OK response indicates an information message from the server.

Fields of Ok

tag: Option<Tag>

When tagged, it indicates successful completion of the associated command. The human-readable text MAY be presented to the user as an information message.

The untagged form indicates an information-only message; the nature of the information MAY be indicated by a response code.

The untagged form is also used as one of three possible greetings at connection startup. It indicates that the connection is not yet authenticated and that a LOGIN command is needed.

code: Option<Code>

Response code (optional)

text: Text

Human-readable text (must be at least 1 character!)

No

7.1.2. NO Response

The NO response indicates an operational error message from the server.

Fields of No

tag: Option<Tag>

When tagged, it indicates unsuccessful completion of the associated command. The untagged form indicates a warning; the command can still complete successfully.

code: Option<Code>

Response code (optional)

text: Text

The human-readable text describes the condition. (must be at least 1 character!)

Bad

7.1.3. BAD Response

The BAD response indicates an error message from the server.

Fields of Bad

tag: Option<Tag>

When tagged, it reports a protocol-level error in the client’s command; the tag indicates the command that caused the error. The untagged form indicates a protocol-level error for which the associated command can not be determined; it can also indicate an internal server failure.

code: Option<Code>

Response code (optional)

text: Text

The human-readable text describes the condition. (must be at least 1 character!)

PreAuth

7.1.4. PREAUTH Response

The PREAUTH response is always untagged, and is one of three possible greetings at connection startup. It indicates that the connection has already been authenticated by external means; thus no LOGIN command is needed.

Fields of PreAuth

code: Option<Code>

Response code (optional)

text: Text

Human-readable text (must be at least 1 character!)

Bye

7.1.5. BYE Response

The BYE response is always untagged, and indicates that the server is about to close the connection.

The BYE response is sent under one of four conditions:

1. as part of a normal logout sequence. The server will close the connection after sending the tagged OK response to the LOGOUT command.

2. as a panic shutdown announcement. The server closes the connection immediately.

3. as an announcement of an inactivity autologout. The server closes the connection immediately.

4. as one of three possible greetings at connection startup, indicating that the server is not willing to accept a connection from this client. The server closes the connection immediately.

The difference between a BYE that occurs as part of a normal LOGOUT sequence (the first case) and a BYE that occurs because of a failure (the other three cases) is that the connection closes immediately in the failure case. In all cases the client SHOULD continue to read response data from the server until the connection is closed; this will ensure that any pending untagged or completion responses are read and processed.

Fields of Bye

code: Option<Code>

Response code (optional)

text: Text

The human-readable text MAY be displayed to the user in a status report by the client. (must be at least 1 character!)

Implementations

impl Status

pub fn greeting(code: Option<Code>, text: &str) -> Result<Self, &'static str>

pub fn ok(
    tag: Option<Tag>,
    code: Option<Code>,
    text: &str
) -> Result<Self, &'static str>

pub fn no(
    tag: Option<Tag>,
    code: Option<Code>,
    text: &str
) -> Result<Self, &'static str>

pub fn bad(
    tag: Option<Tag>,
    code: Option<Code>,
    text: &str
) -> Result<Self, &'static str>

pub fn preauth(code: Option<Code>, text: &str) -> Result<Self, &'static str>

pub fn bye(code: Option<Code>, text: &str) -> Result<Self, &'static str>

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Encode for Status

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

impl Hash for Status

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Status> for Status

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

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

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

This method tests for !=.

impl Eq for Status

impl StructuralEq for Status

impl StructuralPartialEq for Status