Send emails with Rails

The Rails gem adds configuration and a managed client around the Ruby SDK. It uses https://api.signal.apollodeploy.com by default. Before you start, create an API key with Emails: Send permission and verify the From domain.

Install the Rails gem

bundle add apollo-deploy-signal-sdk-rails

Configure the client

Set SIGNAL_API_KEY in your Rails secrets, then create config/initializers/apollo_signal.rb:

ApolloDeploySignalSdkRails.configure do |config|
  config.default_headers = {
    "Authorization" => "Bearer #{ENV.fetch('SIGNAL_API_KEY')}"
  }
end

Send an email

request = ApolloDeploySignalSdkRails::SendEmailRequest.new(
  from: "auth@mail.company.com",
  to: ["alex@example.com"],
  subject: "Reset your password",
  text: "Use the secure link in your account to choose a new password."
)

email = ApolloDeploySignalSdkRails.rails_client.emails.send_email(body: request)
Rails.logger.info("Apollo Signal accepted #{email['id']}")

Keep delivery orchestration in a service or background job when the request should not wait for email acceptance. The From domain must be verified in the API key’s Signal project.

Ruby

Use the core Ruby SDK outside Rails.

All SDKs

Compare every supported language and framework.

Getting started

Dashboard

Emails

Contacts and consent

Insights

Domains

Webhooks

Settings

Migration

Ruby

All SDKs