Перейти к документации
Ruby

Гем для Ruby

Официальный клиент OpenEmail API для Ruby. Без зависимостей во время выполнения и с одним методом на каждый эндпоинт.

Что это

Один гем на весь API (отправка, шаблоны, отслеживание, цепочки, черновики, ярлыки, контакты, аудитории, формы подписки, рассылки, домены, правила, вебхуки, календарь, настройки, роли, участники, подавления, файлы и одноразовые ящики): метод для каждого метода TypeScript SDK под тем же именем в snake_case, класс ошибки для каждого вида отказа, повторы, которые не могут продублировать отправку, и проверка подписи вебхуков. Ему нужен Ruby 3.2 или новее и больше ничего, а один клиент можно безопасно разделять между потоками, и он переживает форк процесса.

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>")

Куда идти дальше

Он оборачивает тот же API, что и все остальные клиенты

Всё здесь описывает ту же поверхность, которую документирует справочник API и оборачивает TypeScript SDK. Что делает эндпоинт, читайте в справочнике API, а как вызвать его из Ruby, читайте здесь. У каждого метода TypeScript есть двойник на Ruby, а проверка соответствия гема запускает оба с одинаковыми аргументами и падает, если они не отправляют побайтно одинаковый запрос.