SendMail

Purpose

The function SendMail sends an email to the system users that includes a file attachment or a file path.

The second syntax listed, useful when running with the optiva secured scripting enabled, uses the EmailFileAttachment object to transport raw data of the file attachment and the file name's between the secured scripting layer and the Optiva application.

A third syntax, with very different arguments, allows designation of a Communication Template (formerly e-mail template) to define the message subject and body. This format also allows file attachments, and the inclusion of tokens to be passed to the Communication Template to show live data at run-time.

Syntax

long SendMail(string EMailTemplate, int addresseeType, string[] addressee, bool useTenantCustomMailConfiguration, params string[] args)

Arguments

Arguments

Syntax

long SendMail(string EMailTemplate, int addresseeType, string[] addressee, List<EmailFileAttachment> attachments, bool useTenantCustomMailConfiguration, string[] args)

Arguments

Description

SendMail returns a 1 if it completes the sending of the email. The message is sent through an external email package that is SMTP compliant. You must set up the system profiles to use an external email package in workflow notifications. External notification requires the SMTP process on the application server.

• Unlike the Notify function, SendMail does not require a template, but use of a Communication Template provides multi-language options and does not require the entire message body to be created by scripting.
• The Graphical formatting (color, bold, logos etc.) is allowed only if the Communication Template option is enabled.
• The live object data in the message text and subject line can be included.
• Use text functions such as string builder to create message text including live data and line returns when using the template-free syntax.
• The subject line is specified in the script function when the template-free syntax is used.
• Multiple system users can be specified in a single SendMail call.
  • When using non-template syntax: You can use functions in workflow such as TableLookup to build a group list before calling SendMail. The string array can only result in user codes.
  • When using the template-based syntax, addresses can be an array of user, group or role codes.
• When you run an action set with the SendMail functions, emails are only sent to users that do not have Deactivate Email selected.

EmailFileAttachment object

Public Class EmailFileAttachment
	Public BinaryData As Byte()
	Public FileName As String

	Public Sub New(ByVal binaryData As Byte(), ByVal fileName As String)
		Me.BinaryData = binaryData
		Me.FileName = fileName
	End Sub
End Class

Simple Example

To simulate fetching file attachments from IDM, this example will use the WebReports Virtual Directory as the place where the files to be attached to the email are stored on disk. The Optiva workflow will use an HTTP call to retrieve the contents of the file.

Typically WebReports is located at C:\inetpub\wwwroot\FsWebReports and the PDF output files are in the tmp subfolder.

Option Strict On
Imports Formation.Shared.Defs

Imports System
Imports System.Collections.Generic
Imports System.Net.Http
Imports System.Net.Mail

Class ActionScript
    Inherits FcProcFuncSetEventWF

    Function wf_start() As Long
        Dim attachments As New List(Of EmailFileAttachment)
        Using httpClient As New HttpClient()
            attachments.Add(GetEMailAttachmentFromWebReports(httpClient, "Example.pdf"))
        End Using
        
        Dim emailTo() As String = {"FSI"}
        Dim subject As String = "Optiva SendMail w/ Attachments " & DateTime.Now.ToShortTimeString()
        Dim body As String = "Test from Optiva with attachments and secured scripting."
        Dim rc As Long = SendMail(emailTo, subject, body, attachments, false)
        MessageList("Message sent.")
        Return 111
    End Function

    Function GetEMailAttachmentFromWebReports(httpClient As HttpClient, fileName As String) As EmailFileAttachment
        Dim url As String = FileLocation("WEBREPORTS", "URL") & "/tmp/" & fileName
        Dim fileData As Byte() = httpClient.GetByteArrayAsync(url).Result
        Return New EmailFileAttachment(fileData, fileName)
    End Function
End Class

Complex example

In this example, multiple file attachments are being made to the email. This example calls the HTTP resource in a parallel fashion making for a faster running script, particularly if there are many files and large files being attached.

Option Strict On

Imports Formation.Shared.Defs

Imports System
Imports System.Collections.Concurrent
Imports System.Collections.Generic
Imports System.Linq
Imports System.Net.Http
Imports System.Threading.Tasks

Class ActionScript
 Inherits FcProcFuncSetEventWF

    Function wf_start() As Long
        Dim fileNames As New List(Of String)() From {"Example1.pdf", "Example2.pdf", "Image1.png", "Image2.jpg", "SummaryDocument1.docx"}
        Dim fileAttachments As New ConcurrentBag(Of EmailFileAttachment)
        Using httpClient As New HttpClient()
                Parallel.ForEach(fileNames, Sub(fileName)
                                                            fileAttachments.Add(GetEMailAttachmentFromWebReports(httpClient, fileName))
                                                         End Sub)
        End Using

        Dim emailTo() As String = {"FSI"}
        Dim subject As String = "Optiva SendMail w/ Multiple Attachments in parallel " & DateTime.Now.ToShortTimeString()
        Dim body As String = "Test from Optiva with multiple attachments and secured scripting."
        Dim rc As Long = SendMail(emailTo, subject, body, fileAttachments.ToList(), false)
        Return 111
    End Function

    Function GetEMailAttachmentFromWebReports(httpClient As HttpClient, fileName As String) As EmailFileAttachment
        Dim url As String = FileLocation("WEBREPORTS", "URL") & "/tmp/" & fileName
        Dim fileData As Byte() = httpClient.GetByteArrayAsync(url).Result
        Return New EmailFileAttachment(fileData, fileName)
    End Function
End Class

Arguments

Purpose

To send an email notification from the system to one or more recipients, optionally with attachments, using either the default or tenant-specific email configuration.

Syntax

SendMail(ref string[] addressees, string subject, string message, ref string[] attachments, bool isHtml = true, bool useTenantCustomMailConfiguration = false)

Arguments

Example

string[] addressees = {"FSI", "ADMIN", "FSI_FR"};
	List<string> fileNames = new List<string> {"Example1.pdf", "Example2.pdf"};
	string message = GetMessageText("FORMULACALCFAILED", ref msg);
	SendMail(ref addressees, "Workflow updates", message, ref fileNames);

Arguments

Example

string[] addressees = {"FSI", "ADMIN", "FSI_FR"};
	string[] attachments = {"Example1.pdf", "Example2.pdf"};
	string message = GetMessageText("FORMULACALCFAILED", ref msg);
	SendMail(ref addressees, "Workflow updates", message, ref attachments);