Class: Net::IMAP

Classes and Modules

Class Net::IMAP::BadResponseError
Class Net::IMAP::BodyTypeBasic
Class Net::IMAP::BodyTypeMessage
Class Net::IMAP::BodyTypeMultipart
Class Net::IMAP::BodyTypeText
Class Net::IMAP::ByeResponseError
Class Net::IMAP::CramMD5Authenticator
Class Net::IMAP::DataFormatError
Class Net::IMAP::Error
Class Net::IMAP::LoginAuthenticator
Class Net::IMAP::NoResponseError
Class Net::IMAP::ResponseError
Class Net::IMAP::ResponseParseError

Constants

SEEN = :Seen Flag indicating a message has been seen

ANSWERED = :Answered Flag indicating a message has been answered

FLAGGED = :Flagged Flag indicating a message has been flagged for special or urgent attention

DELETED = :Deleted Flag indicating a message has been marked for deletion. This will occur when the mailbox is closed or expunged.

DRAFT = :Draft Flag indicating a message is only a draft or work-in-progress version.

RECENT = :Recent Flag indicating that the message is "recent", meaning that this session is the first session in which the client has been notified of this message.

NOINFERIORS = :Noinferiors Flag indicating that a mailbox context name cannot contain children.

NOSELECT = :Noselect Flag indicating that a mailbox is not selected.

MARKED = :Marked Flag indicating that a mailbox has been marked "interesting" by the server; this commonly indicates that the mailbox contains new messages.

UNMARKED = :Unmarked Flag indicating that the mailbox does not contains new messages.

DATE_MONTH = %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)

ContinuationRequest

Struct.new(:data, :raw_data)

Net::IMAP::ContinuationRequest represents command continuation requests.

The command continuation request response is indicated by a "+" token instead of a tag. This form of response indicates that the server is ready to accept the continuation of a command from the client. The remainder of this response is a line of text.

  continue_req    ::= "+" SPACE (resp_text / base64)

Fields:

data:	Returns the data (Net::IMAP::ResponseText).
raw_data:	Returns the raw data string.

UntaggedResponse

Struct.new(:name, :data, :raw_data)

Net::IMAP::UntaggedResponse represents untagged responses.

Data transmitted by the server to the client and status responses that do not indicate command completion are prefixed with the token "*", and are called untagged responses.

  response_data   ::= "*" SPACE (resp_cond_state / resp_cond_bye /
                      mailbox_data / message_data / capability_data)

Fields:

name:	Returns the name such as "FLAGS", "LIST", "FETCH".…
data:	Returns the data such as an array of flag symbols, a ((<Net::IMAP::MailboxList>)) object....
raw_data:	Returns the raw data string.

TaggedResponse

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

Net::IMAP::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. the name is one of "OK", "NO", "BAD".
data:	Returns the data. See ((<Net::IMAP::ResponseText>)).
raw_data:	Returns the raw data string.

ResponseText

Struct.new(:code, :text)

Net::IMAP::ResponseText represents texts of responses. The text may be prefixed by the response code.

  resp_text       ::= ["[" resp_text_code "]" SPACE] (text_mime2 / text)
                      ;; text SHOULD NOT begin with "[" or "="

Fields:

code:	Returns the response code. See ((<Net::IMAP::ResponseCode>)).
text:	Returns the text.

ResponseCode

Struct.new(:name, :data)

Net::IMAP::ResponseCode represents response codes.

  resp_text_code  ::= "ALERT" / "PARSE" /
                      "PERMANENTFLAGS" SPACE "(" #(flag / "\*") ")" /
                      "READ-ONLY" / "READ-WRITE" / "TRYCREATE" /
                      "UIDVALIDITY" SPACE nz_number /
                      "UNSEEN" SPACE nz_number /
                      atom [SPACE 1*<any TEXT_CHAR except "]">]

Fields:

name:	Returns the name such as "ALERT", "PERMANENTFLAGS", "UIDVALIDITY".…
data:	Returns the data if it exists.

