Path: | doc.en/mailbox.html |
Last Update: | Fri Feb 20 01:45:52 CET 2004 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html lang="en"> <head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta http-equiv="Content-Language" content="en">
<title>Mailbox Classes</title> </head> <body>
<h1>Mailbox Classes</h1>
<h2>class <a name="TMail%3a%3aMhMailbox">TMail::MhMailbox</a> </h2>
<p> The class to handle MH mailboxes. </p>
<h3>Class Methods</h3>
<dl> <dt><a name="TMail%3a%3aMhMailbox-new">new(dirname)</a> -> <a href="mailbox.html#TMail%3a%3aMhMailbox">TMail::MhMailbox</a></dt> <dd> <p> dirname: String<br> </p>
<p> creates new MhMailbox object. DIRNAME must be valid MH mailbox directory. </p>
</dd> </dl> <h3>Instance Methods</h3>
<dl> <dt><a name="TMail%3a%3aMhMailbox-each_port%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each_port {|port| .… }</a></dt> <dt><a name="TMail%3a%3aMhMailbox-each%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each {|port| .… }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mail in the mailbox, in assendant order (older mail first). </p>
</dd> <dt><a name="TMail%3a%3aMhMailbox-reverse_each_port%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">reverse_each_port {|port| .… }</a></dt> <dt><a name="TMail%3a%3aMhMailbox-reverse_each%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">reverse_each {|port| .… }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mail in the mailbox, in descendant order (newer mail first). </p>
</dd> <dt><a name="TMail%3a%3aMhMailbox-last_atime">last_atime</a> -> Time</dt> <dt><a name="TMail%3a%3aMhMailbox-last_atime%3d">last_atime=(time)</a></dt> <dd> <p> time: Time<br> </p>
<p> The time which last each_new_port/each_port/reverse_each_port is called. </p>
</dd> <dt><a name="TMail%3a%3aMhMailbox-each_new_port">each_new_port(time = last_atime()) {|port| .… }</a></dt> <dd> <p> time: Time<br> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mails in mailbox, which are newer than TIME. </p>
</dd> <dt><a name="TMail%3a%3aMhMailbox-new_port">new_port</a> -> <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a></dt> <dd> <p> creates a new file in the mailbox and returns its port. </p>
</dd> <dt><a name="TMail%3a%3aMhMailbox-close">close</a></dt> <dd> <p> does nothing. </p>
</dd> </dl> <h2>class <a name="TMail%3a%3aUNIXMbox">TMail::UNIXMbox</a> </h2>
<p> The class to handle UNIX mbox. Current implementation creates temporary MH mbox. </p>
<h3>Class Methods</h3>
<dl> <dt><a name="TMail%3a%3aUNIXMbox-new">new(filename)</a> -> <a href="mailbox.html#TMail%3a%3aUNIXMbox">TMail::UNIXMbox</a></dt> <dd> <p> filename: String<br> </p>
<p> creates new TMail::UNIMbox object. FILENAME must be valid UNIX mbox file name. </p>
</dd> </dl> <h3>Instance Methods</h3>
<dl> <dt><a name="TMail%3a%3aUNIXMbox-each_port%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each_port {|port| .… }</a></dt> <dt><a name="TMail%3a%3aUNIXMbox-each%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each {|port| .… }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mail in the mailbox, in assendant order (older mail first). </p>
</dd> <dt><a name="TMail%3a%3aUNIXMbox-reverse_each_port%20%7b%7cport%7c%20%2e%2e%2e%20%7d">reverse_each_port {|port| … }</a></dt> <dt><a name="TMail%3a%3aUNIXMbox-reverse_each%20%7b%7cport%7c%20%2e%2e%2e%20%7d">reverse_each {|port| … }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mail in the mailbox, in descendant order (newer mail first). </p>
</dd> <dt><a name="TMail%3a%3aUNIXMbox-each_new_port">each_new_port(time = @last_loaded_time) {|port| .… }</a></dt> <dd> <p> time: Time<br> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mails in mailbox, which are newer than TIME. @last_loaded_time is updated when each_new_port/each_port is called. </p>
</dd> <dt><a name="TMail%3a%3aUNIXMbox-new_port">new_port</a> -> <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a></dt> <dd> <p> creates a new file in the mailbox and returns its port. </p>
</dd> <dt><a name="TMail%3a%3aUNIXMbox-close">close</a></dt> <dd> <p> forces an UNIXMbox to write back mails to real mbox file. Once this method is called, any method calls causes to raise IOError exception. </p>
</dd> </dl> <h2>class <a name="TMail%3a%3aMaildir">TMail::Maildir</a> </h2>
<p> The class to handle "maildir" mailbox. </p>
<h3>Class Methods</h3>
<dl> <dt><a name="TMail%3a%3aMaildir-new">new(dirname)</a> -> <a href="mailbox.html#TMail%3a%3aMaildir">TMail::Maildir</a></dt> <dd> <p> dirname: String<br> </p>
<p> creates new TMail::Maildir object. DIRNAME must be valid maildir. </p>
</dd> </dl> <h3>Instance Methods</h3>
<dl> <dt><a name="TMail%3a%3aMaildir-each_port%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each_port {|port| .… }</a></dt> <dt><a name="TMail%3a%3aMaildir-each%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each {|port| .… }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mail in the mailbox, in assendant order (older mail first). </p>
</dd> <dt><a name="TMail%3a%3aMaildir-reverse_each_port%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">reverse_each_port {|port| .… }</a></dt> <dt><a name="TMail%3a%3aMaildir-reverse_each%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">reverse_each {|port| .… }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mail in the mailbox, in descendant order (newer mail first). </p>
</dd> <dt><a name="TMail%3a%3aMaildir-each_new_port%20%7b%7cport%7c%20%2e%2e%2e%2e%20%7d">each_new_port {|port| .… }</a></dt> <dd> <p> port: <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a><br> </p>
<p> iterates for each mails in MAILDIR/new. </p>
</dd> <dt><a name="TMail%3a%3aMaildir-new_port">new_port</a> -> <a href="port.html#TMail%3a%3aFilePort">TMail::FilePort</a></dt> <dd> <p> creates a new file in the mailbox and returns its port. </p> </dd> </dl>
</body> </html>