Codec.Mbox

Mailbox, message, and direction data types

newtype Mbox s

An Mbox is a list of MboxMessage

Constructors

Mbox

Fields

mboxMessages :: [MboxMessage s]

Instances

Eq s => Eq (Mbox s)

Ord s => Ord (Mbox s)

Show s => Show (Mbox s)

data MboxMessage s

An MboxMessage represent an mbox message, featuring the sender, the date-time, and the message body.

Constructors

MboxMessage

Fields

_mboxMsgSender :: s

_mboxMsgTime :: s

_mboxMsgBody :: s

_mboxMsgFile :: FilePath

_mboxMsgOffset :: Int64

Instances

Eq s => Eq (MboxMessage s)

Ord s => Ord (MboxMessage s)

Show s => Show (MboxMessage s)

data Direction

Constructors

Backward

Forward

Mailbox parsing functions

parseMboxFile :: Direction -> FilePath -> IO (Mbox ByteString)

Returns a mbox given a direction (forward/backward) and a file path.

parseMboxFiles :: Direction -> [FilePath] -> IO [Mbox ByteString]

Returns a mbox list given a direction (forward/backward) and a list of file path. Note that files are opened lazily.

parseMbox :: ByteString -> Mbox ByteString

Turns a ByteString into an Mbox by splitting on From_ lines and unquoting the '>*From's of the message.

safeParseMbox :: FilePath -> Int64 -> ByteString -> Either String (Mbox ByteString)

Same as parseMbox but cat returns an error message. However only the line can cause an error message currently, so it's fine to dispatch on the either result.

parseOneMboxMessage :: FilePath -> Handle -> Integer -> IO (MboxMessage ByteString)

Given a file handle and an offset, parseOneMboxMessage returns the message a this offset.

Mailbox printing functions

showMbox :: Mbox ByteString -> ByteString

Turns an mbox into a ByteString

showMboxMessage :: MboxMessage ByteString -> ByteString

Returns a ByteString given an mbox message.

showMboxFromLine :: MboxMessage ByteString -> ByteString

Returns an header line in mbox format given an mbox message.

First-class labels

mboxMsgSender :: MboxMessage s :-> s

First-class label to message's sender

mboxMsgTime :: MboxMessage s :-> s

First-class label to the date and time of the given message

mboxMsgBody :: MboxMessage s :-> s

First-class label to message's raw body

mboxMsgFile :: MboxMessage s :-> FilePath

First-class label to the file path of mbox's message

mboxMsgOffset :: MboxMessage s :-> Int64

First-class label to the offset of the given message into the mbox

Misc

data Month

Constructors

Jan

Feb

Mar

Apr

May

Jun

Jul

Aug

Sep

Oct

Nov

Dec

Instances

Eq Month

Read Month

Show Month

fromQuoting :: (Int64 -> Int64) -> ByteString -> ByteString

fromQuoting f s returns s where the quoting level of From_ lines has been updated using the f function.

The From_ spefication, quoted from http://qmail.org./man/man5/mbox.html:

   >From quoting ensures that the resulting
   lines are not From_ lines:  the program prepends a > to any
   From_ line, >From_ line, >>From_ line, >>>From_ line, etc.

msgYear :: MboxMessage ByteString -> Int

msgMonthYear :: MboxMessage ByteString -> (Month, Int)

opposite :: Direction -> Direction