<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Network/Email/Mailbox.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-
<a name="line-2"></a>Copyright (C) 2005 John Goerzen <jgoerzen@complete.org>
<a name="line-3"></a>
<a name="line-4"></a>This program is free software; you can redistribute it and/or modify
<a name="line-5"></a>it under the terms of the GNU General Public License as published by
<a name="line-6"></a>the Free Software Foundation; either version 2 of the License, or
<a name="line-7"></a>(at your option) any later version.
<a name="line-8"></a>
<a name="line-9"></a>This program is distributed in the hope that it will be useful,
<a name="line-10"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of
<a name="line-11"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<a name="line-12"></a>GNU General Public License for more details.
<a name="line-13"></a>
<a name="line-14"></a>You should have received a copy of the GNU General Public License
<a name="line-15"></a>along with this program; if not, write to the Free Software
<a name="line-16"></a>Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<a name="line-17"></a>-}</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-comment'>{- |
<a name="line-20"></a> Module : Network.Email.Mailbox
<a name="line-21"></a> Copyright : Copyright (C) 2005 John Goerzen
<a name="line-22"></a> License : GNU GPL, version 2 or above
<a name="line-23"></a>
<a name="line-24"></a> Maintainer : John Goerzen <jgoerzen@complete.org>
<a name="line-25"></a> Stability : provisional
<a name="line-26"></a> Portability: portable
<a name="line-27"></a>
<a name="line-28"></a>General support for e-mail mailboxes
<a name="line-29"></a>
<a name="line-30"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-31"></a>-}</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Email</span><span class='hs-varop'>.</span><span class='hs-conid'>Mailbox</span><span class='hs-layout'>(</span><span class='hs-conid'>Flag</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Flags</span><span class='hs-layout'>,</span> <span class='hs-conid'>Message</span><span class='hs-layout'>,</span>
<a name="line-34"></a> <span class='hs-conid'>MailboxReader</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-35"></a> <span class='hs-conid'>MailboxWriter</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-36"></a><span class='hs-keyword'>where</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="Flag"></a><span class='hs-comment'>{- | The flags which may be assigned to a message. -}</span>
<a name="line-39"></a><a name="Flag"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Flag</span> <span class='hs-keyglyph'>=</span>
<a name="line-40"></a> <span class='hs-conid'>SEEN</span>
<a name="line-41"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ANSWERED</span>
<a name="line-42"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>FLAGGED</span>
<a name="line-43"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DELETED</span>
<a name="line-44"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>DRAFT</span>
<a name="line-45"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>FORWARDED</span>
<a name="line-46"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OTHERFLAG</span> <span class='hs-conid'>String</span>
<a name="line-47"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-48"></a>
<a name="line-49"></a><a name="Flags"></a><span class='hs-comment'>{- | Convenience shortcut -}</span>
<a name="line-50"></a><a name="Flags"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span>
<a name="line-51"></a>
<a name="line-52"></a><a name="Message"></a><span class='hs-comment'>{- | A Message is represented as a simple String. -}</span>
<a name="line-53"></a><a name="Message"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Message</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="MailboxReader"></a><span class='hs-comment'>{- | Main class for readable mailboxes.
<a name="line-56"></a>
<a name="line-57"></a>The mailbox object /a/ represents zero or more 'Message's. Each message
<a name="line-58"></a>has a unique identifier /b/ in a format specific to each given mailbox.
<a name="line-59"></a>This identifier may or may not be persistent.
<a name="line-60"></a>
<a name="line-61"></a>Functions which return a list are encouraged -- but not guaranteed -- to
<a name="line-62"></a>do so lazily.
<a name="line-63"></a>
<a name="line-64"></a>Implementing classes must provide, at minimum, 'getAll'.
<a name="line-65"></a>-}</span>
<a name="line-66"></a><a name="MailboxReader"></a><span class='hs-keyword'>class</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>Eq</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>MailboxReader</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyword'>where</span>
<a name="line-67"></a> <span class='hs-comment'>{- | Returns a list of all unique identifiers. -}</span>
<a name="line-68"></a> <span class='hs-varid'>listIDs</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-69"></a> <span class='hs-comment'>{- | Returns a list of all unique identifiers as well as all flags. -}</span>
<a name="line-70"></a> <span class='hs-varid'>listMessageFlags</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>Flags</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-71"></a> <span class='hs-comment'>{- | Returns a list of all messages, including their content,
<a name="line-72"></a> flags, and unique identifiers. -}</span>
<a name="line-73"></a> <span class='hs-varid'>getAll</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>Flags</span><span class='hs-layout'>,</span> <span class='hs-conid'>Message</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-74"></a> <span class='hs-comment'>{- | Returns information about specific messages. -}</span>
<a name="line-75"></a> <span class='hs-varid'>getMessages</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>Flags</span><span class='hs-layout'>,</span> <span class='hs-conid'>Message</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-76"></a>
<a name="line-77"></a> <span class='hs-varid'>listIDs</span> <span class='hs-varid'>mb</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>listMessageFlags</span> <span class='hs-varid'>mb</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>return</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-varid'>fst</span>
<a name="line-78"></a> <span class='hs-varid'>listMessageFlags</span> <span class='hs-varid'>mb</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getAll</span> <span class='hs-varid'>mb</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>return</span> <span class='hs-varop'>.</span>
<a name="line-79"></a> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>i</span><span class='hs-layout'>,</span> <span class='hs-varid'>f</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>i</span><span class='hs-layout'>,</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-80"></a> <span class='hs-varid'>getMessages</span> <span class='hs-varid'>mb</span> <span class='hs-varid'>list</span> <span class='hs-keyglyph'>=</span>
<a name="line-81"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>messages</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getAll</span> <span class='hs-varid'>mb</span>
<a name="line-82"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>id</span><span class='hs-layout'>,</span> <span class='hs-varid'>f</span><span class='hs-layout'>,</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>id</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>list</span><span class='hs-layout'>)</span> <span class='hs-varid'>messages</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="MailboxWriter"></a><span class='hs-keyword'>class</span> <span class='hs-layout'>(</span><span class='hs-conid'>MailboxReader</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>MailboxWriter</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyword'>where</span>
<a name="line-85"></a> <span class='hs-varid'>appendMessages</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Flags</span><span class='hs-layout'>,</span> <span class='hs-conid'>Message</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-86"></a> <span class='hs-varid'>deleteMessages</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-87"></a> <span class='hs-varid'>addFlags</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Flags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-88"></a> <span class='hs-varid'>removeFlags</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Flags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-89"></a> <span class='hs-varid'>setFlags</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Flags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
</pre></body>
</html>
