https://github.com/johno/email_format

Validates the email format with the email_regex gem.
https://github.com/johno/email_format

Last synced: 2 months ago
JSON representation

Validates the email format with the email_regex gem.

• Host: GitHub
• URL: https://github.com/johno/email_format
• Owner: johno
• License: mit
• Created: 2013-12-06T15:48:44.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2016-06-30T17:20:24.000Z (over 8 years ago)
• Last Synced: 2024-10-19T17:29:49.946Z (3 months ago)
• Language: Ruby
• Homepage: http://johnotander.com/gems/2013/12/06/email-format-validator-for-rails/
• Size: 16.6 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Email Format

[![Build Status](https://travis-ci.org/johnotander/email_format.svg?branch=master)](https://travis-ci.org/johnotander/email_format)

This gem uses the thorough email validation implemented by the [email_regex](https://github.com/dougwig/email_regex) gem written by Doug Wiegley which "provides a valid email regex that conforms to most valid RFC edges cases (disallows backticks), and allows for a few illegal patterns that are in common use".

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'email_format'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install email_format

## Usage

### EmailFormat Module

There's a `valid?` method in the `EmailFormat` module that accepts an email as an argument:

```ruby

require 'email_format'

EmailFormat.valid?('invalid_email')   # => false

EmailFormat.valid?('[email protected]') # => true

```

### ActiveModel::Validations

Using it is as simple as using the `validates` keyword in your model:

```ruby

class User < ActiveRecord::Base

  # ...

  validates :email, email_format: true

  # ...

end

```

Now the email attribute will be validated accordingly:

```ruby

User.new('[email protected]').valid? # => true

User.new('invalid_email@@').valid? # => false

```

By default, `email_format` is pretty relaxed, but there is a `strict` mode

```ruby

class User < ActiveRecord::Base

  # ...

  validates :email, email_format: { strict: true }

  # ...

end

```

Also, the model in question doesn't need to inherit from ActiveRecord::Base, you only need to `include ActiveModel::Validations` in your class:

```ruby

require 'email_format'

class Awesome

  include ActiveModel::Validations

  attr_accessor :email

  validates :email, email_format: true

end

awesome = Awesome.new

awesome.email = "[email protected]"

awesome.valid? # => true

awesome.email = "invalid_email"

awesome.valid? # => false

```

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request