The plugin provides access to the standard interface that manages the editing and sending an email message. You can use this view controller to display a standard email view inside your application and populate the fields of that view with initial values, such as the subject, email recipients, body text, and attachments. The user can edit the initial contents you specify and choose to send the email or cancel the operation.
Using this interface does not guarantee immediate delivery of the corresponding email message. The user may cancel the creation of the message, and if the user does choose to send the message, the message is only queued in the Mail application outbox. This allows you to generate emails even in situations where the user does not have network access, such as in airplane mode. This interface does not provide a way for you to verify whether emails were actually sent.
# ~~ from master branch ~~cordova plugin add
from a local folder:
# ~~ local folder ~~cordova plugin add cordova-plugin-email-composer --searchpath path/to/plugin --link
or to use the last stable version:
# ~~ stable version ~~cordova plugin add email@example.com
Add the following xml to your config.xml to always use the latest version of this plugin:
63 commits including bug fixes and enhancements:
The plugin creates the object
cordova.plugins.email with following methods:
The plugin and its methods are not available before the deviceready event has been fired.
The ability to send emails can be revised through the
email.isAvailable interface. The method takes a callback function, passed to which is a boolean property. Optionally the callback scope can be assigned as a second parameter.
The Email service is only available on devices capable which are able to send emails. E.g. which have configured an email account and have installed an email app. You can use this function to hide email functionality from users who will be unable to use it.
If you want to open a draft in a specific application, just pass its uri scheme on iOS, or its name on Android as first parameter, to check whether the application is installed or not. The callback function will return a second parameter of type boolean then.
A pre-filled email draft can be opened through the
email.openDraft interface. The method takes a hash as an argument to specify the email's properties. All properties are optional. Further more it accepts an callback function to be called after the email view has been dismissed.
After opening the draft the user may have the possibilities to edit, delete or send the email.
The following example shows how to create and show an email draft pre-filled with different kind of properties.
Of course its also possible to open a blank draft.
Its possible to send the email body either as text or HTML. In the case of HTML the
isHTML properties needs to be set.
open method supports additional callback to get informed when the view has been dismissed.
Attachments can be either base64 encoded datas, files from the the device storage or assets from within the www folder.
The code below shows how to attach an base64 encoded image which will be added as a image with the name icon.png.
The path to the files must be defined absolute from the root of the file system.
Each app has a resource folder, e.g. the res folder for Android apps or the Resource folder for iOS apps. The following example shows how to attach the app icon from within the app's resource folder.
The path to the files must be defined relative from the root of the mobile web app folder, which is located under the www folder.
Its possible to specify the email app which shall open the draft for further editing. Just pass its scheme name through the drafts app-attribute. If the phone isn´t able to handle the specified scheme it will fallback to standard.
// Specify app by scheme namecordovapluginsemail
On Android the app can be specified by either an alias or its package name. The alias gmail is available by default.
// Add app aliascordovapluginsemail;// Specify app by name or aliascordovapluginsemail
Even Android is capable to render HTML formatted mails, most native Mail clients like the standard app or Gmail only support rich formatted text while writing mails. That means that CSS cannot be used (no class and style support).
The following table gives an overview which tags and attributes can be used:
HTML+CSS formatted body are not supported through the native API for Windows.
git checkout -b my-new-feature)
git commit -am 'Add some feature')
git push origin my-new-feature)
This software is released under the Apache 2.0 License.
© 2013-2016 appPlant UG, Inc. All rights reserved