nylas/nylas-mail

[!CAUTION] 🛑 This repository is archived and no longer maintained.

Nylas Mail (originally N1) was open-sourced in 2015 and maintained by Nylas until 2017. It is preserved here for historical reference. Nylas is now an API platform — see developer.nylas.com. For an actively maintained desktop client, see the community forks listed at the bottom of this README.

---

Nylas Mail - the open-source, extensible mail client

Nylas Mail was an open-source mail client built on the modern web with Electron, React, and Flux. It was designed to be easy to extend, and many third-party plugins are available that add functionality to the client.

⚠️ Nylas Mail was initially released and open-sourced in early 2015 and was maintained by Nylas until Spring 2017. While Nylas no longer supports Nylas Mail, you can download the latest release or build it from source. There are also several forks that are being actively developed and maintained.

Getting Started

Setup your Environment (Mac):

1. Install Homebrew
2. Install NVM & Redis brew install nvm redis
3. Install Node 6 via NVM: nvm install 6
4. npm install

Setup your Environment (Linux - Debian/Ubuntu):

1. Install Node 6+ via NodeSource (trusted):
2. curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
3. sudo apt-get install -y nodejs
4. Install Redis locally sudo apt-get install -y redis-server redis-tools benefit of letting us use subdomains.
5. npm install

Running Nylas Mail

1. npm run client: Starts the app
2. npm run test-client: Run the tests
3. npm run lint-client: Lint the source (ESLint + Coffeelint + LESSLint)

Exploring the Source

This repository contains the full source code to the Nylas Mail client and it's backend services. It is divided into the following packages:

1. Isomorphic Core: Shared code across local client and cloud servers
2. Client App: The main Electron app for Nylas Mail mirrored to open source repo.
3. Client Sync: The local mailsync engine integreated in Nylas Mail
4. Client Private Plugins: Private Nylas Mail plugins (like SFDC)
5. Cloud API: The cloud-based auth and metadata APIs for N1
6. Cloud Core: Shared code used in all remote cloud services
7. Cloud Workers: Cloud workers for services like send later

See /packages for the separate pieces. Each folder in /packages is designed to be its own stand-alone repository. They are all bundled here for the ease of source control management.

Digging Deeper

In early 2016, the Nylas Mail team wrote extensive documentation for the app that was intended for plugin developers. This documentation lives on GitHub Pages and offers a great overview of the app's architecture and important classes. Here are some good places to get started:

• Application Architecture
• Debugging Nylas Mail

The team has also given conference talks and published blog posts about the client:

• ReactEurope: How React & Flux Turn Apps Into Extensible Platforms

• ForwardJS: Electron, React & Pixel Perfect Experiences

• Blog: Splitting from Atom

• Blog: Building Plugins for React Apps

• Blog: Nylas Mail Build Process

• Blog: Low level Electron Debugging

• Blog: A New Search Parser

• Blog: Developers Guide to Emoji

• Blog: Nylas Pro

• Blog: Nylas Mail & PGP

• Blog: Calendar Events and RRULEs

Running the Cloud

When you download and build Nylas Mail from source it runs without its cloud components. The concept of a "Nylas ID" / subscription has been removed, and plugins that require server-side processing are disabled by default. (Plugins like Snooze, Send Later, etc.)

In order to use these plugins and get the full Nylas Mail experience, you need to deploy the backend infrastructure located in the cloud-* packages. Deploying these services is challenging because they are implemented as microservices and designed to be run at enterprise scale with Redis, Postgres, etc. Because these backend services must access your email account, it is also important to use security best-practices (at the very least, SSL, encryption at rest, and a partitioned VPC). For more information about building and deploying this part of the stack, check out the cloud-core README.

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

• Dark
• Darkside (designed by Jamie Wilson)
• Taiga (designed by Noah Buscher)
• Ubuntu (designed by Ahmed Elhanafy)
• Less Is More (designed by Alexander Adkins (account removed))

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!

Plugins

Some plugins come pre-installed, and are a great starting points for creating your own:

• Translate—Works with 10 languages
• Quick Replies—Send emails faster with templates
• Emoji Keyboard—Insert emoji by typing a colon (:) followed by the name of an emoji symbol
• GitHub Sidebar Info
• View on GitHub
• Personal Level Indicators
• Phishing Detection

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

Forks

There are several forks of Nylas Mail that you should check out. If you're just learning about Nylas Mail, it is highly recommended you use one of these instead.

• Mailspring - Significant rewrite by one of the original authors focused on performance and cloud plugins
• Nylas Mail Lives - Community effort to fix bugs and improve the client! (Seeking Maintainers)