HaskellNet-0.2.1: network related libraries such as POP3, SMTP, IMAP Source code Contents Index

Text.IMAPParsers Portability portable Stability stable Maintainer mukai@jmuk.org

Description

Parsers for IMAP server responses

Synopsis

type Mailbox = String type UID = Word64 type Charset = String data MailboxInfo = MboxInfo { _mailbox :: Mailbox _exists :: Integer _recent :: Integer _flags :: [Flag] _permanentFlags :: [Flag] _isWritable :: Bool _isFlagWritable :: Bool _uidNext :: UID _uidValidity :: UID } data Flag = Seen | Answered | Flagged | Deleted | Draft | Recent | Keyword String data Attribute = Noinferiors | Noselect | Marked | Unmarked | OtherAttr String data MboxUpdate = MboxUpdate { exists :: Maybe Integer recent :: Maybe Integer } data StatusCode = ALERT | BADCHARSET [Charset] | CAPABILITY_sc [String] | PARSE | PERMANENTFLAGS [Flag] | READ_ONLY | READ_WRITE | TRYCREATE | UIDNEXT_sc UID | UIDVALIDITY_sc UID | UNSEEN_sc Integer data ServerResponse = OK (Maybe StatusCode) String | NO (Maybe StatusCode) String | BAD (Maybe StatusCode) String | PREAUTH (Maybe StatusCode) String data MailboxStatus = MESSAGES | RECENT | UIDNEXT | UIDVALIDITY data RespDerivs = RespDerivs { dvFlags :: Result RespDerivs [Flag] advTag :: Result RespDerivs String advChar :: Result RespDerivs Char advPos :: Pos } eval :: (RespDerivs -> Result RespDerivs r) -> String -> ByteString -> r parse :: String -> Pos -> ByteString -> RespDerivs eval' :: (RespDerivs -> Result RespDerivs r) -> String -> String -> r parse' :: String -> Pos -> String -> RespDerivs pNone :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, ()) pCapability :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [String]) pList :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [([Attribute], String, Mailbox)]) pLsub :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [([Attribute], String, Mailbox)]) pStatus :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [(MailboxStatus, Integer)]) pExpunge :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [Integer]) pSearch :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [UID]) pSelect :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, MailboxInfo) pFetch :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [(Integer, [(String, String)])]) pDone :: RespDerivs -> Result RespDerivs ServerResponse pFlag :: Parser RespDerivs Flag pParenFlags :: RespDerivs -> Result RespDerivs [Flag] atomChar :: Derivs d => Parser d Char pNumberedLine :: String -> Parser RespDerivs Integer pRecentLine :: Parser RespDerivs Integer pExpungeLine :: Parser RespDerivs Integer pExistsLine :: Parser RespDerivs Integer pOtherLine :: Parser RespDerivs (Either (String, Integer) b) pCapabilityLine :: Parser RespDerivs (Either a [String]) pListLine :: String -> Parser RespDerivs (Either a ([Attribute], String, Mailbox)) pStatusLine :: Parser RespDerivs (Either a [(MailboxStatus, Integer)]) pSearchLine :: Parser RespDerivs (Either a [UID]) pSelectLine :: Parser RespDerivs (MailboxInfo -> MailboxInfo) pFetchLine :: Parser RespDerivs (Either a (Integer, [(String, String)])) crlf :: String crlfP :: Derivs d => Parser d String lookups :: Eq a => a -> [(a, b)] -> [b] catRights :: [Either a b] -> [b] catLefts :: [Either a b] -> [a] isRight :: Either a b -> Bool isLeft :: Either a b -> Bool getLeft :: Either a b -> a getRight :: Either a b -> b

Documentation

type Mailbox = String Source

type UID = Word64 Source

type Charset = String Source

data MailboxInfo Source

Constructors MboxInfo _mailbox :: Mailbox _exists :: Integer _recent :: Integer _flags :: [Flag] _permanentFlags :: [Flag] _isWritable :: Bool _isFlagWritable :: Bool _uidNext :: UID _uidValidity :: UID Instances Eq MailboxInfo Show MailboxInfo

