Version13.0.0

You are reading 13.0.0. See this page in 13.4.1.

Titanium.UI.EmailDialog

viewAndroidiPhoneiPadmacOSsince 0.8

An email dialog is a modal window that allows users to compose and send an email.

Android	iOS

The Email Dialog is created with the Titanium.UI.createEmailDialog method. The user needs to register an e-mail account on the device in order to open the dialog. The dialog will not open when there is not a registered e-mail account.

iOS Platform Notes

On iOS, you cannot test the e-mail dialog on the iOS Simulator. Test the email dialog on device.

Examples

Simple Email Dialog with Attachment

Create and send an email with a file attachment.

var emailDialog = Ti.UI.createEmailDialog()
emailDialog.subject = "Hello from Titanium";
emailDialog.toRecipients = ['foo@yahoo.com'];
emailDialog.messageBody = '<b>Titanium SDK Rocks!</b>';
var f = Ti.Filesystem.getFile('cricket.wav');
emailDialog.addAttachment(f);
emailDialog.open();

Properties 34

accessibilityDisableLongPress

BooleanAndroidsince 12.4.0

Inherited from Titanium.UI.View

Boolean value to remove the long press notification for the device's accessibility service.

Default: true

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

barColor

String | Titanium.UI.ColoriPhoneiPadmacOS

Bar color of the email dialog window, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

bccRecipients

Array<String>

Recipients of the email included via the BCC (Blind Carbon Copy) field.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

CANCELLED

NumberiPhoneiPadmacOSread-only

Constant for the CANCELLED status result. On Android, this property exists but is not used.

ccRecipients

Array<String>

Recipients of the email included via the CC (Carbon Copy) field.

elevation

NumberAndroidsince 5.0.0Android 5+

Inherited from Titanium.UI.View

Base elevation of the view relative to its parent in pixels.

FAILED

Numberread-only

Constant for the FAILED status result.

filterTouchesWhenObscured

BooleanAndroidsince 9.3.0

Inherited from Titanium.UI.View

Discards touch related events if another app's system overlay covers the view.

Default: false

hiddenBehavior

NumberAndroidsince 6.1.0

Inherited from Titanium.UI.View

Sets the behavior when hiding an object to release or keep the free space

Accepts

horizontalMotionEffect

MinMaxOptionsiPhoneiPadmacOSsince 7.3.0

Inherited from Titanium.UI.View

Adds a horizontal parallax effect to the view

html

Boolean

Determines whether the email message, specifically the contents of messageBody, should be sent as HTML content type rather than plain text.

Default: false

id

String

Inherited from Titanium.UI.View

View's identifier.

lifecycleContainer

Titanium.UI.Window | Titanium.UI.TabGroupAndroidsince 3.6.0

Inherited from Titanium.Proxy

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

messageBody

String

Email message body.

previewContext

Titanium.UI.iOS.PreviewContextiPhonesince 5.1.0

Inherited from Titanium.UI.View

The preview context used in the 3D-Touch feature "Peek and Pop".

rotation

NumberAndroidiPhoneiPadsince Android 5.4.0, iPhone 12.3.0, iPad 12.3.0

Inherited from Titanium.UI.View

Clockwise 2D rotation of the view in degrees.

rotationX

NumberAndroidsince 5.4.0

Inherited from Titanium.UI.View

Clockwise rotation of the view in degrees (x-axis).

rotationY

NumberAndroidsince 5.4.0

Inherited from Titanium.UI.View

Clockwise rotation of the view in degrees (y-axis).

SAVED

Numberread-only

Constant for the SAVED status result. On Android, this property exists but is not used.

scaleX

NumberAndroidsince 5.4.0

Inherited from Titanium.UI.View

Scaling of the view in x-axis in pixels.

scaleY

NumberAndroidsince 5.4.0

Inherited from Titanium.UI.View

Scaling of the view in y-axis in pixels.

SENT

Numberread-only

Constant for the SENT status result.

subject

String

Subject line for the email.

toRecipients

Array<String>

Recipients of the email included via the main TO field.

touchFeedback

BooleanAndroidsince 6.1.0

Inherited from Titanium.UI.View

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Default: false

touchFeedbackColor

StringAndroidsince 6.1.0

Inherited from Titanium.UI.View

Optional touch feedback ripple color. This has no effect unless touchFeedback is true.

