Send Email Plug-in Properties

 

The Send Email plug-in enables you to send an email at a specified point within a workflow, such as when an item is approved, requires approval, etc. You can choose to send the email in a rich text format also.

On this page

• Send Email plug-in usage example
• How to configure the Send Email plug-in
• Send Email plug-in parameters

Send Email Plug-in Usage Example

Back to top

Use the Send Email plug-in to keep participants in a workflow notified of tasks and events, such as when a task is overdue or something requires approval . You can choose to send the email in a rich text format also.

Note: For existing solutions (solutions created in versions earlier than 12.1) when the plain text format is converted into rich text, a new line does not get created on pressing the Enter key. We recommend that you should review the converted text to spot and address any text conversion issues.

How to Configure the Send Email Plug-in

Back to top

1. Add a Plug-in Action Node to your workflow.
2. Configure the To, From, Subject, Body, and Server parameters for the plug-in, in addition to any optional parameters. See the Send Email plug-in parameters table for a description of available options.

 

Send Email Plug-in Parameters

Back to top

Property	Description
body	The body of the email message
from	Email Address of the person in which you would like to be shown in the From Field.
server	The name of the SMTP Server (retrieved from the Winshuttle Workflow configuration database) that will be used to send the Email Message. Note: In the event of an error, (for example, the given SMTP Server was either blank or incorrect), the plug-in will fetch the SMTP server address from the C:\inetpub\wwwroot\wss\VirtualDirectories\80\sharevis.config file, and then use this SMTP server address to send the email. If the SMTP server is not present in the configuration database, then the plug-in will use the SMTP server address from the SharePoint administration email settings.
subject	The Subject of the Email Message
to	Email Address(es) to which the Email Message will be sent to.
arguments	SharePoint column(s) to be used in the query, separated by a comma. Example: [ID],[Name] Note: This will be the current SharePoint list column, which is created when the solution is deployed.
connectionstring	The connection string to the database used to retrieve recipients. Example: Provider=SQLOLEDB;DataSource=wid101\SQLEXPRESS;Initial Catalog=TestDB;User ID=Sa;Password=abcd Note: Only SQL is supported.
format	Possible values/formats are MHT and JPG
query	The query to run to determine recipients. This can be used to select users from a database; for example, you could configure the query to select a user from the Database 'TestUsers' A ConnectionString must be configured for this option to work.
senddelay	The number of days to wait before sending the Email Message.
includeitem	(True/False) Whether or not the form should be included as an attachment. (True=include attachment.)
formview	Which form view the recipient should receive in the email. (Only works if includeitem is set to 'true'.
includedatafile	How the recipients should receive the data file in the email: via link, attached file, or both a link and an attached file.