Send HIPAA compliant transactional email with Ruby

Featured image

Share this article

Send HIPAA Compliant Transactional Email with Ruby - Paubox

Ruby for Paubox Email API

The Paubox Ruby gem allows you to construct and send secure, HIPAA compliant transactional email. This package is the official Ruby gem for the Paubox Email API.

The Paubox Email API allows your application to send secure, HIPAA compliant email via Paubox and track deliveries and opens.

SEE ALSO: Why Healthcare Businesses Choose the Paubox Email API

Installation


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 Email 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']
end

Usage


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 = Mail.new do
  from            '[email protected]'
  to              '[email protected]'
  subject         'HIPAA-compliant email made easy'

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

  html_part do
    content_type  'text/html; charset=UTF-8'
    body          '

This message will be sent securely by Paubox.

‘ end delivery_method Mail::Paubox end message.deliver! => {“message”=>”Service OK”, “sourceTrackingId”=>”2a3c048485aa4cf6”} message.source_tracking_id => “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 = Mail.new do
  from            '[email protected]'
  to              '[email protected]'
  subject         'Sending non-PHI'
  body            'This message delivery will not enforce TLS transmission.'

  delivery_method Mail::Paubox
end

message.allow_non_tls = true
message.deliver!

Sending Messages using just the Paubox Email API

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

args = { from: '[email protected]',
         to: '[email protected], [email protected]',
         cc: ['[email protected]', '[email protected]'],
         bcc: '[email protected]',
         reply_to: '[email protected]',
         subject: 'Testing!',
         text_content: 'Hello World!',
         html_content: '

Hello World!

‘ } message = Paubox::Message.new(args) client = Paubox::Client.new client.deliver_mail(message) => {“message”=>”Service OK”, “sourceTrackingId”=>”2a3c048485aa4cf6”}

Checking Email Dispositions

client = Paubox::Client.new
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
=> [>]

# Inspect a message delivery
delivery = message_deliveries.first

delivery.recipient
=> "[email protected]"

# Inspect the message delivery status
status = delivery.status

status.delivery_status
=> "delivered"

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

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

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

Contributing


Bug reports and pull requests are welcome on GitHub at https://github.com/Paubox/paubox_ruby.

Try the Paubox Email API for FREE today.
Author Photo

About the author

Hoala Greevy

Founder of Paubox. Kayak fishing when I can. Native Hawaiian CEO.

Read more by Hoala Greevy

Get started with
end-to-end protection

Bolster your organization’s security with healthcare’s most trusted HIPAA compliant email solution

The #1-rated email encryption 
and security software on G2

G2 Badge: Email Encryption Leader Fall 2022
G2 Badge: Security Best Usability Fall 2022
G2 Badge: Encryption Momentum Leader Fall 2022
G2 Badge: Security Best Relationship Fall 2022
G2 Badge: Security Users Most Likely to Recommend Fall 2022
G2 Badge: Email Gateway Best Relationship Fall 2022
G2 Badge: Email Gateway Best Meets Requirements Fall 2022
G2 Badge - Users Most Likely to Recommend Summer 2022
G2 Badge: Email Gateway Best Results Fall 2022
G2 Badge: Email Gateway Best Usability Fall 2022
G2 Badge: Email Gateway Best Support Fall 2022
G2 Badge: Email Gateway Easiest To Use Fall 2022
G2 Badge: Email Gateway Easiest Setup Fall 2022
G2 Badge: Email Gateway Easiest Admin Fall 2022
G2 Badge: Email Gateway Easiest to do Business with Fall 2022
G2 Badge: Email Gateway Highest User Adoption 2022
G2 Badge: Email Gateway High Performer Fall 2022
G2 Badge: Email Gateway Momentum Leader Fall 2022
G2 Badge: Email Gateway Most Implementable Fall 2022
G2 Badge: Email Gateway Users Most Likely to Recommend Fall 2022