class Net::IMAP::ResponseCode
* MAILBOXID
, #data will be a string
* OBJECTID
{[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html#section-7]
Other supported IMAP extension response codes:
* NONEXISTENT
* ALREADYEXISTS
* OVERQUOTA
* LIMIT
* CANNOT
* CLIENTBUG
* SERVERBUG
* CORRUPTION
* EXPUNGEISSUED
* INUSE
* NOPERM
* CONTACTADMIN
* PRIVACYREQUIRED
* EXPIRED
* AUTHORIZATIONFAILED
* AUTHENTICATIONFAILED
* UNAVAILABLE
have nil
#data of their own:
machine-readable annotations for the human-readable ResponseText#text, and
Codes“ for the definition of the following response codes, which are all
See RFC5530, ”IMAP Response
the \Seen
flag set.
* UNSEEN
, #data is an Integer, the number of messages which do not have
Attribute}[www.rfc-editor.org/rfc/rfc3501#section-2.3.1.1].
{§2.3.1.1, “Unique Identifier (UID) Message
mailbox See [IMAP4rev1],
* UIDVALIDITY
, #data is an Integer, the UID validity value of the
Attribute}[www.rfc-editor.org/rfc/rfc3501#section-2.3.1.1].
{§2.3.1.1, ”Unique Identifier (UID) Message<br>[{IMAP4rev1}],
* UIDNEXT
, #data is an Integer, the next UID value of the mailbox. See
doesn’t exist.
* TRYCREATE
, when #append or #copy fail because the target mailbox
read-write
* READ-WRITE
, the mailbox was selected read-write, or changed to
* READ-ONLY
, the mailbox was selected read-only, or changed to read-only
and keyword flags will be strings. See
* PERMANENTFLAGS
, followed by an array of flags. System flags will be<br> or [MIME-IMB] headers.
* PARSE
, the ResponseText#text presents an error parsing a message’s
* CAPABILITY
, #data will be an array of capability strings.
* BADCHARSET
, #data will be an array of charset strings, or nil
.
brought to the user’s attention.
* ALERT
, the ResponseText#text contains a special alert that MUST be
definitions of the basic set of IMAP4rev1 response codes:
Responses“}[www.rfc-editor.org/rfc/rfc3501#section-7.1] for full
Responses - Status
See [IMAP4rev1] {§7.1, ”Server
will return an unparsed string.
defines them. When unknown response code data is encountered, #data
response codes even if the client has not enabled the extension that
Response codes are backwards compatible: Servers are allowed to send new
registry has links to specifications for all standard response codes.
Codes}[https://www.iana.org/assignments/imap-response-codes/imap-response-codes.xhtml]
The IANA {IMAP Response
IMAP extensions may define new codes and the data that comes with them.
command methods that do not return their TaggedResponse.
Use Net::IMAP#add_response_handler to view tagged response codes for
keyed by #name, unless it is removed by the command that generated it.
Untagged response code #data is pushed directly onto Net::IMAP#responses,
code text, #data returns the unparsed string.
the same response. When Net::IMAP does not know how to parse response
machine-readable annotation for the human-readable ResponseText#text in
Net::IMAP. Others return nil
for #data, but are used as a
Some response codes come with additional data which will be parsed by
is a “condition” (“OK”, “NO”, “BAD”, “PREAUTH”, or “BYE”).
response: any TaggedResponse and UntaggedResponse when the response type
retrieved from ResponseText#code and can be included in any “condition”
Net::IMAP::ResponseCode represents response codes. Response codes can be