Network.Mail.Postie.Settings

Documentation

data Settings

Settings to configure posties behaviour.

Constructors

Settings

Fields

• settingsPort :: PortNumber

  Port postie will run on.

• settingsTimeout :: Int

  Timeout for connections in seconds

• settingsMaxDataSize :: Int

  Maximal size of incoming mail data

• settingsHost :: Maybe HostName

  Hostname which is shown in posties greeting.

• settingsTLS :: Maybe TLSSettings

  TLS settings if you wish to secure connections.

• settingsRequireAuth :: Bool

  Whether authentication is required

• settingsOnException :: Maybe SessionID -> SomeException -> IO ()

  Exception handler (default is defaultExceptionHandler)

• settingsBeforeMainLoop :: IO ()

  Action will be performed before main processing begins.

• settingsOnOpen :: SessionID -> SockAddr -> IO ()

  Action will be performed when connection has been opened.

• settingsOnClose :: SessionID -> IO ()

  Action will be performed when connection has been closed.

• settingsOnStartTLS :: SessionID -> IO ()

  Action will be performend on STARTTLS command.

• settingsOnHello :: SessionID -> ByteString -> IO HandlerResponse

  Performed when client says hello

• settingsOnAuth :: SessionID -> ByteString -> IO HandlerResponse

  Performed when client authenticates

• settingsOnMailFrom :: SessionID -> Address -> IO HandlerResponse

  Performed when client starts mail transaction

• settingsOnRecipient :: SessionID -> Address -> IO HandlerResponse

  Performed when client adds recipient to mail transaction.

Instances

Default Settings

Defined in Network.Mail.Postie.Settings

Methods

def :: Settings

data TLSSettings

Settings for TLS handling

Constructors

TLSSettings

Fields

• certFile :: FilePath

  Path to certificate file

• keyFile :: FilePath

  Path to private key file belonging to certificate

• security :: StartTLSPolicy

  Connection security mode, default is DemandStartTLS

• tlsLogging :: Logging

  Logging for TLS

• tlsAllowedVersions :: [Version]

  Supported TLS versions

• tlsCiphers :: [Cipher]

  Supported ciphers

Instances

Default TLSSettings

Defined in Network.Mail.Postie.Settings

Methods

def :: TLSSettings

data StartTLSPolicy

Connection security policy, either via STARTTLS command or on connection initiation.

Constructors

AllowStartTLS

Allows clients to use STARTTLS command

DemandStartTLS

Client needs to send STARTTLS command before issuing a mail transaction

ConnectWithTLS

Negotiates a TSL context on connection startup.

Instances

Eq StartTLSPolicy

Defined in Network.Mail.Postie.Settings

Methods

(==) :: StartTLSPolicy -> StartTLSPolicy -> Bool

(/=) :: StartTLSPolicy -> StartTLSPolicy -> Bool

Show StartTLSPolicy

Defined in Network.Mail.Postie.Settings

Methods

showsPrec :: Int -> StartTLSPolicy -> ShowS

show :: StartTLSPolicy -> String

showList :: [StartTLSPolicy] -> ShowS

settingsStartTLSPolicy :: Settings -> Maybe StartTLSPolicy

defaultExceptionHandler :: Maybe SessionID -> SomeException -> IO ()

mkServerParams :: TLSSettings -> IO ServerParams

def :: Default a => a

The default value for this type.

reexport from Default class