transitionName

StringAndroidsince 5.0.2Android 5+

Inherited from Titanium.UI.View

A name to identify this view in activity transition.

translationX

NumberAndroidsince 5.0.0

Inherited from Titanium.UI.View

Horizontal location of the view relative to its left position in pixels.

translationY

NumberAndroidsince 5.0.0

Inherited from Titanium.UI.View

Vertical location of the view relative to its top position in pixels.

translationZ

NumberAndroidsince 5.0.0Android 5+

Inherited from Titanium.UI.View

Depth of the view relative to its elevation in pixels.

verticalMotionEffect

MinMaxOptionsiPhoneiPadmacOSsince 7.3.0

Inherited from Titanium.UI.View

Adds a vertical parallax effect to the view

Methods 14

addAttachment

Adds an attachment.

On Android, multiple attachments may be added, but will only work if the user chooses to send via the Android Gmail or K9 mail clients.

The Android "Mail" app, which is only available on some handsets, will only accept one attachment from a Titanium app.

Parameters
Parameters	Type	Description
attachment	Titanium.Blob \| Titanium.Filesystem.File	Attachment to include in the email.

addEventListener

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

applyProperties

since 3.0.0

Inherited from Titanium.Proxy

Applies the properties to the proxy.

Parameters
Parameters	Type	Description
props	Dictionary	A dictionary of properties to apply.

clearMotionEffects

iPhoneiPadmacOSsince 8.2.0

Inherited from Titanium.UI.View

Removes all previously added motion effects.

fireEvent

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
Parameters	Type	Description
name	String	Name of the event.
event?	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

getViewById

since 6.1.0

Inherited from Titanium.UI.View

Returns the matching view of a given view ID.

Parameters
Parameters	Type	Description
id	String	The ID of the view that should be returned. Use the `id` property in your views to enable it for indexing in this method.

Returns Titanium.UI.View

hide

Inherited from Titanium.UI.View

Hides this view.

Parameters
Parameters	Type	Description
options?	AnimatedOptions	Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`

insertAt

since 3.3.0

Inherited from Titanium.UI.View

Inserts a view at the specified position in the children array.

Parameters
Parameters	Type	Description
params	ViewPositionOptions	Pass an object that specifies the view to insert and optionally at which position (defaults to end) 2 fields position? Number Position in the children array of the view element to replace. view Titanium.UI.View View to insert. Required.

isSupported

Indicates whether sending email is supported by the system.

On iOS 10, the user is able to uninstall the built-in applications including Mail. Because of that, you should ensure to check if the email dialog is supported on the current device.

Returns Boolean

open

Opens this email dialog.

Parameters
Parameters	Type	Description
options?	AnimatedOptions	Supported on iOS only. Simple object to override animation. Note that the default here is equivalent to passing in `{ animated: true }` (while typically the default for AnimatedOptions is false)

removeEventListener

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

replaceAt

since 3.3.0

Inherited from Titanium.UI.View

Replaces a view at the specified position in the children array.

Parameters
Parameters	Type	Description
params	ViewPositionOptions	Pass an object with the view to insert and the position of the view to replace. In this case the `position` property is required. 2 fields position? Number Position in the children array of the view element to replace. view Titanium.UI.View View to insert. Required.

show

Inherited from Titanium.UI.View

Makes this view visible.

Parameters
Parameters	Type	Description
options?	AnimatedOptions	Animation options for Android only. Since SDK 5.1.0 and only used on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`

stopAnimation

Androidsince 12.1.0

Inherited from Titanium.UI.View

Stops a running animation.

Events 2

complete

Fired when this email dialog has completed sending an email.

Event properties
Event properties	Type	Description
success	Boolean	Indicates if the email was handled successfully. Returns `true` if request succeeded, `false` otherwise. Note that emails being deleted or saved for later do count as success.
error	String	Error message, if any returned. Will be undefined if `success` is `true`.
code	Number	Error code. Error code will be 0 if `success` is `true`, nonzero otherwise. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.
result	Number	Status of the email send process. The `SAVED` and `CANCELLED` constants are iOS only. On Android, this property will return `SENT` when the user discards or saves a message.

rotate

since 12.7.0

Inherited from Titanium.UI.View

Fired when the device detects a two finger rotation.

Event properties
Event properties	Type	Description
rotate	Number	Rotation in degrees.