HaskellNet-0.5.2: Client support for POP3, SMTP, and IMAP

Safe Haskell	None
Language	Haskell98

Network.HaskellNet.IMAP

Contents

IMAP commands
fetch commands
other types

Synopsis

connectIMAP :: String -> IO IMAPConnection
connectIMAPPort :: String -> PortNumber -> IO IMAPConnection
connectStream :: BSStream -> IO IMAPConnection
noop :: IMAPConnection -> IO ()
capability :: IMAPConnection -> IO [String]
logout :: IMAPConnection -> IO ()
login :: IMAPConnection -> UserName -> Password -> IO ()
authenticate :: IMAPConnection -> AuthType -> UserName -> Password -> IO ()
select :: IMAPConnection -> MailboxName -> IO ()
examine :: IMAPConnection -> MailboxName -> IO ()
create :: IMAPConnection -> MailboxName -> IO ()
delete :: IMAPConnection -> MailboxName -> IO ()
rename :: IMAPConnection -> MailboxName -> MailboxName -> IO ()
subscribe :: IMAPConnection -> MailboxName -> IO ()
unsubscribe :: IMAPConnection -> MailboxName -> IO ()
list :: IMAPConnection -> IO [([Attribute], MailboxName)]
lsub :: IMAPConnection -> IO [([Attribute], MailboxName)]
status :: IMAPConnection -> MailboxName -> [MailboxStatus] -> IO [(MailboxStatus, Integer)]
append :: IMAPConnection -> MailboxName -> ByteString -> IO ()
check :: IMAPConnection -> IO ()
close :: IMAPConnection -> IO ()
expunge :: IMAPConnection -> IO [Integer]
search :: IMAPConnection -> [SearchQuery] -> IO [UID]
store :: IMAPConnection -> UID -> FlagsQuery -> IO ()
copy :: IMAPConnection -> UID -> MailboxName -> IO ()
idle :: IMAPConnection -> Int -> IO ()
fetch :: IMAPConnection -> UID -> IO ByteString
fetchHeader :: IMAPConnection -> UID -> IO ByteString
fetchSize :: IMAPConnection -> UID -> IO Int
fetchHeaderFields :: IMAPConnection -> UID -> [String] -> IO ByteString
fetchHeaderFieldsNot :: IMAPConnection -> UID -> [String] -> IO ByteString
fetchFlags :: IMAPConnection -> UID -> IO [Flag]
fetchR :: IMAPConnection -> (UID, UID) -> IO [(UID, ByteString)]
fetchByString :: IMAPConnection -> UID -> String -> IO [(String, String)]
fetchByStringR :: IMAPConnection -> (UID, UID) -> String -> IO [(UID, [(String, String)])]
data Flag
- = Seen
- | Answered
- | Flagged
- | Deleted
- | Draft
- | Recent
- | Keyword String
data Attribute
- = Noinferiors
- | Noselect
- | Marked
- | Unmarked
- | OtherAttr String
data MailboxStatus
- = MESSAGES
- | RECENT
- | UIDNEXT
- | UIDVALIDITY
- | UNSEEN
data SearchQuery
- = ALLs
- | FLAG Flag
- | UNFLAG Flag
- | BCCs String
- | BEFOREs CalendarTime
- | BODYs String
- | CCs String
- | FROMs String
- | HEADERs String String
- | LARGERs Integer
- | NEWs
- | NOTs SearchQuery
- | OLDs
- | ONs CalendarTime
- | ORs SearchQuery SearchQuery
- | SENTBEFOREs CalendarTime
- | SENTONs CalendarTime
- | SENTSINCEs CalendarTime
- | SINCEs CalendarTime
- | SMALLERs Integer
- | SUBJECTs String
- | TEXTs String
- | TOs String
- | UIDs [UID]
data FlagsQuery
- = ReplaceFlags [Flag]
- | PlusFlags [Flag]
- | MinusFlags [Flag]
data AuthType
- = PLAIN
- | LOGIN
- | CRAM_MD5

Documentation

connectIMAP :: String -> IO IMAPConnection Source #

connectIMAPPort :: String -> PortNumber -> IO IMAPConnection Source #

connectStream :: BSStream -> IO IMAPConnection Source #

IMAP commands

any state commands

noop :: IMAPConnection -> IO () Source #

capability :: IMAPConnection -> IO [String] Source #

logout :: IMAPConnection -> IO () Source #

not authenticated state commands

login :: IMAPConnection -> UserName -> Password -> IO () Source #

authenticate :: IMAPConnection -> AuthType -> UserName -> Password -> IO () Source #

autenticated state commands

