How do I use Letter Opener with Docker or a VM?

Letter Opener typically fails in headless environments because it needs a local browser. To work around this, set ENV variables like LAUNCHY_DRY_RUN=true to suppress errors, but note that emails won't open automatically and you'll need to check stored files manually.

Letter Opener vs MailCatcher: which should I use?

Letter Opener is simpler and opens emails directly in your browser, ideal for local development. MailCatcher runs a SMTP server and web interface, better for remote teams or when you need to inspect emails across sessions. Choose based on whether you prefer automatic previews or a persistent email dashboard.

Why isn't Letter Opener opening emails in my browser on Windows?

This often happens due to Launchy compatibility issues or incorrect file URI schemes. Try configuring the file_uri_scheme for WSL support as shown in the README, or set LAUNCHY_APPLICATION to specify a browser executable.

How to store emails in a different folder with Letter Opener?

Configure the location in an initializer using LetterOpener.configure, such as setting config.location to a custom path like Rails.root.join('tmp', 'my_mails'), which overrides the default tmp/letter_opener directory.

Can Letter Opener handle email attachments in preview?

Yes, Letter Opener displays emails as HTML in the browser, which includes rendering attachments if they are part of the email content. However, it doesn't provide advanced attachment management or download features beyond basic preview.

Is Letter Opener suitable for testing email deliverability?

No, Letter Opener only previews emails visually and doesn't simulate real email sending or provide deliverability metrics. For that, use services like Mailtrap or configure SMTP in development with caution.

Open-Awesome

letter_opener

MITRuby

Preview Rails and Ruby application emails in your browser during development instead of sending them.

GitHub

3.8k stars242 forks0 contributors

What is letter_opener?

Letter Opener is a Ruby gem that intercepts emails generated during development and displays them directly in your web browser instead of sending them. It solves the problem of accidentally sending test emails to real addresses and eliminates the need to configure email delivery in development environments. The gem works with Rails, the Mail gem, Pony, and standalone ActionMailer implementations.

Target Audience

Ruby and Rails developers who need to test email functionality in their applications during development without risking accidental email delivery or configuring complex email services.

Value Proposition

Developers choose Letter Opener for its simplicity and safety—it requires minimal configuration, works with multiple Ruby email libraries, and provides instant visual feedback without external dependencies or service setup.

Overview

Preview mail in the browser instead of sending.

Use Cases

Best For

Testing Rails ActionMailer email templates during development
Previewing transactional emails in Ruby applications without SMTP setup
Developing email features in isolated development environments
Preventing accidental email sends from development/staging servers
Quick visual verification of email content and formatting
Debugging email generation in Ruby applications with instant feedback

Not Ideal For

Teams developing on remote staging servers or virtual machines without a local browser
Projects using Docker containers or headless environments where GUI browsers are unavailable
Developers needing a web dashboard to browse and search historical sent emails

Pros & Cons

Pros

Automatic Browser Preview

Opens generated emails directly in the default web browser as HTML, providing instant visual feedback without manual email client setup, as described in the README's core functionality.

Zero Configuration Safety

Intercepts all outgoing mail in development to prevent accidental sends to real addresses, eliminating the risk of test emails reaching users without complex SMTP configuration.

Multi-Library Compatibility

Works seamlessly with Rails ActionMailer, the Mail gem, and Pony, with clear setup examples provided for each in the README, ensuring broad Ruby email library support.

Customizable Rendering Options

Offers configurable message templates, allowing developers to choose between fully-styled emails or lightweight body-only views via the message_template setting.

Cons

Local-Only Dependency

Requires a local browser to open emails, making it ineffective for remote development setups like VMs or Docker containers, as admitted in the README with suggested workarounds like setting LAUNCHY_DRY_RUN.

No Built-In Email Browsing

Lacks a web interface to review past emails; users must rely on file storage or integrate a separate gem like letter_opener_web for historical access, adding complexity.

Browser Automation Failures

Depends on the Launchy gem, which can fail with command errors in environments without a GUI, requiring manual environment variable overrides and debugging.

Frequently Asked Questions

Related Projects

Postal

📮 A fully featured open source mail delivery platform for incoming & outgoing e-mail

Stars16,467

Forks1,231

Last commit8 days ago

Better Errors

Better error page for Rack apps

Stars6,873

Forks434

Last commit1 year ago

awesome_print

Pretty print your Ruby objects with style -- in full color and with proper indentation

Stars4,084

Forks451