class Net::IMAP::ResponseCode
code text, #data returns the unparsed string.
defines them. When Net::IMAP does not know how to parse response
response codes even if the client has not enabled the extension that
Response codes are backwards compatible: Servers are allowed to send new
== Extension compatibility
* MAILBOXID, #data is a string
See [RFC8474].
=== OBJECTID extension
STORE</tt>.
since the UNCHANGEDSINCE mod-sequence given to STORE or UID<br>* MODIFIED, #data is a SequenceSet, the messages that have been modified<br>all messages in the mailbox. See IMAP#select.<br>* HIGHESTMODSEQ, #data is an Integer, the highest mod-sequence value of<br>mod-sequences. #data is nil. See IMAP#select.<br>* NOMODSEQ, when selecting a mailbox that does not support<br>See {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html].<br>=== CONDSTORE extension<br><br>#data is nil.<br>because the server doesn't allow deletion of mailboxes with children.<br>* HASCHILDREN, with a tagged NO response, when a mailbox delete failed<br>response codes listed above (except "UNSEEN") and adds the following:<br>descriptions of IMAP4rev2 response codes. IMAP4rev2 includes all of the<br>Responses"}[https://www.rfc-editor.org/rfc/rfc9051#section-7.1] for full<br>Responses - Status<br>See {[RFC9051]}[https://www.rfc-editor.org/rfc/rfc9051] {§7.1, "Server<br>=== IMAP4rev2 response codes<br><br>implicitly by selecting or examining another mailbox. #data is nil.<br>* CLOSED, returned when the currently selected mailbox is closed<br>See {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html].<br>=== QRESYNC extension<br><br>* NONEXISTENT<br>* ALREADYEXISTS<br>* OVERQUOTA<br>* LIMIT<br>* CANNOT<br>* CLIENTBUG<br>* SERVERBUG<br>* CORRUPTION<br>* EXPUNGEISSUED<br>* INUSE<br>* NOPERM<br>* CONTACTADMIN<br>* PRIVACYREQUIRED<br>* EXPIRED<br>* AUTHORIZATIONFAILED<br>* AUTHENTICATIONFAILED<br>* UNAVAILABLE<br>have nil #data of their own:<br>machine-readable annotations for the human-readable ResponseText#text, and<br>Codes" for the definition of the following response codes, which are all<br>See {[RFC5530]}[https://www.rfc-editor.org/rfc/rfc5530], "IMAP Response<br>=== RFC5530 response codes<br><br>is not saved. #data is nil.<br>* NOTSAVED, with a tagged NO response, when the search result variable<br>See {[RFC5182]}[https://www.rfc-editor.org/rfc/rfc5182].<br>=== SEARCHRES extension<br><br>* UIDNOTSTICKY, #data is nil. See IMAP#select.<br>* COPYUID, #data is UIDPlusData. See IMAP#copy.<br>* APPENDUID, #data is UIDPlusData. See IMAP#append.<br>See {[RFC4315 §3]}[https://www.rfc-editor.org/rfc/rfc4315#section-3].<br>=== UIDPLUS extension<br><br>See IMAP#fetch.<br>known how to decode a CTE (content-transfer-encoding). #data is nil.<br>* UNKNOWN-CTE, with a tagged NO response, when the server does not<br>See {[RFC3516]}[https://www.rfc-editor.org/rfc/rfc3516].<br>=== BINARY extension<br><br>DEPRECATED by IMAP4rev2.<br>the <tt>\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
=== IMAP4rev1 response codes
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.
== Standard response codes
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,
the same 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 bySTATUS UntaggedResponse (see IMAP#status and StatusData).
Note that these “status responses” are confusingly not the same as the
“OK”, “NO”, “BAD”, “PREAUTH”, or “BYE”.
* any UntaggedResponse when name is
“OK”, “NO”, or “BAD”.
* every TaggedResponse, name is always
:
from ResponseText#code for
ResponseCode represents an IMAP response code, which can be retrieved