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.

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:         'sender@yourdomain.com',
  to:           ['recipient@example.com'],
  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