data Flag Source

Constructors Seen Answered Flagged Deleted Draft Recent Keyword String Instances Eq Flag Show Flag

data Attribute Source

Constructors Noinferiors Noselect Marked Unmarked OtherAttr String Instances Eq Attribute Show Attribute

data MboxUpdate Source

Constructors MboxUpdate exists :: Maybe Integer recent :: Maybe Integer Instances Eq MboxUpdate Show MboxUpdate

data StatusCode Source

Constructors ALERT BADCHARSET [Charset] CAPABILITY_sc [String] PARSE PERMANENTFLAGS [Flag] READ_ONLY READ_WRITE TRYCREATE UIDNEXT_sc UID UIDVALIDITY_sc UID UNSEEN_sc Integer Instances Eq StatusCode Show StatusCode

data ServerResponse Source

Constructors OK (Maybe StatusCode) String NO (Maybe StatusCode) String BAD (Maybe StatusCode) String PREAUTH (Maybe StatusCode) String Instances Eq ServerResponse Show ServerResponse

data MailboxStatus Source

the query data type for the status command Constructors MESSAGES the number of messages in the mailbox RECENT the number of messages with the Recent flag set UIDNEXT the next unique identifier value of the mailbox UIDVALIDITY the unique identifier validity value of the mailbox Instances Eq MailboxStatus Read MailboxStatus Show MailboxStatus

data RespDerivs Source

Constructors RespDerivs dvFlags :: Result RespDerivs [Flag] advTag :: Result RespDerivs String advChar :: Result RespDerivs Char advPos :: Pos Instances Derivs RespDerivs

eval :: (RespDerivs -> Result RespDerivs r) -> String -> ByteString -> r Source

parse :: String -> Pos -> ByteString -> RespDerivs Source

eval' :: (RespDerivs -> Result RespDerivs r) -> String -> String -> r Source

parse' :: String -> Pos -> String -> RespDerivs Source

pNone :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, ()) Source

pCapability :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [String]) Source

pList :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [([Attribute], String, Mailbox)]) Source

pLsub :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [([Attribute], String, Mailbox)]) Source

pStatus :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [(MailboxStatus, Integer)]) Source

pExpunge :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [Integer]) Source

pSearch :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [UID]) Source

pSelect :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, MailboxInfo) Source

pFetch :: RespDerivs -> Result RespDerivs (ServerResponse, MboxUpdate, [(Integer, [(String, String)])]) Source

pDone :: RespDerivs -> Result RespDerivs ServerResponse Source

pFlag :: Parser RespDerivs Flag Source

pParenFlags :: RespDerivs -> Result RespDerivs [Flag] Source

atomChar :: Derivs d => Parser d Char Source

pNumberedLine :: String -> Parser RespDerivs Integer Source

pRecentLine :: Parser RespDerivs Integer Source

pExpungeLine :: Parser RespDerivs Integer Source

pExistsLine :: Parser RespDerivs Integer Source

pOtherLine :: Parser RespDerivs (Either (String, Integer) b) Source

pCapabilityLine :: Parser RespDerivs (Either a [String]) Source

pListLine :: String -> Parser RespDerivs (Either a ([Attribute], String, Mailbox)) Source

pStatusLine :: Parser RespDerivs (Either a [(MailboxStatus, Integer)]) Source

pSearchLine :: Parser RespDerivs (Either a [UID]) Source

pSelectLine :: Parser RespDerivs (MailboxInfo -> MailboxInfo) Source

pFetchLine :: Parser RespDerivs (Either a (Integer, [(String, String)])) Source

crlf :: String Source

crlfP :: Derivs d => Parser d String Source

lookups :: Eq a => a -> [(a, b)] -> [b] Source

catRights :: [Either a b] -> [b] Source

catLefts :: [Either a b] -> [a] Source

isRight :: Either a b -> Bool Source

isLeft :: Either a b -> Bool Source

getLeft :: Either a b -> a Source

getRight :: Either a b -> b Source

Produced by Haddock version 2.6.0