select :: IMAPConnection -> MailboxName -> IO () Source #

examine :: IMAPConnection -> MailboxName -> IO () Source #

create :: IMAPConnection -> MailboxName -> IO () Source #

delete :: IMAPConnection -> MailboxName -> IO () Source #

rename :: IMAPConnection -> MailboxName -> MailboxName -> IO () Source #

subscribe :: IMAPConnection -> MailboxName -> IO () Source #

unsubscribe :: IMAPConnection -> MailboxName -> IO () Source #

list :: IMAPConnection -> IO [([Attribute], MailboxName)] Source #

lsub :: IMAPConnection -> IO [([Attribute], MailboxName)] Source #

status :: IMAPConnection -> MailboxName -> [MailboxStatus] -> IO [(MailboxStatus, Integer)] Source #

append :: IMAPConnection -> MailboxName -> ByteString -> IO () Source #

selected state commands

check :: IMAPConnection -> IO () Source #

close :: IMAPConnection -> IO () Source #

expunge :: IMAPConnection -> IO [Integer] Source #

search :: IMAPConnection -> [SearchQuery] -> IO [UID] Source #

store :: IMAPConnection -> UID -> FlagsQuery -> IO () Source #

copy :: IMAPConnection -> UID -> MailboxName -> IO () Source #

idle :: IMAPConnection -> Int -> IO () Source #

fetch commands

fetch :: IMAPConnection -> UID -> IO ByteString Source #

fetchHeader :: IMAPConnection -> UID -> IO ByteString Source #

fetchSize :: IMAPConnection -> UID -> IO Int Source #

fetchHeaderFields :: IMAPConnection -> UID -> [String] -> IO ByteString Source #

fetchHeaderFieldsNot :: IMAPConnection -> UID -> [String] -> IO ByteString Source #

fetchFlags :: IMAPConnection -> UID -> IO [Flag] Source #

fetchR :: IMAPConnection -> (UID, UID) -> IO [(UID, ByteString)] Source #

fetchByString :: IMAPConnection -> UID -> String -> IO [(String, String)] Source #

fetchByStringR :: IMAPConnection -> (UID, UID) -> String -> IO [(UID, [(String, String)])] Source #

other types

data Flag Source #

Constructors

Seen
Answered
Flagged
Deleted
Draft
Recent
Keyword String

Instances

Eq Flag Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods (==) :: Flag -> Flag -> Bool # (/=) :: Flag -> Flag -> Bool #
Show Flag Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods showsPrec :: Int -> Flag -> ShowS # show :: Flag -> String # showList :: [Flag] -> ShowS #

data Attribute Source #

Constructors

Noinferiors
Noselect
Marked
Unmarked
OtherAttr String

Instances

Eq Attribute Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods (==) :: Attribute -> Attribute -> Bool # (/=) :: Attribute -> Attribute -> Bool #
Show Attribute Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods showsPrec :: Int -> Attribute -> ShowS # show :: Attribute -> String # showList :: [Attribute] -> ShowS #

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
UNSEEN	the number of messages with the Unseen flag set

Instances

Eq MailboxStatus Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods (==) :: MailboxStatus -> MailboxStatus -> Bool # (/=) :: MailboxStatus -> MailboxStatus -> Bool #
Read MailboxStatus Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods readsPrec :: Int -> ReadS MailboxStatus # readList :: ReadS [MailboxStatus] # readPrec :: ReadPrec MailboxStatus # readListPrec :: ReadPrec [MailboxStatus] #
Show MailboxStatus Source #
Instance details Defined in Network.HaskellNet.IMAP.Types Methods showsPrec :: Int -> MailboxStatus -> ShowS # show :: MailboxStatus -> String # showList :: [MailboxStatus] -> ShowS #

data SearchQuery Source #

Instances

Show SearchQuery Source #
Instance details Defined in Network.HaskellNet.IMAP Methods showsPrec :: Int -> SearchQuery -> ShowS # show :: SearchQuery -> String # showList :: [SearchQuery] -> ShowS #

data FlagsQuery Source #

Constructors

ReplaceFlags [Flag]
PlusFlags [Flag]
MinusFlags [Flag]

data AuthType Source #

Constructors

PLAIN
LOGIN
CRAM_MD5

Instances

Eq AuthType Source #
Instance details Defined in Network.HaskellNet.Auth Methods (==) :: AuthType -> AuthType -> Bool # (/=) :: AuthType -> AuthType -> Bool #
Show AuthType Source #
Instance details Defined in Network.HaskellNet.Auth Methods showsPrec :: Int -> AuthType -> ShowS # show :: AuthType -> String # showList :: [AuthType] -> ShowS #