brixxbox Wiki
Search
K

composeEmail

Shows the email compose Dialog, or sends an email without an interface popup.

Parameters

  1. 1.
    emailOptions - (optional) Json object with email parameters.
    • to - array of email addresses
    • cc - array of email addresses
    • bcc - array of email addresses
    • text - message text
    • subject - subject
    • from - single string with an email address
    • replyTo - single email, that will be used as to reply to
    • autoSend - if set to true, the mail will be send automatically. You will not see a dialog at all. (Default is false)
    • hideToEmail - if set to true. The recipients email address is hidden in the email dialog
    • attachmentIds - an array of attachment ids that will be sent as an attachment,
    • attachmentBlobs - an array of blobs objects that will be sent as an attachment, {name: myFileName, blob: myBlob}
    • recordId - RecordId if you would like to attach the email to an record. If empty, this is the current record Id (available from 18.11.2021)
    • appName - AppName if you would like to attach the email to an record. If empty, this is the current App Name (available from 18.11.2021)

Example Usages

Example 1

Shows the dialog without any predefined values
Shows the dialog text and to addresses
composeEmail({
text: `This is the messsage text and this is a link: <a href='http://www.brixxbox.net' target='_blank'>www.brixxbox.net</a>`,
subject: "This is the mail subject",
});

Example 2

Sends the email without a dialog
composeEmail({
text: "This is the messsage text",
subject: "This is the mail subject",
replyTo: "[email protected]",
autoSend: true //Set this to avoid the dialog
});

Example 3 - attachment blobs

composeEmail({
text: "This is the messsage text",
subject: "This is the mail subject",
autoSend: true,
attachmentBlobs: [
{
name: "Test1.pdf",
blob: app.createReport("report")
},
{
name: "Test2.pdf",
blob: app.getAttachmentById(2)
}
],
});

Example 4 - attachment ids

composeEmail({
text: "This is the messsage text",
subject: "This is the mail subject",
autoSend: true,
attachmentIds: [1, 2, 3]
});