How to add file uploads to a MailForm contact form?

Define an attribute with `attachment: true` in your MailForm class and ensure the HTML form uses `multipart: true`. The gem will attach files to the email, but you must handle file size and type validation manually in your validations.

MailForm vs ActionMailer: which is better for contact forms?

MailForm simplifies the process by providing a model-like interface with built-in validations and request appending, ideal for quick setups. ActionMailer offers more flexibility for complex email logic but requires more boilerplate code for form handling.

Can MailForm send emails asynchronously in Rails?

MailForm relies on ActionMailer for delivery, so you can configure ActionMailer to use background jobs like Active Job for async sending. However, MailForm itself doesn't have built-in async handling; it depends on your Rails mailer setup.

How to customize the email template in MailForm?

Create a custom ERB template in `app/views/mail_form/` named after your form class (e.g., contact.erb). The default template is in the gem's lib directory, and overriding it allows tailored email formatting and layout.

Does MailForm support AJAX form submissions?

Yes, since MailForm objects integrate with Rails controllers and form builders, you can use standard Rails UJS or Turbo for AJAX submissions. However, the gem doesn't provide specific AJAX helpers, so you need to handle responses manually.

What are alternatives to MailForm's captcha for spam protection?

You can integrate third-party services like reCAPTCHA by adding custom validations in your MailForm class using the `validate` option with a symbol method. Out-of-the-box, it only offers the hidden nickname field, which may require additional CSS to hide.

MailForm — Rails Form Email Sending Gem

What is MailForm?

MailForm is a Ruby on Rails gem that enables developers to send emails directly from web forms without needing a separate mailer setup. It provides a model-like interface with built-in validations, internationalization, and file attachment support, streamlining the creation of contact forms and similar features. The gem integrates seamlessly with Rails' ActiveModel, making it feel like a natural part of the framework.

Target Audience

Rails developers building contact forms, feedback forms, or any web form that needs to send email notifications directly from user input. It's particularly useful for those who want a quick, convention-over-configuration approach without writing boilerplate code.

Value Proposition

Developers choose MailForm because it reduces boilerplate by leveraging Rails' existing ActiveModel features, providing validations, I18n, and a familiar API out of the box. Its simplicity and integration with Rails' ecosystem make it a time-saving alternative to manually configuring mailers and form objects.

Send e-mail straight from forms in Rails with I18n, validations, attachments and request information.

Use Cases

Best For

Building contact forms with spam protection via hidden captcha fields
Creating feedback forms that include file attachments like screenshots
Sending automated emails from user-generated content without a separate mailer
Adding request metadata (IP, browser) to form submissions for debugging
Integrating email functionality into existing ActiveRecord models via hooks
Implementing multilingual form emails with Rails I18n support

Not Ideal For

Projects requiring multi-step form workflows or complex wizard interfaces
Applications needing advanced email features like tracking, analytics, or third-party service integrations beyond ActionMailer
Non-Rails frameworks or pure Ruby apps, due to tight coupling with Rails ActiveModel

Pros & Cons

Pros

ActiveModel Integration

Seamlessly inherits validations, I18n, and naming from Rails ActiveModel, allowing form objects to behave like ActiveRecord models, as shown in the example with validates_format_of for email validation.

Quick Form Setup

Defines form attributes with validation rules, file attachments, and captcha spam protection in a simple class, reducing boilerplate for contact forms, as demonstrated in the ContactForm example.

Automatic Request Data

Appends client details like remote IP, user agent, and session to emails by setting the request object, useful for debugging and logging form submissions.

ORM Email Triggers

Includes MailForm::Delivery module to send emails on model lifecycle hooks, enabling integration with existing ActiveRecord models without extra code.

Cons

Rails-Only Limitation

Tightly dependent on Rails ActiveModel, making it unsuitable for other Ruby web frameworks or applications not using Rails, which restricts its portability.

Basic Spam Protection

Relies solely on a hidden captcha field for spam detection, which is simplistic and may not be effective against sophisticated bots compared to modern solutions like reCAPTCHA.

Attachment Handling Constraints

Supports file attachments but lacks built-in features for file size limits, cloud storage integration, or advanced processing, which could be limiting for media-heavy forms.

Frequently Asked Questions

What is MailForm?

Target Audience

Value Proposition

Use Cases

Best For

Building contact forms with spam protection via hidden captcha fields
Creating feedback forms that include file attachments like screenshots
Sending automated emails from user-generated content without a separate mailer
Adding request metadata (IP, browser) to form submissions for debugging
Integrating email functionality into existing ActiveRecord models via hooks
Implementing multilingual form emails with Rails I18n support

Not Ideal For

Projects requiring multi-step form workflows or complex wizard interfaces
Applications needing advanced email features like tracking, analytics, or third-party service integrations beyond ActionMailer
Non-Rails frameworks or pure Ruby apps, due to tight coupling with Rails ActiveModel

Pros & Cons

Pros

ActiveModel Integration

Quick Form Setup

Defines form attributes with validation rules, file attachments, and captcha spam protection in a simple class, reducing boilerplate for contact forms, as demonstrated in the ContactForm example.

Automatic Request Data

Appends client details like remote IP, user agent, and session to emails by setting the request object, useful for debugging and logging form submissions.

ORM Email Triggers

Includes MailForm::Delivery module to send emails on model lifecycle hooks, enabling integration with existing ActiveRecord models without extra code.

Cons

Rails-Only Limitation

Tightly dependent on Rails ActiveModel, making it unsuitable for other Ruby web frameworks or applications not using Rails, which restricts its portability.

Basic Spam Protection

Relies solely on a hidden captcha field for spam detection, which is simplistic and may not be effective against sophisticated bots compared to modern solutions like reCAPTCHA.

Attachment Handling Constraints

Supports file attachments but lacks built-in features for file size limits, cloud storage integration, or advanced processing, which could be limiting for media-heavy forms.

Frequently Asked Questions

MailForm

What is MailForm?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

MailForm

What is MailForm?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?