邮件验证器（EmailValidator）技术文档

本文档旨在帮助用户了解并使用EmailValidator项目，该项目的目标是提供一种验证电子邮件地址的方法，符合Rails 3+框架的要求。以下是项目的安装指南、使用说明、API使用文档以及安装方式。

1. 安装指南

Gemfile 配置

在您的Gemfile中添加以下代码：

gem 'email_validator'

执行安装

运行以下命令来安装gem：

bundle install

2. 项目使用说明

模型内验证

在您的模型中添加以下代码以验证电子邮件属性：

validates :my_email_attribute, email: true

允许无完整域名

如果您希望允许没有FQDN的域名（例如user@somehost），默认情况下是有效的。如果需要禁用，可以通过设置require_fqdn: true或启用:strict模式：

validates :my_email_attribute, email: {mode: :strict, require_fqdn: true}

限制单一域名

如果需要限制到特定域名，可以使用以下方式：

validates :my_email_attribute, email: {domain: 'example.com'}

3. 项目API使用文档

松散模式（默认）

使用以下方法在松散模式下验证电子邮件：

EmailValidator.valid?('[e-mail]') # 返回布尔值

需要FQDN

在需要FQDN的情况下，可以使用以下方法：

EmailValidator.valid?('narf@somehost') # 返回布尔值 false
EmailValidator.invalid?('narf@somehost', require_fqdn: false) # 返回布尔值 true

需要特定域名

在需要特定域名的情况下，可以使用以下方法：

EmailValidator.valid?('[e-mail]', domain: 'foo.com') # 返回布尔值 false
EmailValidator.invalid?('[e-mail]', domain: 'foo.com') # 返回布尔值 true

严格模式

在严格模式下，可以使用以下方法：

EmailValidator.regexp(mode: :strict) # 返回正则表达式
EmailValidator.valid?('[e-mail]', mode: :strict) # 返回布尔值

RFC模式

在RFC模式下，可以使用以下方法：

EmailValidator.regexp(mode: :rfc) # 返回正则表达式
EmailValidator.valid?('[e-mail]', mode: :rfc) # 返回布尔值

4. 项目安装方式

请参考上述“安装指南”部分进行安装。

通过本文档，用户应能够有效地安装和使用EmailValidator项目来验证电子邮件地址。如有任何疑问或需要进一步的帮助，请参考项目GitHub页面的相关文档。