PostMark Email Services

City of Boston use PostMark to relay emails.

Code for this service/endpoint is contained in the module bos_email.

REST Endpoints

Requests an email token.

POST /rest/email_token/create

Provides an email session token which must be supplied as a field when the form is submitted to therest/email_session endpoints.

200: OK Creates and saves a new session token.

{
    "token_session": int
}

The session token is saved against the users session on the server.

Deletes an existing token.

POST /rest/token/remove

Invalidates a previously created email session token.

200: OK

{
    "token_session": "removed"
}

or

{
    "token_session": "not found"
}

Send an email via PostMark

POST /rest/email_session/{server}

Headers

Name	Type	Description
authorization*	String	token {token}

Request Body

Name	Type	Description
email["token_session"]*	String	The session token.
email["to_address"]*	String	The recipient.
email["from_address"]*	String	The sender.
email["subject"]*	String	Subject for email.
email["message"]	String	Body for message (contactform)
email["useHtml"]	Int	Should mail be HTML format? 1 or 0
email["template_id"]	String	Use a POSTMARK template
email["cc"]	String	CC recipients for email.
email["bcc"]	String	BCC recipients for email.
email["{string}"]	String	Any other fields required by templates.

200: OK

{
    'status': 'success',
    'response': 'Message sent'
}

or 

{
    'status': 'success',
    'response': 'Message queued'
}

400: Bad Request Catch-all for errors.

{
    'status' => 'error',
    'response' => '{error message}',
}

401: Unauthorized The authorization header is wrong

{
    'status' => 'error',
    'response' => 'could not authenticate',
}

403: Forbidden The token provided was not found in the session. It may have been previously used.

{
        'status': 'error',
        'response': 'invalid token',
}

[legacy] Send an email via PostMark (legacy)

POST /rest/email/{server}

Use email_session for additional security.

200: OK

{
    'status': 'success',
    'response': 'Message sent'
}

or 

{
    'status': 'success',
    'response': 'Message queued'
}

400: Bad Request Catch-all for errors

{
    'status': 'error',
    'response': '{error message}',
}

401: Unauthorized The authorization header is wrong

{
    'status': 'error',
    'response': 'could not authenticate',
}

[deprecated 2021] Alias for /rest/email/contactform

POST /emails