Griddler
A Rails engine for receiving and processing incoming emails via HTTP POST endpoints from email services.
What is Griddler?
Griddler is a Rails engine that provides an endpoint for services that convert incoming emails to HTTP POST requests, parsing them into a structured email object for custom processing. It solves the problem of integrating email reception into Rails apps without dealing with raw email data or service-specific APIs. Note: As of June 2024, it is deprecated in favor of Rails' built-in ActionMailbox.
Rails developers who need to receive and process incoming emails from services like SendGrid, Mailgun, or Postmark in their applications.
Developers choose Griddler for its simplicity, adapter-based architecture supporting multiple email services, and clean abstraction that lets them handle emails with custom logic without wrestling with email parsing complexities.
Overview
Simplify receiving email in Rails (deprecated)
Use Cases
Best For
- Adding email-based features like support tickets or comment systems in Rails apps
- Integrating incoming email from services like SendGrid or Mailgun into Rails
- Processing email attachments and structured data in Rails applications
- Testing email reception logic with factory-based test setups
- Handling email replies with configurable delimiters for threaded conversations
- Migrating from Griddler to ActionMailbox in Rails 6+ applications
Not Ideal For
- New Rails applications built on Rails 6 or later, where ActionMailbox is available and maintained
- Projects requiring deep integration with Rails' built-in features like Active Job or Active Storage without extra configuration
- Teams that prefer a single, unified email solution without managing multiple adapter gems and their updates
Pros & Cons
Pros
Parses incoming email POSTs into a structured Griddler::Email object with attributes like to, from, body, and attachments, eliminating raw email handling.
Supports multiple email services via adapter gems (e.g., SendGrid, Mailgun), allowing easy integration with various providers without rewriting parsing logic.
Enables developers to implement a custom processor class (e.g., EmailProcessor) with options like reply delimiters, tailoring email handling to app needs.
Includes examples for creating test factories, such as with FactoryGirl, to simulate incoming emails in tests, aiding in robust validation.
Cons
As of June 2024, Griddler is officially deprecated, meaning no new updates or support, and Rails' built-in ActionMailbox is the recommended alternative.
Requires installing separate adapter gems for each email service, adding maintenance overhead and risk of outdated or unmaintained adapters.
Setting up involves multiple steps like configuring processor class, email service, and reply delimiters, which can be complex compared to integrated solutions.
Frequently Asked Questions
Related Projects
Postal📮 A fully featured open source mail delivery platform for incoming & outgoing e-mail
letter_openerPreview mail in the browser instead of sending.
MailA Really Ruby Mail Library
premailer-railsCSS styled emails without the hassle.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.