https://github.com/resend/resend-ruby
Resend's Ruby SDK
https://github.com/resend/resend-ruby
Last synced: 8 months ago
JSON representation
Resend's Ruby SDK
- Host: GitHub
- URL: https://github.com/resend/resend-ruby
- Owner: resend
- Created: 2022-12-11T02:56:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-06T13:43:27.000Z (8 months ago)
- Last Synced: 2025-10-06T15:28:37.806Z (8 months ago)
- Language: Ruby
- Homepage: https://resend.com
- Size: 225 KB
- Stars: 36
- Watchers: 1
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Resend Ruby and Rails SDK
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/rb/resend)
---
## Installation
To install Resend Ruby and Rails SDK, simply execute the following command in a terminal:
Via RubyGems:
```
gem install resend
```
Via Gemfile:
```
gem 'resend'
```
## Setup
First, you need to get an API key, which is available in the [Resend Dashboard](https://resend.com).
```ruby
require "resend"
Resend.api_key = ENV["RESEND_API_KEY"]
```
or
```ruby
require "resend"
Resend.configure do |config|
config.api_key = ENV["RESEND_API_KEY"]
end
```
The `#api_key` method also accepts a block without arguments, which can be useful for lazy or dynamic loading of API keys.
```ruby
require "resend"
Resend.api_key = -> { ENV["RESEND_API_KEY"] }
```
```ruby
Resend.configure do |config|
config.api_key = -> { Current.user.resend_api_key } # Assumes the user has a `resend_api_key` attribute.
end
```
## Example
```rb
require "resend"
Resend.api_key = ENV["RESEND_API_KEY"]
params = {
"from": "onboarding@resend.dev",
"to": ["delivered@resend.dev", "your@email.com"],
"html": "
Hello World
",
"subject": "Hey"
}
r = Resend::Emails.send(params)
puts r
```
You can view all the examples in the [examples folder](https://github.com/drish/resend-ruby/tree/main/examples)
# Rails and ActionMailer support
This gem can be used as an ActionMailer delivery method, add this to your `config/environments/environment.rb` file.
```ruby
config.action_mailer.delivery_method = :resend
```
Create or update your mailer initializer file and replace the placeholder with your Resend API Key.
```rb
# /config/initializers/resend.rb
Resend.api_key = "re_123456"
```
After that you can deliver_now!, example below:
```ruby
#/app/mailers/user_mailer
class UserMailer < ApplicationMailer
default from: 'you@yourdomain.io'
def welcome_email
@user = params[:user]
@url = 'http://example.com/login'
mail(to: ["example2@mail.com", "example1@mail.com"], subject: 'Hello from Resend')
end
end
# anywhere in the app
u = User.new name: "derich"
mailer = UserMailer.with(user: u).welcome_email
mailer.deliver_now!
# => {:id=>"b8f94710-0d84-429c-925a-22d3d8f86916", from: 'you@yourdomain.io', to: ["example2@mail.com", "example1@mail.com"]}
```