MailboxList

Struct.new(:attr, :delim, :name)

Net::IMAP::MailboxList represents contents of the LIST response.

  mailbox_list    ::= "(" #("\Marked" / "\Noinferiors" /
                      "\Noselect" / "\Unmarked" / flag_extension) ")"
                      SPACE (<"> QUOTED_CHAR <"> / nil) SPACE mailbox

Fields:

attr:	Returns the name attributes. Each name attribute is a symbol capitalized by String#capitalize, such as :Noselect (not :NoSelect).
delim:	Returns the hierarchy delimiter
name:	Returns the mailbox name.

MailboxQuota

Struct.new(:mailbox, :usage, :quota)

Net::IMAP::MailboxQuota represents contents of GETQUOTA response. This object can also be a response to GETQUOTAROOT. In the syntax specification below, the delimiter used with the "#" construct is a single space (SPACE).

   quota_list      ::= "(" #quota_resource ")"

   quota_resource  ::= atom SPACE number SPACE number

   quota_response  ::= "QUOTA" SPACE astring SPACE quota_list

Fields:

mailbox:	The mailbox with the associated quota.
usage:	Current storage usage of mailbox.
quota:	Quota limit imposed on mailbox.

MailboxQuotaRoot

Struct.new(:mailbox, :quotaroots)

Net::IMAP::MailboxQuotaRoot represents part of the GETQUOTAROOT response. (GETQUOTAROOT can also return Net::IMAP::MailboxQuota.)

   quotaroot_response ::= "QUOTAROOT" SPACE astring *(SPACE astring)

Fields:

mailbox:	The mailbox with the associated quota.
quotaroots:	Zero or more quotaroots that effect the quota on the specified mailbox.

MailboxACLItem

Struct.new(:user, :rights)

Net::IMAP::MailboxACLItem represents response from GETACL.

   acl_data        ::= "ACL" SPACE mailbox *(SPACE identifier SPACE rights)

   identifier      ::= astring

   rights          ::= astring

Fields:

user:	Login name that has certain rights to the mailbox that was specified with the getacl command.
rights:	The access rights the indicated user has to the mailbox.

StatusData

Struct.new(:mailbox, :attr)

Net::IMAP::StatusData represents contents of the STATUS response.

Fields:

mailbox:	Returns the mailbox name.
attr:	Returns a hash. Each key is one of "MESSAGES", "RECENT", "UIDNEXT", "UIDVALIDITY", "UNSEEN". Each value is a number.

FetchData

Struct.new(:seqno, :attr)

Net::IMAP::FetchData represents contents of the FETCH response.

Fields:

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[<section>]<<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.

Envelope

Struct.new(:date, :subject, :from, :sender, :reply_to, :to, :cc, :bcc, :in_reply_to, :message_id)

Net::IMAP::Envelope represents envelope structures of messages.

Fields:

date:	Returns a string that represents the date.
subject:	Returns a string that represents the subject.
from:	Returns an array of Net::IMAP::Address that represents the from.
sender:	Returns an array of Net::IMAP::Address that represents the sender.
reply_to:	Returns an array of Net::IMAP::Address that represents the reply-to.
to:	Returns an array of Net::IMAP::Address that represents the to.
cc:	Returns an array of Net::IMAP::Address that represents the cc.
bcc:	Returns an array of Net::IMAP::Address that represents the bcc.
in_reply_to:	Returns a string that represents the in-reply-to.
message_id:	Returns a string that represents the message-id.

Address

Struct.new(:name, :route, :mailbox, :host)

Net::IMAP::Address represents electronic mail addresses.

Fields:

name:	Returns the phrase from [RFC-822] mailbox.
route:	Returns the route from [RFC-822] route-addr.
mailbox:	nil indicates end of [RFC-822] group. If non-nil and host is nil, returns [RFC-822] group name. Otherwise, returns [RFC-822] local-part
host:	nil indicates [RFC-822] group syntax. Otherwise, returns [RFC-822] domain name.

