SAMPLE APP :point_right:
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.
Execute from the projects root folder:
$ cordova plugin add cordova-plugin-email-composer
Or install a specific version:
$ cordova plugin add cordova-plugin-email-composer@VERSION
Or install the latest head version:
$ cordova plugin add https://github.com/katzer/cordova-plugin-email-composer.git
Or install from local source:
$ cordova plugin add cordova-plugin-email-composer --searchpath <path>
The plugin creates the object
cordova.plugins.email and is accessible after the deviceready event has been fired.
The Email service is only available on devices which have configured an email account:
To check for a specific mail client, just pass its uri scheme on iOS, or its name on Android as first parameter:
All properties are optional. After opening the draft the user may have the possibilities to edit the draft.
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 specify the email client. If the phone isn´t able to handle the specified scheme it will fallback to the system default:
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;
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.
The path must be defined relative from the directory holding application files.
The plugin might ask for granting permissions like reading email account informations. That's done automatically.
Its possible to request them manually:
Or check if they have been granted already:
In case of missing permissions the result of
isAvailable might be wrong.
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).
Update: Seems it stopped working with gmail at version 6.x and Android Mail, see #264.
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.
Made with 😋 from Leipzig
© 2013 appPlant GmbH