Top
Top
LibraryEASYProcess Reference Manual 5ProcessesServicesEmailWorkshopSendWebPartEmail

SendWebPartEmail Overview

The service “SendWebPartEmail” is used to send webpart as an email to a single or multiple recipients with customizable title and body using our own SMTP configurations. This service also allows us to add other important email related features such as cc, bcc, attachments, set priority, and etc.


SendWebPartEmail Use Examples
Workshop:EmailWorkshop
Service:SendWebPartEmail
Inputs
WebPartId"WebPartId" is the WebPartId of the WebPart which we would like to send as an email in HTML or Text format.

FiltersFilters are passed as QueryStrings to the WebPart which we would like to send as an email. We can add Filters by right clicking on this node and selecting Add New Filter option. Filters can also be copy pasted or can be Pasted using the EASYEdit feature.

Filter"Filter" is a container node which accepts no input but represents a single Filter that can contain Name, and Value of the Filter. Each Filter node is indexed.

ParameterParameter is the name of the filter we would like to pass.

ValueValue is the value of the filter we would like to pass.

SessionsSession variables can be passed to the WebPart by right clicking on this node by right clicking on this node and selecting Add New Sessions option. Sessions can also be copy pasted or can be Pasted using the EASYEdit feature.

Session"Session" is a container node which accepts no input but represents a single Session that can contain Name, and Value of the Session variable. Each Session node is indexed.

ParameterParameter is the name of the Session variable we would like to pass.

ValueValue is the value of the session variable we would like to pass.

SiteUrlSiteUrl is used to render HTML for the webpart we would like to send as an email .This usually uses default website instance from AppSettings configuration. Example: http://localhost//EP_RenderWebPartHtml.aspx

From"From" is the from email address. We can enter the from email address here or load it from configuration variables. Usually this is loaded from configuration variables.

EmailSubject"EmailSubject" is the subject of the email.

To"To" is the To email address. We can enter the To email address here or load it from configuration variables. Usually this is loaded from configuration variables.

Bcc"Bcc" is email address(es) we want to send blind carbon copy of the email to. Bcc works similar to cc except the copy of the email is sent privately, and recipients cannot know with whom the email is shared.

Cc"Cc" is email address(es) we want to send carbon copy of the email to. "Cc'd" is that which is copied to one or more recipients. Note: The main recipient (whose address is in the "To:" field) and the Cc'd recipients can see all the addresses the email was sent to.

EmailFormat"EmailFormat" decides which format the email has to be sent. Valid values are "HTML" and "text".

AttachmentsThis is the filepath(s) of the attachments to the email. Multiple filepaths must be semicolon separated.

SMTPServer"SMTPServer" is the name of the SMTP server. We can enter the SMTP server name here or load it from configuration variables. Usually this is loaded from configuration variables.

UserName"UserName" is the user name for SMTP server. We can enter the SMTP user name here or load it from configuration variables. Usually this is loaded from configuration variables.

Password"Password" is the password for SMTP server.We can enter the SMTP password here or load it from configuration variables. Usually this is loaded from configuration variables.

UseSSL"UseSSL" decides whether to use SSL or not. SSL stands for Secure Socket Layer. SSL creates an encryption link between web server and a browser. In this case SSL encrypts email traffic.

HttpRequestTimeout

Priority"Priority" is the priority of the email. Valid values are "High", "Low", and "Normal". Priority helps find emails faster.

WrapOutputHTML

TestEmailId"TestEmailId" acts as "To" email address when "TestMode" is true. This input is usually loaded from configuration variables.

TestMode"TestMode" takes values True or False. When this is set to True, "SendEmail" services ignores the "To" email address input and sends email to the email address(es) passed into "TestEmailId" input. When this is done, the Subject of the email will be the concatenated with the To, CC, BCC values that would have been used had TestMode not been on. "TestMode" is usually loaded from configuration variables.

SendWebPartEmail Basic Use Example

Under the “Email Services”, expand “SendWebPartEmail”. You will see “Default” option with saved email configurations. These will be populated based on the existing instances under the “SendEmail” configuration in the configuration variables.

Drag over the Default option to the Process Canvas. This will create a “SendWebPartEmail” Service on the Process Canvas. Grab one of the connector nodes from the “Start” service and connect it to your newly added “SendWebPartEmail”. Now double click the service to configure it.

Since we dragged the Default from a saved SendEmail Configuration, some inputs are already filled out with variables pointing to the option we selected.

Here are some important points to note while filling out other inputs:

Adding Filters

Any Filters we send using the “Filters” input are passed as query strings to the WebPart. We can right click on the “Filters” input to add filters. Here is an example of filters:

Adding Attachments

Using the “Attachments” input we can also include attachment(s) in the email we are sending. The “Attachments” input node takes File path as an input. If we would like to include multiple attachments, file paths have to be semicolon separated.

 

TestMode and TestEmailId

TestMode and TestEmailId instances are saved under “SendEmail” saved configuration. If the TestMode is set to True, “SendEmail” ignores “To” email address(es) and uses email address(es) passed to “TestEmailId” input.


Powered by EASYProcess (© 2019 K-Rise Systems, Inc).