EmailComposerOptions

The EmailComposerOptions object contains options that are passed into blackberry.invoke.card.invokeEmailComposer().


Supported Platform(s)

- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
attachment           Y 
body           Y 
calendarevent           Y 
cc           Y 
from           Y 
subject           Y 
to           Y 

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

This API does not require a <feature> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties

String[] attachment
String body
Number calendarevent
String[] cc
Number from
String subject
String [] to

Properties

String[] attachment


array of filepaths to files that will be attached to this email


Supported Platforms
 - BlackBerry 10

String body


The email body that should be set when the composer is invoked.


Supported Platforms
 - BlackBerry 10

Number calendarevent


calendar event ID to attach to this email


Supported Platforms
 - BlackBerry 10

String[] cc


array of cc'd email addresses.


Supported Platforms
 - BlackBerry 10

Number from


The account ID of the account the composer should send the email from.


Supported Platforms
 - BlackBerry 10

String subject


The subject that should be set when the composer is invoked.


Supported Platforms
 - BlackBerry 10

String [] to


array of recipient email addresses.


Supported Platforms
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:06 GMT-0500 (EST)