Email Composer

Improve this doc

Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the Email Composer plugin docs.

Repo: https://github.com/katzer/cordova-plugin-email-composer

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-email-composer
   $ npm install --save @ionic-native/email-composer@4
   

2. Add this plugin to your app's module

Supported platforms

• Amazon Fire OS
• Android
• Browser
• iOS
• Windows
• macOS

Usage

import { EmailComposer } from '@ionic-native/email-composer';

constructor(private emailComposer: EmailComposer) { }

...


this.emailComposer.isAvailable().then((available: boolean) =>{
 if(available) {
   //Now we know we can send
 }
});

let email = {
  to: 'max@mustermann.de',
  cc: 'erika@mustermann.de',
  bcc: ['john@doe.com', 'jane@doe.com'],
  attachments: [
    'file://img/logo.png',
    'res://icon.png',
    'base64:icon.png//iVBORw0KGgoAAAANSUhEUg...',
    'file://README.pdf'
  ],
  subject: 'Cordova Icons',
  body: 'How are you? Nice greetings from Leipzig',
  isHtml: true
};

// Send a text message using default options
this.emailComposer.open(email);

You can also assign aliases to email apps

// add alias
this.email.addAlias('gmail', 'com.google.android.gm');

// then use alias when sending email
this.email.open({
  app: 'gmail',
  ...
});

Instance Members

hasPermission()

Checks if the app has a permission to access email accounts information

requestPermission()

Request permission to access email accounts information

isAvailable(app)

Verifies if sending emails is supported on the device.

open(options, scope)

Displays the email composer pre-filled with data.

addAlias(alias, packageName)

Adds a new mail app alias.

EmailComposerOptions