Skip to content

chuangker/nice-mail

Repository files navigation

logo
Nice Mail

Node.js Version Build Status npm version Standard - JavaScript Style Guide

💌 Nice Mail 是一款以 Markdown 为基础的邮件编辑器。如果你厌倦了平淡无奇的传统邮件格式,那么 Nice Mail 的主题一定能让你眼前一亮。

💡 TIP:主题持续完善中哦!欢迎提 PR。

预览图

特性

  • 支持主题 & 字段配置
  • 支持自定义主题
  • 支持历史邮件保存
  • 支持保存为草稿
  • 支持实时预览
  • 支持往编辑器中拖拽上传图片
  • 支持 HTML
  • 支持 Markdown
  • 支持保存为 PDF
  • 支持保存为图片

安装

安装前,请确认已经安装 Node.js(>= v8.9.0)

$ npm install -g @chuangker/nice-mail

配置文件

默认情况下,所有的数据都被存放在 Nice Mail 安装的目录下。为了防止升级所造成的数据清空,那么就需要在 第一次使用前完成以下配置

# 获取帮助
$ nice-mail config -h

# 配置缓存数据的目录地址,一般用来缓存发件人等信息
$ nice-mail config --db <dir>

# 配置上传文件的目录地址
$ nice-mail config --upload <dir>

快速开始

# 默认使用 7500 端口
$ nice-mail start

# 如果需要自定义端口,请使用
$ nice-mail start -p <端口号>
  • 打开浏览器(建议使用 Chrome 以获得最佳体验)
  • 访问 http://127.0.0.1:7500 (如果是自定义端口,需替换端口号)
  • 尽情享受吧!

自定义主题

后续完善。

参考 nice-mail 主题模板。

License

MIT