Network.Api.Postmark.Settings

Settings types

data PostmarkSettings

To construct PostmarkSettings, use postmarkHttps or postmarkHttp.

Or to use the test API instead, use postmarkHttpsTest or postmarkHttpTest.

Constructors

PostmarkSettings

Fields

• apiUrl :: Text
• apiToken :: PostmarkApiToken

Instances

Eq PostmarkSettings

Defined in Network.Api.Postmark.Settings

Methods

(==) :: PostmarkSettings -> PostmarkSettings -> Bool

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

Show PostmarkSettings

Defined in Network.Api.Postmark.Settings

Methods

showsPrec :: Int -> PostmarkSettings -> ShowS

show :: PostmarkSettings -> String

showList :: [PostmarkSettings] -> ShowS

type PostmarkApiToken = Text

The Postmark “server token” which is sent via the X-Postmark-Server-Token HTTP header. You can find your server token under the “Credentials” tab on the Postmark website.

If you do not yet have a Postmark account, or if you want to send test emails that don't actually get delivered, you may use postmarkTestToken.

https://postmarkapp.com/developer/api/overview#authentication

Settings construction

postmarkHttp :: PostmarkApiToken -> PostmarkSettings

Constructs Postmark settings using the HTTP protocol and your API token.

HTTPS is recommended instead (postmarkHttps).

postmarkHttps :: PostmarkApiToken -> PostmarkSettings

Constructs Postmark settings using the HTTPS protocol and your API token.

Using the test token

postmarkTestToken :: PostmarkApiToken

An API token that you can use when you want to send test emails that don't actually get delivered to the recipient.

https://postmarkapp.com/developer/api/overview#authentication

postmarkHttpTest :: PostmarkSettings

Postmark settings using the HTTP protocol and the test API token (postmarkTestToken).

HTTPS is recommended instead (postmarkHttpsTest).

postmarkHttpsTest :: PostmarkSettings

Postmark settings using the HTTPS protocol and the test API token (postmarkTestToken).