Murl Engine Lua Addon API  Version 1.0 beta
Murl.IEMail

The e-mail interface.

The IEMail object can be created by the IWebControl object.


Table members

Methods


SetSubject(subject)

Set the e-mail subject string.

Boolean SetSubject(String subject)

Parameters
subjectThe e-mail subject string.
Returns
Boolean true if successful.

SetMessage(message)

Set the e-mail message string.

Boolean SetMessage(String message)

Parameters
messageThe e-mail message string.
Returns
Boolean true if successful.

AddToRecipient(address)

Add a receipient e-mail address string to the TO field.

Boolean AddToRecipient(String address)

Parameters
addressThe e-mail address string.
Returns
Boolean true if successful.

AddCcRecipient(address)

Add a receipient e-mail address string to the carbon copy field.

Boolean AddCcRecipient(String address)

Parameters
addressThe e-mail address string.
Returns
Boolean true if successful.

AddBccRecipient(address)

Add a receipient e-mail address string to the blind carbon copy field.

Boolean AddBccRecipient(String address)

Parameters
addressThe e-mail address string.
Returns
Boolean true if successful.

AddAttachment(fileName, mimeType, data)

Add an attachment to the e-mail. Currently only supported on iOS devices.

Boolean AddAttachment(String fileName, String mimeType, Murl.Data data)

Parameters
fileNameThe name of the attachment.
mimeTypeThe MIME type of the attachment (e.g. "image/png").
dataThe data of the attachment.
Returns
Boolean true if successful.

GetSubject()

Get the e-mail subject string.

String GetSubject()

Returns
String subject The e-mail subject string.

GetMessage()

Get the e-mail message string.

String GetMessage()

Returns
String message The e-mail message string.

GetNumberOfToRecipients()

Get the number of available receipients of the TO field.

Integer GetNumberOfToRecipients()

Returns
Integer The number of available receipients.

GetToRecipient(index)

Get the receipients e-mail address string from the TO field. A valid index is [0 .. GetNumberOfToRecipients() - 1].

String GetToRecipient(Integer index)

Parameters
indexThe zero-based index of the receipients.
Returns
String The receipients e-mail address string.

GetNumberOfCcRecipients()

Get the number of available receipients of the carbon copy field.

Integer GetNumberOfCcRecipients()

Returns
Integer The number of available receipients.

GetCcRecipient(index)

Get the receipients e-mail address string from the carbon copy field. A valid index is [0 .. GetNumberOfToRecipients() - 1].

String GetCcRecipient(Integer index)

Parameters
indexThe zero-based index of the receipients.
Returns
String The receipients e-mail address string.

GetNumberOfBccRecipients()

Get the number of available receipients of the blind carbon copy field.

Integer GetNumberOfBccRecipients()

Returns
Integer The number of available receipients.

GetBccRecipient(index)

Get the receipients e-mail address string from the blind carbon copy field. A valid index is [0 .. GetNumberOfToRecipients() - 1].

String GetBccRecipient(Integer index)

Parameters
indexThe zero-based index of the receipients.
Returns
String The receipients e-mail address string.

GetNumberOfAttachments()

Get the number of attachments.

Integer GetNumberOfAttachments()

Returns
Integer The number of attachments.

GetAttachmentFileName(index)

Get the name of an attachment. A valid index is [0 .. GetNumberOfAttachments() - 1].

String GetAttachmentFileName(Integer index)

Parameters
indexThe zero-based index of the attachment.
Returns
String The name of the attachment.

GetAttachmentMimeType(index)

Get the MIME type of an attachment. A valid index is [0 .. GetNumberOfAttachments() - 1].

String GetAttachmentMimeType(Integer index)

Parameters
indexThe zero-based index of the attachment.
Returns
String The MIME type of the attachment.

GetAttachmentData(index)

Get the data of an attachment. A valid index is [0 .. GetNumberOfAttachments() - 1].

Murl.Data GetAttachmentData(Integer index)

Parameters
indexThe zero-based index of the attachment.
Returns
Murl.Data The data of the attachment.

Send()

Send the e-mail.

Boolean Send()

Returns
Boolean true if successful.

IsInQueue()

Check if the e-mail is in the send queue.

Boolean IsInQueue()

Returns
Boolean true if the e-mail is in the send queue.

IsSending()

Check if the e-mail is currently sent.

Boolean IsSending()

Returns
Boolean true if the e-mail is currently sent.

WasSent()

Check if the e-mail was sent in the most recent tick.

Boolean WasSent()

Returns
Boolean true if the e-mail was sent in the most recent tick.

WasSaved()

Check if the e-mail was saved in the most recent tick.

Boolean WasSaved()

Returns
Boolean true if the e-mail was saved in the most recent tick.

WasCancelled()

Check if the e-mail was cancelled in the most recent tick.

Boolean WasCancelled()

Returns
Boolean true if the e-mail was cancelled in the most recent tick.

WasRejected()

Check if the e-mail was rejected in the most recent tick.

Boolean WasRejected()

Returns
Boolean true if the e-mail was rejected in the most recent tick.