Maktoub 技术文档

1. 安装指南

在您的 Ruby on Rails 项目中，首先需要在 Gemfile 文件中添加以下代码：

gem 'maktoub'

然后运行 bundle install 命令来安装 Maktoub。

确保您的项目使用的是 Rails 4 或更高版本。如果使用 Rails 3.1+，请使用版本 0.3.1。

2. 项目的使用说明

配置

可以通过运行以下命令来生成配置文件：

rails generate maktoub:config

此命令会在 config/initializers 目录下创建一个 maktoub.rb 文件。请按照文件中的指示进行配置。

编写邮件

在 app/views/maktoub/newsletters/ 目录下创建一个普通的视图部分（partial），作为您的邮件内容。邮件的主题将自动从部分的名称推断出来。

编辑样式

在 app/views/layouts/maktoub/_styles.erb 目录下创建一个视图部分来定义邮件的样式。请注意，这会完全覆盖 Maktoub 自带的样式。您可以复制内建的样式并进行修改。

发送邮件

Maktoub 提供了两个 Rake 任务以便于发送邮件：

• 发送测试邮件到您的邮件的“发件人”地址：

  rake maktoub:test['name_of_my_newsletter_partial']
  

• 将邮件发送给所有订阅者。如果已安装 delayed_job，它将使用后台作业来逐个发送邮件：

  rake maktoub:mail['name_of_my_newsletter_partial']
  

另外，您可以通过 Maktoub::NewsletterMailer 这个 ActionMailer 对象使用 publish 方法：

Maktoub::NewsletterMailer.publish('my_newsletter_partial', name: 'User name', email: '[e-mail]')

在浏览器中查看

若要在浏览器中查看邮件，需要在 routes.rb 文件中添加相应的路由：

• 将引擎挂载到您选择的路径，例如：mount Maktoub::Engine => '/'
• 然后可以通过 http://example.com/<mounted_path>/newsletter/my_awesome_newletter 访问邮件内容。

3. 项目API使用文档

本项目提供的API使用方法和具体细节未在给出的 readme 中明确说明，请参考源码或项目的官方文档以获取API使用详情。

4. 项目安装方式

请遵循以下步骤安装 Maktoub：

1. 在 Gemfile 中添加 gem 'maktoub'。
2. 运行 bundle install。
3. 根据需要配置 maktoub.rb 文件。
4. 按照使用说明编写邮件内容、样式并发送邮件。

通过以上步骤，您应该能够成功安装并使用 Maktoub 项目。