Send emails with Ruby

Prerequisites

A Sendbaze API key
A verified domain. A test key works without one, and so does the shared test address for emails to yourself.
Ruby 3.1 or later

The examples use the standard library net/http, so nothing needs installing. An official gem is on the roadmap.

Guide

Set your API key

.env

SENDBAZE_API_KEY=sk_live_xxxxxxxx

Send an email

send.rb

require "net/http"
require "json"

uri = URI("https://api.sendbaze.com/v1/emails")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("SENDBAZE_API_KEY")}"
request["Content-Type"] = "application/json"
request.body = {
  from: "Yourshop <orders@yourshop.co.za>",
  to: "thandi@example.com",
  subject: "Your order #1042 has shipped",
  html: "<p>Tracking: <b>CG123456789ZA</b></p>"
}.to_json

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
body = JSON.parse(response.body)

if response.is_a?(Net::HTTPSuccess)
  puts body["id"] # em_01j9...
else
  warn "#{body.dig("error", "code")}: #{body.dig("error", "message")}"
end

Try it

Run ruby send.rb and open the dashboard Logs.

Examples

A small client

sendbaze.rb

require "net/http"
require "json"

class Sendbaze
  Error = Class.new(StandardError) do
    attr_reader :code, :fields
    def initialize(body)
      @code = body.dig("error", "code")
      @fields = body.dig("error", "fields")
      super(body.dig("error", "message"))
    end
  end

  def initialize(api_key: ENV.fetch("SENDBAZE_API_KEY"), base_url: "https://api.sendbaze.com")
    @api_key = api_key
    @base_url = base_url
  end

  def send_email(idempotency_key: nil, **email)
    request(:post, "/v1/emails", email, idempotency_key: idempotency_key)
  end

  def get_email(id)
    request(:get, "/v1/emails/#{id}")
  end

  private

  def request(method, path, body = nil, idempotency_key: nil)
    uri = URI(@base_url + path)
    req = Net::HTTP.const_get(method.to_s.capitalize).new(uri)
    req["Authorization"] = "Bearer #{@api_key}"
    req["Content-Type"] = "application/json"
    req["Idempotency-Key"] = idempotency_key if idempotency_key
    req.body = body.to_json if body
    res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, read_timeout: 30) { |http| http.request(req) }
    parsed = JSON.parse(res.body)
    raise Error.new(parsed) unless res.is_a?(Net::HTTPSuccess)
    parsed
  end
end

Rails

Use a mailer-style service object from a job so a slow network never blocks a request.

app/jobs/send_receipt_job.rb

class SendReceiptJob < ApplicationJob
  queue_as :default

  def perform(order)
    Sendbaze.new.send_email(
      idempotency_key: "receipt-#{order.id}",
      from: "orders@yourshop.co.za",
      to: order.user.email,
      templateId: "tpl_receipt",
      variables: { name: order.user.first_name, order_id: order.id, total: order.total.format },
      tags: ["receipt"]
    )
  end
end

Attach a file

require "base64"

Sendbaze.new.send_email(
  from: "orders@yourshop.co.za",
  to: "thandi@example.com",
  subject: "Invoice 1042",
  html: "<p>Your invoice is attached.</p>",
  attachments: [
    { filename: "invoice-1042.pdf", contentType: "application/pdf", content: Base64.strict_encode64(File.binread("invoice-1042.pdf")) }
  ]
)

Get started

Learn

Resources

Send emails with Ruby

Prerequisites

Guide

Examples

A small client

Rails

Attach a file

​Prerequisites

​Guide

​Examples

​A small client

​Rails

​Attach a file

Prerequisites

Guide

Examples

A small client

Rails

Attach a file