Skip to main content
The Paubox Ruby SDK (paubox gem) is the core Ruby client library for the Paubox Email API and Paubox Forms. It provides direct API access for sending and scheduling encrypted email, managing dynamic templates, tracking delivery, receiving inbound email, managing webhook endpoints, and working with forms.

What you can do

  • Send encrypted, HIPAA compliant email to one or more recipients
  • Create, update, and delete dynamic Handlebars templates
  • Send templated messages with per-message variable substitution
  • Track delivery status and open engagement per recipient
  • Schedule, reschedule, and cancel future sends
  • Manage receiving domains and mailboxes, and read inbound email and attachments
  • Manage webhook endpoints for Email API and Forms events
  • Retrieve Paubox Form schemas and submit form responses with file attachments

Requirements

  • Ruby 2.5 or later
  • Dependencies installed automatically: mail, rest-client, base64, and ostruct

Rails applications

If you are using Rails, the paubox_rails gem builds on top of this library and adds ActionMailer integration. Use paubox directly for non-Rails Ruby applications, scripts, or background jobs.

Get started

Quickstart

Configure credentials and send your first email in minutes.

Authentication

Configure globally or per-client with your API key.

Email client

Full reference for sending email, managing templates, and tracking delivery.

Forms client

Retrieve form schemas and submit responses.