Safe Haskell	Safe-Inferred
Language	Haskell2010

Smtpbz.Internal.Api

Description

The response bodies are really un(der)specified, so this library doesn't try to do to much with them. You are on your own.

Functions' names map (trivially) to API routes. So, for some of them, it's not obvious what they do from their name. This is by design.

Synopsis

user :: Has smtpbz => smtpbz -> IO (Response ByteString)
userStats :: Has smtpbz => smtpbz -> IO (Response ByteString)
userDomains :: Has smtpbz => smtpbz -> IO (Response ByteString)
userDomain :: Has smtpbz => smtpbz -> String -> IO (Response ByteString)
userIPs :: Has smtpbz => smtpbz -> IO (Response ByteString)
userIP :: Has smtpbz => smtpbz -> String -> IO (Response ByteString)
data LogMessages = LogMessages {
- limit :: Maybe Int
- offset :: Maybe Int
- from :: Maybe ByteString
- to :: Maybe ByteString
- isOpen :: Maybe Bool
- tag :: Maybe ByteString
}
logMessages :: Has smtpbz => smtpbz -> LogMessages -> IO (Response ByteString)
logMessage :: Has smtpbz => smtpbz -> String -> IO (Response ByteString)
data Unsubscribe = Unsubscribe {
- limit :: Maybe Int
- offset :: Maybe Int
- address :: Maybe ByteString
- reason :: Maybe ByteString
}
unsubscribe :: Has smtpbz => smtpbz -> Unsubscribe -> IO (Response ByteString)
unsubscribeAdd :: Has smtpbz => smtpbz -> ByteString -> IO (Response ByteString)
unsubscribeRemove :: Has smtpbz => smtpbz -> ByteString -> IO (Response ByteString)
unsubscribeRemoveAll :: Has smtpbz => smtpbz -> IO (Response ByteString)
data SmtpSend = SmtpSend {
- from :: ByteString
- name :: Maybe ByteString
- subject :: ByteString
- to :: ByteString
- replyTo :: Maybe ByteString
- html :: ByteString
- text :: Maybe ByteString
}
sendSmtp :: Has smtpbz => smtpbz -> SmtpSend -> IO (Response ByteString)
checkEmail :: Has smtpbz => smtpbz -> String -> IO (Response ByteString)
successfulCall :: Response ByteString -> Bool
debugPrintResponse :: Response ByteString -> IO ()

Documentation

user :: Has smtpbz => smtpbz -> IO (Response ByteString) Source #

User data.

userStats :: Has smtpbz => smtpbz -> IO (Response ByteString) Source #

User's mail distribution statistics.

userDomains :: Has smtpbz => smtpbz -> IO (Response ByteString) Source #

User's domains data.

userDomain :: Has smtpbz => smtpbz -> String -> IO (Response ByteString) Source #

User's specific domain data.

userIPs :: Has smtpbz => smtpbz -> IO (Response ByteString) Source #

User's IPs data.

userIP :: Has smtpbz => smtpbz -> String -> IO (Response ByteString) Source #

User's specific IP data.

data LogMessages Source #

Constructors

LogMessages
Fields limit :: Maybe Int offset :: Maybe Int from :: Maybe ByteString to :: Maybe ByteString isOpen :: Maybe Bool tag :: Maybe ByteString

Instances

Instances details

Show LogMessages Source #
Instance details Defined in Smtpbz.Internal.Api Methods showsPrec :: Int -> LogMessages -> ShowS # show :: LogMessages -> String # showList :: [LogMessages] -> ShowS #
Eq LogMessages Source #
Instance details Defined in Smtpbz.Internal.Api Methods (==) :: LogMessages -> LogMessages -> Bool # (/=) :: LogMessages -> LogMessages -> Bool #

logMessages :: Has smtpbz => smtpbz -> LogMessages -> IO (Response ByteString) Source #

Message log search.

logMessage :: Has smtpbz => smtpbz -> String -> IO (Response ByteString) Source #

Look up a specific message.

data Unsubscribe Source #

Constructors

Unsubscribe
Fields limit :: Maybe Int offset :: Maybe Int address :: Maybe ByteString reason :: Maybe ByteString

Instances

Instances details

Show Unsubscribe Source #
Instance details Defined in Smtpbz.Internal.Api Methods showsPrec :: Int -> Unsubscribe -> ShowS # show :: Unsubscribe -> String # showList :: [Unsubscribe] -> ShowS #
Eq Unsubscribe Source #
Instance details Defined in Smtpbz.Internal.Api Methods (==) :: Unsubscribe -> Unsubscribe -> Bool # (/=) :: Unsubscribe -> Unsubscribe -> Bool #

unsubscribe :: Has smtpbz => smtpbz -> Unsubscribe -> IO (Response ByteString) Source #

List of e-mail addresses mail is not delivired to.

unsubscribeAdd :: Has smtpbz => smtpbz -> ByteString -> IO (Response ByteString) Source #

Ignore an address.

unsubscribeRemove :: Has smtpbz => smtpbz -> ByteString -> IO (Response ByteString) Source #

Stop ignoring an address.

unsubscribeRemoveAll :: Has smtpbz => smtpbz -> IO (Response ByteString) Source #

Stop ignoring all previously ignored addresses.

data SmtpSend Source #

Constructors

SmtpSend
Fields from :: ByteString name :: Maybe ByteString subject :: ByteString to :: ByteString replyTo :: Maybe ByteString html :: ByteString text :: Maybe ByteString

Instances

Instances details

Show SmtpSend Source #
Instance details Defined in Smtpbz.Internal.Api Methods showsPrec :: Int -> SmtpSend -> ShowS # show :: SmtpSend -> String # showList :: [SmtpSend] -> ShowS #
Eq SmtpSend Source #
Instance details Defined in Smtpbz.Internal.Api Methods (==) :: SmtpSend -> SmtpSend -> Bool # (/=) :: SmtpSend -> SmtpSend -> Bool #

sendSmtp :: Has smtpbz => smtpbz -> SmtpSend -> IO (Response ByteString) Source #

checkEmail :: Has smtpbz => smtpbz -> String -> IO (Response ByteString) Source #

successfulCall :: Response ByteString -> Bool Source #

Check if response status code is in [200, 300).

debugPrintResponse :: Response ByteString -> IO () Source #

Print response body to stdout.