Nylas Mail - the open-source, extensible mail client

N1 Screenshot

Nylas Mail is an open-source mail client built on the modern web with Electron, React, and Flux. It is designed to be extensible, so it's easy to create new experiences and workflows around email. Want to learn more? Check out the full documentation.

Build Status Slack Invite Button

Want to help build the future of email? Nylas is hiring!

Download Nylas Mail

You can download compiled versions of Nylas Mail for Windows, Mac OS X, and Linux (.deb) from https://nylas.com/download. You can also build and run Nylas Mail (Previously N1) on Fedora. On Arch Linux, you can install n1 or n1-git from the aur.

Build A Plugin

Plugins lie at the heart of Nylas Mail and give it its powerful features. Building your own plugins allows you to integrate the app with other tools, experiment with new workflows, and more. Follow the Getting Started guide to write your first plugin in five minutes. To create your own theme, go to our Theme Starter guide.

If you would like to run the N1 source and contribute, check out our contributing guide.

Themes

The Nylas Mail user interface is styled using CSS, which means it's easy to modify and extend. Nylas Mail comes stock with a few beautiful themes, and there are many more which have been built by community developers

Bundled Themes

Community Themes

To install community themes:

  1. Download and unzip the repo
  2. In Nylas Mail, select Developer > Install a Package Manually...
  3. Navigate to where you downloaded the theme and select the root folder. The theme is copied into the ~/.nylas-mail folder for your convinence
  4. Select Change Theme... from the top level menu, and you'll see the newly installed theme. That's it!

Want to dive in more? Try creating your own theme!

Plugin List

We're working on building a plugin index that makes it super easy to add them to Nylas Mail. For now, check out the list below! (Feel free to submit a PR if you build a plugin and want it featured here.)

Bundled Plugins

Great starting points for creating your own plugins!

Community Plugins

Note these are not tested or officially supported by Nylas, but we still think they are really cool! If you find bugs with them, please open GitHub issues on their individual project pages, not the Nylas Mail (N1) repo page. Thanks!

When you install packages, they're moved to ~/.nylas-mail/packages, and Nylas Mail runs apm install on the command line to fetch dependencies listed in the package's package.json

Building the docs

Plugin SDK docs are available at https://nylas.github.io/nylas-mail/. Here's how you build them:

Until my patch gets merged, docs need to be built manually using mg's fork.

git clone git@github.com:grinich/gitbook.git

cd nylas-mail

./node_modules/.bin/gitbook alias ../gitbook latest

Then to actually build the docs:

script/grunt docs

./node_modules/.bin/gitbook --gitbook=latest build . ./_docs_output --log=debug --debug

rm -r docs_src/classes

If you want to preview the docs:

pushd ./_docs_output; python -m SimpleHTTPServer; popd

Just want to publish everything? There's a helper script that does it for you:

script/publish-docs

Configuration

You can configure Nylas Mail in a few ways—for instance, pointing it to your self-hosted instance of the sync engine or changing the interface zoom level. Learn more about how.

Feature Requests / Plugin Ideas

Have an idea for a package or a feature you'd love to see in Nylas Mail? Search for existing GitHub issues and join the conversation!



Nylas Mail - the open-source, extensible mail client

N1屏幕截图data-canonical-src

Nylas Mail是一个基于现代网络的开源邮件客户端, Electron 订购 Flux 它的设计是可扩展的,因此可以轻松地创建新的电子邮件体验和工作流程。想要了解更多?查看完整的文档

建立状态

Want to help build the future of email? Nylas is hiring!

下载Nylas Mail

您可以从 https://nylas.com/download下载Nylas Mail for Windows,Mac OS X和Linux(.deb)的编译版本您还可以在Fedora上构建并运行Nylas Mail(以前的N1)。在Arch Linux上,您可以安装 n1 n1-git 从aur。

构建插件

插件是Nylas Mail的核心,并赋予其强大的功能。构建自己的插件可让您将应用程序与其他工具集成,实验新工作流程等。按照入门指南在五分钟内编写您的第一个插件。要创建自己的主题,请访问我们的主题入门指南

如果您想运行N1来源并作出贡献,请查看我们的贡献 指南

主题

Nylas Mail用户界面使用CSS样式,这意味着它易于修改和扩展。 Nylas Mail有几个美丽的主题,还有更多的由社区开发者构建的

Bundled Themes

Community Themes

To install community themes:

  1. Download and unzip the repo
  2. In Nylas Mail, select Developer > Install a Package Manually…
  3. Navigate to where you downloaded the theme and select the root folder. The theme is copied into the ~/.nylas-mail folder for your convinence
  4. Select Change Theme… from the top level menu, and you'll see the newly installed theme. That's it!
想要潜水更多?尝试创建自己的主题

插件列表

我们正在努力构建一个插件索引,使其非常容易地将其添加到Nylas Mail。现在,查看下面的列表! (如果您构建一个插件,并且希望在此处提供功能,请随时提交公告。)

Bundled Plugins

创建自己的插件的好起点!

Community Plugins

注意,这些没有被Nylas测试或正式支持,但我们仍然认为他们真的很酷!如果您发现错误,请在其各自的项目页面上打开GitHub问题,而不是Nylas Mail(N1)的回购页面。谢谢!

安装软件包时,将它们移动到〜/ .nylas-mail / packages,Nylas Mail在命令行中运行apm安装,以获取包package.json中列出的依赖项。

构建文档

插件SDK文档可从 https://nylas.github.io/nylas-mail/ 获取。以下是您如何构建它们:

在我的修补程序合并之前,需要使用mg的fork手动构建文档。

git clone git@github.com:grinich/gitbook.git

cd nylas-mail

./node_modules/.bin/gitbook alias ../gitbook latest

然后实际构建文档:

script/grunt docs

./node_modules/.bin/gitbook –gitbook=latest build . ./_docs_output –log=debug –debug

rm -r docs_src/classes

如果您要预览文档:

pushd ./_docs_output; python -m SimpleHTTPServer; popd
只想发布所有内容?有一个帮助脚本可以为您做:

script/publish-docs

配置

您可以通过几种方式配置Nylas Mail,例如,将其指向同步引擎的自托管实例或更改界面缩放级别。 详细了解如何

GitHub问题并加入对话!




相关问题推荐