Sign in to fill these examples with your own keys. Sign in Start free trial

Send emails with Ruby

Install the Ruby SDK from GitHub and call send_email.

What you'll build

A Ruby script that sends a receipt email with the postshiba gem and prints the queued message.

Before you start

  • An API key with Send only access. Full access also works. See Create an API key. Support keys cannot send.
  • A verified sending domain. See Add and verify a domain. from must be an address on it.
  • A cluster that is ready to send (sending_ready is true). See Clusters.
  • Ruby 3.1 or later.

Install

The gem is on GitHub, not RubyGems. Add it to your Gemfile, then run bundle install.

Gemfile
1gem "postshiba", git: "https://github.com/postshiba/postshiba-ruby.git"

Send your first email

Pass your API key to PostShiba.new, then call send_email with a Hash. team_id is only needed for team-scoped calls such as listing clusters, which need a Full access key kept out of your deployed app. It is on the API keys page.

send.rb
1require "postshiba" 2 3postshiba = PostShiba.new(api_key: "YOUR_API_KEY", team_id: "KjkAJW") 4 5sent = postshiba.send_email({ 6 from: "hello@mail.example.com", 7 to: ["you@example.com"], 8 reply_to: "support@example.com", 9 subject: "Your receipt", 10 text: "Thanks for your order.", 11 html: "<p>Thanks for your order.</p>", 12 unique_args: {order_id: "ord_123"} 13}) 14puts sent

Run it with bundle exec ruby send.rb. send_email returns the JSON body of the 201 response as a Hash with string keys. The message then shows under Events in the dashboard.

response.json
1{ 2 "queued": true, 3 "message_id": "abc@capsule.test", 4 "from": "hello@mail.example.com", 5 "to": ["you@example.com"], 6 "subject": "Your receipt", 7 "unique_args": {"order_id": "ord_123"} 8}

Pin a cluster

Without a pin, PostShiba uses your first cluster that is ready to send. Pass cluster_id: after the message Hash to choose one.

pin.rb
1postshiba.send_email(message, cluster_id: "NmQpXr")

Attachments and templates

Attach a file

Add attachments with filename, content_type, and base64 content. Up to 10 files, 18 MB in total. See Attachments for allowed types.

attachment.rb
1require "base64" 2 3postshiba.send_email({ 4 from: "hello@mail.example.com", 5 to: ["you@example.com"], 6 subject: "Your invoice", 7 text: "Your invoice is attached.", 8 attachments: [ 9 {filename: "invoice.pdf", content_type: "application/pdf", content: Base64.strict_encode64(File.binread("invoice.pdf"))} 10 ] 11})

Send a published template

Pass template with the alias or public id and its variables. Leave out html and text.

template.rb
1postshiba.send_email({ 2 from: "hello@mail.example.com", 3 to: ["you@example.com"], 4 template: {id: "welcome", variables: {name: "Ada"}} 5})

Keep the key safe

Use a Send only key in your app. It can send email and call GET /api/v1/users/me. Every other request returns 403 forbidden.

If this key leaks Send only Full access
Send mail from your verified domains Yes Yes
Read events, recipients, templates, and sent messages No Yes
See SMTP passwords and webhook secrets No Yes
Change clusters, domains, credentials, webhooks, and suppressions No Yes
  • Keep Full access keys for setup scripts, the CLI, and MCP. Don't deploy one with your app.
  • Read the key from an environment variable, such as PostShiba.new(api_key: ENV.fetch("POSTSHIBA_API_KEY")). Don't commit it, log it, or put it in a URL.
  • Send from your server. Never put a key, even a Send only key, in browser or mobile code.
  • Create one key per app and environment. If a key leaks, delete it on API keys and create a new one. Deleting stops it straight away.

Troubleshooting

A response outside 2xx raises PostShiba::Error. error and field come from the JSON body, and message holds the explanation.

errors.rb
1begin 2 postshiba.send_email(message) 3rescue PostShiba::Error => e 4 warn [e.error, e.field, e.message].join(" ") 5 raise 6end
Status error What to do
401 Invalid token or no user signed in The API key is missing, mistyped, or deleted. Copy it again from API keys.
403 forbidden Support keys cannot send. Use a Send only or Full access key. A Send only key gets this on any call other than sending.
403 domain_unverified from is not on a verified domain.
403 kyc_required Your team is pending production approval. Until then, send only to team members, live inbox addresses, and inbox forward-to addresses.
422 invalid field names the problem, such as a missing to, an unpublished template, or a rejected attachment.
429 throttled The cluster hit its hourly throttle or 24-hour cap. The client does not retry, and retrying right away hits the same cap. See What happens at your cap.
429 rate_limited More than 300 send requests in one minute on one API key. Slow down.

Every other status is on Errors.

Next steps