Custom Email Notification Information per Signer Functionality in v3.6
ProntoOpenNet Thursday, May 28 2009We have new functionality for customizing email notifications on a “per Signer” basis. This functionality will be available in Pronto Server version 3.6 with the AlphaTrust.Pronto.OpenNet.dll version 3.6 (file version 3.6.0.3).
Here is a code example:
...
Dim en As New Pronto.Signer.EmailNotification() en.FileName = "Mail_CustomSignerNotification1.htm" en.Subject = "This is Your First Notification!" en.IntervalBetweenEmailsInMinutes = 1440 signer.EmailNotifications.Add(en) ’or you can just add the notification directly like this: signer.EmailNotifications.Add("Mail_CustomSignerNotification2.htm", "This is your Second Notification",2880)
...
Below is an excerpt from the Pronto Server Developer’s Guide. The most important thing to take note of is the ability to use Placeholders for information to insert into your email template.
AddSignerEmailInfo Function:
AddSignerEmailInfo(sTemplateFile As Variant, sEmailSubject As Variant, sMinutesBeforeNextEmailNotice As Variant) As Variant
All parameters should be passed as byVal variant string data types.
Purpose:
This function adds one data set defining custom information for email notifications related to the associated signature. This function must be call after an "AddSigner..." function and will relate to the most recently called "AddSigner..." record. This function should be called one time for each custom email notification required for the signature. For example, if up to three email notifications are required, then call this function three times passing in the appropriate information for each separate email notification that will occur.
This is an optional function and not required in a transaction. If omitted, the global default signature notice processing will occur using the standard email tempates for the account along with globally defined email subjects and timing of emails.
Parameters:
TemplateFile - variant string with the file name of the email template used for sending this user notice. The file must be located in the email template folder or a sub-folder (if Multiple Template Sets are defined).
EmailSubject - variant string with the text of the email subject line for this notification. The text may contain defined replacement text strings (such as DOCUMENT_TITLE).
MinutesBeforeNextEmailNotice - the number of minutes to wait to send the next defined email notice if the user has not completed the action requested in the current email notice.Errors:
This function will raise an error upon failure. Consult the error message raised for details.
Return Value:
Variant Boolean "True" or "False".
Example:
bReturn = AddSignerEmailInfo("mail_signernotice-1.txt","Signature Request 1","120")
bReturn = AddSignerEmailInfo("mail_signernotice-2.txt","Signature Request 2","720")
bReturn = AddSignerEmailInfo("mail_signernotice-3.txt","Signature Request 3","720")
This example asks for up to three email notices. Each notice uses a different template and a different email subject line. The wait time between each email is unique.Placeholders:
You may include the following special text placeholders in the email subject line and/or email body, and PRONTO™ Server will substitute the actual value, if available. If the actual value is not available, the substituted value will be an empty string (blank value). Capitalization of the text placeholders is required:SIGNER_NAME - The signer name in the Signature record will be substituted.
DOCUMENT_TITLE - The document title in the Document record will be substituted.
DOCUMENT_ID - The 10 digit document id in the Document record will be substituted.
DOCUMENT_SIGNERS - A list of the signers of the document will be substituted.
TRANSACTION_ID - The 10 digit transaction id in the TX record will be substituted.
SIGNATURE_ID - The 10 digit signature id in the Signature record will be substituted.