Ruby

Ruby gem

The official Ruby client for the OpenEmail API. No runtime dependencies, and one method for every endpoint.

What it is

One gem over the whole API (sending, templates, tracking, threads, drafts, labels, contacts, audiences, sign-up forms, broadcasts, domains, rules, webhooks, calendar, settings, roles, members, suppressions, files and disposable inboxes) with a method for every method of the TypeScript SDK under the same name in snake_case, an error class for every kind of refusal, retries that cannot duplicate a send, and a webhook signature verifier. It needs Ruby 3.2 or later and nothing else, and one client is safe to share across threads and survives a fork.

bundle add openemail

send_email.rb

require "openemail" OpenEmail.init(api_key: ENV.fetch("OPENEMAIL_API_KEY")) OpenEmail.emails.send(  from: "Acme Billing <[email protected]>",  to: "[email protected]",  subject: "Your September invoice",  html: "<p>Invoice attached.</p>")

Where to go

InstallAdd the gem and send your first message.ConfigurationEvery option, and what it refuses.Send an emailEvery field on a message.ThreadsRead, organise, snooze, attachments.WebhooksRegister an endpoint and verify it.ErrorsWhat raises, and how to rescue it.RetriesWhy a retried send cannot duplicate.PaginationOne page, every page, or one item at a time.RailsCredentials, jobs, webhooks and tests.Every methodThe complete list, one row each.

It wraps the same API as every other client

Everything here is the surface the API reference documents and the TypeScript SDK wraps, so read the API reference for what an endpoint does and this for how to call it from Ruby. Every TypeScript method has a Ruby twin, and the gem’s parity check runs both with the same arguments and fails unless they send byte for byte the same request.

API referenceWhat each endpoint does, and how it fails.

Ruby gem

What it is

Where to go

It wraps the same API as every other client

Your inbox,on your own terms.

Your inbox,
on your own terms.