邮箱验证工具技术文档

1. 安装指南

要使用Valid Email工具，首先需要在项目的Gemfile文件中添加以下代码：

gem 'valid_email'

然后执行bundle install命令以安装该gem。

2. 项目的使用说明

Valid Email用于验证邮箱地址是否有效，这对于应用中注册新账户等功能非常有用。

在代码中，可以通过以下方式使用：

require 'valid_email'

class Person
  include ActiveModel::Validations
  attr_accessor :name, :email

  validates :name, presence: true, length: { maximum: 100 }
  validates :email, presence: true, email: true
end

创建一个Person实例，并为其设置name和email属性：

person = Person.new
person.name = 'hallelujah'
person.email = '[e-mail]'

使用valid?方法验证邮箱：

person.valid? # => true

如果邮箱格式不正确或域名不存在MX记录，验证将失败：

person.email = 'john@doe'
person.valid? # => false

person.email = 'John Does <[e-mail]>'
person.valid? # => false

3. 项目API使用文档

Valid Email提供了几种验证邮箱的方式：

• 检查MX记录：确保邮箱域名有有效的MX记录。

validates :email,
          email: {
            mx: true,
            message: I18n.t('validations.errors.models.user.invalid_email')
          }

• 同时检查MX和A记录：

validates :email, email: { mx_with_fallback: true }

• 检测一次性邮箱账户：

validates :email,
          email: {
            ban_disposable_email: true,
            message: I18n.t('validations.errors.models.user.invalid_email')
          }

• 使用扩展方法：如果你想在非模型验证的场景下使用，可以如下：

ValidateEmail.valid?('[e-mail]')
ValidateEmail.mx_valid?('[e-mail]')
ValidateEmail.mx_valid_with_fallback?('[e-mail]')

4. 项目安装方式

除了在Gemfile中添加gem外，如果你想在字符串和nil对象中使用扩展方法，你需要在Gemfile中这样添加：

gem 'valid_email', require: 'valid_email/all_with_extensions'

然后执行bundle install，这样你就可以使用如下方法：

nil.email? # => false
'[e-mail]'.email? # => 可能返回true如果邮箱存在。