Quickstart

Install the Paubox Ruby gem and send your first HIPAA compliant email in minutes.

1. Install the gem

   Add to your Gemfile:

   gem 'paubox'
   

   Then install:

   bundle install
   

   Or install directly:

   gem install paubox
   
2. Configure credentials

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

   To obtain credentials, see Authentication.

3. Send your first email

   client = Paubox::Client.new
   
   message = Paubox::Message.new(
     from:         '[e-mail]',
     to:           ['[e-mail]'],
     subject:      'Your first Paubox email',
     text_content: 'This message was sent with the Paubox Ruby SDK.'
   )
   
   response = client.send_mail(message)
   
   puts "Sent. Tracking ID: #{response[:source_tracking_id]}"
   
4. Check delivery status

   tracking_id = response[:source_tracking_id]
   disposition = client.email_disposition(tracking_id)
   
   disposition.message_deliveries.each do |delivery|
     puts "#{delivery.recipient} → #{delivery.status.delivery_status}"
   end
   

Next steps

• Email client: attachments, dynamic templates, error handling
• Forms client: retrieve form schemas and submit responses