NSOA.meta.sendMail(message)

Use this function to send email messages from a form, library, or scheduled script. Form scripts are allowed to send a maximum of 3 emails and scheduled scripts a maximum of 100 email by Scripting Governance.

Parameters

msg {object} [required] — An email message object with the following properties:
- to — [optional] array of OpenAir User IDs / email addresses.
- cc — [optional] array of OpenAir User IDs / email addresses.
- bcc — [optional] array of OpenAir User IDs / email addresses.
  
  Important:
  At least one of to, cc, or bcc is required.
- format — [optional] if “HTML” the body will be treated as HTML. If this is set to any other value or omitted then the body will be treated as plain text.
- subject — [optional] string holding the email subject. The subject is trimmed to the first line if carriage return characters are used.
  
  Important:
  At least one of subject or body is required.
- body — [optional] string holding the email body.
  
  Important:
  There is a maximum body length set for your emails sent by form and scheduled scripts. Email messages with bodies above that maximum body length are not sent.
  
  The maximum body length is set to 30,000 characters by default and can be changed to suit your requirements. To review or to increase the maximum body length set for your account, contact OpenAir Customer Support.
  
  Tip:
  If the format is set to ”HTML” any tags you can place within the <body></body> section of an HTML file are valid.
- author — [optional] use to set one OpenAir user ID as the author of the emails.
See Code Samples for more examples.

Returns

True if the email was placed in the queue for sending and false otherwise.

Units Limit

10 units

For more information, see Scripting Governance.

Since

October 17, 2015

Example

This sends a plain text email.

                  // Send a plain text message
    var msg = {
        to: ["mcollins@example.com"],
        cc: ["jadmin@example.com"],
        subject: "Script alert",
        body: "Form saved"
    };

    NSOA.meta.sendMail(msg);

This sends an HTML email.

                  // Send an HTML message
    var msg = {
        to: ["mcollins@example.com"],
        subject: "Project Assignment",
        format: "HTML",
        body: "<b>Client:</b> Altima Technologies</br>" +
              "<b>Project:</b> CRM Implementation</br>" +
              "<b>Project Manager:</b> Collins, Marc"
    };

    NSOA.meta.sendMail(msg);

See Code Samples for more examples.