Skip to main content
The Paubox Rails SDK (paubox_rails) integrates the Paubox Email API directly into Rails as an ActionMailer delivery method. Your mailer classes work exactly as they do today; just point ActionMailer at Paubox and every email you send becomes encrypted and HIPAA compliant. The gem also includes a lightweight client for the Paubox Forms API.

What you can do

  • Send encrypted, HIPAA compliant email through standard Rails mailers and ActionMailer
  • Use HTML and plain-text templates, CC and BCC, reply-to, and attachments. Other headers are not sent to Paubox.
  • Deliver synchronously with deliver_now or asynchronously with deliver_later
  • Schedule sends, manage receiving domains and mailboxes, and read inbound email through Paubox::Client from the paubox gem
  • Manage webhook endpoints with PauboxRails::Webhooks
  • Retrieve Paubox Form schemas and submit form responses with file attachments

Requirements

  • ActionMailer 4.0 or later. The samples use parameterized mailers (with and params), which need Rails 5.1 or later.
  • Ruby 2.5 or later
  • Dependencies installed automatically: actionmailer and the paubox gem (~> 1.0)
The scheduling and receiving samples need paubox 1.3.1 or later. Run bundle update paubox if your lockfile has an older 1.x version. The webhook samples need paubox_rails 1.2.0 or later.

Get started

Quickstart

Add the gem, configure credentials, and send your first email in minutes.

Authentication

Configure your API key via a Rails initializer.

Email delivery

Full guide to sending email through ActionMailer with Paubox.

Forms client

Retrieve form schemas and submit responses.