An Erlang library for consuming the Postmark mail service API, inspired by the official Postmark PHP package https://github.com/wildbit/postmark-php.

• Build
• Quickstart
• Supported Operations
• Installation
• Data Types
• Record Types
• Modules Index
• Module Exports Details
• Simple Usage

$ rebar3 compile

To use erlang_postmarkapp from the console, simply do this:

$ ./init.sh

This will build it and start the Erlang shell.

This library currently supports sending emails, handling bounces and managing servers. [are more functions in the planning?]

• Sending a single text or html email send_email/1, send_email/4, send_email/11
• Sending multiple emails in a batch: send_email_batch/1
• Sending a single email using a template: send_email_with_template/1, send_email_with_template/10
• Getting delivery stats: get_delivery_stats/0
• Querying for bounces: get_bounces/1
• Getting a single bounce: get_bounce/1
• Getting the dump for a bounce: get_bounce_dump/1
• Activating an email that had a bounce: activate_bounce/1
• Getting tags with bounces: get_bounce_tags/0
• Getting information about a server: get_server/0
• Editing a server: edit_server/1

Add it to your rebar.config like so:

{deps, [
       ...
       {erlang_postmarkapp, "1.*", {git, "https://github.com/emmanix2002/erlang_postmarkapp.git", {branch, "master"}}}
]}.

deliveryStat() = {inactive_mails, integer()} | {bounces, [#postmark_bounce_stats{}]}

deliveryStatsResponse() = [deliveryStat()] | {error, string()}

bounce() = #postmark_bounce{}

bounces() = [bounce()]

bouncesInfo() = {total, integer()} | {bounces, bounces()}

bouncesResponse() = [bouncesInfo()]

emailBody() = {text, string()} | {html, string()}

optionalValue() = string() | undefined

optionalListValue() = list() | undefined

postmarkEmail() = #postmark_email{}

postmarkEmails() = [postmarkEmail()]

sendEmailResponse() = {ok, string()} | {error, string()}

serverColor() = purple | blue | turqoise | green | red | yellow | grey

tag() = string()

tags() = [tag()]

trackLinkStatus() = none | html_and_text | html_only | text_only

setup/1, setup/2, send_email/1, send_email/4, send_email/11, send_email_with_template/1, send_email_with_template/10,
send_email_batch/1, get_server_token/0, get_account_token/0, track_links_to_string/1

activate_bounce/1, get_delivery_stats/0, get_bounces/1, get_bounce/1, get_bounce_dump/1, get_bounce_tags/0,

get_server/0, edit_server/1

Set up erlang_postmarkapp by providing the Server Token [and optionally an Account Token].
Before you start making calls, you must call the setup/1 or setup/2 functions to initialise the library and start all required processes. We recommend putting the call to setup() in your init function, if you have any.

Here's a simple example of sending a plaintext email:

send_text_mail() ->
    ServerToken = "your server token here",
    erlang_postmarkapp:setup(ServerToken),
    Body = {text, "Hello World!"},
    case erlang_postmarkapp:send_email("signature@domain.com", "recipient@example.com", "A good example", Body) of
        {ok, MessageId} -> io:format("Successfully sent email with MessageID ~p~n", [MessageId]);
        {error, Reason} -> io:format("Message sending failed because ~p~n", [Reason])
    end.

• setup(ServerToken): sets the server token for authenticating with the Postmark API.
• send_email*(): these functions allow you to send an email.

NOTE: based on the information on the Postman documentation, batch emails are limited to a maximum of 500 messages (the library enforces this). For single emails, you can have a maximum of 50 email addresses from a combination of all To, Cc, and Bcc addresses.