Class: Net::IMAP::FetchData

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

Overview

FetchData represents the contents of the FETCH response.

seqno

Returns the message sequence number. (Note: not the unique identifier, even for the UID command response.)

attr

Returns a hash. Each key is a data item name, and each value is its value.

The current data items are:

BODY: A form of BODYSTRUCTURE without extension data.
BODY<<origin_octet>>: A string expressing the body contents of the specified section.
BODYSTRUCTURE: An object that describes the [MIME-IMB] body structure of a message. See Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText, Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart.
ENVELOPE: A Net::IMAP::Envelope object that describes the envelope structure of a message.
FLAGS: A array of flag symbols that are set for this message. Flag symbols are capitalized by String#capitalize.
INTERNALDATE: A string representing the internal date of the message.
RFC822: Equivalent to BODY[].
RFC822.HEADER: Equivalent to BODY.PEEK[HEADER].
RFC822.SIZE: A number expressing the [RFC-822] size of the message.
RFC822.TEXT: Equivalent to BODY[TEXT].
UID: A number expressing the unique identifier of the message.

FetchData represents the contents of the FETCH response.

seqno

Returns the message sequence number. (Note: not the unique identifier, even for the UID command response.)

attr

Returns a hash. Each key is a data item name, and each value is its value.

The current data items are:

BODY: A form of BODYSTRUCTURE without extension data.
BODY<<origin_octet>>: A string expressing the body contents of the specified section.
BODYSTRUCTURE: An object that describes the [MIME-IMB] body structure of a message. See Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText, Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart.
ENVELOPE: A Net::IMAP::Envelope object that describes the envelope structure of a message.
FLAGS: A array of flag symbols that are set for this message. Flag symbols are capitalized by String#capitalize.
INTERNALDATE: A string representing the internal date of the message.
RFC822: Equivalent to BODY[].
RFC822.HEADER: Equivalent to BODY.PEEK[HEADER].
RFC822.SIZE: A number expressing the [RFC-822] size of the message.
RFC822.TEXT: Equivalent to BODY[TEXT].
UID: A number expressing the unique identifier of the message.

[ GitHub ]

# File 'lib/net/imap/response_data.rb', line 276


class FetchData < Struct.new(:seqno, :attr)

FetchData represents the contents of the FETCH response.

seqno

Returns the message sequence number. (Note: not the unique identifier, even for the UID command response.)

attr

Returns a hash. Each key is a data item name, and each value is its value.

The current data items are:

BODY: A form of BODYSTRUCTURE without extension data.
BODY<<origin_octet>>: A string expressing the body contents of the specified section.
BODYSTRUCTURE: An object that describes the [MIME-IMB] body structure of a message. See Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText, Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart.
ENVELOPE: A Net::IMAP::Envelope object that describes the envelope structure of a message.
FLAGS: A array of flag symbols that are set for this message. Flag symbols are capitalized by String#capitalize.
INTERNALDATE: A string representing the internal date of the message.
RFC822: Equivalent to BODY[].
RFC822.HEADER: Equivalent to BODY.PEEK[HEADER].
RFC822.SIZE: A number expressing the [RFC-822] size of the message.
RFC822.TEXT: Equivalent to BODY[TEXT].
UID: A number expressing the unique identifier of the message.

[ GitHub ]

# File 'lib/net/imap/response_data.rb', line 276


class FetchData < Struct.new(:seqno, :attr)