Mailgun Rubygem 技术文档

1. 安装指南

在开始使用 Mailgun Rubygem 之前，请确保您的环境中已经安装了 Ruby。以下是安装指南：

gem install mailgun

2. 项目的使用说明

Mailgun Rubygem 是一个 Ruby 库，允许您在 Ruby 应用程序中以直观的方式使用 Mailgun 服务。Mailgun 是一项电子邮件即服务（email-as-a-service），让您使用电子邮件变得更加合理。

配置

首先，您需要初始化 Mailgun 对象并配置 API 密钥和域名：

Mailgun.configure do |config|
  config.api_key = 'your-api-key'
  config.domain  = 'your-mailgun-domain'
end

@mailgun = Mailgun()

发送电子邮件

以下是发送电子邮件的基本示例：

parameters = {
  :to => "[e-mail]",
  :subject => "missing tps reports",
  :text => "yeah, we're gonna need you to come in on friday...yeah.",
  :from => "[e-mail]"
}
@mailgun.messages.send_email(parameters)

邮件列表

邮件列表相关的操作如下：

# 创建邮件列表
@mailgun.lists.create "[e-mail]"

# 列出所有邮件列表
@mailgun.lists.list

# 查找邮件列表
@mailgun.lists.find "[e-mail]"

# 更新邮件列表
@mailgun.lists.update("[e-mail]", "[e-mail]", "Developers", "Developer Mailing List")

# 删除邮件列表
@mailgun.lists.delete("[e-mail]")

邮件列表成员

邮件列表成员的操作包括：

# 列出邮件列表中的所有成员
@mailgun.list_members.list "[e-mail]"

# 在邮件列表中查找特定成员
@mailgun.list_members.find "[e-mail]", "[e-mail]"

# 向邮件列表添加成员
@mailgun.list_members.add "[e-mail]", "[e-mail]"

# 向邮件列表添加多个成员
@mailgun.list_members.add_multi "[e-mail]", [{"address": "Alice <[e-mail]>", "vars": {"age": 26}}, {"name": "Bob", "address": "[e-mail]", "vars": {"age": 34}}].to_json, {:upsert => true}
    
# 更新邮件列表中的成员信息
@mailgun.list_members.update "[e-mail]", "[e-mail]", "Q", {:gender => 'male'}.to_json, :subscribed => 'no'

# 从邮件列表中移除成员
@mailgun.list_members.remove "[e-mail]", "[e-mail]"

邮箱

邮箱相关的操作包括：

# 创建邮箱
@mailgun.mailboxes.create "[e-mail]", "password"

# 列出属于域的所有邮箱
@mailgun.mailboxes.list "domain.com"

# 销毁邮箱
@mailgun.mailboxes.destroy "[e-mail]"

路由

路由操作如下：

# 创建路由
@mailgun.routes.create "Description for the new route", 1,
     [:match_recipient, "[e-mail]"],
     [[:forward, "http://my-site.com/incoming-mail-route"], [:stop]]

# 列出属于域的所有路由
@mailgun.routes.list 100, 0

# 通过 id 获取路由详情
@mailgun.routes.find "4e97c1b2ba8a48567f007fb6"

# 通过 id 更新路由
@mailgun.routes.update "4e97c1b2ba8a48567f007fb6", {
     :priority   => 2,
     :expression => [:match_header, :subject, "*.support"],
     :actions    => [[:forward, "http://new-site.com/incoming-emails"]]
     }

# 通过 id 销毁路由
@mailgun.routes.destroy "4e97c1b2ba8a48567f007fb6"

域名

域名操作如下：

# 添加域名
@mailgun.domains.create "example.com"

# 列出所有域名
@mailgun.domains.list

# 获取域名信息
@mailgun.domains.find "example.com"

# 删除域名
@mailgun.domains.delete "example.com"

Webhooks

Webhooks 操作包括：

# 获取可用的 webhooks 列表
@mailgun.webhooks.available_ids

# 获取指定域的 webhooks 列表
@mailgun.webhooks.list

# 获取指定的 webhook 详情
@mailgun.webhooks.find(:open)

# 创建新的 webhook
@mailgun.webhooks.create(:open, "http://bin.example.com/8de4a9c4")

# 更新 webhook
@mailgun.webhooks.update(:open, "http://bin.example.com/8de4a9c4")

# 删除 webhook
@mailgun.webhooks.delete(:open)

地址验证

地址验证需要设置 public_api_key：

# 验证任意地址
@mailgun.addresses.validate('[e-mail]')

3. 项目API使用文档

Mailgun Rubygem 的 API 使用文档在上述项目使用说明中已经包含。所有操作都是通过 Mailgun 对象的方法调用来实现的。

4. 项目安装方式

项目的安装方式在安装指南中已经说明，使用以下命令：

gem install mailgun