File: C:/Ruby27-x64/share/doc/ruby/html/Net/IMAP.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::IMAP - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-Net::IMAP-label-IMAP+Overview">IMAP Overview</a>
<li><a href="#class-Net::IMAP-label-Examples+of+Usage">Examples of Usage</a>
<li><a href="#class-Net::IMAP-label-List+sender+and+subject+of+all+recent+messages+in+the+default+mailbox">List sender and subject of all recent messages in the default mailbox</a>
<li><a href="#class-Net::IMAP-label-Move+all+messages+from+April+2003+from+-22Mail-2Fsent-mail-22+to+-22Mail-2Fsent-apr03-22">Move all messages from April 2003 from “Mail/sent-mail” to “Mail/sent-apr03”</a>
<li><a href="#class-Net::IMAP-label-Thread+Safety">Thread Safety</a>
<li><a href="#class-Net::IMAP-label-Errors">Errors</a>
<li><a href="#class-Net::IMAP-label-References">References</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Protocol
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../MonitorMixin.html">MonitorMixin</a>
<li><a class="include" href="../OpenSSL.html">OpenSSL</a>
<li><a class="include" href="../OpenSSL/SSL.html">OpenSSL::SSL</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-add_authenticator">::add_authenticator</a>
<li ><a href="#method-c-debug">::debug</a>
<li ><a href="#method-c-debug-3D">::debug=</a>
<li ><a href="#method-c-decode_utf7">::decode_utf7</a>
<li ><a href="#method-c-default_imap_port">::default_imap_port</a>
<li ><a href="#method-c-default_imaps_port">::default_imaps_port</a>
<li ><a href="#method-c-default_port">::default_port</a>
<li ><a href="#method-c-default_ssl_port">::default_ssl_port</a>
<li ><a href="#method-c-default_tls_port">::default_tls_port</a>
<li ><a href="#method-c-encode_utf7">::encode_utf7</a>
<li ><a href="#method-c-format_date">::format_date</a>
<li ><a href="#method-c-format_datetime">::format_datetime</a>
<li ><a href="#method-c-max_flag_count">::max_flag_count</a>
<li ><a href="#method-c-max_flag_count-3D">::max_flag_count=</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-add_response_handler">#add_response_handler</a>
<li ><a href="#method-i-append">#append</a>
<li ><a href="#method-i-authenticate">#authenticate</a>
<li ><a href="#method-i-capability">#capability</a>
<li ><a href="#method-i-check">#check</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-copy">#copy</a>
<li ><a href="#method-i-copy_internal">#copy_internal</a>
<li ><a href="#method-i-create">#create</a>
<li ><a href="#method-i-create_ssl_params">#create_ssl_params</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-disconnect">#disconnect</a>
<li ><a href="#method-i-disconnected-3F">#disconnected?</a>
<li ><a href="#method-i-examine">#examine</a>
<li ><a href="#method-i-expunge">#expunge</a>
<li ><a href="#method-i-fetch">#fetch</a>
<li ><a href="#method-i-fetch_internal">#fetch_internal</a>
<li ><a href="#method-i-generate_tag">#generate_tag</a>
<li ><a href="#method-i-get_response">#get_response</a>
<li ><a href="#method-i-get_tagged_response">#get_tagged_response</a>
<li ><a href="#method-i-getacl">#getacl</a>
<li ><a href="#method-i-getquota">#getquota</a>
<li ><a href="#method-i-getquotaroot">#getquotaroot</a>
<li ><a href="#method-i-idle">#idle</a>
<li ><a href="#method-i-idle_done">#idle_done</a>
<li ><a href="#method-i-list">#list</a>
<li ><a href="#method-i-login">#login</a>
<li ><a href="#method-i-logout">#logout</a>
<li ><a href="#method-i-lsub">#lsub</a>
<li ><a href="#method-i-move">#move</a>
<li ><a href="#method-i-noop">#noop</a>
<li ><a href="#method-i-normalize_searching_criteria">#normalize_searching_criteria</a>
<li ><a href="#method-i-put_string">#put_string</a>
<li ><a href="#method-i-receive_responses">#receive_responses</a>
<li ><a href="#method-i-record_response">#record_response</a>
<li ><a href="#method-i-remove_response_handler">#remove_response_handler</a>
<li ><a href="#method-i-rename">#rename</a>
<li ><a href="#method-i-search">#search</a>
<li ><a href="#method-i-search_internal">#search_internal</a>
<li ><a href="#method-i-select">#select</a>
<li ><a href="#method-i-send_command">#send_command</a>
<li ><a href="#method-i-send_data">#send_data</a>
<li ><a href="#method-i-send_list_data">#send_list_data</a>
<li ><a href="#method-i-send_literal">#send_literal</a>
<li ><a href="#method-i-send_number_data">#send_number_data</a>
<li ><a href="#method-i-send_quoted_string">#send_quoted_string</a>
<li ><a href="#method-i-send_string_data">#send_string_data</a>
<li ><a href="#method-i-send_symbol_data">#send_symbol_data</a>
<li ><a href="#method-i-send_time_data">#send_time_data</a>
<li ><a href="#method-i-setacl">#setacl</a>
<li ><a href="#method-i-setquota">#setquota</a>
<li ><a href="#method-i-sort">#sort</a>
<li ><a href="#method-i-sort_internal">#sort_internal</a>
<li ><a href="#method-i-start_tls_session">#start_tls_session</a>
<li ><a href="#method-i-starttls">#starttls</a>
<li ><a href="#method-i-status">#status</a>
<li ><a href="#method-i-store">#store</a>
<li ><a href="#method-i-store_internal">#store_internal</a>
<li ><a href="#method-i-subscribe">#subscribe</a>
<li ><a href="#method-i-tcp_socket">#tcp_socket</a>
<li ><a href="#method-i-thread">#thread</a>
<li ><a href="#method-i-thread_internal">#thread_internal</a>
<li ><a href="#method-i-uid_copy">#uid_copy</a>
<li ><a href="#method-i-uid_fetch">#uid_fetch</a>
<li ><a href="#method-i-uid_move">#uid_move</a>
<li ><a href="#method-i-uid_search">#uid_search</a>
<li ><a href="#method-i-uid_sort">#uid_sort</a>
<li ><a href="#method-i-uid_store">#uid_store</a>
<li ><a href="#method-i-uid_thread">#uid_thread</a>
<li ><a href="#method-i-unsubscribe">#unsubscribe</a>
<li ><a href="#method-i-validate_data">#validate_data</a>
<li ><a href="#method-i-xlist">#xlist</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::IMAP">
<h1 id="class-Net::IMAP" class="class">
class Net::IMAP
</h1>
<section class="description">
<p><a href="IMAP.html"><code>Net::IMAP</code></a> implements Internet Message Access Protocol (<a href="IMAP.html"><code>IMAP</code></a>) client functionality. The protocol is described in [IMAP].</p>
<h2 id="class-Net::IMAP-label-IMAP+Overview"><a href="IMAP.html"><code>IMAP</code></a> Overview<span><a href="#class-Net::IMAP-label-IMAP+Overview">¶</a> <a href="#top">↑</a></span></h2>
<p>An <a href="IMAP.html"><code>IMAP</code></a> client connects to a server, and then authenticates itself using either <a href="IMAP.html#method-i-authenticate"><code>authenticate()</code></a> or <a href="IMAP.html#method-i-login"><code>login()</code></a>. 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 files in mailbox format within a hierarchy of directories.</p>
<p>To work on the messages within a mailbox, the client must first select that mailbox, using either <a href="IMAP.html#method-i-select"><code>select()</code></a> or (for read-only access) <a href="IMAP.html#method-i-examine"><code>examine()</code></a>. Once the client has successfully selected a mailbox, they enter <em>selected</em> state, and that mailbox becomes the <em>current</em> mailbox, on which mail-item related commands implicitly operate.</p>
<p>Messages have two sorts of identifiers: message sequence numbers and UIDs.</p>
<p>Message sequence numbers number messages within a mailbox from 1 up to the number of items in the mailbox. If a new message arrives during a session, it receives a sequence number equal to the new size of the mailbox. If messages are expunged from the mailbox, remaining messages have their sequence numbers “shuffled down” to fill the gaps.</p>
<p>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 <a href="IMAP.html"><code>IMAP</code></a> client thus cannot rearrange message orders.</p>
<h2 id="class-Net::IMAP-label-Examples+of+Usage">Examples of Usage<span><a href="#class-Net::IMAP-label-Examples+of+Usage">¶</a> <a href="#top">↑</a></span></h2>
<h3 id="class-Net::IMAP-label-List+sender+and+subject+of+all+recent+messages+in+the+default+mailbox">List sender and subject of all recent messages in the default mailbox<span><a href="#class-Net::IMAP-label-List+sender+and+subject+of+all+recent+messages+in+the+default+mailbox">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">imap</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">IMAP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'mail.example.com'</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">authenticate</span>(<span class="ruby-string">'LOGIN'</span>, <span class="ruby-string">'joe_user'</span>, <span class="ruby-string">'joes_password'</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">examine</span>(<span class="ruby-string">'INBOX'</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">search</span>([<span class="ruby-string">"RECENT"</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">message_id</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">envelope</span> = <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">message_id</span>, <span class="ruby-string">"ENVELOPE"</span>)[<span class="ruby-value">0</span>].<span class="ruby-identifier">attr</span>[<span class="ruby-string">"ENVELOPE"</span>]
<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{envelope.from[0].name}: \t#{envelope.subject}"</span>
<span class="ruby-keyword">end</span>
</pre>
<h3 id="class-Net::IMAP-label-Move+all+messages+from+April+2003+from+-22Mail-2Fsent-mail-22+to+-22Mail-2Fsent-apr03-22">Move all messages from April 2003 from “Mail/sent-mail” to “Mail/sent-apr03”<span><a href="#class-Net::IMAP-label-Move+all+messages+from+April+2003+from+-22Mail-2Fsent-mail-22+to+-22Mail-2Fsent-apr03-22">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">imap</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">IMAP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'mail.example.com'</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">authenticate</span>(<span class="ruby-string">'LOGIN'</span>, <span class="ruby-string">'joe_user'</span>, <span class="ruby-string">'joes_password'</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">select</span>(<span class="ruby-string">'Mail/sent-mail'</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">list</span>(<span class="ruby-string">'Mail/'</span>, <span class="ruby-string">'sent-apr03'</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">'Mail/sent-apr03'</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">search</span>([<span class="ruby-string">"BEFORE"</span>, <span class="ruby-string">"30-Apr-2003"</span>, <span class="ruby-string">"SINCE"</span>, <span class="ruby-string">"1-Apr-2003"</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">message_id</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">copy</span>(<span class="ruby-identifier">message_id</span>, <span class="ruby-string">"Mail/sent-apr03"</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">store</span>(<span class="ruby-identifier">message_id</span>, <span class="ruby-string">"+FLAGS"</span>, [<span class="ruby-value">:Deleted</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">expunge</span>
</pre>
<h2 id="class-Net::IMAP-label-Thread+Safety"><a href="../Thread.html"><code>Thread</code></a> Safety<span><a href="#class-Net::IMAP-label-Thread+Safety">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="IMAP.html"><code>Net::IMAP</code></a> supports concurrent threads. For example,</p>
<pre class="ruby"><span class="ruby-identifier">imap</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">IMAP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"imap.foo.net"</span>, <span class="ruby-string">"imap2"</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">authenticate</span>(<span class="ruby-string">"cram-md5"</span>, <span class="ruby-string">"bar"</span>, <span class="ruby-string">"password"</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">select</span>(<span class="ruby-string">"inbox"</span>)
<span class="ruby-identifier">fetch_thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">start</span> { <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>, <span class="ruby-string">"UID"</span>) }
<span class="ruby-identifier">search_result</span> = <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">search</span>([<span class="ruby-string">"BODY"</span>, <span class="ruby-string">"hello"</span>])
<span class="ruby-identifier">fetch_result</span> = <span class="ruby-identifier">fetch_thread</span>.<span class="ruby-identifier">value</span>
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">disconnect</span>
</pre>
<p>This script invokes the FETCH command and the SEARCH command concurrently.</p>
<h2 id="class-Net::IMAP-label-Errors">Errors<span><a href="#class-Net::IMAP-label-Errors">¶</a> <a href="#top">↑</a></span></h2>
<p>An <a href="IMAP.html"><code>IMAP</code></a> server can send three different types of responses to indicate failure:</p>
<dl class="rdoc-list note-list"><dt>NO
<dd>
<p>the attempted command could not be successfully completed. For instance, the username/password used for logging in are incorrect; the selected mailbox does not exist; etc.</p>
</dd><dt>BAD
<dd>
<p>the request from the client does not follow the server's understanding of the <a href="IMAP.html"><code>IMAP</code></a> 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.</p>
</dd><dt>BYE
<dd>
<p>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 your 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.</p>
</dd></dl>
<p>These three error response are represented by the errors <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a>, <a href="IMAP/BadResponseError.html"><code>Net::IMAP::BadResponseError</code></a>, and <a href="IMAP/ByeResponseError.html"><code>Net::IMAP::ByeResponseError</code></a>, all of which are subclasses of <a href="IMAP/ResponseError.html"><code>Net::IMAP::ResponseError</code></a>. 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.</p>
<p>Because the <a href="IMAP.html"><code>IMAP</code></a> 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 <a href="../Errno.html"><code>Errno</code></a> 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.</p>
<p>Finally, a <a href="IMAP/DataFormatError.html"><code>Net::IMAP::DataFormatError</code></a> 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 <a href="IMAP/ResponseParseError.html"><code>Net::IMAP::ResponseParseError</code></a> is thrown if a server response is non-parseable.</p>
<h2 id="class-Net::IMAP-label-References">References<span><a href="#class-Net::IMAP-label-References">¶</a> <a href="#top">↑</a></span></h2>
<dl class="rdoc-list label-list"><dt>[IMAP]
<dd><ol style="list-style-type: upper-alpha"><li>
<p>Crispin, “INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1”,</p>
</li></ol>
<p>RFC 2060, December 1996. (Note: since obsoleted by RFC 3501)</p>
</dd><dt>[LANGUAGE-TAGS]
<dd>
<p>Alvestrand, H., “Tags for the Identification of Languages”, RFC 1766, March 1995.</p>
</dd><dt>[MD5]
<dd>
<p>Myers, J., and M. Rose, “The Content-MD5 Header Field”, RFC 1864, October 1995.</p>
</dd><dt>[MIME-IMB]
<dd>
<p>Freed, N., and N. Borenstein, “MIME (Multipurpose Internet Mail Extensions) Part One: Format of Internet Message Bodies”, RFC 2045, November 1996.</p>
</dd><dt>[RFC-822]
<dd>
<p>Crocker, D., “Standard for the Format of ARPA Internet Text Messages”, STD 11, RFC 822, University of Delaware, August 1982.</p>
</dd><dt>[RFC-2087]
<dd>
<p>Myers, J., “IMAP4 QUOTA extension”, RFC 2087, January 1997.</p>
</dd><dt>[RFC-2086]
<dd>
<p>Myers, J., “IMAP4 <a href="../ACL.html"><code>ACL</code></a> extension”, RFC 2086, January 1997.</p>
</dd><dt>[RFC-2195]
<dd>
<p>Klensin, J., Catoe, R., and Krumviede, P., “IMAP/POP AUTHorize Extension for Simple Challenge/Response”, RFC 2195, September 1997.</p>
</dd><dt>[SORT-THREAD-EXT]
<dd>
<p>Crispin, M., “INTERNET MESSAGE ACCESS PROTOCOL - SORT and THREAD Extensions”, draft-ietf-imapext-sort, May 2003.</p>
</dd><dt>[OSSL]
<dd>
<p><a href="http://www.openssl.org">www.openssl.org</a></p>
</dd><dt>[RSSL]
<dd>
<p><a href="http://savannah.gnu.org/projects/rubypki">savannah.gnu.org/projects/rubypki</a></p>
</dd><dt>[UTF7]
<dd>
<p>Goldsmith, D. and Davis, M., “UTF-7: A Mail-Safe Transformation Format of Unicode”, RFC 2152, May 1997.</p>
</dd></dl>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ANSWERED">ANSWERED
<dd><p>Flag indicating a message has been answered.</p>
<dt id="Address">Address
<dd><p><a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> represents electronic mail addresses.</p>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>name
<dd>
<p>Returns the phrase from [RFC-822] mailbox.</p>
</dd><dt>route
<dd>
<p>Returns the route from [RFC-822] route-addr.</p>
</dd><dt>mailbox
<dd>
<p>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.</p>
</dd><dt>host
<dd>
<p>nil indicates [RFC-822] group syntax. Otherwise, returns [RFC-822] domain name.</p>
</dd></dl>
<dt id="ContentDisposition">ContentDisposition
<dd><p><a href="IMAP.html#ContentDisposition"><code>Net::IMAP::ContentDisposition</code></a> represents Content-Disposition fields.</p>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>dsp_type
<dd>
<p>Returns the disposition type.</p>
</dd><dt>param
<dd>
<p>Returns a hash that represents parameters of the Content-Disposition field.</p>
</dd></dl>
<dt id="ContinuationRequest">ContinuationRequest
<dd><p><a href="IMAP.html#ContinuationRequest"><code>Net::IMAP::ContinuationRequest</code></a> represents command continuation requests.</p>
<p>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.</p>
<pre>continue_req ::= "+" SPACE (resp_text / base64)</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>data
<dd>
<p>Returns the data (<a href="IMAP.html#ResponseText"><code>Net::IMAP::ResponseText</code></a>).</p>
</dd><dt>raw_data
<dd>
<p>Returns the raw data string.</p>
</dd></dl>
<dt id="DATE_MONTH">DATE_MONTH
<dd>
<dt id="DELETED">DELETED
<dd><p>Flag indicating a message has been marked for deletion. This will occur when the mailbox is closed or expunged.</p>
<dt id="DRAFT">DRAFT
<dd><p>Flag indicating a message is only a draft or work-in-progress version.</p>
<dt id="Envelope">Envelope
<dd><p><a href="IMAP.html#Envelope"><code>Net::IMAP::Envelope</code></a> represents envelope structures of messages.</p>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>date
<dd>
<p>Returns a string that represents the date.</p>
</dd><dt>subject
<dd>
<p>Returns a string that represents the subject.</p>
</dd><dt>from
<dd>
<p>Returns an array of <a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> that represents the from.</p>
</dd><dt>sender
<dd>
<p>Returns an array of <a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> that represents the sender.</p>
</dd><dt>reply_to
<dd>
<p>Returns an array of <a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> that represents the reply-to.</p>
</dd><dt>to
<dd>
<p>Returns an array of <a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> that represents the to.</p>
</dd><dt>cc
<dd>
<p>Returns an array of <a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> that represents the cc.</p>
</dd><dt>bcc
<dd>
<p>Returns an array of <a href="IMAP.html#Address"><code>Net::IMAP::Address</code></a> that represents the bcc.</p>
</dd><dt>in_reply_to
<dd>
<p>Returns a string that represents the in-reply-to.</p>
</dd><dt>message_id
<dd>
<p>Returns a string that represents the message-id.</p>
</dd></dl>
<dt id="FLAGGED">FLAGGED
<dd><p>Flag indicating a message has been flagged for special or urgent attention.</p>
<dt id="FetchData">FetchData
<dd><p><a href="IMAP.html#FetchData"><code>Net::IMAP::FetchData</code></a> represents the contents of the FETCH response.</p>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>seqno
<dd>
<p>Returns the message sequence number. (Note: not the unique identifier, even for the UID command response.)</p>
</dd><dt>attr
<dd>
<p>Returns a hash. Each key is a data item name, and each value is its value.</p>
<p>The current data items are:</p>
<dl class="rdoc-list label-list"><dt>BODY
<dd>
<p>A form of BODYSTRUCTURE without extension data.</p>
</dd><dt><a href="<section>“>BODY</a><<origin_octet>>
<dd>
<p>A string expressing the body contents of the specified section.</p>
</dd><dt>BODYSTRUCTURE
<dd>
<p>An object that describes the [MIME-IMB] body structure of a message. See <a href="IMAP/BodyTypeBasic.html"><code>Net::IMAP::BodyTypeBasic</code></a>, <a href="IMAP/BodyTypeText.html"><code>Net::IMAP::BodyTypeText</code></a>, <a href="IMAP/BodyTypeMessage.html"><code>Net::IMAP::BodyTypeMessage</code></a>, <a href="IMAP/BodyTypeMultipart.html"><code>Net::IMAP::BodyTypeMultipart</code></a>.</p>
</dd><dt>ENVELOPE
<dd>
<p>A <a href="IMAP.html#Envelope"><code>Net::IMAP::Envelope</code></a> object that describes the envelope structure of a message.</p>
</dd><dt>FLAGS
<dd>
<p>A array of flag symbols that are set for this message. Flag symbols are capitalized by <a href="../String.html#method-i-capitalize"><code>String#capitalize</code></a>.</p>
</dd><dt>INTERNALDATE
<dd>
<p>A string representing the internal date of the message.</p>
</dd><dt>RFC822
<dd>
<p>Equivalent to BODY[].</p>
</dd><dt>RFC822.HEADER
<dd>
<p>Equivalent to <a href="HEADER">BODY.PEEK</a>.</p>
</dd><dt>RFC822.SIZE
<dd>
<p>A number expressing the [RFC-822] size of the message.</p>
</dd><dt>RFC822.TEXT
<dd>
<p>Equivalent to <a href="TEXT">BODY</a>.</p>
</dd><dt>UID
<dd>
<p>A number expressing the unique identifier of the message.</p>
</dd></dl>
</dd></dl>
<dt id="MARKED">MARKED
<dd><p>Flag indicating that a mailbox has been marked “interesting” by the server; this commonly indicates that the mailbox contains new messages.</p>
<dt id="MailboxACLItem">MailboxACLItem
<dd><p><a href="IMAP.html#MailboxACLItem"><code>Net::IMAP::MailboxACLItem</code></a> represents the response from GETACL.</p>
<pre>acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE rights)
identifier ::= astring
rights ::= astring</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>user
<dd>
<p>Login name that has certain rights to the mailbox that was specified with the getacl command.</p>
</dd><dt>rights
<dd>
<p>The access rights the indicated user has to the mailbox.</p>
</dd></dl>
<dt id="MailboxList">MailboxList
<dd><p><a href="IMAP.html#MailboxList"><code>Net::IMAP::MailboxList</code></a> represents contents of the LIST response.</p>
<pre>mailbox_list ::= "(" #("\Marked" / "\Noinferiors" /
"\Noselect" / "\Unmarked" / flag_extension) ")"
SPACE (<"> QUOTED_CHAR <"> / nil) SPACE mailbox</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>attr
<dd>
<p>Returns the name attributes. Each name attribute is a symbol capitalized by <a href="../String.html#method-i-capitalize"><code>String#capitalize</code></a>, such as :Noselect (not :NoSelect).</p>
</dd><dt>delim
<dd>
<p>Returns the hierarchy delimiter.</p>
</dd><dt>name
<dd>
<p>Returns the mailbox name.</p>
</dd></dl>
<dt id="MailboxQuota">MailboxQuota
<dd><p><a href="IMAP.html#MailboxQuota"><code>Net::IMAP::MailboxQuota</code></a> 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).</p>
<pre>quota_list ::= "(" #quota_resource ")"
quota_resource ::= atom SPACE number SPACE number
quota_response ::= "QUOTA" SPACE astring SPACE quota_list</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>mailbox
<dd>
<p>The mailbox with the associated quota.</p>
</dd><dt>usage
<dd>
<p>Current storage usage of the mailbox.</p>
</dd><dt>quota
<dd>
<p>Quota limit imposed on the mailbox.</p>
</dd></dl>
<dt id="MailboxQuotaRoot">MailboxQuotaRoot
<dd><p><a href="IMAP.html#MailboxQuotaRoot"><code>Net::IMAP::MailboxQuotaRoot</code></a> represents part of the GETQUOTAROOT response. (GETQUOTAROOT can also return <a href="IMAP.html#MailboxQuota"><code>Net::IMAP::MailboxQuota</code></a>.)</p>
<pre>quotaroot_response ::= "QUOTAROOT" SPACE astring *(SPACE astring)</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>mailbox
<dd>
<p>The mailbox with the associated quota.</p>
</dd><dt>quotaroots
<dd>
<p>Zero or more quotaroots that affect the quota on the specified mailbox.</p>
</dd></dl>
<dt id="NOINFERIORS">NOINFERIORS
<dd><p>Flag indicating that a mailbox context name cannot contain children.</p>
<dt id="NOSELECT">NOSELECT
<dd><p>Flag indicating that a mailbox is not selected.</p>
<dt id="RECENT">RECENT
<dd><p>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.</p>
<dt id="RESPONSE_ERRORS">RESPONSE_ERRORS
<dd>
<dt id="ResponseCode">ResponseCode
<dd><p><a href="IMAP.html#ResponseCode"><code>Net::IMAP::ResponseCode</code></a> represents response codes.</p>
<pre>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 "]">]</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>name
<dd>
<p>Returns the name, such as “ALERT”, “PERMANENTFLAGS”, or “UIDVALIDITY”.</p>
</dd><dt>data
<dd>
<p>Returns the data, if it exists.</p>
</dd></dl>
<dt id="ResponseText">ResponseText
<dd><p><a href="IMAP.html#ResponseText"><code>Net::IMAP::ResponseText</code></a> represents texts of responses. The text may be prefixed by the response code.</p>
<pre>resp_text ::= ["[" resp_text_code "]" SPACE] (text_mime2 / text)
;; text SHOULD NOT begin with "[" or "="</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>code
<dd>
<p>Returns the response code. See ((<Net::IMAP::ResponseCode>)).</p>
</dd><dt>text
<dd>
<p>Returns the text.</p>
</dd></dl>
<dt id="SEEN">SEEN
<dd><p>Flag indicating a message has been seen.</p>
<dt id="StatusData">StatusData
<dd><p><a href="IMAP.html#StatusData"><code>Net::IMAP::StatusData</code></a> represents the contents of the STATUS response.</p>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>mailbox
<dd>
<p>Returns the mailbox name.</p>
</dd><dt>attr
<dd>
<p>Returns a hash. Each key is one of “MESSAGES”, “RECENT”, “UIDNEXT”, “UIDVALIDITY”, “UNSEEN”. Each value is a number.</p>
</dd></dl>
<dt id="TaggedResponse">TaggedResponse
<dd><p><a href="IMAP.html#TaggedResponse"><code>Net::IMAP::TaggedResponse</code></a> represents tagged responses.</p>
<p>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.</p>
<pre>response_tagged ::= tag SPACE resp_cond_state CRLF
tag ::= 1*<any ATOM_CHAR except "+">
resp_cond_state ::= ("OK" / "NO" / "BAD") SPACE resp_text</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>tag
<dd>
<p>Returns the tag.</p>
</dd><dt>name
<dd>
<p>Returns the name, one of “OK”, “NO”, or “BAD”.</p>
</dd><dt>data
<dd>
<p>Returns the data. See ((<Net::IMAP::ResponseText>)).</p>
</dd><dt>raw_data
<dd>
<p>Returns the raw data string.</p>
</dd></dl>
<dt id="ThreadMember">ThreadMember
<dd><p><a href="IMAP.html#ThreadMember"><code>Net::IMAP::ThreadMember</code></a> represents a thread-node returned by <a href="IMAP.html#method-i-thread"><code>Net::IMAP#thread</code></a>.</p>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>seqno
<dd>
<p>The sequence number of this message.</p>
</dd><dt>children
<dd>
<p>An array of <a href="IMAP.html#ThreadMember"><code>Net::IMAP::ThreadMember</code></a> objects for mail items that are children of this in the thread.</p>
</dd></dl>
<dt id="UNMARKED">UNMARKED
<dd><p>Flag indicating that the mailbox does not contains new messages.</p>
<dt id="UntaggedResponse">UntaggedResponse
<dd><p><a href="IMAP.html#UntaggedResponse"><code>Net::IMAP::UntaggedResponse</code></a> represents untagged responses.</p>
<p><a href="../Data.html"><code>Data</code></a> 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.</p>
<pre>response_data ::= "*" SPACE (resp_cond_state / resp_cond_bye /
mailbox_data / message_data / capability_data)</pre>
<h4 id="label-Fields-3A">Fields:<span><a href="#label-Fields-3A">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>name
<dd>
<p>Returns the name, such as “FLAGS”, “LIST”, or “FETCH”.</p>
</dd><dt>data
<dd>
<p>Returns the data such as an array of flag symbols, a ((<Net::IMAP::MailboxList>)) object.</p>
</dd><dt>raw_data
<dd>
<p>Returns the raw data string.</p>
</dd></dl>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-client_thread" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">client_thread</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The thread to receive exceptions.</p>
</div>
</div>
<div id="attribute-i-greeting" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">greeting</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Returns an initial greeting response from the server.</p>
</div>
</div>
<div id="attribute-i-open_timeout" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">open_timeout</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Seconds to wait until a connection is opened. If the <a href="IMAP.html"><code>IMAP</code></a> object cannot open a connection within this time, it raises a <a href="OpenTimeout.html"><code>Net::OpenTimeout</code></a> exception. The default value is 30 seconds.</p>
</div>
</div>
<div id="attribute-i-response_handlers" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">response_handlers</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Returns all response handlers.</p>
</div>
</div>
<div id="attribute-i-responses" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">responses</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Returns recorded untagged responses. For example:</p>
<pre class="ruby"><span class="ruby-identifier">imap</span>.<span class="ruby-identifier">select</span>(<span class="ruby-string">"inbox"</span>)
<span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">responses</span>[<span class="ruby-string">"EXISTS"</span>][<span class="ruby-value">-1</span>]
<span class="ruby-comment">#=> 2</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">responses</span>[<span class="ruby-string">"UIDVALIDITY"</span>][<span class="ruby-value">-1</span>]
<span class="ruby-comment">#=> 968263756</span>
</pre>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-add_authenticator" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_authenticator</span><span
class="method-args">(auth_type, authenticator)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds an authenticator for <a href="IMAP.html#method-i-authenticate"><code>Net::IMAP#authenticate</code></a>. <code>auth_type</code> is the type of authentication this authenticator supports (for instance, “LOGIN”). The <code>authenticator</code> is an object which defines a process() method to handle authentication with the server. See <a href="IMAP/LoginAuthenticator.html"><code>Net::IMAP::LoginAuthenticator</code></a>, <a href="IMAP/CramMD5Authenticator.html"><code>Net::IMAP::CramMD5Authenticator</code></a>, and <a href="IMAP/DigestMD5Authenticator.html"><code>Net::IMAP::DigestMD5Authenticator</code></a> for examples.</p>
<p>If <code>auth_type</code> refers to an existing authenticator, it will be replaced by the new one.</p>
<div class="method-source-code" id="add_authenticator-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 301</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">add_authenticator</span>(<span class="ruby-identifier">auth_type</span>, <span class="ruby-identifier">authenticator</span>)
<span class="ruby-identifier">@@authenticators</span>[<span class="ruby-identifier">auth_type</span>] = <span class="ruby-identifier">authenticator</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-debug" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the debug mode.</p>
<div class="method-source-code" id="debug-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 271</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">debug</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">@@debug</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-debug-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the debug mode.</p>
<div class="method-source-code" id="debug-3D-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 276</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">debug=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">@@debug</span> = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-decode_utf7" class="method-detail ">
<div class="method-heading">
<span class="method-name">decode_utf7</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Decode a string from modified UTF-7 format to UTF-8.</p>
<p>UTF-7 is a 7-bit encoding of Unicode [UTF7]. <a href="IMAP.html"><code>IMAP</code></a> uses a slightly modified version of this to encode mailbox names containing non-ASCII characters; see [IMAP] section 5.1.3.</p>
<p><a href="IMAP.html"><code>Net::IMAP</code></a> does <em>not</em> automatically encode and decode mailbox names to and from UTF-7.</p>
<div class="method-source-code" id="decode_utf7-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1000</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">decode_utf7</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/&([^-]+)?-/n</span>) {
<span class="ruby-keyword">if</span> <span class="ruby-node">$1</span>
(<span class="ruby-node">$1</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">","</span>, <span class="ruby-string">"/"</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"==="</span>).<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">"m"</span>).<span class="ruby-identifier">encode</span>(<span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>, <span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_16BE</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-string">"&"</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-default_imap_port" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">default_imap_port</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="IMAP.html#method-c-default_port">default_port</a>
</div>
</div>
<div id="method-c-default_imaps_port" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">default_imaps_port</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="IMAP.html#method-c-default_tls_port">default_tls_port</a>
</div>
</div>
<div id="method-c-default_port" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_port</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The default port for <a href="IMAP.html"><code>IMAP</code></a> connections, port 143</p>
<div class="method-source-code" id="default_port-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 306</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">default_port</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">PORT</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="IMAP.html#method-c-default_imap_port">default_imap_port</a>
</div>
</div>
<div id="method-c-default_ssl_port" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">default_ssl_port</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="IMAP.html#method-c-default_tls_port">default_tls_port</a>
</div>
</div>
<div id="method-c-default_tls_port" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_tls_port</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The default port for IMAPS connections, port 993</p>
<div class="method-source-code" id="default_tls_port-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 311</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">default_tls_port</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">SSL_PORT</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="IMAP.html#method-c-default_imaps_port">default_imaps_port</a>, <a href="IMAP.html#method-c-default_ssl_port">default_ssl_port</a>
</div>
</div>
<div id="method-c-encode_utf7" class="method-detail ">
<div class="method-heading">
<span class="method-name">encode_utf7</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Encode a string from UTF-8 format to modified UTF-7.</p>
<div class="method-source-code" id="encode_utf7-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1011</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">encode_utf7</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/(&)|[^\x20-\x7e]+/</span>) {
<span class="ruby-keyword">if</span> <span class="ruby-node">$1</span>
<span class="ruby-string">"&-"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">base64</span> = [<span class="ruby-node">$&</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_16BE</span>)].<span class="ruby-identifier">pack</span>(<span class="ruby-string">"m0"</span>)
<span class="ruby-string">"&"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">base64</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"="</span>).<span class="ruby-identifier">tr</span>(<span class="ruby-string">"/"</span>, <span class="ruby-string">","</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"-"</span>
<span class="ruby-keyword">end</span>
}.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"ASCII-8BIT"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-format_date" class="method-detail ">
<div class="method-heading">
<span class="method-name">format_date</span><span
class="method-args">(time)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Formats <code>time</code> as an IMAP-style date.</p>
<div class="method-source-code" id="format_date-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1023</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">format_date</span>(<span class="ruby-identifier">time</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">time</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">'%d-%b-%Y'</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-format_datetime" class="method-detail ">
<div class="method-heading">
<span class="method-name">format_datetime</span><span
class="method-args">(time)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Formats <code>time</code> as an IMAP-style date-time.</p>
<div class="method-source-code" id="format_datetime-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1028</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">format_datetime</span>(<span class="ruby-identifier">time</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">time</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">'%d-%b-%Y %H:%M %z'</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-max_flag_count" class="method-detail ">
<div class="method-heading">
<span class="method-name">max_flag_count</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the max number of flags interned to symbols.</p>
<div class="method-source-code" id="max_flag_count-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 281</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">max_flag_count</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">@@max_flag_count</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-max_flag_count-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">max_flag_count=</span><span
class="method-args">(count)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the max number of flags interned to symbols.</p>
<div class="method-source-code" id="max_flag_count-3D-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 286</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">max_flag_count=</span>(<span class="ruby-identifier">count</span>)
<span class="ruby-identifier">@@max_flag_count</span> = <span class="ruby-identifier">count</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Net::IMAP.new(host, options = {})
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="IMAP.html"><code>Net::IMAP</code></a> object and connects it to the specified <code>host</code>.</p>
<p><code>options</code> is an option hash, each key of which is a symbol.</p>
<p>The available options are:</p>
<dl class="rdoc-list note-list"><dt>port
<dd>
<p>Port number (default value is 143 for imap, or 993 for imaps)</p>
</dd><dt>ssl
<dd>
<p>If <a href=":ssl">options</a> is true, then an attempt will be made to use SSL (now TLS) to connect to the server. For this to work <a href="../OpenSSL.html"><code>OpenSSL</code></a> [OSSL] and the Ruby <a href="../OpenSSL.html"><code>OpenSSL</code></a> [RSSL] extensions need to be installed. If <a href=":ssl">options</a> is a hash, it's passed to <a href="../OpenSSL/SSL/SSLContext.html#method-i-set_params"><code>OpenSSL::SSL::SSLContext#set_params</code></a> as parameters.</p>
</dd><dt><a href="IMAP.html#attribute-i-open_timeout"><code>open_timeout</code></a>
<dd>
<p>Seconds to wait until a connection is opened</p>
</dd></dl>
<p>The most common errors are:</p>
<dl class="rdoc-list note-list"><dt>Errno::ECONNREFUSED
<dd>
<p>Connection refused by <code>host</code> or an intervening firewall.</p>
</dd><dt>Errno::ETIMEDOUT
<dd>
<p>Connection timed out (possibly due to packets being dropped by an intervening firewall).</p>
</dd><dt>Errno::ENETUNREACH
<dd>
<p>There is no route to that network.</p>
</dd><dt><a href="../SocketError.html"><code>SocketError</code></a>
<dd>
<p>Hostname not known or other socket error.</p>
</dd><dt><a href="IMAP/ByeResponseError.html"><code>Net::IMAP::ByeResponseError</code></a>
<dd>
<p>The connected to the host was successful, but it immediately said goodbye.</p>
</dd></dl>
<div class="method-calls-super">
Calls superclass method
<a href="../MonitorMixin.html#method-c-new"><code>MonitorMixin::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1071</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port_or_options</span> = {},
<span class="ruby-identifier">usessl</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">certs</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">verify</span> = <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">host</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">port_or_options</span>.<span class="ruby-identifier">to_hash</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>
<span class="ruby-comment"># for backward compatibility</span>
<span class="ruby-identifier">options</span> = {}
<span class="ruby-identifier">options</span>[<span class="ruby-value">:port</span>] = <span class="ruby-identifier">port_or_options</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">usessl</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl</span>] = <span class="ruby-identifier">create_ssl_params</span>(<span class="ruby-identifier">certs</span>, <span class="ruby-identifier">verify</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@port</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:port</span>] <span class="ruby-operator">||</span> (<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl</span>] <span class="ruby-operator">?</span> <span class="ruby-constant">SSL_PORT</span> <span class="ruby-operator">:</span> <span class="ruby-constant">PORT</span>)
<span class="ruby-ivar">@tag_prefix</span> = <span class="ruby-string">"RUBY"</span>
<span class="ruby-ivar">@tagno</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@open_timeout</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:open_timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">30</span>
<span class="ruby-ivar">@parser</span> = <span class="ruby-constant">ResponseParser</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@sock</span> = <span class="ruby-identifier">tcp_socket</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@port</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl</span>]
<span class="ruby-identifier">start_tls_session</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl</span>])
<span class="ruby-ivar">@usessl</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@usessl</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@responses</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>([].<span class="ruby-identifier">freeze</span>)
<span class="ruby-ivar">@tagged_responses</span> = {}
<span class="ruby-ivar">@response_handlers</span> = []
<span class="ruby-ivar">@tagged_response_arrival</span> = <span class="ruby-identifier">new_cond</span>
<span class="ruby-ivar">@continued_command_tag</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@continuation_request_arrival</span> = <span class="ruby-identifier">new_cond</span>
<span class="ruby-ivar">@continuation_request_exception</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@idle_done_cond</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@logout_command_tag</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@debug_output_bol</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@exception</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@greeting</span> = <span class="ruby-identifier">get_response</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@greeting</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Error</span>, <span class="ruby-string">"connection closed"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@greeting</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"BYE"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ByeResponseError</span>, <span class="ruby-ivar">@greeting</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@client_thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
<span class="ruby-ivar">@receiver_thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">start</span> {
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">receive_responses</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-ivar">@receiver_thread_terminating</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">close</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add_response_handler" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_response_handler</span><span
class="method-args">(handler = nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds a response handler. For example, to detect when the server sends a new EXISTS response (which normally indicates new messages being added to the mailbox), add the following handler after selecting the mailbox:</p>
<pre class="ruby"><span class="ruby-identifier">imap</span>.<span class="ruby-identifier">add_response_handler</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">resp</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">IMAP</span><span class="ruby-operator">::</span><span class="ruby-constant">UntaggedResponse</span>) <span class="ruby-keyword">and</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"EXISTS"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Mailbox now has #{resp.data} messages"</span>
<span class="ruby-keyword">end</span>
}
</pre>
<div class="method-source-code" id="add_response_handler-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 906</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_response_handler</span>(<span class="ruby-identifier">handler</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"two Procs are passed"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">handler</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">block</span>
<span class="ruby-ivar">@response_handlers</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">block</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">handler</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-append" class="method-detail ">
<div class="method-heading">
<span class="method-name">append</span><span
class="method-args">(mailbox, message, flags = nil, date_time = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a APPEND command to append the <code>message</code> to the end of the <code>mailbox</code>. The optional <code>flags</code> argument is an array of flags initially passed to the new message. The optional <code>date_time</code> argument specifies the creation time to assign to the new message; it defaults to the current time. For example:</p>
<pre class="ruby"><span class="ruby-identifier">imap</span>.<span class="ruby-identifier">append</span>(<span class="ruby-string">"inbox"</span>, <span class="ruby-identifier"><<EOF</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\n/</span>, <span class="ruby-string">"\r\n"</span>), [<span class="ruby-value">:Seen</span>], <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>)
<span class="ruby-value">Subject: hello
From: shugo@ruby-lang.org
To: shugo@ruby-lang.org
hello world
</span><span class="ruby-identifier">EOF</span>
</pre>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if the mailbox does not exist (it is not created automatically), or if the flags, date_time, or message arguments contain errors.</p>
<div class="method-source-code" id="append-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 699</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append</span>(<span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">flags</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">date_time</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">args</span> = []
<span class="ruby-keyword">if</span> <span class="ruby-identifier">flags</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">date_time</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">date_time</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">push</span>(<span class="ruby-constant">Literal</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>))
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"APPEND"</span>, <span class="ruby-identifier">mailbox</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-authenticate" class="method-detail ">
<div class="method-heading">
<span class="method-name">authenticate</span><span
class="method-args">(auth_type, *args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends an AUTHENTICATE command to authenticate the client. The <code>auth_type</code> parameter is a string that represents the authentication mechanism to be used. Currently <a href="IMAP.html"><code>Net::IMAP</code></a> supports the authentication mechanisms:</p>
<pre>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.</pre>
<p>For both of these mechanisms, there should be two <code>args</code>: username and (cleartext) password. A server may not support one or the other of these mechanisms; check <a href="IMAP.html#method-i-capability"><code>capability()</code></a> for a capability of the form “AUTH=LOGIN” or “AUTH=CRAM-MD5”.</p>
<p>Authentication is done using the appropriate authenticator object: see @@authenticators for more information on plugging in your own authenticator.</p>
<p>For example:</p>
<pre class="ruby"><span class="ruby-identifier">imap</span>.<span class="ruby-identifier">authenticate</span>(<span class="ruby-string">'LOGIN'</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>)
</pre>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if authentication fails.</p>
<div class="method-source-code" id="authenticate-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 417</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">authenticate</span>(<span class="ruby-identifier">auth_type</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">auth_type</span> = <span class="ruby-identifier">auth_type</span>.<span class="ruby-identifier">upcase</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">@@authenticators</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">auth_type</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
<span class="ruby-identifier">format</span>(<span class="ruby-string">'unknown auth type - "%s"'</span>, <span class="ruby-identifier">auth_type</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">authenticator</span> = <span class="ruby-identifier">@@authenticators</span>[<span class="ruby-identifier">auth_type</span>].<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"AUTHENTICATE"</span>, <span class="ruby-identifier">auth_type</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">resp</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">ContinuationRequest</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">authenticator</span>.<span class="ruby-identifier">process</span>(<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">data</span>.<span class="ruby-identifier">text</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">"m"</span>)[<span class="ruby-value">0</span>])
<span class="ruby-identifier">s</span> = [<span class="ruby-identifier">data</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">"m0"</span>)
<span class="ruby-identifier">send_string_data</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-constant">CRLF</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-capability" class="method-detail ">
<div class="method-heading">
<span class="method-name">capability</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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.</p>
<p>Note that the <a href="IMAP.html"><code>Net::IMAP</code></a> 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.</p>
<div class="method-source-code" id="capability-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 359</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">capability</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"CAPABILITY"</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"CAPABILITY"</span>)[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check" class="method-detail ">
<div class="method-heading">
<span class="method-name">check</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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.</p>
<div class="method-source-code" id="check-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 713</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"CHECK"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a CLOSE command to close the currently selected mailbox. The CLOSE command permanently removes from the mailbox all messages that have the Deleted flag set.</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 720</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"CLOSE"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-copy" class="method-detail ">
<div class="method-heading">
<span class="method-name">copy</span><span
class="method-args">(set, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a COPY command to copy the specified message(s) to the end of the specified destination <code>mailbox</code>. The <code>set</code> parameter is a number, an array of numbers, or a <a href="../Range.html"><code>Range</code></a> object. The number is a message sequence number.</p>
<div class="method-source-code" id="copy-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 853</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">copy</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">copy_internal</span>(<span class="ruby-string">"COPY"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create" class="method-detail ">
<div class="method-heading">
<span class="method-name">create</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a CREATE command to create a new <code>mailbox</code>.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if a mailbox with that name cannot be created.</p>
<div class="method-source-code" id="create-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 480</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"CREATE"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a DELETE command to remove the <code>mailbox</code>.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> 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.</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 489</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"DELETE"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-disconnect" class="method-detail ">
<div class="method-heading">
<span class="method-name">disconnect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Disconnects from the server.</p>
<div class="method-source-code" id="disconnect-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 322</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">disconnect</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">disconnected?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-comment"># try to call SSL::SSLSocket#io.</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">io</span>.<span class="ruby-identifier">shutdown</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>
<span class="ruby-comment"># @sock is not an SSL::SSLSocket.</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">shutdown</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOTCONN</span>
<span class="ruby-comment"># ignore `Errno::ENOTCONN: Socket is not connected' on some platforms.</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-ivar">@receiver_thread</span>.<span class="ruby-identifier">raise</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@receiver_thread</span>.<span class="ruby-identifier">join</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-disconnected-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">disconnected?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if disconnected from the server.</p>
<div class="method-source-code" id="disconnected-3F-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 345</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">disconnected?</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">closed?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-examine" class="method-detail ">
<div class="method-heading">
<span class="method-name">examine</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a EXAMINE command to select a <code>mailbox</code> so that messages in the <code>mailbox</code> can be accessed. Behaves the same as <a href="IMAP.html#method-i-select"><code>select()</code></a>, except that the selected <code>mailbox</code> is identified as read-only.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if the mailbox does not exist or is for some reason non-examinable.</p>
<div class="method-source-code" id="examine-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 469</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">examine</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"EXAMINE"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-expunge" class="method-detail ">
<div class="method-heading">
<span class="method-name">expunge</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a EXPUNGE command to permanently remove from the currently selected mailbox all messages that have the Deleted flag set.</p>
<div class="method-source-code" id="expunge-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 726</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expunge</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"EXPUNGE"</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"EXPUNGE"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch</span><span
class="method-args">(set, attr, mod = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a FETCH command to retrieve data associated with a message in the mailbox.</p>
<p>The <code>set</code> parameter is a number or a range between two numbers, or an array of those. The number is a message sequence number, where -1 represents a '*' for use in range notation like 100..-1 being interpreted as '100:*'. Beware that the <code>exclude_end?</code> property of a <a href="../Range.html"><code>Range</code></a> object is ignored, and the contents of a range are independent of the order of the range endpoints as per the protocol specification, so 1…5, 5..1 and 5…1 are all equivalent to 1..5.</p>
<p><code>attr</code> is a list of attributes to fetch; see the documentation for <a href="IMAP.html#FetchData"><code>Net::IMAP::FetchData</code></a> for a list of valid attributes.</p>
<p>The return value is an array of <a href="IMAP.html#FetchData"><code>Net::IMAP::FetchData</code></a> or nil (instead of an empty array) if there is no matching message.</p>
<p>For example:</p>
<pre class="ruby"><span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">6</span><span class="ruby-operator">..</span><span class="ruby-value">8</span>, <span class="ruby-string">"UID"</span>)
<span class="ruby-comment">#=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, \\</span>
<span class="ruby-comment">#<Net::IMAP::FetchData seqno=7, attr={"UID"=>99}>, \\</span>
<span class="ruby-comment">#<Net::IMAP::FetchData seqno=8, attr={"UID"=>100}>]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">6</span>, <span class="ruby-string">"BODY[HEADER.FIELDS (SUBJECT)]"</span>)
<span class="ruby-comment">#=> [#<Net::IMAP::FetchData seqno=6, attr={"BODY[HEADER.FIELDS (SUBJECT)]"=>"Subject: test\r\n\r\n"}>]</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">uid_fetch</span>(<span class="ruby-value">98</span>, [<span class="ruby-string">"RFC822.SIZE"</span>, <span class="ruby-string">"INTERNALDATE"</span>])[<span class="ruby-value">0</span>]
<span class="ruby-identifier">p</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">seqno</span>
<span class="ruby-comment">#=> 6</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">attr</span>[<span class="ruby-string">"RFC822.SIZE"</span>]
<span class="ruby-comment">#=> 611</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">attr</span>[<span class="ruby-string">"INTERNALDATE"</span>]
<span class="ruby-comment">#=> "12-Oct-2000 22:40:59 +0900"</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">attr</span>[<span class="ruby-string">"UID"</span>]
<span class="ruby-comment">#=> 98</span>
</pre>
<div class="method-source-code" id="fetch-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 817</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">mod</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">fetch_internal</span>(<span class="ruby-string">"FETCH"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">mod</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-getacl" class="method-detail ">
<div class="method-heading">
<span class="method-name">getacl</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Send the GETACL command along with a specified <code>mailbox</code>. If this mailbox exists, an array containing objects of <a href="IMAP.html#MailboxACLItem"><code>Net::IMAP::MailboxACLItem</code></a> will be returned.</p>
<div class="method-source-code" id="getacl-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 639</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getacl</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"GETACL"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"ACL"</span>)[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-getquota" class="method-detail ">
<div class="method-heading">
<span class="method-name">getquota</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends the GETQUOTA command along with specified <code>mailbox</code>. If this mailbox exists, then an array containing a <a href="IMAP.html#MailboxQuota"><code>Net::IMAP::MailboxQuota</code></a> object is returned. This command is generally only available to server admin.</p>
<div class="method-source-code" id="getquota-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 603</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getquota</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"GETQUOTA"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"QUOTA"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-getquotaroot" class="method-detail ">
<div class="method-heading">
<span class="method-name">getquotaroot</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends the GETQUOTAROOT command along with the specified <code>mailbox</code>. This command is generally available to both admin and user. If this mailbox exists, it returns an array containing objects of type <a href="IMAP.html#MailboxQuotaRoot"><code>Net::IMAP::MailboxQuotaRoot</code></a> and <a href="IMAP.html#MailboxQuota"><code>Net::IMAP::MailboxQuota</code></a>.</p>
<div class="method-source-code" id="getquotaroot-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 589</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getquotaroot</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"GETQUOTAROOT"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">result</span> = []
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"QUOTAROOT"</span>))
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"QUOTA"</span>))
<span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-idle" class="method-detail ">
<div class="method-heading">
<span class="method-name">idle</span><span
class="method-args">(timeout = nil, &response_handler)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends an IDLE command that waits for notifications of new or expunged messages. Yields responses from the server during the IDLE.</p>
<p>Use <a href="IMAP.html#method-i-idle_done"><code>idle_done()</code></a> to leave IDLE.</p>
<p>If <code>timeout</code> is given, this method returns after <code>timeout</code> seconds passed. <code>timeout</code> can be used for keep-alive. For example, the following code checks the connection for each 60 seconds.</p>
<pre>loop do
imap.idle(60) do |res|
...
end
end</pre>
<div class="method-source-code" id="idle-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 953</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">idle</span>(<span class="ruby-identifier">timeout</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">response_handler</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">LocalJumpError</span>, <span class="ruby-string">"no block given"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">response_handler</span>
<span class="ruby-identifier">response</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">tag</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-value">:net_imap_tag</span>] = <span class="ruby-identifier">generate_tag</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-node">"#{tag} IDLE#{CRLF}"</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">add_response_handler</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">response_handler</span>)
<span class="ruby-ivar">@idle_done_cond</span> = <span class="ruby-identifier">new_cond</span>
<span class="ruby-ivar">@idle_done_cond</span>.<span class="ruby-identifier">wait</span>(<span class="ruby-identifier">timeout</span>)
<span class="ruby-ivar">@idle_done_cond</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@receiver_thread_terminating</span>
<span class="ruby-identifier">raise</span> <span class="ruby-ivar">@exception</span> <span class="ruby-operator">||</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">IMAP</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"connection closed"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@receiver_thread_terminating</span>
<span class="ruby-identifier">remove_response_handler</span>(<span class="ruby-identifier">response_handler</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-node">"DONE#{CRLF}"</span>)
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">get_tagged_response</span>(<span class="ruby-identifier">tag</span>, <span class="ruby-string">"IDLE"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">response</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-idle_done" class="method-detail ">
<div class="method-heading">
<span class="method-name">idle_done</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Leaves IDLE.</p>
<div class="method-source-code" id="idle_done-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 983</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">idle_done</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@idle_done_cond</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">IMAP</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-string">"not during IDLE"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@idle_done_cond</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-list" class="method-detail ">
<div class="method-heading">
<span class="method-name">list</span><span
class="method-args">(refname, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a LIST command, and returns a subset of names from the complete set of all names available to the client. <code>refname</code> provides a context (for instance, a base directory in a directory-based mailbox hierarchy). <code>mailbox</code> specifies a mailbox or (via wildcards) mailboxes under that context. Two wildcards may be used in <code>mailbox</code>: '*', which matches all characters <strong>including</strong> the hierarchy delimiter (for instance, '/' on a UNIX-hosted directory-based mailbox hierarchy); and '%', which matches all characters <strong>except</strong> the hierarchy delimiter.</p>
<p>If <code>refname</code> is empty, <code>mailbox</code> is used directly to determine which mailboxes to match. If <code>mailbox</code> is empty, the root name of <code>refname</code> and the hierarchy delimiter are returned.</p>
<p>The return value is an array of <code>Net::IMAP::MailboxList</code>. For example:</p>
<pre class="ruby"><span class="ruby-identifier">imap</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"foo/bar"</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"foo/baz"</span>)
<span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">list</span>(<span class="ruby-string">""</span>, <span class="ruby-string">"foo/%"</span>)
<span class="ruby-comment">#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\</span>
<span class="ruby-comment">#<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\</span>
<span class="ruby-comment">#<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]</span>
</pre>
<div class="method-source-code" id="list-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 546</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">list</span>(<span class="ruby-identifier">refname</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"LIST"</span>, <span class="ruby-identifier">refname</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"LIST"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-login" class="method-detail ">
<div class="method-heading">
<span class="method-name">login</span><span
class="method-args">(user, password)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a LOGIN command to identify the client and carries the plaintext <code>password</code> authenticating this <code>user</code>. Note that, unlike calling <a href="IMAP.html#method-i-authenticate"><code>authenticate()</code></a> with an <code>auth_type</code> of “LOGIN”, <a href="IMAP.html#method-i-login"><code>login()</code></a> does <strong>not</strong> use the login authenticator.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if authentication fails.</p>
<div class="method-source-code" id="login-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 440</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"LOGIN"</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-logout" class="method-detail ">
<div class="method-heading">
<span class="method-name">logout</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a LOGOUT command to inform the server that the client is done with the connection.</p>
<div class="method-source-code" id="logout-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 373</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"LOGOUT"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-lsub" class="method-detail ">
<div class="method-heading">
<span class="method-name">lsub</span><span
class="method-args">(refname, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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.” <code>refname</code> and <code>mailbox</code> are interpreted as for <a href="IMAP.html#method-i-list"><code>list()</code></a>. The return value is an array of <code>Net::IMAP::MailboxList</code>.</p>
<div class="method-source-code" id="lsub-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 651</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lsub</span>(<span class="ruby-identifier">refname</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"LSUB"</span>, <span class="ruby-identifier">refname</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"LSUB"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-move" class="method-detail ">
<div class="method-heading">
<span class="method-name">move</span><span
class="method-args">(set, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a MOVE command to move the specified message(s) to the end of the specified destination <code>mailbox</code>. The <code>set</code> parameter is a number, an array of numbers, or a <a href="../Range.html"><code>Range</code></a> object. The number is a message sequence number. The <a href="IMAP.html"><code>IMAP</code></a> MOVE extension is described in [RFC-6851].</p>
<div class="method-source-code" id="move-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 867</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">move</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">copy_internal</span>(<span class="ruby-string">"MOVE"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-noop" class="method-detail ">
<div class="method-heading">
<span class="method-name">noop</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a NOOP command to the server. It does nothing.</p>
<div class="method-source-code" id="noop-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 367</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">noop</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"NOOP"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remove_response_handler" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove_response_handler</span><span
class="method-args">(handler)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes the response handler.</p>
<div class="method-source-code" id="remove_response_handler-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 912</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_response_handler</span>(<span class="ruby-identifier">handler</span>)
<span class="ruby-ivar">@response_handlers</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">handler</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rename" class="method-detail ">
<div class="method-heading">
<span class="method-name">rename</span><span
class="method-args">(mailbox, newname)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a RENAME command to change the name of the <code>mailbox</code> to <code>newname</code>.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if a mailbox with the name <code>mailbox</code> cannot be renamed to <code>newname</code> for whatever reason; for instance, because <code>mailbox</code> does not exist, or because there is already a mailbox with the name <code>newname</code>.</p>
<div class="method-source-code" id="rename-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 500</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rename</span>(<span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">newname</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"RENAME"</span>, <span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">newname</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search" class="method-detail ">
<div class="method-heading">
<span class="method-name">search</span><span
class="method-args">(keys, charset = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a SEARCH command to search the mailbox for messages that match the given searching criteria, and returns message sequence numbers. <code>keys</code> 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.</p>
<dl class="rdoc-list note-list"><dt><message set>
<dd>
<p>a set of message sequence numbers. ',' indicates an interval, ':' indicates a range. For instance, '2,10:12,15' means “2,10,11,12,15”.</p>
</dd><dt>BEFORE <date>
<dd>
<p>messages with an internal date strictly before <date>. The date argument has a format similar to 8-Aug-2002.</p>
</dd><dt>BODY <string>
<dd>
<p>messages that contain <string> within their body.</p>
</dd><dt>CC <string>
<dd>
<p>messages containing <string> in their CC field.</p>
</dd><dt>FROM <string>
<dd>
<p>messages that contain <string> in their FROM field.</p>
</dd><dt>NEW
<dd>
<p>messages with the Recent, but not the Seen, flag set.</p>
</dd><dt>NOT <search-key>
<dd>
<p>negate the following search key.</p>
</dd><dt>OR <search-key> <search-key>
<dd>
<p>“or” two search keys together.</p>
</dd><dt>ON <date>
<dd>
<p>messages with an internal date exactly equal to <date>, which has a format similar to 8-Aug-2002.</p>
</dd><dt>SINCE <date>
<dd>
<p>messages with an internal date on or after <date>.</p>
</dd><dt>SUBJECT <string>
<dd>
<p>messages with <string> in their subject.</p>
</dd><dt>TO <string>
<dd>
<p>messages with <string> in their TO field.</p>
</dd></dl>
<p>For example:</p>
<pre class="ruby"><span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">search</span>([<span class="ruby-string">"SUBJECT"</span>, <span class="ruby-string">"hello"</span>, <span class="ruby-string">"NOT"</span>, <span class="ruby-string">"NEW"</span>])
<span class="ruby-comment">#=> [1, 6, 7, 8]</span>
</pre>
<div class="method-source-code" id="search-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 773</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-identifier">keys</span>, <span class="ruby-identifier">charset</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">search_internal</span>(<span class="ruby-string">"SEARCH"</span>, <span class="ruby-identifier">keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-select" class="method-detail ">
<div class="method-heading">
<span class="method-name">select</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a SELECT command to select a <code>mailbox</code> so that messages in the <code>mailbox</code> can be accessed.</p>
<p>After you have selected a mailbox, you may retrieve the number of items in that mailbox from @<a href=""EXISTS"">responses</a>[-1], and the number of recent messages from @<a href=""RECENT"">responses</a>[-1]. Note that these values can change if new messages arrive during a session; see <a href="IMAP.html#method-i-add_response_handler"><code>add_response_handler()</code></a> for a way of detecting this event.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if the mailbox does not exist or is for some reason non-selectable.</p>
<div class="method-source-code" id="select-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 456</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">select</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"SELECT"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setacl" class="method-detail ">
<div class="method-heading">
<span class="method-name">setacl</span><span
class="method-args">(mailbox, user, rights)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends the SETACL command along with <code>mailbox</code>, <code>user</code> and the <code>rights</code> that user is to have on that mailbox. If <code>rights</code> is nil, then that user will be stripped of any rights to that mailbox. The <a href="IMAP.html"><code>IMAP</code></a> <a href="../ACL.html"><code>ACL</code></a> commands are described in [RFC-2086].</p>
<div class="method-source-code" id="setacl-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 628</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setacl</span>(<span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">rights</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">rights</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"SETACL"</span>, <span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">user</span>, <span class="ruby-string">""</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"SETACL"</span>, <span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">rights</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setquota" class="method-detail ">
<div class="method-heading">
<span class="method-name">setquota</span><span
class="method-args">(mailbox, quota)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a SETQUOTA command along with the specified <code>mailbox</code> and <code>quota</code>. If <code>quota</code> is nil, then <code>quota</code> will be unset for that mailbox. Typically one needs to be logged in as a server admin for this to work. The <a href="IMAP.html"><code>IMAP</code></a> quota commands are described in [RFC-2087].</p>
<div class="method-source-code" id="setquota-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 615</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setquota</span>(<span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">quota</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">quota</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">data</span> = <span class="ruby-string">'()'</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">data</span> = <span class="ruby-string">'(STORAGE '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">quota</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">')'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"SETQUOTA"</span>, <span class="ruby-identifier">mailbox</span>, <span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">data</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sort" class="method-detail ">
<div class="method-heading">
<span class="method-name">sort</span><span
class="method-args">(sort_keys, search_keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a SORT command to sort messages in the mailbox. Returns an array of message sequence numbers. For example:</p>
<pre class="ruby"><span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">sort</span>([<span class="ruby-string">"FROM"</span>], [<span class="ruby-string">"ALL"</span>], <span class="ruby-string">"US-ASCII"</span>)
<span class="ruby-comment">#=> [1, 2, 3, 5, 6, 7, 8, 4, 9]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">sort</span>([<span class="ruby-string">"DATE"</span>], [<span class="ruby-string">"SUBJECT"</span>, <span class="ruby-string">"hello"</span>], <span class="ruby-string">"US-ASCII"</span>)
<span class="ruby-comment">#=> [6, 7, 8, 1]</span>
</pre>
<p>See [SORT-THREAD-EXT] for more details.</p>
<div class="method-source-code" id="sort-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 885</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort</span>(<span class="ruby-identifier">sort_keys</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">sort_internal</span>(<span class="ruby-string">"SORT"</span>, <span class="ruby-identifier">sort_keys</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-starttls" class="method-detail ">
<div class="method-heading">
<span class="method-name">starttls</span><span
class="method-args">(options = {}, verify = true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a STARTTLS command to start TLS session.</p>
<div class="method-source-code" id="starttls-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 378</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">starttls</span>(<span class="ruby-identifier">options</span> = {}, <span class="ruby-identifier">verify</span> = <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"STARTTLS"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">resp</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">TaggedResponse</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"OK"</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-comment"># for backward compatibility</span>
<span class="ruby-identifier">certs</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">to_str</span>
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">create_ssl_params</span>(<span class="ruby-identifier">certs</span>, <span class="ruby-identifier">verify</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">start_tls_session</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-status" class="method-detail ">
<div class="method-heading">
<span class="method-name">status</span><span
class="method-args">(mailbox, attr)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a STATUS command, and returns the status of the indicated <code>mailbox</code>. <code>attr</code> is a list of one or more attributes whose statuses are to be requested. Supported attributes include:</p>
<pre>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.</pre>
<p>The return value is a hash of attributes. For example:</p>
<pre class="ruby"><span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">status</span>(<span class="ruby-string">"inbox"</span>, [<span class="ruby-string">"MESSAGES"</span>, <span class="ruby-string">"RECENT"</span>])
<span class="ruby-comment">#=> {"RECENT"=>0, "MESSAGES"=>44}</span>
</pre>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if status values for <code>mailbox</code> cannot be returned; for instance, because it does not exist.</p>
<div class="method-source-code" id="status-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 674</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">status</span>(<span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">attr</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"STATUS"</span>, <span class="ruby-identifier">mailbox</span>, <span class="ruby-identifier">attr</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"STATUS"</span>)[<span class="ruby-value">-1</span>].<span class="ruby-identifier">attr</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-store" class="method-detail ">
<div class="method-heading">
<span class="method-name">store</span><span
class="method-args">(set, attr, flags)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a STORE command to alter data associated with messages in the mailbox, in particular their flags. The <code>set</code> parameter is a number, an array of numbers, or a <a href="../Range.html"><code>Range</code></a> object. Each number is a message sequence number. <code>attr</code> is the name of a data item to store: 'FLAGS' will replace the message's flag list with the provided one, '+FLAGS' will add the provided flags, and '-FLAGS' will remove them. <code>flags</code> is a list of flags.</p>
<p>The return value is an array of <a href="IMAP.html#FetchData"><code>Net::IMAP::FetchData</code></a>. For example:</p>
<pre class="ruby"><span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">store</span>(<span class="ruby-value">6</span><span class="ruby-operator">..</span><span class="ruby-value">8</span>, <span class="ruby-string">"+FLAGS"</span>, [<span class="ruby-value">:Deleted</span>])
<span class="ruby-comment">#=> [#<Net::IMAP::FetchData seqno=6, attr={"FLAGS"=>[:Seen, :Deleted]}>, \\</span>
<span class="ruby-comment">#<Net::IMAP::FetchData seqno=7, attr={"FLAGS"=>[:Seen, :Deleted]}>, \\</span>
<span class="ruby-comment">#<Net::IMAP::FetchData seqno=8, attr={"FLAGS"=>[:Seen, :Deleted]}>]</span>
</pre>
<div class="method-source-code" id="store-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 840</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">store</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">store_internal</span>(<span class="ruby-string">"STORE"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-subscribe" class="method-detail ">
<div class="method-heading">
<span class="method-name">subscribe</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a SUBSCRIBE command to add the specified <code>mailbox</code> name to the server's set of “active” or “subscribed” mailboxes as returned by <a href="IMAP.html#method-i-lsub"><code>lsub()</code></a>.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if <code>mailbox</code> cannot be subscribed to; for instance, because it does not exist.</p>
<div class="method-source-code" id="subscribe-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 510</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subscribe</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"SUBSCRIBE"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-thread" class="method-detail ">
<div class="method-heading">
<span class="method-name">thread</span><span
class="method-args">(algorithm, search_keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-search"><code>search()</code></a>, but returns message sequence numbers in threaded format, as a <a href="IMAP.html#ThreadMember"><code>Net::IMAP::ThreadMember</code></a> tree. The supported algorithms are:</p>
<dl class="rdoc-list note-list"><dt>ORDEREDSUBJECT
<dd>
<p>split into single-level threads according to subject, ordered by date.</p>
</dd><dt>REFERENCES
<dd>
<p>split into threads by parent/child relationships determined by which message is a reply to which.</p>
</dd></dl>
<p>Unlike <a href="IMAP.html#method-i-search"><code>search()</code></a>, <code>charset</code> is a required argument. US-ASCII and UTF-8 are sample values.</p>
<p>See [SORT-THREAD-EXT] for more details.</p>
<div class="method-source-code" id="thread-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 929</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">thread</span>(<span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">thread_internal</span>(<span class="ruby-string">"THREAD"</span>, <span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_copy" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_copy</span><span
class="method-args">(set, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-copy"><code>copy()</code></a>, but <code>set</code> contains unique identifiers.</p>
<div class="method-source-code" id="uid_copy-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 858</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_copy</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">copy_internal</span>(<span class="ruby-string">"UID COPY"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_fetch" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_fetch</span><span
class="method-args">(set, attr, mod = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-fetch"><code>fetch()</code></a>, but <code>set</code> contains unique identifiers.</p>
<div class="method-source-code" id="uid_fetch-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 822</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_fetch</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">mod</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">fetch_internal</span>(<span class="ruby-string">"UID FETCH"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">mod</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_move" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_move</span><span
class="method-args">(set, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-move"><code>move()</code></a>, but <code>set</code> contains unique identifiers.</p>
<div class="method-source-code" id="uid_move-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 872</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_move</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">copy_internal</span>(<span class="ruby-string">"UID MOVE"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_search" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_search</span><span
class="method-args">(keys, charset = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-search"><code>search()</code></a>, but returns unique identifiers.</p>
<div class="method-source-code" id="uid_search-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 778</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_search</span>(<span class="ruby-identifier">keys</span>, <span class="ruby-identifier">charset</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">search_internal</span>(<span class="ruby-string">"UID SEARCH"</span>, <span class="ruby-identifier">keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_sort" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_sort</span><span
class="method-args">(sort_keys, search_keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-sort"><code>sort()</code></a>, but returns an array of unique identifiers.</p>
<div class="method-source-code" id="uid_sort-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 890</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_sort</span>(<span class="ruby-identifier">sort_keys</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">sort_internal</span>(<span class="ruby-string">"UID SORT"</span>, <span class="ruby-identifier">sort_keys</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_store" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_store</span><span
class="method-args">(set, attr, flags)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-store"><code>store()</code></a>, but <code>set</code> contains unique identifiers.</p>
<div class="method-source-code" id="uid_store-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 845</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_store</span>(<span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">store_internal</span>(<span class="ruby-string">"UID STORE"</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uid_thread" class="method-detail ">
<div class="method-heading">
<span class="method-name">uid_thread</span><span
class="method-args">(algorithm, search_keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Similar to <a href="IMAP.html#method-i-thread"><code>thread()</code></a>, but returns unique identifiers instead of message sequence numbers.</p>
<div class="method-source-code" id="uid_thread-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 935</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uid_thread</span>(<span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">thread_internal</span>(<span class="ruby-string">"UID THREAD"</span>, <span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unsubscribe" class="method-detail ">
<div class="method-heading">
<span class="method-name">unsubscribe</span><span
class="method-args">(mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a UNSUBSCRIBE command to remove the specified <code>mailbox</code> name from the server's set of “active” or “subscribed” mailboxes.</p>
<p>A <a href="IMAP/NoResponseError.html"><code>Net::IMAP::NoResponseError</code></a> is raised if <code>mailbox</code> cannot be unsubscribed from; for instance, because the client is not currently subscribed to it.</p>
<div class="method-source-code" id="unsubscribe-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 520</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unsubscribe</span>(<span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"UNSUBSCRIBE"</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-xlist" class="method-detail ">
<div class="method-heading">
<span class="method-name">xlist</span><span
class="method-args">(refname, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a XLIST command, and returns a subset of names from the complete set of all names available to the client. <code>refname</code> provides a context (for instance, a base directory in a directory-based mailbox hierarchy). <code>mailbox</code> specifies a mailbox or (via wildcards) mailboxes under that context. Two wildcards may be used in <code>mailbox</code>: '*', which matches all characters <strong>including</strong> the hierarchy delimiter (for instance, '/' on a UNIX-hosted directory-based mailbox hierarchy); and '%', which matches all characters <strong>except</strong> the hierarchy delimiter.</p>
<p>If <code>refname</code> is empty, <code>mailbox</code> is used directly to determine which mailboxes to match. If <code>mailbox</code> is empty, the root name of <code>refname</code> and the hierarchy delimiter are returned.</p>
<p>The XLIST command is like the LIST command except that the flags returned refer to the function of the folder/mailbox, e.g. :Sent</p>
<p>The return value is an array of <code>Net::IMAP::MailboxList</code>. For example:</p>
<pre class="ruby"><span class="ruby-identifier">imap</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"foo/bar"</span>)
<span class="ruby-identifier">imap</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"foo/baz"</span>)
<span class="ruby-identifier">p</span> <span class="ruby-identifier">imap</span>.<span class="ruby-identifier">xlist</span>(<span class="ruby-string">""</span>, <span class="ruby-string">"foo/%"</span>)
<span class="ruby-comment">#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\</span>
<span class="ruby-comment">#<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\</span>
<span class="ruby-comment">#<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]</span>
</pre>
<div class="method-source-code" id="xlist-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 578</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xlist</span>(<span class="ruby-identifier">refname</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-string">"XLIST"</span>, <span class="ruby-identifier">refname</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"XLIST"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-copy_internal" class="method-detail ">
<div class="method-heading">
<span class="method-name">copy_internal</span><span
class="method-args">(cmd, set, mailbox)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="copy_internal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1461</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">copy_internal</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">mailbox</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-constant">MessageSet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">set</span>), <span class="ruby-identifier">mailbox</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create_ssl_params" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_ssl_params</span><span
class="method-args">(certs = nil, verify = true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_ssl_params-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1500</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_ssl_params</span>(<span class="ruby-identifier">certs</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">verify</span> = <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">params</span> = {}
<span class="ruby-keyword">if</span> <span class="ruby-identifier">certs</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">certs</span>)
<span class="ruby-identifier">params</span>[<span class="ruby-value">:ca_file</span>] = <span class="ruby-identifier">certs</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">certs</span>)
<span class="ruby-identifier">params</span>[<span class="ruby-value">:ca_path</span>] = <span class="ruby-identifier">certs</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">verify</span>
<span class="ruby-identifier">params</span>[<span class="ruby-value">:verify_mode</span>] = <span class="ruby-constant">VERIFY_PEER</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">params</span>[<span class="ruby-value">:verify_mode</span>] = <span class="ruby-constant">VERIFY_NONE</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">params</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_internal" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_internal</span><span
class="method-args">(cmd, set, attr, mod = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fetch_internal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1429</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_internal</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">mod</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">attr</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">attr</span> = <span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">attr</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">attr</span> = <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">arg</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">arg</span>
}
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"FETCH"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">mod</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-constant">MessageSet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">set</span>), <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">mod</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-constant">MessageSet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">set</span>), <span class="ruby-identifier">attr</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"FETCH"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-generate_tag" class="method-detail ">
<div class="method-heading">
<span class="method-name">generate_tag</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="generate_tag-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1285</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">generate_tag</span>
<span class="ruby-ivar">@tagno</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">format</span>(<span class="ruby-string">"%s%04d"</span>, <span class="ruby-ivar">@tag_prefix</span>, <span class="ruby-ivar">@tagno</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_response" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_response</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_response-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1230</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_response</span>
<span class="ruby-identifier">buff</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">s</span> = <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">gets</span>(<span class="ruby-constant">CRLF</span>)
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">s</span>
<span class="ruby-identifier">buff</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\{(\d+)\}\r\n/n</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">s</span>
<span class="ruby-identifier">s</span> = <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">read</span>(<span class="ruby-node">$1</span>.<span class="ruby-identifier">to_i</span>)
<span class="ruby-identifier">buff</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">buff</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">@@debug</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">buff</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^/n</span>, <span class="ruby-string">"S: "</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">buff</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_tagged_response" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_tagged_response</span><span
class="method-args">(tag, cmd)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_tagged_response-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1212</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_tagged_response</span>(<span class="ruby-identifier">tag</span>, <span class="ruby-identifier">cmd</span>)
<span class="ruby-keyword">until</span> <span class="ruby-ivar">@tagged_responses</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">tag</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-ivar">@exception</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@exception</span>
<span class="ruby-ivar">@tagged_response_arrival</span>.<span class="ruby-identifier">wait</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">resp</span> = <span class="ruby-ivar">@tagged_responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A(?:OK)\z/ni</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">resp</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A(?:NO)\z/ni</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NoResponseError</span>, <span class="ruby-identifier">resp</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A(?:BAD)\z/ni</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">BadResponseError</span>, <span class="ruby-identifier">resp</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownResponseError</span>, <span class="ruby-identifier">resp</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-normalize_searching_criteria" class="method-detail ">
<div class="method-heading">
<span class="method-name">normalize_searching_criteria</span><span
class="method-args">(keys)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="normalize_searching_criteria-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1489</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">normalize_searching_criteria</span>(<span class="ruby-identifier">keys</span>)
<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">collect!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">i</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">-1</span>, <span class="ruby-constant">Range</span>, <span class="ruby-constant">Array</span>
<span class="ruby-constant">MessageSet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">i</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">i</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-put_string" class="method-detail ">
<div class="method-heading">
<span class="method-name">put_string</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="put_string-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1290</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put_string</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">@@debug</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@debug_output_bol</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span>(<span class="ruby-string">"C: "</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\n(?!\z)/n</span>, <span class="ruby-string">"\nC: "</span>))
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\r\n\z/n</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-ivar">@debug_output_bol</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@debug_output_bol</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-receive_responses" class="method-detail ">
<div class="method-heading">
<span class="method-name">receive_responses</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="receive_responses-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1141</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">receive_responses</span>
<span class="ruby-identifier">connection_closed</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">until</span> <span class="ruby-identifier">connection_closed</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@exception</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">resp</span> = <span class="ruby-identifier">get_response</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">close</span>
<span class="ruby-ivar">@exception</span> = <span class="ruby-identifier">e</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">resp</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@exception</span> = <span class="ruby-constant">EOFError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"end of file reached"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">resp</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">TaggedResponse</span>
<span class="ruby-ivar">@tagged_responses</span>[<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">tag</span>] = <span class="ruby-identifier">resp</span>
<span class="ruby-ivar">@tagged_response_arrival</span>.<span class="ruby-identifier">broadcast</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">tag</span>
<span class="ruby-keyword">when</span> <span class="ruby-ivar">@logout_command_tag</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">when</span> <span class="ruby-ivar">@continued_command_tag</span>
<span class="ruby-ivar">@continuation_request_exception</span> =
<span class="ruby-constant">RESPONSE_ERRORS</span>[<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">name</span>].<span class="ruby-identifier">new</span>(<span class="ruby-identifier">resp</span>)
<span class="ruby-ivar">@continuation_request_arrival</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">UntaggedResponse</span>
<span class="ruby-identifier">record_response</span>(<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">data</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">ResponseText</span>) <span class="ruby-operator">&&</span>
(<span class="ruby-identifier">code</span> = <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">data</span>.<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">record_response</span>(<span class="ruby-identifier">code</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">code</span>.<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"BYE"</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@logout_command_tag</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">close</span>
<span class="ruby-ivar">@exception</span> = <span class="ruby-constant">ByeResponseError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">resp</span>)
<span class="ruby-identifier">connection_closed</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">ContinuationRequest</span>
<span class="ruby-ivar">@continuation_request_arrival</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@response_handlers</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">handler</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">handler</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">resp</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-ivar">@exception</span> = <span class="ruby-identifier">e</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@tagged_response_arrival</span>.<span class="ruby-identifier">broadcast</span>
<span class="ruby-ivar">@continuation_request_arrival</span>.<span class="ruby-identifier">broadcast</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@receiver_thread_terminating</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@tagged_response_arrival</span>.<span class="ruby-identifier">broadcast</span>
<span class="ruby-ivar">@continuation_request_arrival</span>.<span class="ruby-identifier">broadcast</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@idle_done_cond</span>
<span class="ruby-ivar">@idle_done_cond</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-record_response" class="method-detail ">
<div class="method-heading">
<span class="method-name">record_response</span><span
class="method-args">(name, data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="record_response-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1250</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">record_response</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">data</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@responses</span>[<span class="ruby-identifier">name</span>] = []
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@responses</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">push</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search_internal" class="method-detail ">
<div class="method-heading">
<span class="method-name">search_internal</span><span
class="method-args">(cmd, keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="search_internal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1413</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_internal</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">keys</span> = [<span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">keys</span>)]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">normalize_searching_criteria</span>(<span class="ruby-identifier">keys</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">charset</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-string">"CHARSET"</span>, <span class="ruby-identifier">charset</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">keys</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">keys</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"SEARCH"</span>)[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_command" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_command</span><span
class="method-args">(cmd, *args, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_command-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1257</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">validate_data</span>(<span class="ruby-identifier">i</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">tag</span> = <span class="ruby-identifier">generate_tag</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-identifier">tag</span> <span class="ruby-operator">+</span> <span class="ruby-string">" "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">cmd</span>)
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">" "</span>)
<span class="ruby-identifier">send_data</span>(<span class="ruby-identifier">i</span>, <span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-constant">CRLF</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">cmd</span> <span class="ruby-operator">==</span> <span class="ruby-string">"LOGOUT"</span>
<span class="ruby-ivar">@logout_command_tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">add_response_handler</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_tagged_response</span>(<span class="ruby-identifier">tag</span>, <span class="ruby-identifier">cmd</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">remove_response_handler</span>(<span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_data</span><span
class="method-args">(data, tag = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1326</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_data</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">tag</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">"NIL"</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">send_string_data</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Integer</span>
<span class="ruby-identifier">send_number_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-identifier">send_list_data</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Time</span>
<span class="ruby-identifier">send_time_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Symbol</span>
<span class="ruby-identifier">send_symbol_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">send_data</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_list_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_list_data</span><span
class="method-args">(list, tag = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_list_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1385</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_list_data</span>(<span class="ruby-identifier">list</span>, <span class="ruby-identifier">tag</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">"("</span>)
<span class="ruby-identifier">first</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">first</span>
<span class="ruby-identifier">first</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">" "</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">send_data</span>(<span class="ruby-identifier">i</span>, <span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">")"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_literal" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_literal</span><span
class="method-args">(str, tag = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_literal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1364</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_literal</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">tag</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">"{"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">bytesize</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">"}"</span> <span class="ruby-operator">+</span> <span class="ruby-constant">CRLF</span>)
<span class="ruby-ivar">@continued_command_tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-ivar">@continuation_request_exception</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@continuation_request_arrival</span>.<span class="ruby-identifier">wait</span>
<span class="ruby-identifier">e</span> = <span class="ruby-ivar">@continuation_request_exception</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@exception</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-ivar">@continued_command_tag</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@continuation_request_exception</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_number_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_number_data</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_number_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1381</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_number_data</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-identifier">num</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_quoted_string" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_quoted_string</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_quoted_string-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1360</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_quoted_string</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">'"'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/["\\]/n</span>, <span class="ruby-string">"\\\\\\&"</span>) <span class="ruby-operator">+</span> <span class="ruby-string">'"'</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_string_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_string_data</span><span
class="method-args">(str, tag = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_string_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1345</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_string_data</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">tag</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">str</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">""</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">'""'</span>)
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/[\x80-\xff\r\n]/n</span>
<span class="ruby-comment"># literal</span>
<span class="ruby-identifier">send_literal</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">tag</span>)
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/[(){ \x00-\x1f\x7f%*"\\]/n</span>
<span class="ruby-comment"># quoted string</span>
<span class="ruby-identifier">send_quoted_string</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">put_string</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_symbol_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_symbol_data</span><span
class="method-args">(symbol)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_symbol_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1409</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_symbol_data</span>(<span class="ruby-identifier">symbol</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-string">"\\"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">symbol</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_time_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_time_data</span><span
class="method-args">(time)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_time_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1401</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_time_data</span>(<span class="ruby-identifier">time</span>)
<span class="ruby-identifier">t</span> = <span class="ruby-identifier">time</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">gmtime</span>
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">format</span>(<span class="ruby-string">'"%2d-%3s-%4d %02d:%02d:%02d +0000"'</span>,
<span class="ruby-identifier">t</span>.<span class="ruby-identifier">day</span>, <span class="ruby-constant">DATE_MONTH</span>[<span class="ruby-identifier">t</span>.<span class="ruby-identifier">month</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>], <span class="ruby-identifier">t</span>.<span class="ruby-identifier">year</span>,
<span class="ruby-identifier">t</span>.<span class="ruby-identifier">hour</span>, <span class="ruby-identifier">t</span>.<span class="ruby-identifier">min</span>, <span class="ruby-identifier">t</span>.<span class="ruby-identifier">sec</span>)
<span class="ruby-identifier">put_string</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sort_internal" class="method-detail ">
<div class="method-heading">
<span class="method-name">sort_internal</span><span
class="method-args">(cmd, sort_keys, search_keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="sort_internal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1465</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_internal</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">sort_keys</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">search_keys</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">search_keys</span> = [<span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">search_keys</span>)]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">normalize_searching_criteria</span>(<span class="ruby-identifier">search_keys</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">normalize_searching_criteria</span>(<span class="ruby-identifier">search_keys</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">sort_keys</span>, <span class="ruby-identifier">charset</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">search_keys</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"SORT"</span>)[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start_tls_session" class="method-detail ">
<div class="method-heading">
<span class="method-name">start_tls_session</span><span
class="method-args">(params = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="start_tls_session-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1517</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_tls_session</span>(<span class="ruby-identifier">params</span> = {})
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-string">"SSL extension not installed"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLSocket</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-string">"already using SSL"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">to_hash</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>
<span class="ruby-identifier">params</span> = {}
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">context</span> = <span class="ruby-constant">SSLContext</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">context</span>.<span class="ruby-identifier">set_params</span>(<span class="ruby-identifier">params</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">VerifyCallbackProc</span>)
<span class="ruby-identifier">context</span>.<span class="ruby-identifier">verify_callback</span> = <span class="ruby-constant">VerifyCallbackProc</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@sock</span> = <span class="ruby-constant">SSLSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@sock</span>, <span class="ruby-identifier">context</span>)
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">sync_close</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">hostname</span> = <span class="ruby-ivar">@host</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:hostname=</span>
<span class="ruby-identifier">ssl_socket_connect</span>(<span class="ruby-ivar">@sock</span>, <span class="ruby-ivar">@open_timeout</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">context</span>.<span class="ruby-identifier">verify_mode</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">VERIFY_NONE</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">post_connection_check</span>(<span class="ruby-ivar">@host</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-store_internal" class="method-detail ">
<div class="method-heading">
<span class="method-name">store_internal</span><span
class="method-args">(cmd, set, attr, flags)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="store_internal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1450</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">store_internal</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">set</span>, <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">attr</span> = <span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">attr</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"FETCH"</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-constant">MessageSet</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">set</span>), <span class="ruby-identifier">attr</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"FETCH"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tcp_socket" class="method-detail ">
<div class="method-heading">
<span class="method-name">tcp_socket</span><span
class="method-args">(host, port)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="tcp_socket-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tcp_socket</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>)
<span class="ruby-identifier">s</span> = <span class="ruby-constant">Socket</span>.<span class="ruby-identifier">tcp</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>, <span class="ruby-value">:connect_timeout</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@open_timeout</span>)
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">setsockopt</span>(<span class="ruby-value">:SOL_SOCKET</span>, <span class="ruby-value">:SO_KEEPALIVE</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">s</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ETIMEDOUT</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">OpenTimeout</span>, <span class="ruby-string">"Timeout to open TCP connection to "</span> <span class="ruby-operator">+</span>
<span class="ruby-node">"#{host}:#{port} (exceeds #{@open_timeout} seconds)"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-thread_internal" class="method-detail ">
<div class="method-heading">
<span class="method-name">thread_internal</span><span
class="method-args">(cmd, algorithm, search_keys, charset)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="thread_internal-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1478</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">thread_internal</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">search_keys</span>, <span class="ruby-identifier">charset</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">search_keys</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">search_keys</span> = [<span class="ruby-constant">RawData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">search_keys</span>)]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">normalize_searching_criteria</span>(<span class="ruby-identifier">search_keys</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">normalize_searching_criteria</span>(<span class="ruby-identifier">search_keys</span>)
<span class="ruby-identifier">send_command</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">charset</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">search_keys</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@responses</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"THREAD"</span>)[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-validate_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">validate_data</span><span
class="method-args">(data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="validate_data-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1305</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Integer</span>
<span class="ruby-constant">NumValidator</span>.<span class="ruby-identifier">ensure_number</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'CHANGEDSINCE'</span>
<span class="ruby-constant">NumValidator</span>.<span class="ruby-identifier">ensure_mod_sequence_value</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value">1</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">validate_data</span>(<span class="ruby-identifier">i</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Time</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Symbol</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">validate</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>