Project

postmark

0.41
A long-lived project that still receives updates
Use this gem to send emails through Postmark HTTP API and retrieve info about bounces.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0

Runtime

>= 0
 Project Readme
Postmark Logo

Postmark Ruby Gem

Build Status Code Climate License Gem Version

Postmark allows you to send your emails with high delivery rates. It also includes detailed statistics. In addition, Postmark can parse incoming emails which are forwarded back to your application.

This gem is the official wrapper for the Postmark HTTP API.

Usage

Please see the wiki for detailed instructions about sending email, using the bounce api and other Postmark API features. For details about Postmark API in general, please check out Postmark developer docs.

Requirements

You will need a Postmark account, server and sender signature (or verified domain) set up to use it. For details about setup, check out wiki pages.

If you plan using the library in a Rails project, check out the postmark-rails gem, which is meant to integrate with ActionMailer. The plugin will try to use ActiveSupport JSON if it is already included. If not, it will attempt to use the built-in Ruby JSON library.

You can also explicitly specify which one to be used, using following code:

Postmark.response_parser_class = :Json # :ActiveSupport or :Yajl are also supported.

Installation

You can use the library with or without a Bundler.

With Bundler:

gem 'postmark'

Without Bundler:

gem install postmark

Deprecations

Deprecations can be either silenced or set to raise using:

Postmark::Deprecations.behavior = :silence
Postmark::Deprecations.behavior = :raise

Note on Patches/Pull Requests

See CONTRIBUTING.md file for details.

Issues & Comments

Feel free to contact us if you encounter any issues with the library or Postmark API. Please leave all comments, bugs, requests and issues on the Issues page.

License

The Postmark Ruby library is licensed under the MIT license. Refer to the LICENSE file for more information.

Tests

The integration tests currently use a real test email address, configured via POSTMARK_CI_RECIPIENT.

Copyright

Copyright © 2023 ActiveCampaign LLC.