Paubox Transactional Email API Official Ruby Gem
Switch branches/tags
Clone or download


Paubox Gem

This gem and Paubox Transactional Email HTTP API are currently in alpha development.

This is the official Ruby wrapper for the Paubox Transactional Email HTTP API. The Paubox Transactional Email API allows your application to send secure, HIPAA-compliant email via Paubox and track deliveries and opens.

It extends the Ruby Mail Library for seamless integration in your existing Ruby application. The API wrapper also allows you to construct and send messages directly without the Ruby Mail Library.

Table of Contents


Add this line to your application's Gemfile:

gem 'paubox'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install paubox

Getting Paubox API Credentials

You will need to have a Paubox account. You can sign up here.

Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.

Configuring API Credentials

Include your API credentials in an initializer (e.g. config/initializers/paubox.rb in Rails).

Keep your API credentials out of version control. Store these in environmental variables.

Paubox.configure do |config|
  config.api_key = ENV['PAUBOX_API_KEY']
  config.api_user = ENV['PAUBOX_API_USER']


Sending Messages with the Ruby Mail Library

Using the Ruby Mail Library? Sending via Paubox is easy. Just build a message as normal and set Mail::Paubox as the delivery method.

message = do
  from            ''
  to              ''
  subject         'HIPAA-compliant email made easy'

  text_part do
    body          'This message will be sent securely by Paubox.'

  html_part do
    content_type  'text/html; charset=UTF-8'
    body          '<h1>This message will be sent securely by Paubox.</h1>'

  delivery_method Mail::Paubox

=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}

=> "2a3c048485aa4cf6"

Allowing non-TLS message delivery

If you want to send non-PHI mail that does not need to be HIPAA-compliant, you can allow the message delivery to take place even if a TLS connection is unavailable. This means a message will not be converted into a secure portal message when a non-TLS connection is encountered.

message = do
  from            ''
  to              ''
  subject         'Sending non-PHI'
  body            'This message delivery will not enforce TLS transmission.'

  delivery_method Mail::Paubox

message.allow_non_tls = true

Sending Messages using just the Paubox API

You don't need to use Ruby Mail to build and send messages with Paubox.

args = { from: '',
         to: ',',
         cc: ['', ''],
         bcc: '',
         reply_to: '',
         subject: 'Testing!',
         text_content: 'Hello World!',
         html_content: '<h1>Hello World!</h1>' }

message =

client =
=> {"message"=>"Service OK", "sourceTrackingId"=>"2a3c048485aa4cf6"}

Checking Email Dispositions

client =
email_disposition = client.email_disposition('2a3c048485aa4cf6')

# Get array of email_dispositions. One email_disposition is generated for each recipient.
message_deliveries = email_disposition.message_deliveries
=> [<struct Paubox::EmailDisposition::MessageDelivery recipient="", status=#<struct Paubox::EmailDisposition::MessageDeliveryStatus delivery_status="delivered", delivery_time=Mon, 30 Apr 2018 12:54:19 -0700, opened_status="opened", opened_time=Mon, 30 Apr 2018 12:55:19 -0700>>]

# Inspect a message delivery
delivery = message_deliveries.first

=> ""

# Inspect the message delivery status
status = delivery.status

=> "delivered"

=> Mon, 30 Apr 2018 12:54:19 -0700

# opened_status is only available for single-recipient messages
=> "opened"

# opened_time is only available for single-recipient messages
=> Mon, 30 Apr 2018 12:55:19 -0700


Bug reports and pull requests are welcome on GitHub at


Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


Copyright © 2018, Paubox Inc.