EmailFormManager Class Methods
This section describes the public methods of interest to application developers for emailFormManager, in alphabetical order.
Syntax
addRecipient(&emailAddress, &userID)
Description
Users added via this method will be allowed to act on the email form.
Parameters
Parameter |
Description |
---|---|
&emailAddress |
Email address, as string. Required. |
Parameter |
Description |
---|---|
&userID |
User ID, as string. Optional. |
Returns
None.
Syntax
addCC(&emailAddress)
Description
Email addresses added via this method will be copied on every email sent out.
Parameters
Parameter |
Description |
---|---|
&emailAddress |
Email address, as string. Required. |
Returns
None.
Syntax
addBCC(&emailAddress)
Description
Email addresses added via this method will be blind copied on every email sent out.
Parameters
Parameter |
Description |
---|---|
&emailAddress |
Email address, as string. Required. |
Returns
None.
Syntax
addAttachment(&filePath, &filePathType, &fileName, &fileTitle)
Description
Adds an attachment to be sent along with the email.
Parameters
Parameter |
Description |
---|---|
&filePath |
A string consisting of the complete path to the file and the filename itself. |
&filePathType |
A number representing type of file path used in first parameter. Use tools system variables such as %FilePath_Relative. |
&fileName |
A string representing the name of the file being attached. |
&fileTitle |
A string consisting of the title of the file. The titles appear near the attachment icons in place of the fully qualified filename. |
Returns
None.
Syntax
sendEmails(&sentToCheckOnReturn)
Description
Does the actual send of the email once all other information is ready.
Parameters
Parameter |
Description |
---|---|
&sentToCheckOnReturn |
If set to true, the EMC will verify that the user to whom the email was sent is the same as the user who sent the response. If this is not true, an error will be inserted into the error stack allowing the implementing application to handle it as they see fit. |