7edafa3819
Summary: Lots o docs Test Plan: Run tests, review docs Reviewers: evan Reviewed By: evan Differential Revision: https://review.inboxapp.com/D1496
1.8 KiB
| Title | Section | Order |
|---|---|---|
| Extending the Composer | Guides | 5 |
The composer lies at the heart of Nylas Mail, and many improvements to the mail experience require deep integration with the composer. To enable these sort of plugins, the DraftStore exposes an extension API.
This API allows your package to:
-
Display warning messages before a draft is sent. (ie: "Are you sure you want to send this without attaching a proposal?")
-
Intercept keyboard and mouse events to the composer's text editor.
-
Transform the draft and make additional changes before it is sent.
To create a Draft Store Extension, subclass {DraftStoreExtension} and override the methods your extension needs. See {DraftStoreExtension} for a complete list of the methods your extension can implement. In the sample packages repository, templates is an example of a package which uses a DraftStoreExtension to enhance the composer experience.
####Example:
This extension displays a warning before sending a draft that contains the names of competitor's products and if the user proceeds to send the draft containing the words, it appends a disclaimer.
{DraftStoreExtension} = require 'inbox-exports'
class ProductsExtension extends DraftStoreExtension
@warningsForSending: (draft) ->
words = ['iphone', 'ipad', 'apple', 'iwatch', 'macbook']
body = draft.body.toLowercase()
for word in words
if body.indexOf(word) > 0
return ["with the word '#{word}'?"]
return []
@finalizeSessionBeforeSending: (session) ->
draft = session.draft()
if @warningsForSending(draft)
bodyWithWarning = draft.body += "<br>This email \
contains competitor's product names \
or trademarks used in context."
session.changes.add(body: bodyWithWarning)