首页
/ Maktoub 技术文档

Maktoub 技术文档

2024-12-26 21:23:25作者:薛曦旖Francesca

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: 'user@example.com')

在浏览器中查看

若要在浏览器中查看邮件,需要在 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 项目。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0