Net::IMAP::ResponseCode represents response codes. Response codes can be retrieved from
ResponseText#code and can be included in any “condition” response: any
UntaggedResponse when the response type is a “condition” (“OK”, “NO”, “BAD”, “PREAUTH”, or “BYE”).
Some response codes come with additional data which will be parsed by
Net::IMAP. Others return
data, but are used as a machine-readable annotation for the human-readable
ResponseText#text in the same response. When
Net::IMAP does not know how to parse response code text,
data returns the unparsed string.
Untagged response code
data is pushed directly onto
Net::IMAP#responses, keyed by
name, unless it is removed by the command that generated it. Use
Net::IMAP#add_response_handler to view tagged response codes for command methods that do not return their
IMAP extensions may define new codes and the data that comes with them. The IANA IMAP Response Codes registry has links to specifications for all standard response codes. Response codes are backwards compatible: Servers are allowed to send new response codes even if the client has not enabled the extension that defines them. When unknown response code data is encountered,
data will return an unparsed string.
See [IMAP4rev1] §7.1, “Server Responses - Status Responses” for full definitions of the basic set of IMAP4rev1 response codes:
ResponseText#textcontains a special alert that MUST be brought to the user’s attention.
datawill be an array of charset strings, or
datawill be an array of capability strings.
ResponseText#textpresents an error parsing a message’s [RFC5322] or [MIME-IMB] headers.
PERMANENTFLAGS, followed by an array of flags. System flags will be symbols, and keyword flags will be strings. See System flags at
READ-ONLY, the mailbox was selected read-only, or changed to read-only
READ-WRITE, the mailbox was selected read-write, or changed to read-write
TRYCREATE, when append or copy fail because the target mailbox doesn’t exist.
datais an Integer, the next UID value of the mailbox. See [IMAP4rev1], §126.96.36.199, “Unique Identifier (UID) Message Attribute.
datais an Integer, the UID validity value of the mailbox See [IMAP4rev1], §188.8.131.52, “Unique Identifier (UID) Message Attribute.
datais an Integer, the number of messages which do not have the
See RFC5530, “IMAP Response Codes” for the definition of the following response codes, which are all machine-readable annotations for the human-readable
ResponseText#text, and have
data of their own:
Public Instance Methods
Returns the parsed response code data, e.g: an array of capabilities strings, an array of character set strings, a list of permanent flags, an Integer, etc. The response code determines what form the response code data can take.
# File net-imap-0.3.4/lib/net/imap/response_data.rb, line 209
Returns the response code name, such as “ALERT”, “PERMANENTFLAGS”, or “UIDVALIDITY”.
# File net-imap-0.3.4/lib/net/imap/response_data.rb, line 202