Class: Net::IMAP::ResponseText
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
Struct
|
|
|
Instance Chain:
self,
Struct
|
|
| Inherits: |
Struct
|
| Defined in: | lib/net/imap/response_data.rb |
Overview
ResponseText represents texts of responses.
The text may be prefixed by a ResponseCode.
ResponseText is returned from TaggedResponse#data or UntaggedResponse#data for “status responses”:
-
every
TaggedResponse, name is always “OK”, “NO”, or “BAD”. -
any
UntaggedResponsewhen name is “OK”, “NO”, “BAD”, “PREAUTH”, or “BYE”.
Note that these “status responses” are confusingly not the same as the STATUS UntaggedResponse (see #status and StatusData).
Constant Summary
-
EMPTY =
# File 'lib/net/imap/response_data.rb', line 179
Used to avoid an allocation when
ResponseTextis emptynew(nil, "").freeze
Instance Attribute Summary
Instance Attribute Details
#code (rw)
ResponseText represents texts of responses.
The text may be prefixed by a ResponseCode.
ResponseText is returned from TaggedResponse#data or UntaggedResponse#data for “status responses”:
-
every
TaggedResponse, name is always “OK”, “NO”, or “BAD”. -
any
UntaggedResponsewhen name is “OK”, “NO”, “BAD”, “PREAUTH”, or “BYE”.
Note that these “status responses” are confusingly not the same as the STATUS UntaggedResponse (see Net::IMAP#status and StatusData).
#text (rw)
ResponseText represents texts of responses.
The text may be prefixed by a ResponseCode.
ResponseText is returned from TaggedResponse#data or UntaggedResponse#data for “status responses”:
-
every
TaggedResponse, name is always “OK”, “NO”, or “BAD”. -
any
UntaggedResponsewhen name is “OK”, “NO”, “BAD”, “PREAUTH”, or “BYE”.
Note that these “status responses” are confusingly not the same as the STATUS UntaggedResponse (see Net::IMAP#status and StatusData).