Ruby

Mailtrap Ruby SDK on GitHub

Overview

Mailtrap can be integrated with Ruby apps and projects for email sending.

Email API/SMTP for Ruby

SDK integration

The Mailtrap Ruby SDK provides an idiomatic Ruby interface for sending transactional and bulk emails. The SDK supports:

• Transactional email sending

• Batch email sending

• Template management

• ActionMailer integration for Rails applications

• Comprehensive error handling

Installation

Add the SDK to your Gemfile:

Gemfile

gem 'mailtrap'

Then run:

Terminal

bundle install

Minimal Example Ruby on Rails (Actionmailer)

config/environments/production.rb

# place this code in config/environments/production.rb:
config.action_mailer.delivery_method = :mailtrap

# then set the MAILTRAP_API_KEY environment variable
# using your hosting solution.

Minimal Example Ruby

Here's a minimal example to send your first email:

send_email.rb

require 'mailtrap'

client = Mailtrap::Client.new(api_key: 'your-api-token')

mail = Mailtrap::Mail::FromTemplate.new(
  from: { email: '[email protected]', name: 'Mailtrap Test' },
  to: [{ email: '[email protected]' }],
  template_uuid: 'template-uuid',
  template_variables: {
    'user_name' => 'John Doe'
  }
)

# Or send a simple email
mail = {
  from: { email: '[email protected]', name: 'Mailtrap Test' },
  to: [{ email: '[email protected]' }],
  subject: 'Hello from Mailtrap!',
  text: 'Welcome to Mailtrap Email Sending!',
  html: '<p>Welcome to <strong>Mailtrap</strong> Email Sending!</p>'
}

response = client.send(mail)
puts response

Get your API token from your Mailtrap account under Settings → API Tokens.

SMTP integration

To integrate SMTP with your Ruby app, navigate to the Integrations tab, choose either Ruby on Rails or Ruby Net/SMTP, and copy-paste the credentials or ready-made code snippets.

SMTP integration is compatible with any Ruby framework or library that sends emails via SMTP.

Read more about SMTP integration in the Email API/SMTP - SMTP Integration article.

RESTful API integration

To integrate Mailtrap using RESTful API, use the configuration available among Code samples under the API section.

API integration can be used with any Ruby framework or library that supports HTTP requests. For more details, refer to the API documentation.

Read more about API integration in the Email API/SMTP - API Integration article.