https://github.com/activecampaign/postmark-gem
Official Ruby client library for the Postmark HTTP API
https://github.com/activecampaign/postmark-gem
Last synced: about 1 year ago
JSON representation
Official Ruby client library for the Postmark HTTP API
- Host: GitHub
- URL: https://github.com/activecampaign/postmark-gem
- Owner: ActiveCampaign
- License: mit
- Created: 2009-11-04T14:55:57.000Z (over 16 years ago)
- Default Branch: main
- Last Pushed: 2024-07-31T14:22:45.000Z (almost 2 years ago)
- Last Synced: 2025-03-31T19:11:22.427Z (about 1 year ago)
- Language: Ruby
- Homepage: https://postmarkapp.com
- Size: 645 KB
- Stars: 219
- Watchers: 16
- Forks: 71
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rdoc
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Postmark Ruby Gem
[](https://circleci.com/gh/ActiveCampaign/postmark-gem)
[](https://codeclimate.com/github/ActiveCampaign/postmark-gem)
[](http://www.opensource.org/licenses/MIT)
[](https://badge.fury.io/rb/postmark)
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](https://postmarkapp.com).
## Usage
Please see the [wiki](https://github.com/ActiveCampaign/postmark-gem/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](https://postmarkapp.com/developer).
## 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](https://github.com/ActiveCampaign/postmark-gem/wiki/Getting-Started).
If you plan using the library in a Rails project, check out the [postmark-rails](https://github.com/ActiveCampaign/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:
```ruby
Postmark.response_parser_class = :Json # :ActiveSupport or :Yajl are also supported.
```
## Installation
You can use the library with or without a Bundler.
With Bundler:
```ruby
gem 'postmark'
```
Without Bundler:
```bash
gem install postmark
```
## Deprecations
Deprecations can be either silenced or set to raise using:
```rb
Postmark::Deprecations.behavior = :silence
Postmark::Deprecations.behavior = :raise
```
## Note on Patches/Pull Requests
See [CONTRIBUTING.md](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](http://www.opensource.org/licenses/mit-license.php) license.
Refer to the [LICENSE](https://github.com/ActiveCampaign/postmark-gem/blob/main/LICENSE) file for more information.
## Tests
The [integration tests](https://github.com/ActiveCampaign/postmark-gem/tree/main/spec/integration) currently use a real test email address, configured via `POSTMARK_CI_RECIPIENT`.
## Copyright
Copyright © 2023 ActiveCampaign LLC.