Postmark

Writes

• Send email

  read back

  postmark-send-email

  Send one email to one recipient from a confirmed sender signature or domain, in a message stream. Give text_body, html_body or both. Returns the MessageID.

• Send template email

  read back

  postmark-send-template-email

  Send one email to one recipient from a server template, filled with template_model. Give template_id or template_alias. Returns the MessageID.

• Activate bounce

  read back

  postmark-activate-bounce

  Reactivate an address Postmark deactivated after a bounce, so email to it is sent again. A bounce can be reactivated when its CanActivate is true.

• Suppress recipient

  read back

  postmark-suppress-recipient

  Stop a stream from sending to one address (a manual suppression). Email to it is then refused until the suppression is removed.

• Unsuppress recipient

  read back

  postmark-unsuppress-recipient

  Remove one address from a stream's suppressions, so email to it is sent again. A suppression for a spam complaint cannot be removed.

Reads

• List message streams

  postmark-list-message-streams

  List the server's message streams that are not archived: id, name, type (Transactional, Broadcasts, Inbound) and unsubscribe handling. Use a stream's id as message_stream in the other actions. A server has few streams, so they come in one response.

• Search outbound messages

  postmark-search-outbound-messages

  Search sent and queued emails: message id, recipients, from, subject, tag, status, metadata and stream, without bodies (use get-outbound-message). 20 a page. Messages are kept for the server's retention period, 45 days unless changed in Postmark.

• Get outbound message

  postmark-get-outbound-message

  Get one sent email by message id: recipients, from, subject, text and HTML bodies, tag, metadata, status, and its events (Delivered, Bounced, Opened, LinkClicked, Transient, SubscriptionChanged) with their times. A long body can be cut at the response limit.

• Search inbound messages

  postmark-search-inbound-messages

  Search emails the server received: message id, from, to, subject, mailbox hash, attachments' names and sizes, and status. 20 a page. Postmark returns processed messages unless status is given.

• Get inbound message

  postmark-get-inbound-message

  Get one received email by message id: from, to, cc, reply-to, subject, date, text and HTML bodies, headers, attachments' names, status and, if it was blocked, why. A long body can be cut at the response limit.

• List bounces

  postmark-list-bounces

  List bounces: bounce id, type (HardBounce, SoftBounce, Transient and others), the address, the message id, when, and whether Postmark deactivated the address and it can be reactivated (Inactive, CanActivate). 20 a page.

• Get bounce

  postmark-get-bounce

  Get one bounce by id: type, description, details, the address, the message id, when, whether the address is inactive and can be reactivated, and the bounce content. Long content can be cut at the response limit.

• Get delivery stats

  postmark-get-delivery-stats

  Get the server's bounce totals by type, and how many addresses are inactive because of a bounce or a complaint. Changes nothing.

• Get outbound stats

  postmark-get-outbound-stats

  Get the server's sending totals: sent, bounced, bounce rate, spam complaints, opens, unique opens and clicks, for all time or a date range, optionally for one tag or stream. Dates are US Eastern time.

• List suppressions

  postmark-list-suppressions

  List the addresses a stream will not send to, with the reason (HardBounce, SpamComplaint, ManualSuppression), the origin (Recipient, Customer, Admin) and when. Postmark returns every match in one response, so give an address or a date range on a large list: a response over the limit is cut.

• List templates

  postmark-list-templates

  List the server's templates: id, name, alias, whether it is active, and its type (Standard or Layout). 20 a page. Use an id or alias in get-template or send-template-email.

• Get template

  postmark-get-template

  Get one template by id or alias: name, subject, HTML and text bodies with their placeholders, whether it is active, and its layout. Read it before send-template-email to know which values template_model needs.