Truemail 开源项目教程

Truemail 开源项目教程

truemail🚀 Configurable framework agnostic plain Ruby 📨 email validator/verifier. Verify email via Regex, DNS, SMTP and even more. Be sure that email address valid and exists.项目地址:https://gitcode.com/gh_mirrors/tr/truemail

1. 项目的目录结构及介绍

Truemail 项目的目录结构如下：

truemail/
├── bin/
│   └── truemail
├── lib/
│   ├── truemail/
│   │   ├── configuration.rb
│   │   ├── core.rb
│   │   ├── validator.rb
│   │   └── version.rb
│   └── truemail.rb
├── spec/
│   ├── configuration_spec.rb
│   ├── core_spec.rb
│   ├── validator_spec.rb
│   └── version_spec.rb
├── .gitignore
├── .rspec
├── .rubocop.yml
├── .travis.yml
├── Gemfile
├── LICENSE.txt
├── README.md
└── truemail.gemspec

目录结构介绍

• bin/: 包含可执行文件 truemail，用于启动 Truemail 服务。
• lib/: 包含 Truemail 的核心代码。
  • truemail/: 包含 Truemail 的主要功能模块。
    • configuration.rb: 配置文件，用于设置 Truemail 的各项参数。
    • core.rb: 核心逻辑文件，处理主要的业务逻辑。
    • validator.rb: 验证器文件，用于验证电子邮件地址。
    • version.rb: 版本信息文件，记录当前项目的版本号。
  • truemail.rb: 主入口文件，加载 Truemail 的所有模块。
• spec/: 包含项目的测试文件，用于测试各个模块的功能。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• .rspec: RSpec 配置文件，用于配置 RSpec 测试框架。
• .rubocop.yml: RuboCop 配置文件，用于配置代码风格检查工具。
• .travis.yml: Travis CI 配置文件，用于配置持续集成服务。
• Gemfile: 依赖管理文件，列出项目所需的 Ruby 依赖库。
• LICENSE.txt: 许可证文件，说明项目的开源许可证。
• README.md: 项目说明文件，介绍项目的功能、使用方法等。
• truemail.gemspec: Gem 规范文件，用于打包和发布 Truemail 项目。

2. 项目的启动文件介绍

Truemail 项目的启动文件位于 bin/ 目录下，文件名为 truemail。该文件是一个可执行文件，用于启动 Truemail 服务。

启动文件内容

#!/usr/bin/env ruby

require 'truemail'

Truemail.configure do |config|
  config.verifier_email = 'verifier@example.com'
end

Truemail.validate('user@example.com')

启动文件介绍

• #!/usr/bin/env ruby: 指定使用 Ruby 解释器来执行该脚本。
• require 'truemail': 加载 Truemail 库。
• Truemail.configure: 配置 Truemail，设置验证器的邮箱地址。
• Truemail.validate: 调用 Truemail 的验证方法，验证指定的邮箱地址。

3. 项目的配置文件介绍

Truemail 的配置文件位于 lib/truemail/configuration.rb，该文件用于配置 Truemail 的各项参数。

配置文件内容

module Truemail
  class Configuration
    attr_accessor :verifier_email, :smtp_port, :smtp_server, :connection_timeout

    def initialize
      @verifier_email = nil
      @smtp_port = 25
      @smtp_server = 'localhost'
      @connection_timeout = 2
    end
  end
end

配置文件介绍

• verifier_email: 设置验证器的邮箱地址。
• smtp_port: 设置 SMTP 服务器的端口号，默认为 25。
• smtp_server: 设置 SMTP 服务器地址，默认为 localhost。
• connection_timeout: 设置连接超时时间，默认为 2 秒。

通过修改这些配置项，可以自定义 Truemail 的行为，以满足不同的需求。

truemail🚀 Configurable framework agnostic plain Ruby 📨 email validator/verifier. Verify email via Regex, DNS, SMTP and even more. Be sure that email address valid and exists.项目地址:https://gitcode.com/gh_mirrors/tr/truemail