Skip to content
💌 A beautiful, fast and maintained fork of @nylas Mail by one of the original authors.
TypeScript HTML JavaScript CSS Shell Visual Basic
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Use a docker image with more linux configuration Mar 17, 2019
.snapcraft Update snapcraft travis config Oct 13, 2019
.vscode Add a proper address book with CardDAV + Google People support Oct 12, 2019
app Bump to 1.7.1, update Changelog Oct 14, 2019
mailsync @ 5c7a626 Fix URL from curl_easy_getinfo used after freed by curl_easy_cleanup #… Oct 14, 2019
screenshots Add screenshot back to README Aug 2, 2017
scripts Replace Babel with TypeScript compiler, switch entire app to TypeScript Mar 4, 2019
snap Add DISABLE_WAYLAND to snapcraft.yaml to resolve Electron/snapd/Wayla… Jun 10, 2019
.appveyor.yml Spring cleaning: Build with Node 11 instead of Node 6.9 Jun 11, 2019
.eslintrc Fix a whole bunch of failing tests that needed ❤️ [7 left] Sep 23, 2019
.gitignore Send IDs to Sentry so issues can be sorted by number of impacted users Nov 5, 2018
.gitmodules Fix rename of mailsync module Sep 5, 2017
.prettierrc Adopt prettier , upgrade ESLint Sep 26, 2017
.travis.yml Add a proper address book with CardDAV + Google People support Oct 12, 2019
CHANGELOG.md Bump to 1.7.1, update Changelog Oct 14, 2019
CONTRIBUTING.md allow cancel upgrade prompt (#1514, #913), change invalid 'apt instal… Sep 23, 2019
ISSUE_TEMPLATE.md Update issue template to show that you only need to provide the x.x.x… Oct 14, 2019
LICENSE-mailsync.md Add a “View License” menu item similar to Atom’s Jan 3, 2019
LICENSE.md fix(license): Swap ref to GPLv3 with the whole thing so GitHub picks … Oct 15, 2016
LOCALIZATION.md Fill gaps in translations using Google NLT API [hope contributors can… Oct 9, 2018
README.md Remove the (broken) plugin template and link to the starter github re… Oct 9, 2019
ROADMAP.md Update changelog, cut v1.5.4 release Dec 29, 2018
book.json Switch product name to “Mailspring” Sep 5, 2017
package-lock.json Semver caret syntax is patch-only for 0.x.x, fork to update slate-edi… Jun 11, 2019
package.json Spring cleaning: Build with Node 11 instead of Node 6.9 Jun 11, 2019

README.md

💌 Mailspring

Travis Status AppVeyor Status Mailspring Slack

Mailspring is a new version of Nylas Mail maintained by one of the original authors. It's faster, leaner, and shipping today! It replaces the JavaScript sync code in Nylas Mail with a new C++ sync engine based on Mailcore2. It uses roughly half the RAM and CPU of Nylas Mail and idles with almost zero "CPU Wakes", which translates to great battery life. It also has an entirely revamped composer and other great new features.

Mailspring's UI is open source (GPLv3) and written in TypeScript with Electron and React - it's built on a plugin architecture and was designed to be easy to extend. Check out CONTRIBUTING.md to get started!

Mailspring's sync engine is spawned by the Electron application and runs locally on your computer. It will be open-sourced in the future but is currently closed source. When you set up your development environment, Mailspring uses the latest version of the sync process we've shipped for your platform so you don't need to pull sources or install its compile-time dependencies.

Mailspring Screenshot

Features

Mailspring comes packed with powerful features like Unified Inbox, Snooze, Send Later, Mail Rules, Templates and more. Mailspring Pro, which you can unlock with a monthly subscription, adds even more features for people who send a ton of email: link tracking, read receipts, mailbox analytics, contact and company profiles. All of these features run in the client - Mailspring does not send your email credentials to the cloud. For a full list of features, check out getmailspring.com.

Download Mailspring

You can download compiled versions of Mailspring for Windows, Mac OS X, and Linux (deb, rpm and snap) from https://getmailspring.com/download.

Contributing

Mailspring's UI is entirely open-source and pull requests and contributions are welcome! There are three ways to contribute: building a plugin, building a theme, and submitting pull requests to the project itself. When you're getting started, you may want to join our public slack so you can ask questions and learn from other people doing development.

Building A Plugin

Plugins lie at the heart of Mailspring 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.

A plugin "store" like the Chrome Web Store is coming soon, and will make it easy for other users to discover plugins you create. (Right now, users need to "sideload" the plugins into the app by downloading them and copying them into place.)

Building a Theme

The Mailspring user interface is styled using CSS, which means it's easy to modify and extend. Mailspring comes stock with a few beautiful themes, and there are many more which have been built by community developers. To start creating a theme, clone the theme starter!

If you are updating an existing Nylas theme for Mailspring here is a step by step tutorial. Notice: as part of the update process you will probably need to import mailspring base variables.

Localizing / Translating

Mailspring 1.5.0 and above support localization. If you're a fluent speaker of another language, we'd love your help improving translations. Check out the LOCALIZATION guide for more information.

Contributing to Mailspring Core

Pull requests are always welcome - check out CONTRIBUTING for more information about setting up the development environment, running tests locally, and submitting pull requests.

You can’t perform that action at this time.