Nylas Mail一款基于Web构建的可扩展桌面邮件应用

Nylas Mail - 开源、可扩展的邮件客户端


Nylas Mail

Nylas Mail 是一款基于现代 Web 平台的开源邮件客户端,基于 ElectronReactFlux 构建。 它的设计易于扩展,并且提供了许多第三方插件来为客户端增添功能。

⚠️ Nylas Mail 最初于 2015 年初发布并开源,并由 Nylas 维护至 2017 年春季。 虽然 Nylas 不再支持 Nylas Mail,但您可以下载最新版本或从源代码构建。此外,还有 多个 forks 正在积极开发和维护中。

入门

设置环境 (Mac):

  1. 安装 Homebrew
  2. 安装 NVM 和 Redis brew install nvm redis
  3. 通过 NVM 安装 Node 6:nvm install 6
  4. npm install

设置环境 (Linux - Debian/Ubuntu):

  1. 通过 NodeSource(受信任)安装 Node 6+:
  2. curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
  3. sudo apt-get install -y nodejs
  4. 本地安装 Redis sudo apt-get install -y redis-server redis-tools
    允许我们使用子域名的好处。
  5. npm install

运行 Nylas Mail

  1. npm run client:启动应用
  2. npm run test-client:运行测试
  3. npm run lint-client:对源代码进行 Lint 测试(ESLint + Coffeelint + LESSLint)

探索源代码

此代码库包含 Nylas Mail 客户端及其后端服务的完整源代码。它分为以下几个包:

  1. Isomorphic Core:本地客户端和云服务器共享代码
  2. 客户端应用:Nylas Mail 的主 Electron 应用
    已镜像到开源代码库。
  3. 客户端同步:Nylas Mail 集成的本地邮件同步引擎
  4. 客户端私有插件:Nylas Mail 私有插件(例如 SFDC)
  5. 云 API:N1 基于云的身份验证和元数据 API
  6. 云核心:所有远程云服务使用的共享代码
  7. 云工作者:用于“稍后发送”等服务的云工作者

参见/packages 目录用于存放各个组件。/packages 目录下的每个文件夹
都被设计为独立的代码库。为了便于源代码管理,它们都打包在这里。

深入挖掘

2016 年初,Nylas Mail 团队为该应用编写了详尽的文档,主要面向插件开发者。该文档发布在 GitHub Pages 上,对应用的架构和重要类进行了全面的概述。以下是一些不错的入门指南:

该团队还在会议上发表了演讲,并发布了关于该客户端的博客文章:

云端运行

从源代码下载并构建 Nylas Mail 时,它无需云组件即可运行。“Nylas ID”/订阅的概念已被移除,并且需要服务器端处理的插件默认处于禁用状态。(例如 Snooze、Send Later 等插件)。

为了使用这些插件并获得完整的 Nylas Mail 体验,您需要部署位于 cloud-* 软件包中的后端基础架构。部署这些服务具有挑战性,因为它们以微服务的形式实现,并设计为使用 Redis、Postgres 等在企业级规模上运行。由于这些后端服务必须访问您的电子邮件帐户,因此使用安全最佳实践(至少包括 SSL、静态加密和分区 VPC)也至关重要。有关构建和部署此堆栈部分的更多信息,请查看 cloud-core README

主题

Nylas Mail 的用户界面采用 CSS 样式设计,易于修改和扩展。 Nylas Mail 自带一些精美主题,此外还有更多由社区开发者打造的主题。

N1 主题

捆绑主题

社区主题

ToogaBooga Material Monokai
Agapanthus— 灵感源自收件箱的主题 Stripe Kleinstein— 隐藏账户侧边栏
Arc Dark Solarized Dark Darkish
Predawn Ido—Polymail 风格主题 Berend
ElementaryOS LevelUp Sunrise
BoraBora Honeyduke
赫尔 Express 黑苏打
Bemind 德古拉 MouseEatsCat
Sublime Dark Firefox Gmail

安装社区主题:

  1. 下载并解压 repo
  2. 在 Nylas Mail 中,选择“开发者 > 手动安装软件包...”
  3. 导航到您下载主题的位置并选择根文件夹。为了方便起见,主题会被复制到“~/.nylas-mail”文件夹中。
  4. 从顶层菜单中选择“更改主题...”,您将看到新安装的主题。就是这样!

想要了解更多?尝试创建您自己的主题

插件

部分插件已预装,是您创建自己的插件的绝佳起点:

社区插件

请注意,这些插件未经 Nylas 测试或官方支持,但我们仍然认为它们非常棒!如果您发现它们存在错误,请在其各自的项目页面上提交 GitHub 问题,而不是在 Nylas Mail (N1) 代码库页面上提交。谢谢!

Jiffy—插入动态 GIF 天气 Todoist
取消订阅 Squirt Speed Reader 网站启动器—在单独窗口中打开网址
Cypher—PGP 加密 头像 活动日历(开发中)
Mail in Chat (WIP) Evernote Wunderlist
参与者显示 GitHub

当您安装软件包时,它们会被移动到 ~/.nylas-mail/packages,Nylas Mail 会在命令行中运行 apm install 来获取软件包 package.json 中列出的依赖项。

分支

Nylas Mail 有多个分支,您应该查看一下。如果您只是在学习 Nylas Mail,强烈建议您使用其中一个。

  • Mailspring - 由原作者之一进行了重大改写,重点改进了性能和云插件
  • Nylas Mail Lives - 社区致力于修复错误并改进客户端!(寻求维护者)

关于项目

Nylas Mail 是一款基于现代 Web 技术、基于 Electron、React 和 Flux 构建的开源邮件客户端。它易于扩展,并且提供许多第三方插件来增强客户端的功能。
MIT
Javascript
24,810
1372
448
2014-10-17
2022-11-24

增长趋势 - stars