Safe Haskell	None
Language	Haskell2010

Network.Mail.Pool

Contents

specify connection type
optparse applicative
lenses
Exceptions
re exports

Description

SMTP is s an incredibly stable and well supported protocol. Using this rather then API's prevents vendorlocking.

This module provides a ready to go connection pool for SMTP. Which has been used in various deployments already.

Synopsis

sendEmail :: MonadIO m => Pool SMTPConnection -> Mail -> m ()
smtpPool :: PoolSettings -> IO (Pool SMTPConnection)
defSettings :: SmtpCred -> PoolSettings
data SmtpCred = SmtpCred {
- _smtpPassword :: String
- _smtpLogin :: String
- _smtpHost :: String
- _smtpPort :: PortNumber
}
data PoolSettings = PoolSettings {
- _poolCred :: SmtpCred
- _poolConnf :: SmtpCred -> IO SMTPConnection
- _poolStripes :: Int
- _poolUnused :: NominalDiffTime
- _poolStripeMax :: Int
}
openTls :: SmtpCred -> IO SMTPConnection
openPlain :: SmtpCred -> IO SMTPConnection
openTls' :: Settings -> SmtpCred -> IO SMTPConnection
emailOptions :: Parser SmtpCred
poolCred :: Lens' PoolSettings SmtpCred
poolConnf :: Lens' PoolSettings (SmtpCred -> IO SMTPConnection)
poolStripes :: Lens' PoolSettings Int
poolUnused :: Lens' PoolSettings NominalDiffTime
poolStripeMax :: Lens' PoolSettings Int
smtpHost :: Lens' SmtpCred String
smtpLogin :: Lens' SmtpCred String
smtpPassword :: Lens' SmtpCred String
smtpPort :: Lens' SmtpCred PortNumber
data ServiceAuthFailure a
module Network.HaskellNet.SMTP.SSL
module Network.HaskellNet.SMTP
module Data.Pool

Documentation

sendEmail :: MonadIO m => Pool SMTPConnection -> Mail -> m () Source #

Send a Mail with help of a connection pool.

smtpPool :: PoolSettings -> IO (Pool SMTPConnection) Source #

Construct a connection pool from settings.

defSettings :: SmtpCred -> PoolSettings Source #

Create settings with good defaults from SmtpCred.

data SmtpCred Source #

Authentication information for the SMTP connection

Constructors

SmtpCred
Fields _smtpPassword :: String _smtpLogin :: String _smtpHost :: String _smtpPort :: PortNumber

Instances

Show SmtpCred Source #
Instance details Defined in Network.Mail.Pool Methods showsPrec :: Int -> SmtpCred -> ShowS # show :: SmtpCred -> String # showList :: [SmtpCred] -> ShowS #
FromJSON SmtpCred Source #
Instance details Defined in Network.Mail.Pool Methods parseJSON :: Value -> Parser SmtpCred # parseJSONList :: Value -> Parser [SmtpCred] #

data PoolSettings Source #

This allows you to override the default settings from defSettings

Constructors

PoolSettings

Fields

_poolCred :: SmtpCred
credentials for smtp connection
_poolConnf :: SmtpCred -> IO SMTPConnection
allows overriding of the opening function, for example openPlain or openTls
_poolStripes :: Int
stripes, see docs: https://hackage.haskell.org/package/resource-pool-0.2.3.2/docs/Data-Pool.html
_poolUnused :: NominalDiffTime
specify how long connections are kept open.
_poolStripeMax :: Int
how many connections per stripe.

specify connection type

openTls :: SmtpCred -> IO SMTPConnection Source #

openPlain :: SmtpCred -> IO SMTPConnection Source #

openTls' :: Settings -> SmtpCred -> IO SMTPConnection Source #

optparse applicative

emailOptions :: Parser SmtpCred Source #

lenses

poolCred :: Lens' PoolSettings SmtpCred Source #

poolConnf :: Lens' PoolSettings (SmtpCred -> IO SMTPConnection) Source #

poolStripes :: Lens' PoolSettings Int Source #

poolUnused :: Lens' PoolSettings NominalDiffTime Source #

poolStripeMax :: Lens' PoolSettings Int Source #

smtpHost :: Lens' SmtpCred String Source #

smtpLogin :: Lens' SmtpCred String Source #

smtpPassword :: Lens' SmtpCred String Source #

smtpPort :: Lens' SmtpCred PortNumber Source #

Exceptions

data ServiceAuthFailure a Source #

Failed to authetnicate with some upstream service (smtp for example)

Instances

Show a => Show (ServiceAuthFailure a) Source #
Instance details Defined in Network.Mail.Pool Methods showsPrec :: Int -> ServiceAuthFailure a -> ShowS # show :: ServiceAuthFailure a -> String # showList :: [ServiceAuthFailure a] -> ShowS #
(Typeable a, Show a) => Exception (ServiceAuthFailure a) Source #
Instance details Defined in Network.Mail.Pool Methods toException :: ServiceAuthFailure a -> SomeException # fromException :: SomeException -> Maybe (ServiceAuthFailure a) # displayException :: ServiceAuthFailure a -> String #

re exports

module Network.HaskellNet.SMTP.SSL

module Network.HaskellNet.SMTP

module Data.Pool