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

HaskellNet.POP3 Portability portable Stability stable Maintainer mukai@jmuk.org

Contents Types Establishing Connection Send Command More Specific Operations Other Useful Operations

Description

POP3 client implementation

Synopsis

data Command = USER UserName | PASS Password | APOP UserName Password | AUTH AuthType UserName Password | NOOP | QUIT | STAT | LIST (Maybe Int) | DELE Int | RETR Int | RSET | TOP Int Int | UIDL (Maybe Int) data BSStream s => POP3Connection s = POP3C !s !String data Response = Ok | Err connectPop3Port :: String -> PortNumber -> IO (POP3Connection Handle) connectPop3 :: String -> IO (POP3Connection Handle) connectStream :: BSStream s => s -> IO (POP3Connection s) sendCommand :: BSStream s => POP3Connection s -> Command -> IO (Response, ByteString) closePop3 :: BSStream s => POP3Connection s -> IO () user :: BSStream s => POP3Connection s -> String -> IO () pass :: BSStream s => POP3Connection s -> String -> IO () userPass :: BSStream s => POP3Connection s -> UserName -> Password -> IO () apop :: BSStream s => POP3Connection s -> String -> String -> IO () auth :: BSStream s => POP3Connection s -> AuthType -> UserName -> Password -> IO () stat :: BSStream s => POP3Connection s -> IO (Int, Int) dele :: BSStream s => POP3Connection s -> Int -> IO () retr :: BSStream s => POP3Connection s -> Int -> IO ByteString top :: BSStream s => POP3Connection s -> Int -> Int -> IO ByteString rset :: BSStream s => POP3Connection s -> IO () allList :: BSStream s => POP3Connection s -> IO [(Int, Int)] list :: BSStream s => POP3Connection s -> Int -> IO Int allUIDLs :: BSStream s => POP3Connection s -> IO [(Int, ByteString)] uidl :: BSStream s => POP3Connection s -> Int -> IO ByteString doPop3Port :: String -> PortNumber -> (POP3Connection Handle -> IO a) -> IO a doPop3 :: String -> (POP3Connection Handle -> IO a) -> IO a doPop3Stream :: BSStream s => s -> (POP3Connection s -> IO b) -> IO b

Types

data Command Source

Constructors USER UserName PASS Password APOP UserName Password AUTH AuthType UserName Password NOOP QUIT STAT LIST (Maybe Int) DELE Int RETR Int RSET TOP Int Int UIDL (Maybe Int)

data BSStream s => POP3Connection s Source

Constructors POP3C !s !String APOP key

data Response Source

Constructors Ok Err Instances Eq Response Show Response

Establishing Connection

connectPop3Port :: String -> PortNumber -> IO (POP3Connection Handle) Source

connecting to the pop3 server specified by the hostname and port number

connectPop3 :: String -> IO (POP3Connection Handle) Source

connecting to the pop3 server specified by the hostname. 110 is used for the port number.

connectStream :: BSStream s => s -> IO (POP3Connection s) Source

connecting to the pop3 server via a stream

Send Command

sendCommand :: BSStream s => POP3Connection s -> Command -> IO (Response, ByteString) Source

sendCommand sends a pop3 command via a pop3 connection. This action is too generic. Use more specific actions

More Specific Operations

closePop3 :: BSStream s => POP3Connection s -> IO () Source

user :: BSStream s => POP3Connection s -> String -> IO () Source

pass :: BSStream s => POP3Connection s -> String -> IO () Source

userPass :: BSStream s => POP3Connection s -> UserName -> Password -> IO () Source

apop :: BSStream s => POP3Connection s -> String -> String -> IO () Source

auth :: BSStream s => POP3Connection s -> AuthType -> UserName -> Password -> IO () Source

stat :: BSStream s => POP3Connection s -> IO (Int, Int) Source

dele :: BSStream s => POP3Connection s -> Int -> IO () Source

retr :: BSStream s => POP3Connection s -> Int -> IO ByteString Source

top :: BSStream s => POP3Connection s -> Int -> Int -> IO ByteString Source

rset :: BSStream s => POP3Connection s -> IO () Source

allList :: BSStream s => POP3Connection s -> IO [(Int, Int)] Source

list :: BSStream s => POP3Connection s -> Int -> IO Int Source

allUIDLs :: BSStream s => POP3Connection s -> IO [(Int, ByteString)] Source

uidl :: BSStream s => POP3Connection s -> Int -> IO ByteString Source

Other Useful Operations

doPop3Port :: String -> PortNumber -> (POP3Connection Handle -> IO a) -> IO a Source

doPop3 :: String -> (POP3Connection Handle -> IO a) -> IO a Source

doPop3Stream :: BSStream s => s -> (POP3Connection s -> IO b) -> IO b Source

Produced by Haddock version 2.6.0