💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
Go to file
2019-10-13 15:57:57 -05:00
.circleci Use a docker image with more linux configuration 2019-03-17 10:45:03 -07:00
.snapcraft Update snapcraft travis config 2019-10-13 14:42:09 -05:00
.vscode Add a proper address book with CardDAV + Google People support 2019-10-12 12:40:57 -05:00
app Adjust Windows-specific CSS to match new slightly narrower toolbar 2019-10-13 15:57:57 -05:00
mailsync@d379fd8ea8 Make VCard parsing allow \n as well as \r\n for FastMail 2019-10-13 15:28:51 -05:00
screenshots Add screenshot back to README 2017-08-02 12:46:04 -07:00
scripts Replace Babel with TypeScript compiler, switch entire app to TypeScript 🎉 (#1404) 2019-03-04 11:03:12 -08:00
snap Add DISABLE_WAYLAND to snapcraft.yaml to resolve Electron/snapd/Wayland issues (#1517) 2019-06-10 17:52:21 -05:00
.appveyor.yml Spring cleaning: Build with Node 11 instead of Node 6.9 2019-06-11 01:00:12 -05:00
.eslintrc Fix a whole bunch of failing tests that needed ❤️ [7 left] 2019-09-23 13:24:15 -05:00
.gitignore Send IDs to Sentry so issues can be sorted by number of impacted users 2018-11-05 10:13:30 -08:00
.gitmodules Fix rename of mailsync module 2017-09-05 14:13:02 -07:00
.prettierrc Adopt prettier , upgrade ESLint 2017-09-26 11:33:08 -07:00
.travis.yml Add a proper address book with CardDAV + Google People support 2019-10-12 12:40:57 -05:00
book.json Switch product name to “Mailspring” 2017-09-05 13:40:25 -07:00
CHANGELOG.md Bump version to 1.7.0 and update changelog 2019-10-13 14:44:04 -05:00
CONTRIBUTING.md allow cancel upgrade prompt (#1514, #913), change invalid 'apt install libgconf2-4' to libgconf-2-4 in CONTRIBUTING.md 2019-09-23 10:48:08 -05:00
ISSUE_TEMPLATE.md Add a note to the ISSUE_TEMPLATE asking for mailsync logs 2018-08-02 12:46:52 -07:00
LICENSE-mailsync.md Add a “View License” menu item similar to Atom’s 2019-01-03 01:11:20 -08:00
LICENSE.md fix(license): Swap ref to GPLv3 with the whole thing so GitHub picks it up 2016-10-15 10:48:44 -07:00
LOCALIZATION.md Fill gaps in translations using Google NLT API [hope contributors can improve these!] 2018-10-09 13:31:07 -07:00
package-lock.json Semver caret syntax is patch-only for 0.x.x, fork to update slate-edit-list peerDep 2019-06-11 01:48:25 -05:00
package.json Spring cleaning: Build with Node 11 instead of Node 6.9 2019-06-11 01:00:12 -05:00
README.md Remove the (broken) plugin template and link to the starter github repo instead #1645 2019-10-08 22:42:56 -05:00
ROADMAP.md Update changelog, cut v1.5.4 release 2018-12-29 08:26:29 -05:00

💌 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.