Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

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 encrypted email, managing dynamic templates, tracking delivery with typed response objects, and submitting form responses. 
# Gemfile
gem 'paubox'

​
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
  • Retrieve Paubox Form schemas and submit form responses with file attachments

​
Requirements

  • Ruby >= 2.3
  • Dependencies installed automatically: mail and rest-client

​
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 and username.

Email client

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

Forms client

Retrieve form schemas and submit responses.