Class: Net::IMAP::TaggedResponse

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Struct
Instance Chain: self, Struct
Inherits:	Struct Object Struct Net::IMAP::TaggedResponse
Defined in:	lib/net/imap.rb

Overview

TaggedResponse represents tagged responses.

The server completion result response indicates the success or failure of the operation. It is tagged with the same tag as the client command which began the operation.

response_tagged ::= tag SPACE resp_cond_state CRLF

tag             ::= 1*<any ATOM_CHAR except "+">

resp_cond_state ::= ("OK" / "NO" / "BAD") SPACE resp_text

Fields:

tag: Returns the tag.
name: Returns the name, one of “OK”, “NO”, or “BAD”.
data: Returns the data. See ((<Net::IMAP::ResponseText>)).
raw_data: Returns the raw data string.

Instance Attribute Summary

#data rw

TaggedResponse represents tagged responses.
#name rw

TaggedResponse represents tagged responses.
#raw_data rw

TaggedResponse represents tagged responses.
#tag rw

TaggedResponse represents tagged responses.

Instance Attribute Details

#data (rw)

TaggedResponse represents tagged responses.

The server completion result response indicates the success or failure of the operation. It is tagged with the same tag as the client command which began the operation.

response_tagged ::= tag SPACE resp_cond_state CRLF

tag             ::= 1*<any ATOM_CHAR except "+">

resp_cond_state ::= ("OK" / "NO" / "BAD") SPACE resp_text

Fields:

tag: Returns the tag.
name: Returns the name, one of “OK”, “NO”, or “BAD”.
data: Returns the data. See ((<Net::IMAP::ResponseText>)).
raw_data: Returns the raw data string.

[ GitHub ]

# File 'lib/net/imap.rb', line 1771


TaggedResponse = Struct.new(:tag, :name, :data, :raw_data)

#name (rw)

TaggedResponse represents tagged responses.

The server completion result response indicates the success or failure of the operation. It is tagged with the same tag as the client command which began the operation.

response_tagged ::= tag SPACE resp_cond_state CRLF

tag             ::= 1*<any ATOM_CHAR except "+">

resp_cond_state ::= ("OK" / "NO" / "BAD") SPACE resp_text

Fields:

tag: Returns the tag.
name: Returns the name, one of “OK”, “NO”, or “BAD”.
data: Returns the data. See ((<Net::IMAP::ResponseText>)).
raw_data: Returns the raw data string.

[ GitHub ]

# File 'lib/net/imap.rb', line 1771


TaggedResponse = Struct.new(:tag, :name, :data, :raw_data)

#raw_data (rw)

TaggedResponse represents tagged responses.

The server completion result response indicates the success or failure of the operation. It is tagged with the same tag as the client command which began the operation.

response_tagged ::= tag SPACE resp_cond_state CRLF

tag             ::= 1*<any ATOM_CHAR except "+">

resp_cond_state ::= ("OK" / "NO" / "BAD") SPACE resp_text

Fields:

tag: Returns the tag.
name: Returns the name, one of “OK”, “NO”, or “BAD”.
data: Returns the data. See ((<Net::IMAP::ResponseText>)).
raw_data: Returns the raw data string.

[ GitHub ]

# File 'lib/net/imap.rb', line 1771


TaggedResponse = Struct.new(:tag, :name, :data, :raw_data)

#tag (rw)

TaggedResponse represents tagged responses.

The server completion result response indicates the success or failure of the operation. It is tagged with the same tag as the client command which began the operation.

response_tagged ::= tag SPACE resp_cond_state CRLF

tag             ::= 1*<any ATOM_CHAR except "+">

resp_cond_state ::= ("OK" / "NO" / "BAD") SPACE resp_text

Fields:

tag: Returns the tag.
name: Returns the name, one of “OK”, “NO”, or “BAD”.
data: Returns the data. See ((<Net::IMAP::ResponseText>)).
raw_data: Returns the raw data string.

[ GitHub ]

# File 'lib/net/imap.rb', line 1771


TaggedResponse = Struct.new(:tag, :name, :data, :raw_data)