Class | Net::IMAP |
In: |
lib/net/imap.rb
|
Parent: | Object |
Net::IMAP implements Internet Message Access Protocol (IMAP) client functionality. The protocol is described in [IMAP].
An IMAP client connects to a server, and then authenticates itself using either authenticate() or login(). Having authenticated itself, there is a range of commands available to it. Most work with mailboxes, which may be arranged in an hierarchical namespace, and each of which contains zero or more messages. How this is implemented on the server is implementation-dependent; on a UNIX server, it will frequently be implemented as a files in mailbox format within a hierarchy of directories.
To work on the messages within a mailbox, the client must first select that mailbox, using either select() or (for read-only access) examine(). Once the client has successfully selected a mailbox, they enter selected state, and that mailbox becomes the current mailbox, on which mail-item related commands implicitly operate.
Messages have two sorts of identifiers: message sequence numbers, and UIDs.
Message sequence numbers number messages within a mail box from 1 up to the number of items in the mail box. If new message arrives during a session, it receives a sequence number equal to the new size of the mail box. If messages are expunged from the mailbox, remaining messages have their sequence numbers "shuffled down" to fill the gaps.
UIDs, on the other hand, are permanently guaranteed not to identify another message within the same mailbox, even if the existing message is deleted. UIDs are required to be assigned in ascending (but not necessarily sequential) order within a mailbox; this means that if a non-IMAP client rearranges the order of mailitems within a mailbox, the UIDs have to be reassigned. An IMAP client cannot thus rearrange message orders.
imap = Net::IMAP.new('mail.example.com') imap.authenticate('LOGIN', 'joe_user', 'joes_password') imap.examine('INBOX') imap.search(["RECENT"]).each do |message_id| envelope = imap.fetch(message_id, "ENVELOPE")[0].attr["ENVELOPE"] puts "#{envelope.from[0].name}: \t#{envelope.subject}" end
imap = Net::IMAP.new('mail.example.com') imap.authenticate('LOGIN', 'joe_user', 'joes_password') imap.select('Mail/sent-mail') if not imap.list('Mail/', 'sent-apr03') imap.create('Mail/sent-apr03') end imap.search(["BEFORE", "30-Apr-2003", "SINCE", "1-Apr-2003"]).each do |message_id| imap.copy(message_id, "Mail/sent-apr03") imap.store(message_id, "+FLAGS", [:Deleted]) end imap.expunge
Net::IMAP supports concurrent threads. For example,
imap = Net::IMAP.new("imap.foo.net", "imap2") imap.authenticate("cram-md5", "bar", "password") imap.select("inbox") fetch_thread = Thread.start { imap.fetch(1..-1, "UID") } search_result = imap.search(["BODY", "hello"]) fetch_result = fetch_thread.value imap.disconnect
This script invokes the FETCH command and the SEARCH command concurrently.
An IMAP server can send three different types of responses to indicate failure:
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. |
These three error response are represented by the errors Net::IMAP::NoResponseError, Net::IMAP::BadResponseError, and Net::IMAP::ByeResponseError, all of which are subclasses of Net::IMAP::ResponseError. Essentially, all methods that involve sending a request to the server can generate one of these errors. Only the most pertinent instances have been documented below.
Because the IMAP class uses Sockets for communication, its methods are also susceptible to the various errors that can occur when working with sockets. These are generally represented as Errno errors. For instance, any method that involves sending a request to the server and/or receiving a response from it could raise an Errno::EPIPE error if the network connection unexpectedly goes down. See the socket(7), ip(7), tcp(7), socket(2), connect(2), and associated man pages.
Finally, a Net::IMAP::DataFormatError is thrown if low-level data is found to be in an incorrect format (for instance, when converting between UTF-8 and UTF-16), and Net::IMAP::ResponseParseError is thrown if a server response is non-parseable.
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
StatusData | = | Struct.new(:mailbox, :attr) |
Net::IMAP::StatusData represents contents of the STATUS response.
Fields:
|
|||||||||||||||||||||
FetchData | = | Struct.new(:seqno, :attr) |
Net::IMAP::FetchData represents contents of the FETCH response.
Fields:
|
|||||||||||||||||||||
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:
|
|||||||||||||||||||||
Address | = | Struct.new(:name, :route, :mailbox, :host) |
Net::IMAP::Address represents electronic mail addresses.
Fields:
|
|||||||||||||||||||||
ContentDisposition | = | Struct.new(:dsp_type, :param) |
Net::IMAP::ContentDisposition represents Content-Disposition fields.
Fields:
|
|||||||||||||||||||||
ThreadMember | = | Struct.new(:seqno, :children) |
Net::IMAP::ThreadMember represents a thread-node returned by Net::IMAP#thread
Fields:
items that are children of this in the thread. |
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 |
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.
# File lib/net/imap.rb, line 281 281: def self.add_authenticator(auth_type, authenticator) 282: @@authenticators[auth_type] = authenticator 283: end
Decode a string from modified UTF-7 format to UTF-8.
UTF-7 is a 7-bit encoding of Unicode [UTF7]. IMAP uses a slightly modified version of this to encode mailbox names containing non-ASCII characters; see [IMAP] section 5.1.3.
Net::IMAP does not automatically encode and decode mailbox names to and from utf7.
# File lib/net/imap.rb, line 825 825: def self.decode_utf7(s) 826: return s.gsub(/&(.*?)-/n) { 827: if $1.empty? 828: "&" 829: else 830: base64 = $1.tr(",", "/") 831: x = base64.length % 4 832: if x > 0 833: base64.concat("=" * (4 - x)) 834: end 835: u16tou8(base64.unpack("m")[0]) 836: end 837: } 838: end
Encode a string from UTF-8 format to modified UTF-7.
# File lib/net/imap.rb, line 841 841: def self.encode_utf7(s) 842: return s.gsub(/(&)|([^\x20-\x25\x27-\x7e]+)/n) { |x| 843: if $1 844: "&-" 845: else 846: base64 = [u8tou16(x)].pack("m") 847: "&" + base64.delete("=\n").tr("/", ",") + "-" 848: end 849: } 850: end
Creates a new Net::IMAP object and connects it to the specified port (143 by default) on the named host. If usessl is true, then an attempt will be made to use SSL (now TLS) to connect to the server. For this to work OpenSSL [OSSL] and the Ruby OpenSSL [RSSL] extensions need to be installed. The certs parameter indicates the path or file containing the CA cert of the server, and the verify parameter is for the OpenSSL verification callback.
The most common errors are:
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. |
# File lib/net/imap.rb, line 879 879: def initialize(host, port = PORT, usessl = false, certs = nil, verify = false) 880: super() 881: @host = host 882: @port = port 883: @tag_prefix = "RUBY" 884: @tagno = 0 885: @parser = ResponseParser.new 886: @sock = TCPSocket.open(host, port) 887: if usessl 888: unless defined?(OpenSSL) 889: raise "SSL extension not installed" 890: end 891: @usessl = true 892: 893: # verify the server. 894: context = SSLContext::new() 895: context.ca_file = certs if certs && FileTest::file?(certs) 896: context.ca_path = certs if certs && FileTest::directory?(certs) 897: context.verify_mode = VERIFY_PEER if verify 898: if defined?(VerifyCallbackProc) 899: context.verify_callback = VerifyCallbackProc 900: end 901: @sock = SSLSocket.new(@sock, context) 902: @sock.connect # start ssl session. 903: @sock.post_connection_check(@host) if verify 904: else 905: @usessl = false 906: end 907: @responses = Hash.new([].freeze) 908: @tagged_responses = {} 909: @response_handlers = [] 910: @response_arrival = new_cond 911: @continuation_request = nil 912: @logout_command_tag = nil 913: @debug_output_bol = true 914: 915: @greeting = get_response 916: if @greeting.name == "BYE" 917: @sock.close 918: raise ByeResponseError, @greeting.raw_data 919: end 920: 921: @client_thread = Thread.current 922: @receiver_thread = Thread.start { 923: receive_responses 924: } 925: end
# File lib/net/imap.rb, line 1225 1225: def self.u16tou8(s) 1226: len = s.length 1227: if len < 2 1228: return "" 1229: end 1230: buf = "" 1231: i = 0 1232: while i < len 1233: c = s[i] << 8 | s[i + 1] 1234: i += 2 1235: if c == 0xfeff 1236: next 1237: elsif c < 0x0080 1238: buf.concat(c) 1239: elsif c < 0x0800 1240: b2 = c & 0x003f 1241: b1 = c >> 6 1242: buf.concat(b1 | 0xc0) 1243: buf.concat(b2 | 0x80) 1244: elsif c >= 0xdc00 && c < 0xe000 1245: raise DataFormatError, "invalid surrogate detected" 1246: elsif c >= 0xd800 && c < 0xdc00 1247: if i + 2 > len 1248: raise DataFormatError, "invalid surrogate detected" 1249: end 1250: low = s[i] << 8 | s[i + 1] 1251: i += 2 1252: if low < 0xdc00 || low > 0xdfff 1253: raise DataFormatError, "invalid surrogate detected" 1254: end 1255: c = (((c & 0x03ff)) << 10 | (low & 0x03ff)) + 0x10000 1256: b4 = c & 0x003f 1257: b3 = (c >> 6) & 0x003f 1258: b2 = (c >> 12) & 0x003f 1259: b1 = c >> 18; 1260: buf.concat(b1 | 0xf0) 1261: buf.concat(b2 | 0x80) 1262: buf.concat(b3 | 0x80) 1263: buf.concat(b4 | 0x80) 1264: else # 0x0800-0xffff 1265: b3 = c & 0x003f 1266: b2 = (c >> 6) & 0x003f 1267: b1 = c >> 12 1268: buf.concat(b1 | 0xe0) 1269: buf.concat(b2 | 0x80) 1270: buf.concat(b3 | 0x80) 1271: end 1272: end 1273: return buf 1274: end
# File lib/net/imap.rb, line 1277 1277: def self.u8tou16(s) 1278: len = s.length 1279: buf = "" 1280: i = 0 1281: while i < len 1282: c = s[i] 1283: if (c & 0x80) == 0 1284: buf.concat(0x00) 1285: buf.concat(c) 1286: i += 1 1287: elsif (c & 0xe0) == 0xc0 && 1288: len >= 2 && 1289: (s[i + 1] & 0xc0) == 0x80 1290: if c == 0xc0 || c == 0xc1 1291: raise DataFormatError, format("non-shortest UTF-8 sequence (%02x)", c) 1292: end 1293: u = ((c & 0x1f) << 6) | (s[i + 1] & 0x3f) 1294: buf.concat(u >> 8) 1295: buf.concat(u & 0x00ff) 1296: i += 2 1297: elsif (c & 0xf0) == 0xe0 && 1298: i + 2 < len && 1299: (s[i + 1] & 0xc0) == 0x80 && 1300: (s[i + 2] & 0xc0) == 0x80 1301: if c == 0xe0 && s[i + 1] < 0xa0 1302: raise DataFormatError, format("non-shortest UTF-8 sequence (%02x)", c) 1303: end 1304: u = ((c & 0x0f) << 12) | ((s[i + 1] & 0x3f) << 6) | (s[i + 2] & 0x3f) 1305: # surrogate chars 1306: if u >= 0xd800 && u <= 0xdfff 1307: raise DataFormatError, format("none-UTF-16 char detected (%04x)", u) 1308: end 1309: buf.concat(u >> 8) 1310: buf.concat(u & 0x00ff) 1311: i += 3 1312: elsif (c & 0xf8) == 0xf0 && 1313: i + 3 < len && 1314: (s[i + 1] & 0xc0) == 0x80 && 1315: (s[i + 2] & 0xc0) == 0x80 && 1316: (s[i + 3] & 0xc0) == 0x80 1317: if c == 0xf0 && s[i + 1] < 0x90 1318: raise DataFormatError, format("non-shortest UTF-8 sequence (%02x)", c) 1319: end 1320: u = ((c & 0x07) << 18) | ((s[i + 1] & 0x3f) << 12) | 1321: ((s[i + 2] & 0x3f) << 6) | (s[i + 3] & 0x3f) 1322: if u < 0x10000 1323: buf.concat(u >> 8) 1324: buf.concat(u & 0x00ff) 1325: elsif u < 0x110000 1326: high = ((u - 0x10000) >> 10) | 0xd800 1327: low = (u & 0x03ff) | 0xdc00 1328: buf.concat(high >> 8) 1329: buf.concat(high & 0x00ff) 1330: buf.concat(low >> 8) 1331: buf.concat(low & 0x00ff) 1332: else 1333: raise DataFormatError, format("none-UTF-16 char detected (%04x)", u) 1334: end 1335: i += 4 1336: else 1337: raise DataFormatError, format("illegal UTF-8 sequence (%02x)", c) 1338: end 1339: end 1340: return buf 1341: end
Adds a response handler. For example, to detect when the server sends us a new EXISTS response (which normally indicates new messages being added to the mail box), you could add the following handler after selecting the mailbox.
imap.add_response_handler { |resp| if resp.kind_of?(Net::IMAP::UntaggedResponse) and resp.name == "EXISTS" puts "Mailbox now has #{resp.data} messages" end }
# File lib/net/imap.rb, line 785 785: def add_response_handler(handler = Proc.new) 786: @response_handlers.push(handler) 787: end
Sends a APPEND command to append the message to the end of the mailbox. The optional flags argument is an array of flags to initially passing to the new message. The optional date_time argument specifies the creation time to assign to the new message; it defaults to the current time. For example:
imap.append("inbox", <<EOF.gsub(/\n/, "\r\n"), [:Seen], Time.now) Subject: hello From: shugo@ruby-lang.org To: shugo@ruby-lang.org hello world EOF
A Net::IMAP::NoResponseError is raised if the mailbox does not exist (it is not created automatically), or if the flags, date_time, or message arguments contain errors.
# File lib/net/imap.rb, line 604 604: def append(mailbox, message, flags = nil, date_time = nil) 605: args = [] 606: if flags 607: args.push(flags) 608: end 609: args.push(date_time) if date_time 610: args.push(Literal.new(message)) 611: send_command("APPEND", mailbox, *args) 612: end
Sends an AUTHENTICATE command to authenticate the client. The auth_type parameter is a string that represents the authentication mechanism to be used. Currently Net::IMAP supports authentication mechanisms:
LOGIN:: login using cleartext user and password. CRAM-MD5:: login with cleartext user and encrypted password (see [RFC-2195] for a full description). This mechanism requires that the server have the user's password stored in clear-text password.
For both these mechanisms, there should be two args: username and (cleartext) password. A server may not support one or other of these mechanisms; check capability() for a capability of the form "AUTH=LOGIN" or "AUTH=CRAM-MD5".
Authentication is done using the appropriate authenticator object: see @@authenticators for more information on plugging in your own authenticator.
For example:
imap.authenticate('LOGIN', user, password)
A Net::IMAP::NoResponseError is raised if authentication fails.
# File lib/net/imap.rb, line 354 354: def authenticate(auth_type, *args) 355: auth_type = auth_type.upcase 356: unless @@authenticators.has_key?(auth_type) 357: raise ArgumentError, 358: format('unknown auth type - "%s"', auth_type) 359: end 360: authenticator = @@authenticators[auth_type].new(*args) 361: send_command("AUTHENTICATE", auth_type) do |resp| 362: if resp.instance_of?(ContinuationRequest) 363: data = authenticator.process(resp.data.text.unpack("m")[0]) 364: s = [data].pack("m").gsub(/\n/, "") 365: send_string_data(s) 366: put_string(CRLF) 367: end 368: end 369: end
Sends a CAPABILITY command, and returns an array of capabilities that the server supports. Each capability is a string. See [IMAP] for a list of possible capabilities.
Note that the Net::IMAP class does not modify its behaviour according to the capabilities of the server; it is up to the user of the class to ensure that a certain capability is supported by a server before using it.
# File lib/net/imap.rb, line 311 311: def capability 312: synchronize do 313: send_command("CAPABILITY") 314: return @responses.delete("CAPABILITY")[-1] 315: end 316: end
Sends a CHECK command to request a checkpoint of the currently selected mailbox. This performs implementation-specific housekeeping, for instance, reconciling the mailbox‘s in-memory and on-disk state.
# File lib/net/imap.rb, line 618 618: def check 619: send_command("CHECK") 620: end
Sends a COPY command to copy the specified message(s) to the end of the specified destination mailbox. The set parameter is a number or an array of numbers or a Range object. The number is a message sequence number.
# File lib/net/imap.rb, line 746 746: def copy(set, mailbox) 747: copy_internal("COPY", set, mailbox) 748: end
Sends a CREATE command to create a new mailbox.
A Net::IMAP::NoResponseError is raised if a mailbox with that name cannot be created.
# File lib/net/imap.rb, line 417 417: def create(mailbox) 418: send_command("CREATE", mailbox) 419: end
Sends a DELETE command to remove the mailbox.
A Net::IMAP::NoResponseError is raised if a mailbox with that name cannot be deleted, either because it does not exist or because the client does not have permission to delete it.
# File lib/net/imap.rb, line 426 426: def delete(mailbox) 427: send_command("DELETE", mailbox) 428: end
Disconnects from the server.
# File lib/net/imap.rb, line 286 286: def disconnect 287: if SSL::SSLSocket === @sock 288: @sock.io.shutdown 289: else 290: @sock.shutdown 291: end 292: @receiver_thread.join 293: @sock.close 294: end
Returns true if disconnected from the server.
# File lib/net/imap.rb, line 297 297: def disconnected? 298: return @sock.closed? 299: end
Sends a EXAMINE command to select a mailbox so that messages in the mailbox can be accessed. Behaves the same as select(), except that the selected mailbox is identified as read-only.
A Net::IMAP::NoResponseError is raised if the mailbox does not exist or is for some reason non-examinable.
# File lib/net/imap.rb, line 406 406: def examine(mailbox) 407: synchronize do 408: @responses.clear 409: send_command("EXAMINE", mailbox) 410: end 411: end
Sends a EXPUNGE command to permanently remove from the currently selected mailbox all messages that have the \Deleted flag set.
# File lib/net/imap.rb, line 631 631: def expunge 632: synchronize do 633: send_command("EXPUNGE") 634: return @responses.delete("EXPUNGE") 635: end 636: end
Sends a FETCH command to retrieve data associated with a message in the mailbox. The set parameter is a number or an array of numbers or a Range object. The number is a message sequence number. attr is a list of attributes to fetch; see the documentation for Net::IMAP::FetchData for a list of valid attributes. The return value is an array of Net::IMAP::FetchData. For example:
p imap.fetch(6..8, "UID") #=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, \\ #<Net::IMAP::FetchData seqno=7, attr={"UID"=>99}>, \\ #<Net::IMAP::FetchData seqno=8, attr={"UID"=>100}>] p imap.fetch(6, "BODY[HEADER.FIELDS (SUBJECT)]") #=> [#<Net::IMAP::FetchData seqno=6, attr={"BODY[HEADER.FIELDS (SUBJECT)]"=>"Subject: test\r\n\r\n"}>] data = imap.uid_fetch(98, ["RFC822.SIZE", "INTERNALDATE"])[0] p data.seqno #=> 6 p data.attr["RFC822.SIZE"] #=> 611 p data.attr["INTERNALDATE"] #=> "12-Oct-2000 22:40:59 +0900" p data.attr["UID"] #=> 98
# File lib/net/imap.rb, line 710 710: def fetch(set, attr) 711: return fetch_internal("FETCH", set, attr) 712: end
Send the GETACL command along with specified mailbox. If this mailbox exists, an array containing objects of Net::IMAP::MailboxACLItem will be returned.
# File lib/net/imap.rb, line 544 544: def getacl(mailbox) 545: synchronize do 546: send_command("GETACL", mailbox) 547: return @responses.delete("ACL")[-1] 548: end 549: end
Sends the GETQUOTA command along with specified mailbox. If this mailbox exists, then an array containing a Net::IMAP::MailboxQuota object is returned. This command generally is only available to server admin.
# File lib/net/imap.rb, line 508 508: def getquota(mailbox) 509: synchronize do 510: send_command("GETQUOTA", mailbox) 511: return @responses.delete("QUOTA") 512: end 513: end
Sends the GETQUOTAROOT command along with specified mailbox. This command is generally available to both admin and user. If mailbox exists, returns an array containing objects of Net::IMAP::MailboxQuotaRoot and Net::IMAP::MailboxQuota.
# File lib/net/imap.rb, line 494 494: def getquotaroot(mailbox) 495: synchronize do 496: send_command("GETQUOTAROOT", mailbox) 497: result = [] 498: result.concat(@responses.delete("QUOTAROOT")) 499: result.concat(@responses.delete("QUOTA")) 500: return result 501: end 502: end
Sends a LIST command, and returns a subset of names from the complete set of all names available to the client. refname provides a context (for instance, a base directory in a directory-based mailbox hierarchy). mailbox specifies a mailbox or (via wildcards) mailboxes under that context. Two wildcards may be used in mailbox: ’*’, which matches all characters including the hierarchy delimiter (for instance, ’/’ on a UNIX-hosted directory-based mailbox hierarchy); and ’%’, which matches all characters except the hierarchy delimiter.
If refname is empty, mailbox is used directly to determine which mailboxes to match. If mailbox is empty, the root name of refname and the hierarchy delimiter are returned.
The return value is an array of +Net::IMAP::MailboxList+. For example:
imap.create("foo/bar") imap.create("foo/baz") p imap.list("", "foo/%") #=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\ #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\ #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]
# File lib/net/imap.rb, line 483 483: def list(refname, mailbox) 484: synchronize do 485: send_command("LIST", refname, mailbox) 486: return @responses.delete("LIST") 487: end 488: end
Sends a LOGIN command to identify the client and carries the plaintext password authenticating this user. Note that, unlike calling authenticate() with an auth_type of "LOGIN", login() does not use the login authenticator.
A Net::IMAP::NoResponseError is raised if authentication fails.
# File lib/net/imap.rb, line 377 377: def login(user, password) 378: send_command("LOGIN", user, password) 379: end
Sends a LOGOUT command to inform the server that the client is done with the connection.
# File lib/net/imap.rb, line 325 325: def logout 326: send_command("LOGOUT") 327: end
Sends a LSUB command, and returns a subset of names from the set of names that the user has declared as being "active" or "subscribed". refname and mailbox are interpreted as for list(). The return value is an array of +Net::IMAP::MailboxList+.
# File lib/net/imap.rb, line 556 556: def lsub(refname, mailbox) 557: synchronize do 558: send_command("LSUB", refname, mailbox) 559: return @responses.delete("LSUB") 560: end 561: end
Sends a NOOP command to the server. It does nothing.
# File lib/net/imap.rb, line 319 319: def noop 320: send_command("NOOP") 321: end
Removes the response handler.
# File lib/net/imap.rb, line 790 790: def remove_response_handler(handler) 791: @response_handlers.delete(handler) 792: end
Sends a RENAME command to change the name of the mailbox to newname.
A Net::IMAP::NoResponseError is raised if a mailbox with the name mailbox cannot be renamed to newname for whatever reason; for instance, because mailbox does not exist, or because there is already a mailbox with the name newname.
# File lib/net/imap.rb, line 437 437: def rename(mailbox, newname) 438: send_command("RENAME", mailbox, newname) 439: end
Sends a SEARCH command to search the mailbox for messages that match the given searching criteria, and returns message sequence numbers. keys can either be a string holding the entire search string, or a single-dimension array of search keywords and arguments. The following are some common search criteria; see [IMAP] section 6.4.4 for a full list.
<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. |
For example:
p imap.search(["SUBJECT", "hello", "NOT", "NEW"]) #=> [1, 6, 7, 8]
# File lib/net/imap.rb, line 678 678: def search(keys, charset = nil) 679: return search_internal("SEARCH", keys, charset) 680: end
Sends a SELECT command to select a mailbox so that messages in the mailbox can be accessed.
After you have selected a mailbox, you may retrieve the number of items in that mailbox from @responses["EXISTS"][-1], and the number of recent messages from @responses["RECENT"][-1]. Note that these values can change if new messages arrive during a session; see add_response_handler() for a way of detecting this event.
A Net::IMAP::NoResponseError is raised if the mailbox does not exist or is for some reason non-selectable.
# File lib/net/imap.rb, line 393 393: def select(mailbox) 394: synchronize do 395: @responses.clear 396: send_command("SELECT", mailbox) 397: end 398: end
Sends the SETACL command along with mailbox, user and the rights that user is to have on that mailbox. If rights is nil, then that user will be stripped of any rights to that mailbox. The IMAP ACL commands are described in [RFC-2086].
# File lib/net/imap.rb, line 533 533: def setacl(mailbox, user, rights) 534: if rights.nil? 535: send_command("SETACL", mailbox, user, "") 536: else 537: send_command("SETACL", mailbox, user, rights) 538: end 539: end
Sends a SETQUOTA command along with the specified mailbox and quota. If quota is nil, then quota will be unset for that mailbox. Typically one needs to be logged in as server admin for this to work. The IMAP quota commands are described in [RFC-2087].
# File lib/net/imap.rb, line 520 520: def setquota(mailbox, quota) 521: if quota.nil? 522: data = '()' 523: else 524: data = '(STORAGE ' + quota.to_s + ')' 525: end 526: send_command("SETQUOTA", mailbox, RawData.new(data)) 527: end
Sends a SORT command to sort messages in the mailbox. Returns an array of message sequence numbers. For example:
p imap.sort(["FROM"], ["ALL"], "US-ASCII") #=> [1, 2, 3, 5, 6, 7, 8, 4, 9] p imap.sort(["DATE"], ["SUBJECT", "hello"], "US-ASCII") #=> [6, 7, 8, 1]
See [SORT-THREAD-EXT] for more details.
# File lib/net/imap.rb, line 764 764: def sort(sort_keys, search_keys, charset) 765: return sort_internal("SORT", sort_keys, search_keys, charset) 766: end
Sends a STATUS command, and returns the status of the indicated mailbox. attr is a list of one or more attributes that we are request the status of. Supported attributes include:
MESSAGES:: the number of messages in the mailbox. RECENT:: the number of recent messages in the mailbox. UNSEEN:: the number of unseen messages in the mailbox.
The return value is a hash of attributes. For example:
p imap.status("inbox", ["MESSAGES", "RECENT"]) #=> {"RECENT"=>0, "MESSAGES"=>44}
A Net::IMAP::NoResponseError is raised if status values for mailbox cannot be returned, for instance because it does not exist.
# File lib/net/imap.rb, line 579 579: def status(mailbox, attr) 580: synchronize do 581: send_command("STATUS", mailbox, attr) 582: return @responses.delete("STATUS")[-1].attr 583: end 584: end
Sends a STORE command to alter data associated with messages in the mailbox, in particular their flags. The set parameter is a number or an array of numbers or a Range object. Each number is a message sequence number. attr is the name of a data item to store: ‘FLAGS’ means to replace the message‘s flag list with the provided one; ’+FLAGS’ means to add the provided flags; and ’-FLAGS’ means to remove them. flags is a list of flags.
The return value is an array of Net::IMAP::FetchData. For example:
p imap.store(6..8, "+FLAGS", [:Deleted]) #=> [#<Net::IMAP::FetchData seqno=6, attr={"FLAGS"=>[:Seen, :Deleted]}>, \\ #<Net::IMAP::FetchData seqno=7, attr={"FLAGS"=>[:Seen, :Deleted]}>, \\ #<Net::IMAP::FetchData seqno=8, attr={"FLAGS"=>[:Seen, :Deleted]}>]
# File lib/net/imap.rb, line 733 733: def store(set, attr, flags) 734: return store_internal("STORE", set, attr, flags) 735: end
Sends a SUBSCRIBE command to add the specified mailbox name to the server‘s set of "active" or "subscribed" mailboxes as returned by lsub().
A Net::IMAP::NoResponseError is raised if mailbox cannot be subscribed to, for instance because it does not exist.
# File lib/net/imap.rb, line 447 447: def subscribe(mailbox) 448: send_command("SUBSCRIBE", mailbox) 449: end
As for search(), but returns message sequence numbers in threaded format, as a Net::IMAP::ThreadMember tree. The supported algorithms are:
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. |
Unlike search(), charset is a required argument. US-ASCII and UTF-8 are sample values.
See [SORT-THREAD-EXT] for more details.
# File lib/net/imap.rb, line 807 807: def thread(algorithm, search_keys, charset) 808: return thread_internal("THREAD", algorithm, search_keys, charset) 809: end
Sends a UNSUBSCRIBE command to remove the specified mailbox name from the server‘s set of "active" or "subscribed" mailboxes.
A Net::IMAP::NoResponseError is raised if mailbox cannot be unsubscribed from, for instance because the client is not currently subscribed to it.
# File lib/net/imap.rb, line 457 457: def unsubscribe(mailbox) 458: send_command("UNSUBSCRIBE", mailbox) 459: end
# File lib/net/imap.rb, line 1186 1186: def copy_internal(cmd, set, mailbox) 1187: send_command(cmd, MessageSet.new(set), mailbox) 1188: end
# File lib/net/imap.rb, line 1164 1164: def fetch_internal(cmd, set, attr) 1165: if attr.instance_of?(String) 1166: attr = RawData.new(attr) 1167: end 1168: synchronize do 1169: @responses.delete("FETCH") 1170: send_command(cmd, MessageSet.new(set), attr) 1171: return @responses.delete("FETCH") 1172: end 1173: end
# File lib/net/imap.rb, line 1041 1041: def generate_tag 1042: @tagno += 1 1043: return format("%s%04d", @tag_prefix, @tagno) 1044: end
# File lib/net/imap.rb, line 989 989: def get_response 990: buff = "" 991: while true 992: s = @sock.gets(CRLF) 993: break unless s 994: buff.concat(s) 995: if /\{(\d+)\}\r\n/n =~ s 996: s = @sock.read($1.to_i) 997: buff.concat(s) 998: else 999: break 1000: end 1001: end 1002: return nil if buff.length == 0 1003: if @@debug 1004: $stderr.print(buff.gsub(/^/n, "S: ")) 1005: end 1006: return @parser.parse(buff) 1007: end
# File lib/net/imap.rb, line 970 970: def get_tagged_response(tag) 971: until @tagged_responses.key?(tag) 972: @response_arrival.wait 973: end 974: return pick_up_tagged_response(tag) 975: end
# File lib/net/imap.rb, line 1214 1214: def normalize_searching_criteria(keys) 1215: keys.collect! do |i| 1216: case i 1217: when -1, Range, Array 1218: MessageSet.new(i) 1219: else 1220: i 1221: end 1222: end 1223: end
# File lib/net/imap.rb, line 977 977: def pick_up_tagged_response(tag) 978: resp = @tagged_responses.delete(tag) 979: case resp.name 980: when /\A(?:NO)\z/ni 981: raise NoResponseError, resp.data.text 982: when /\A(?:BAD)\z/ni 983: raise BadResponseError, resp.data.text 984: else 985: return resp 986: end 987: end
# File lib/net/imap.rb, line 1046 1046: def put_string(str) 1047: @sock.print(str) 1048: if @@debug 1049: if @debug_output_bol 1050: $stderr.print("C: ") 1051: end 1052: $stderr.print(str.gsub(/\n(?!\z)/n, "\nC: ")) 1053: if /\r\n\z/n.match(str) 1054: @debug_output_bol = true 1055: else 1056: @debug_output_bol = false 1057: end 1058: end 1059: end
# File lib/net/imap.rb, line 927 927: def receive_responses 928: while true 929: begin 930: resp = get_response 931: rescue Exception 932: @sock.close 933: @client_thread.raise($!) 934: break 935: end 936: break unless resp 937: begin 938: synchronize do 939: case resp 940: when TaggedResponse 941: @tagged_responses[resp.tag] = resp 942: @response_arrival.broadcast 943: if resp.tag == @logout_command_tag 944: return 945: end 946: when UntaggedResponse 947: record_response(resp.name, resp.data) 948: if resp.data.instance_of?(ResponseText) && 949: (code = resp.data.code) 950: record_response(code.name, code.data) 951: end 952: if resp.name == "BYE" && @logout_command_tag.nil? 953: @sock.close 954: raise ByeResponseError, resp.raw_data 955: end 956: when ContinuationRequest 957: @continuation_request = resp 958: @response_arrival.broadcast 959: end 960: @response_handlers.each do |handler| 961: handler.call(resp) 962: end 963: end 964: rescue Exception 965: @client_thread.raise($!) 966: end 967: end 968: end
# File lib/net/imap.rb, line 1009 1009: def record_response(name, data) 1010: unless @responses.has_key?(name) 1011: @responses[name] = [] 1012: end 1013: @responses[name].push(data) 1014: end
# File lib/net/imap.rb, line 1148 1148: def search_internal(cmd, keys, charset) 1149: if keys.instance_of?(String) 1150: keys = [RawData.new(keys)] 1151: else 1152: normalize_searching_criteria(keys) 1153: end 1154: synchronize do 1155: if charset 1156: send_command(cmd, "CHARSET", charset, *keys) 1157: else 1158: send_command(cmd, *keys) 1159: end 1160: return @responses.delete("SEARCH")[-1] 1161: end 1162: end
# File lib/net/imap.rb, line 1016 1016: def send_command(cmd, *args, &block) 1017: synchronize do 1018: tag = Thread.current[:net_imap_tag] = generate_tag 1019: put_string(tag + " " + cmd) 1020: args.each do |i| 1021: put_string(" ") 1022: send_data(i) 1023: end 1024: put_string(CRLF) 1025: if cmd == "LOGOUT" 1026: @logout_command_tag = tag 1027: end 1028: if block 1029: add_response_handler(block) 1030: end 1031: begin 1032: return get_tagged_response(tag) 1033: ensure 1034: if block 1035: remove_response_handler(block) 1036: end 1037: end 1038: end 1039: end
# File lib/net/imap.rb, line 1061 1061: def send_data(data) 1062: case data 1063: when nil 1064: put_string("NIL") 1065: when String 1066: send_string_data(data) 1067: when Integer 1068: send_number_data(data) 1069: when Array 1070: send_list_data(data) 1071: when Time 1072: send_time_data(data) 1073: when Symbol 1074: send_symbol_data(data) 1075: else 1076: data.send_data(self) 1077: end 1078: end
# File lib/net/imap.rb, line 1120 1120: def send_list_data(list) 1121: put_string("(") 1122: first = true 1123: list.each do |i| 1124: if first 1125: first = false 1126: else 1127: put_string(" ") 1128: end 1129: send_data(i) 1130: end 1131: put_string(")") 1132: end
# File lib/net/imap.rb, line 1099 1099: def send_literal(str) 1100: put_string("{" + str.length.to_s + "}" + CRLF) 1101: while @continuation_request.nil? && 1102: !@tagged_responses.key?(Thread.current[:net_imap_tag]) 1103: @response_arrival.wait 1104: end 1105: if @continuation_request.nil? 1106: pick_up_tagged_response(Thread.current[:net_imap_tag]) 1107: raise ResponseError.new("expected continuation request") 1108: end 1109: @continuation_request = nil 1110: put_string(str) 1111: end
# File lib/net/imap.rb, line 1113 1113: def send_number_data(num) 1114: if num < 0 || num >= 4294967296 1115: raise DataFormatError, num.to_s 1116: end 1117: put_string(num.to_s) 1118: end
# File lib/net/imap.rb, line 1095 1095: def send_quoted_string(str) 1096: put_string('"' + str.gsub(/["\\]/n, "\\\\\\&") + '"') 1097: end
# File lib/net/imap.rb, line 1080 1080: def send_string_data(str) 1081: case str 1082: when "" 1083: put_string('""') 1084: when /[\x80-\xff\r\n]/n 1085: # literal 1086: send_literal(str) 1087: when /[(){ \x00-\x1f\x7f%*"\\]/n 1088: # quoted string 1089: send_quoted_string(str) 1090: else 1091: put_string(str) 1092: end 1093: end
# File lib/net/imap.rb, line 1144 1144: def send_symbol_data(symbol) 1145: put_string("\\" + symbol.to_s) 1146: end
# File lib/net/imap.rb, line 1136 1136: def send_time_data(time) 1137: t = time.dup.gmtime 1138: s = format('"%2d-%3s-%4d %02d:%02d:%02d +0000"', 1139: t.day, DATE_MONTH[t.month - 1], t.year, 1140: t.hour, t.min, t.sec) 1141: put_string(s) 1142: end
# File lib/net/imap.rb, line 1190 1190: def sort_internal(cmd, sort_keys, search_keys, charset) 1191: if search_keys.instance_of?(String) 1192: search_keys = [RawData.new(search_keys)] 1193: else 1194: normalize_searching_criteria(search_keys) 1195: end 1196: normalize_searching_criteria(search_keys) 1197: synchronize do 1198: send_command(cmd, sort_keys, charset, *search_keys) 1199: return @responses.delete("SORT")[-1] 1200: end 1201: end
# File lib/net/imap.rb, line 1175 1175: def store_internal(cmd, set, attr, flags) 1176: if attr.instance_of?(String) 1177: attr = RawData.new(attr) 1178: end 1179: synchronize do 1180: @responses.delete("FETCH") 1181: send_command(cmd, MessageSet.new(set), attr, flags) 1182: return @responses.delete("FETCH") 1183: end 1184: end
# File lib/net/imap.rb, line 1203 1203: def thread_internal(cmd, algorithm, search_keys, charset) 1204: if search_keys.instance_of?(String) 1205: search_keys = [RawData.new(search_keys)] 1206: else 1207: normalize_searching_criteria(search_keys) 1208: end 1209: normalize_searching_criteria(search_keys) 1210: send_command(cmd, algorithm, charset, *search_keys) 1211: return @responses.delete("THREAD")[-1] 1212: end