Network.Mail.Mailgun.Config

Documentation

type DomainName = String

data MailgunConfig

The configuration we use when accessing the Mailgun API.

Constructors

MailgunConfig

Fields

• _mailgunDomain :: DomainName

  The domain we're using mailgun with.

• _mailgunApiKey :: ByteString

  Our mailgun API key.

• _mailgunApiDomain :: String

  The base URL for the mailgun API, usually "https://api.mailgun.net"

• _mailgunTestMode :: Bool

Instances

Eq MailgunConfig

Defined in Network.Mail.Mailgun.Config

Methods

(==) :: MailgunConfig -> MailgunConfig -> Bool

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

Show MailgunConfig

Defined in Network.Mail.Mailgun.Config

Methods

showsPrec :: Int -> MailgunConfig -> ShowS

show :: MailgunConfig -> String

showList :: [MailgunConfig] -> ShowS

HasMailgunConfig MailgunConfig

Defined in Network.Mail.Mailgun.Config

Methods

mailgunConfig :: Lens' MailgunConfig MailgunConfig

mailgunApiDomain :: Lens' MailgunConfig String

mailgunApiKey :: Lens' MailgunConfig ByteString

mailgunDomain :: Lens' MailgunConfig DomainName

mailgunTestMode :: Lens' MailgunConfig Bool

class HasMailgunConfig c where

Minimal complete definition

mailgunConfig

Methods

mailgunConfig :: Lens' c MailgunConfig

mailgunApiDomain :: Lens' c String

mailgunApiKey :: Lens' c ByteString

mailgunDomain :: Lens' c DomainName

mailgunTestMode :: Lens' c Bool

Instances

HasMailgunConfig MailgunConfig

Defined in Network.Mail.Mailgun.Config

Methods

mailgunConfig :: Lens' MailgunConfig MailgunConfig

mailgunApiDomain :: Lens' MailgunConfig String

mailgunApiKey :: Lens' MailgunConfig ByteString

mailgunDomain :: Lens' MailgunConfig DomainName

mailgunTestMode :: Lens' MailgunConfig Bool

mailgunGetConfig :: (MonadIO m, MonadCatch m) => m MailgunConfig

Uses the available options to discover a MaingunConfig if possible.

mailgunFromEnv :: (MonadIO m, MonadThrow m) => m MailgunConfig

Builds a MaingunConfig from enviromental variables.

MAILGUN_API_KEY: Required; the API key for mailgun. MAILGUN_DOMAIN: Required; the domain in mailgun we're using. MAILGUN_REGION: Optional; Selects teh regional API endpoint. Valid values are US, and EU, defaults to US. MAILGUN_API_BASE: Optional; Override the base URL (primarily for testing). Takes presidence over MAILGUN_REGION. MAILGUN_LIVE: Optional: Unless set to True, set to test mode. In test mode Mailgun accepts but does not send messages.

mailgunFromIni :: forall m. (MonadIO m, MonadThrow m) => m MailgunConfig

Looks for an ini format file at ".mailgun" and "~/.mailgun" in that order. Credentials are read from the ini in the format: [mailgun] region: US domain: mydomain.com key: 3ax6xnjp29jd6fds4gc373sgvjxteol0 api_domain: api.mailgun.com live: True

The API key and domain are required, other values are optional.

data MailgunConfigException

Constructors

MailgunApiKeyRequired

MailgunDomainRequired

MailgunInvalidRegion

MailgunIniNotFound

MailgunConextUnavailable

Instances

Show MailgunConfigException

Defined in Network.Mail.Mailgun.Config

Methods

showsPrec :: Int -> MailgunConfigException -> ShowS

show :: MailgunConfigException -> String

showList :: [MailgunConfigException] -> ShowS

Exception MailgunConfigException

Defined in Network.Mail.Mailgun.Config

Methods

toException :: MailgunConfigException -> SomeException

fromException :: SomeException -> Maybe MailgunConfigException

displayException :: MailgunConfigException -> String

_MailgunApiKeyRequired :: Prism' MailgunConfigException ()

_MailgunDomainRequired :: Prism' MailgunConfigException ()

_MailgunInvalidRegion :: Prism' MailgunConfigException ()

_MailgunIniNotFound :: Prism' MailgunConfigException ()

_MailgunConextUnavailable :: Prism' MailgunConfigException ()