File: C:/Ruby27-x64/share/doc/ruby/html/Net/POPMail.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::POPMail - 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 id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-all">#all</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-delete-21">#delete!</a>
<li ><a href="#method-i-deleted-3F">#deleted?</a>
<li ><a href="#method-i-header">#header</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-mail">#mail</a>
<li ><a href="#method-i-pop">#pop</a>
<li ><a href="#method-i-top">#top</a>
<li ><a href="#method-i-uidl">#uidl</a>
<li ><a href="#method-i-unique_id">#unique_id</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::POPMail">
<h1 id="class-Net::POPMail" class="class">
class Net::POPMail
</h1>
<section class="description">
<p>This class represents a message which exists on the POP server. Instances of this class are created by the <a href="POP3.html"><code>POP3</code></a> class; they should not be directly created by the user.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-length" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">length</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The length of the message in octets.</p>
</div>
</div>
<div id="attribute-i-number" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">number</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The sequence number of the message on the server.</p>
</div>
</div>
<div id="attribute-i-size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The length of the message in octets.</p>
</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-all" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">all</span><span
class="method-args">( dest = +'' )</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="POPMail.html#method-i-pop">pop</a>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Marks a message for deletion on the server. Deletion does not actually occur until the end of the session; deletion may be cancelled for <em>all</em> marked messages by calling <a href="POP3.html#method-i-reset"><code>POP3#reset()</code></a>.</p>
<p>This method raises a <a href="POPError.html"><code>POPError</code></a> if an error occurs.</p>
<h3 id="method-i-delete-label-Example">Example<span><a href="#method-i-delete-label-Example">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-constant">POP3</span>.<span class="ruby-identifier">start</span>(<span class="ruby-string">'pop.example.com'</span>, <span class="ruby-value">110</span>,
<span class="ruby-string">'YourAccount'</span>, <span class="ruby-string">'YourPassword'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pop</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">n</span> = <span class="ruby-value">1</span>
<span class="ruby-identifier">pop</span>.<span class="ruby-identifier">mails</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">popmail</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"inbox/#{n}"</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">popmail</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">popmail</span>.<span class="ruby-identifier">delete</span> <span class="ruby-comment">####</span>
<span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 859</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>
<span class="ruby-ivar">@command</span>.<span class="ruby-identifier">dele</span> <span class="ruby-ivar">@number</span>
<span class="ruby-ivar">@deleted</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="POPMail.html#method-i-delete-21">delete!</a>
</div>
</div>
<div id="method-i-delete-21" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">delete!</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="POPMail.html#method-i-delete">delete</a>
</div>
</div>
<div id="method-i-deleted-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">deleted?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>True if the mail has been deleted.</p>
<div class="method-source-code" id="deleted-3F-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 867</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deleted?</span>
<span class="ruby-ivar">@deleted</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-header" class="method-detail ">
<div class="method-heading">
<span class="method-name">header</span><span
class="method-args">(dest = +'')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetches the message header.</p>
<p>The optional <code>dest</code> argument is obsolete.</p>
<p>This method raises a <a href="POPError.html"><code>POPError</code></a> if an error occurs.</p>
<div class="method-source-code" id="header-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 835</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header</span>(<span class="ruby-identifier">dest</span> = <span class="ruby-string">+''</span>)
<span class="ruby-identifier">top</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">dest</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Provide human-readable stringification of class state.</p>
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 761</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>
<span class="ruby-node">+"#<#{self.class} #{@number}#{@deleted ? ' deleted' : ''}>"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mail" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">mail</span><span
class="method-args">( dest = +'' )</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="POPMail.html#method-i-pop">pop</a>
</div>
</div>
<div id="method-i-pop" class="method-detail ">
<div class="method-heading">
<span class="method-name">pop</span><span
class="method-args">( dest = +'' ) { |message_chunk| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This method fetches the message. If called with a block, the message is yielded to the block one chunk at a time. If called without a block, the message is returned as a <a href="../String.html"><code>String</code></a>. The optional <code>dest</code> argument will be prepended to the returned <a href="../String.html"><code>String</code></a>; this argument is essentially obsolete.</p>
<h3 id="method-i-pop-label-Example+without+block">Example without block<span><a href="#method-i-pop-label-Example+without+block">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-constant">POP3</span>.<span class="ruby-identifier">start</span>(<span class="ruby-string">'pop.example.com'</span>, <span class="ruby-value">110</span>,
<span class="ruby-string">'YourAccount'</span>, <span class="ruby-string">'YourPassword'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pop</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">n</span> = <span class="ruby-value">1</span>
<span class="ruby-identifier">pop</span>.<span class="ruby-identifier">mails</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">popmail</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"inbox/#{n}"</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">popmail</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">popmail</span>.<span class="ruby-identifier">delete</span>
<span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<h3 id="method-i-pop-label-Example+with+block">Example with block<span><a href="#method-i-pop-label-Example+with+block">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-constant">POP3</span>.<span class="ruby-identifier">start</span>(<span class="ruby-string">'pop.example.com'</span>, <span class="ruby-value">110</span>,
<span class="ruby-string">'YourAccount'</span>, <span class="ruby-string">'YourPassword'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pop</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">n</span> = <span class="ruby-value">1</span>
<span class="ruby-identifier">pop</span>.<span class="ruby-identifier">mails</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">popmail</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"inbox/#{n}"</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">popmail</span>.<span class="ruby-identifier">pop</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">chunk</span><span class="ruby-operator">|</span> <span class="ruby-comment">####</span>
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">chunk</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<p>This method raises a <a href="POPError.html"><code>POPError</code></a> if an error occurs.</p>
<div class="method-source-code" id="pop-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 803</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pop</span>( <span class="ruby-identifier">dest</span> = <span class="ruby-string">+''</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> ) <span class="ruby-comment"># :yield: message_chunk</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-ivar">@command</span>.<span class="ruby-identifier">retr</span>(<span class="ruby-ivar">@number</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@command</span>.<span class="ruby-identifier">retr</span>(<span class="ruby-ivar">@number</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">chunk</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">dest</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">chunk</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">dest</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="POPMail.html#method-i-all">all</a>, <a href="POPMail.html#method-i-mail">mail</a>
</div>
</div>
<div id="method-i-top" class="method-detail ">
<div class="method-heading">
<span class="method-name">top</span><span
class="method-args">(lines, dest = +'')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetches the message header and <code>lines</code> lines of body.</p>
<p>The optional <code>dest</code> argument is obsolete.</p>
<p>This method raises a <a href="POPError.html"><code>POPError</code></a> if an error occurs.</p>
<div class="method-source-code" id="top-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 823</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">top</span>(<span class="ruby-identifier">lines</span>, <span class="ruby-identifier">dest</span> = <span class="ruby-string">+''</span>)
<span class="ruby-ivar">@command</span>.<span class="ruby-identifier">top</span>(<span class="ruby-ivar">@number</span>, <span class="ruby-identifier">lines</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">chunk</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">dest</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">chunk</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">dest</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uidl" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">uidl</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="POPMail.html#method-i-unique_id">unique_id</a>
</div>
</div>
<div id="method-i-unique_id" class="method-detail ">
<div class="method-heading">
<span class="method-name">unique_id</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the unique-id of the message. Normally the unique-id is a hash string of the message.</p>
<p>This method raises a <a href="POPError.html"><code>POPError</code></a> if an error occurs.</p>
<div class="method-source-code" id="unique_id-source">
<pre><span class="ruby-comment"># File lib/net/pop.rb, line 875</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unique_id</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@uid</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@uid</span>
<span class="ruby-ivar">@pop</span>.<span class="ruby-identifier">set_all_uids</span>
<span class="ruby-ivar">@uid</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="POPMail.html#method-i-uidl">uidl</a>
</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>