ContentDisposition

Struct.new(:dsp_type, :param)

Net::IMAP::ContentDisposition represents Content-Disposition fields.

Fields:

dsp_type:	Returns the disposition type.
param:	Returns a hash that represents parameters of the Content-Disposition field.

ThreadMember

Struct.new(:seqno, :children)

Net::IMAP::ThreadMember represents a thread-node returned by Net::IMAP#thread

Fields:

seqno:	The sequence number of this message.
children:	an array of Net::IMAP::ThreadMember objects for mail

items that are children of this in the thread.

Attributes

client_thread	[RW]	The thread to receive exceptions.
greeting	[R]	Returns an initial greeting response from the server.
response_handlers	[R]	Returns all response handlers.
responses	[R]	Returns recorded untagged responses. For example: imap.select("inbox") p imap.responses["EXISTS"][-1] #=> 2 p imap.responses["UIDVALIDITY"][-1] #=> 968263756

Public Class methods

add_authenticator(auth_type, authenticator)

Adds an authenticator for Net::IMAP#authenticate. auth_type is the type of authentication this authenticator supports (for instance, "LOGIN"). The authenticator is an object which defines a process() method to handle authentication with the server. See Net::IMAP::LoginAuthenticator and Net::IMAP::CramMD5Authenticator for examples.

If auth_type refers to an existing authenticator, it will be replaced by the new one.

NO:	the attempted command could not be successfully completed. For instance, the username/password used for logging in are incorrect; the selected mailbox does not exists; etc.
BAD:	the request from the client does not follow the server‘s understanding of the IMAP protocol. This includes attempting commands from the wrong client state; for instance, attempting to perform a SEARCH command without having SELECTed a current mailbox. It can also signal an internal server failure (such as a disk crash) has occurred.
BYE:	the server is saying goodbye. This can be part of a normal logout sequence, and can be used as part of a login sequence to indicate that the server is (for some reason) unwilling to accept our connection. As a response to any other command, it indicates either that the server is shutting down, or that the server is timing out the client connection due to inactivity.

Errno::ECONNREFUSED:	connection refused by `host` or an intervening firewall.
Errno::ETIMEDOUT:	connection timed out (possibly due to packets being dropped by an intervening firewall).
Errno::ENETUNREACH:	there is no route to that network.
SocketError:	hostname not known or other socket error.
Net::IMAP::ByeResponseError:	we connected to the host, but they immediately said goodbye to us.

<message set>:	a set of message sequence numbers. ’,’ indicates an interval, ’:’ indicates a range. For instance, ‘2,10:12,15’ means "2,10,11,12,15".
BEFORE <date>:	messages with an internal date strictly before <date>. The date argument has a format similar to 8-Aug-2002.
BODY <string>:	messages that contain <string> within their body.
CC <string>:	messages containing <string> in their CC field.
FROM <string>:	messages that contain <string> in their FROM field.
NEW:	messages with the \Recent, but not the \Seen, flag set.
NOT <search-key>:	negate the following search key.
OR <search-key> <search-key>:	"or" two search keys together.
ON <date>:	messages with an internal date exactly equal to <date>, which has a format similar to 8-Aug-2002.
SINCE <date>:	messages with an internal date on or after <date>.
SUBJECT <string>:	messages with <string> in their subject.
TO <string>:	messages with <string> in their TO field.

ORDEREDSUBJECT:	split into single-level threads according to subject, ordered by date.
REFERENCES:	split into threads by parent/child relationships determined by which message is a reply to which.

IMAP Overview

Examples of Usage

List sender and subject of all recent messages in the default mailbox

Move all messages from April 2003 from "Mail/sent-mail" to "Mail/sent-apr03"

Thread Safety

Errors

References

Methods

Included Modules

Classes and Modules

Constants

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Fields:

Attributes

Public Class methods

Private Class methods

Public Instance methods

Private Instance methods