AgileApps Support Wiki Pre Release

Difference between revisions of "SendEmailUsingTemplate"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 20: Line 20:
:;cc:A list of comma separated email addresses
:;cc:A list of comma separated email addresses
:;subject:A descriptive text string
:;subject:A descriptive text string
:;bodyTemplateID:ID of the template created in 'Template' object. Its template is evaluated at run time, the template variables substituted, and then sent as the body of the message.
:;bodyTemplateID:ID of the [[Email Template]]. It is evaluated at run time, template variables substituted, and then sent as the body of the message.
:;attachmentTemplateIdList:A list of comma-separated [[Document Template]] identifiers. The template variables are evaluated at run time, their values are substituted, and the resulting documents are then sent as attachments.
:;attachmentTemplateIdList:A list of comma-separated [[Document Template]] identifiers. The template variables are evaluated at run time, their values are substituted, and the resulting documents are then sent as attachments.
:;attachmentIdList:A list of comma-separated document identifiers to send as attachments
:;attachmentIdList:A list of comma-separated document identifiers to send as attachments

Revision as of 21:20, 19 March 2014

Sends an Email message using the Template identified by the bodyTemplateId parameter. Generates one or more documents and includes them as attachments.

Prerequisites

Go to GearIcon.png > Objects > {Object} > Email Templates
Define or find a template.
Get the ID of that template, for use in the bodyTemplateID parameter.

Syntax

<syntaxhighlight lang="java" enclose="div">

Result result = Functions.sendEmailUsingTemplate(String objectID, String recordID,

   String to, String cc, String subject, String bodyTemplateID, 
   String attachmentTemplateIdList, String attachmentID);

</syntaxhighlight>

Parameters

objectID
The identifier of the related object
recordID
The identifier of the related record
to
A list of comma-separated email addresses
cc
A list of comma separated email addresses
subject
A descriptive text string
bodyTemplateID
ID of the Email Template. It is evaluated at run time, template variables substituted, and then sent as the body of the message.
attachmentTemplateIdList
A list of comma-separated Document Template identifiers. The template variables are evaluated at run time, their values are substituted, and the resulting documents are then sent as attachments.
attachmentIdList
A list of comma-separated document identifiers to send as attachments

Return

Result object
Example
This example calls sendEmailUsingTemplate for a contact.

<syntaxhighlight lang="java" enclose="div"> String contactID = ""; String attachmentTemplateIdList = ""; String bodyTemplateID = ""; String attachmentID = "";

// Some code to populate contactID. // Populate attachmentTemplateIdList manually from the template Ids displayed in UI from Template object // Populate bodyTemplateID manually from the template Id displayed in the UI from Template object

Functions.sendEmailUsingTemplate("CONTACT", contactID, "joe.smith@acme.com,mark.smith@acme.com", "cc.smith@xyz.com", "Some subject", bodyTemplateID, attachmentTemplateIdList, attachmentID); </syntaxhighlight>