JavaScript CoffeeScript HTML CSS Shell Visual Basic
Latest commit 7890b92 Feb 17, 2017 @jstejada jstejada update(changelog)
Permalink
Failed to load latest commit information.
apm fix(rename): update nylas/N1 to nylas/nylas-mail Github references Jan 30, 2017
build fix(linux-build): Update rpm spec to use new package name Feb 17, 2017
docs Add built docs Jan 30, 2017
docs_src Fix broken link (#3284) Feb 14, 2017
dot-nylas Fix references for ~/.nylas to ~/.nylas-mail Jan 14, 2017
flow-typed rm(grim): We’re not using Grim for deprecations Oct 25, 2016
internal_packages feat(offline) Re add offline status notification Feb 15, 2017
keymaps es6(composer): Composer extensions => ES2016 Oct 28, 2016
menus 🎨(rename): Update Nylas N1 to Nylas Mail Jan 12, 2017
script fix(linux-build): Update rpm spec to use new package name Feb 17, 2017
spec fix(spec): re-enable NylasEnv specs and fix duplicate rejection log Feb 16, 2017
spec_integration fix(rename): update nylas/N1 to nylas/nylas-mail Github references Jan 30, 2017
src fix(cli): s/n1/nylas-mail/ Feb 16, 2017
static feat(usage): add new feature usage modal Feb 7, 2017
.eslintrc Update grunt tasks to lint and transpile es6 code using babel Nov 7, 2015
.gitignore feat(specs): Add support for generating JUnit XML by passing --junit-… Feb 13, 2017
.gitmodules Move old edgehill src/pro into K2/packages/nylas-private Dec 12, 2016
.travis.yml Actually fix travis Feb 10, 2017
.watchmanconfig fix(watchman): There's some stuff in build/ we don't want to ignore Feb 16, 2017
CHANGELOG.md update(changelog) Feb 17, 2017
CONFIGURATION.md feat(self-hosting): Add onboarding flow for self-hosted sync engine Jul 21, 2016
CONTRIBUTING.md update(docs): Add note about Linux dependencies Jan 31, 2017
ISSUE_TEMPLATE.md fix(rename): update nylas/N1 to nylas/nylas-mail Github references Jan 30, 2017
LICENSE.md fix(license): Swap ref to GPLv3 with the whole thing so GitHub picks … Oct 15, 2016
README.md Update README.md (#3255) Feb 3, 2017
appveyor.yml bump(appveyor): build stable branches Feb 3, 2017
book.json Update docs config Jan 30, 2017
keymap.json fix(config): Move all reads / writes to the main process May 16, 2016
package.json fix(linux-build): Change package name to Nylas Mail Feb 16, 2017

README.md

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!