![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The e-mail interface.
The IEMail object can be created by the IWebControl object.
Set the e-mail subject string.
Boolean SetSubject(String subject)
subject | The e-mail subject string. |
Set the e-mail message string.
Boolean SetMessage(String message)
message | The e-mail message string. |
Add a receipient e-mail address string to the TO field.
Boolean AddToRecipient(String address)
address | The e-mail address string. |
Add a receipient e-mail address string to the carbon copy field.
Boolean AddCcRecipient(String address)
address | The e-mail address string. |
Add a receipient e-mail address string to the blind carbon copy field.
Boolean AddBccRecipient(String address)
address | The e-mail address string. |
Add an attachment to the e-mail. Currently only supported on iOS devices.
Boolean AddAttachment(String fileName, String mimeType, Murl.Data data)
fileName | The name of the attachment. |
mimeType | The MIME type of the attachment (e.g. "image/png"). |
data | The data of the attachment. |
Get the e-mail subject string.
String GetSubject()
Get the e-mail message string.
String GetMessage()
Get the number of available receipients of the TO field.
Integer GetNumberOfToRecipients()
Get the receipients e-mail address string from the TO field. A valid index is [0 .. GetNumberOfToRecipients() - 1].
String GetToRecipient(Integer index)
index | The zero-based index of the receipients. |
Get the number of available receipients of the carbon copy field.
Integer GetNumberOfCcRecipients()
Get the receipients e-mail address string from the carbon copy field. A valid index is [0 .. GetNumberOfToRecipients() - 1].
String GetCcRecipient(Integer index)
index | The zero-based index of the receipients. |
Get the number of available receipients of the blind carbon copy field.
Integer GetNumberOfBccRecipients()
Get the receipients e-mail address string from the blind carbon copy field. A valid index is [0 .. GetNumberOfToRecipients() - 1].
String GetBccRecipient(Integer index)
index | The zero-based index of the receipients. |
Get the number of attachments.
Integer GetNumberOfAttachments()
Get the name of an attachment. A valid index is [0 .. GetNumberOfAttachments() - 1].
String GetAttachmentFileName(Integer index)
index | The zero-based index of the attachment. |
Get the MIME type of an attachment. A valid index is [0 .. GetNumberOfAttachments() - 1].
String GetAttachmentMimeType(Integer index)
index | The zero-based index of the attachment. |
Get the data of an attachment. A valid index is [0 .. GetNumberOfAttachments() - 1].
Murl.Data GetAttachmentData(Integer index)
index | The zero-based index of the attachment. |
Send the e-mail.
Boolean Send()
Check if the e-mail is in the send queue.
Boolean IsInQueue()
Check if the e-mail is currently sent.
Boolean IsSending()
Check if the e-mail was sent in the most recent tick.
Boolean WasSent()
Check if the e-mail was saved in the most recent tick.
Boolean WasSaved()
Check if the e-mail was cancelled in the most recent tick.
Boolean WasCancelled()
Check if the e-mail was rejected in the most recent tick.
Boolean WasRejected()