8 lines
12 KiB
HTML
8 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.Email.Mailbox</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
|
|
window.onload = function () {pageLoad();setSynopsis("mini_Network-Email-Mailbox.html");};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">MissingH-1.3.0.1: Large utility library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>Copyright (C) 2005-2011 John Goerzen</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>John Goerzen <jgoerzen@complete.org> </td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Network.Email.Mailbox</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>General support for e-mail mailboxes</p><p>Written by John Goerzen, jgoerzen@complete.org</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Flag">Flag</a><ul class="subs"><li>= <a href="#v:SEEN">SEEN</a></li><li>| <a href="#v:ANSWERED">ANSWERED</a></li><li>| <a href="#v:FLAGGED">FLAGGED</a></li><li>| <a href="#v:DELETED">DELETED</a></li><li>| <a href="#v:DRAFT">DRAFT</a></li><li>| <a href="#v:FORWARDED">FORWARDED</a></li><li>| <a href="#v:OTHERFLAG">OTHERFLAG</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:Flags">Flags</a> = [<a href="Network-Email-Mailbox.html#t:Flag">Flag</a>]</li><li class="src short"><span class="keyword">type</span> <a href="#t:Message">Message</a> = <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">class</span> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> a, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> b, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> b) => <a href="#t:MailboxReader">MailboxReader</a> a b <span class="keyword">where</span><ul class="subs"><li><a href="#v:listIDs">listIDs</a> :: a -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [b]</li><li><a href="#v:listMessageFlags">listMessageFlags</a> :: a -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(b, <a href="Network-Email-Mailbox.html#t:Flags">Flags</a>)]</li><li><a href="#v:getAll">getAll</a> :: a -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(b, <a href="Network-Email-Mailbox.html#t:Flags">Flags</a>, <a href="Network-Email-Mailbox.html#t:Message">Message</a>)]</li><li><a href="#v:getMessages">getMessages</a> :: a -> [b] -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(b, <a href="Network-Email-Mailbox.html#t:Flags">Flags</a>, <a href="Network-Email-Mailbox.html#t:Message">Message</a>)]</li></ul></li><li class="src short"><span class="keyword">class</span> <a href="Network-Email-Mailbox.html#t:MailboxReader">MailboxReader</a> a b => <a href="#t:MailboxWriter">MailboxWriter</a> a b <span class="keyword">where</span><ul class="subs"><li><a href="#v:appendMessages">appendMessages</a> :: a -> [(<a href="Network-Email-Mailbox.html#t:Flags">Flags</a>, <a href="Network-Email-Mailbox.html#t:Message">Message</a>)] -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [b]</li><li><a href="#v:deleteMessages">deleteMessages</a> :: a -> [b] -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</li><li><a href="#v:addFlags">addFlags</a> :: a -> [b] -> <a href="Network-Email-Mailbox.html#t:Flags">Flags</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</li><li><a href="#v:removeFlags">removeFlags</a> :: a -> [b] -> <a href="Network-Email-Mailbox.html#t:Flags">Flags</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</li><li><a href="#v:setFlags">setFlags</a> :: a -> [b] -> <a href="Network-Email-Mailbox.html#t:Flags">Flags</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Flag" class="def">Flag</a></p><div class="doc"><p>The flags which may be assigned to a message. </p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SEEN" class="def">SEEN</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ANSWERED" class="def">ANSWERED</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:FLAGGED" class="def">FLAGGED</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:DELETED" class="def">DELETED</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:DRAFT" class="def">DRAFT</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:FORWARDED" class="def">FORWARDED</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:OTHERFLAG" class="def">OTHERFLAG</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Flag" class="caption collapser" onclick="toggleSection('i:Flag')">Instances</p><div id="section.i:Flag" class="show"><table><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Network-Email-Mailbox.html#t:Flag">Flag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> <a href="Network-Email-Mailbox.html#t:Flag">Flag</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Flags" class="def">Flags</a> = [<a href="Network-Email-Mailbox.html#t:Flag">Flag</a>]</p><div class="doc"><p>Convenience shortcut </p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Message" class="def">Message</a> = <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></p><div class="doc"><p>A Message is represented as a simple String. </p></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> a, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> b, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> b) => <a name="t:MailboxReader" class="def">MailboxReader</a> a b <span class="keyword">where</span></p><div class="doc"><p>Main class for readable mailboxes. </p><p>The mailbox object <em>a</em> represents zero or more <code><a href="Network-Email-Mailbox.html#t:Message">Message</a></code>s. Each message
|
|
has a unique identifier <em>b</em> in a format specific to each given mailbox.
|
|
This identifier may or may not be persistent.</p><p>Functions which return a list are encouraged -- but not guaranteed -- to
|
|
do so lazily.</p><p>Implementing classes must provide, at minimum, <code><a href="Network-Email-Mailbox.html#v:getAll">getAll</a></code>.</p></div><div class="subs minimal"><p class="caption">Minimal complete definition</p><p class="src"><a href="Network-Email-Mailbox.html#v:getAll">getAll</a></p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:listIDs" class="def">listIDs</a> :: a -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [b]</p><div class="doc"><p>Returns a list of all unique identifiers. </p></div><p class="src"><a name="v:listMessageFlags" class="def">listMessageFlags</a> :: a -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(b, <a href="Network-Email-Mailbox.html#t:Flags">Flags</a>)]</p><div class="doc"><p>Returns a list of all unique identifiers as well as all flags. </p></div><p class="src"><a name="v:getAll" class="def">getAll</a> :: a -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(b, <a href="Network-Email-Mailbox.html#t:Flags">Flags</a>, <a href="Network-Email-Mailbox.html#t:Message">Message</a>)]</p><div class="doc"><p>Returns a list of all messages, including their content,
|
|
flags, and unique identifiers. </p></div><p class="src"><a name="v:getMessages" class="def">getMessages</a> :: a -> [b] -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(b, <a href="Network-Email-Mailbox.html#t:Flags">Flags</a>, <a href="Network-Email-Mailbox.html#t:Message">Message</a>)]</p><div class="doc"><p>Returns information about specific messages. </p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Network-Email-Mailbox.html#t:MailboxReader">MailboxReader</a> a b => <a name="t:MailboxWriter" class="def">MailboxWriter</a> a b <span class="keyword">where</span></p><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:appendMessages" class="def">appendMessages</a> :: a -> [(<a href="Network-Email-Mailbox.html#t:Flags">Flags</a>, <a href="Network-Email-Mailbox.html#t:Message">Message</a>)] -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [b]</p><p class="src"><a name="v:deleteMessages" class="def">deleteMessages</a> :: a -> [b] -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</p><p class="src"><a name="v:addFlags" class="def">addFlags</a> :: a -> [b] -> <a href="Network-Email-Mailbox.html#t:Flags">Flags</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</p><p class="src"><a name="v:removeFlags" class="def">removeFlags</a> :: a -> [b] -> <a href="Network-Email-Mailbox.html#t:Flags">Flags</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</p><p class="src"><a name="v:setFlags" class="def">setFlags</a> :: a -> [b] -> <a href="Network-Email-Mailbox.html#t:Flags">Flags</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.0</p></div></body></html> |