Mailspring/packages/client-app/docs_src

Nylas Mail Plugin SDK

The Nylas SDK allows you to create powerful extensions to Nylas Mail, a mail client for Mac OS X, Windows, and Linux. Building on Nylas Mail saves time and allows you to build innovative new experiences fast. Get Started

Installing Nylas Mail

Nylas Mail is available for Mac, Windows, and Linux. Download the latest build for your platform below:

• Mac OS X
• Linux
• Windows

Package Architecture

Packages lie at the heart of Nylas Mail. Each part of the core experience is a separate package that uses the Nylas Package API to add functionality to the client. Learn more about packages and create your first package.

• Create a Plugin
• Plugin Overview

Dive Deeper

• Application Architecture
• React & Component Injection
• Core Interface Concepts
• Accessing the Database
• Draft Store Extensions

Debugging Packages

Nylas Mail is built on top of Electron, which runs the latest version of Chromium. Learn how to access debug tools in Electron and use our Developer Tools Extensions:

• Debugging in Nylas

Questions?

Need help? Check out the FAQ or post a question in the slack channel.

TODOs

• Add plugin examples with code (es6 not coffeescript)
• Smart Linkify references. Maybe use something like gitbook-plugin-regexplace
• Have class reference files link to their actual sourcefiles
• Consider adding infinite scroll