Send Mail

From Grooper Wiki
Jump to navigation Jump to search
Sendmail001.png

The Send Mail activity allows users to send emails straight from a Batch in Grooper.

Send Mail will send one email for each document in scope.  It has mail merge support for "To", "CC", "Subject", and "Body".

Send Mail also supports attachments:

  • Content File: Optionally attach the document content.
  • Metadata: Optionally attach the document metadata.
  • Text Content: Optionally attach a plain text version of the document.

Version Differences

Send Mail is new to version 2.72. Unlike in previous versions of Grooper, Send Mail is now its own dedicated activity, so using the Spawn Batch activity to send emails may no longer be required (depending on the type of implementation and project requirements).

Text Templates

When configuring the "To", "CC", "Subject", or "Body" property, you have the option of using new text templates to dynamically construct your message.

When composing your template, typing the { character will open the Intellisense menu and provide a list of merge variables that can be used.

{Batch Name} Returns the name of the batch.
{Batch Process Name} Returns the name of the Batch Process.
{Content Type Name} Returns the name of the content type assigned to the current document.
{Document Name} Returns the display name of the document.
{Field} Returns the value of a field.
{File Extension} Returns the file extension associated with the current document.
{File Name} Returns the filename associated with the current document.
{Flag Message} Returns the flag message attached to the current document.
{Media Description} Returns a description for the MIME type associated with the current document, if one is available.
{Media Type} Returns the MIME type associated with the current document.
{Now} Returns the current local date/time.  An optional "Format" parameter defines the text prepresentation to be used.
Writing a "Body" template.
Sendmail002.png
The resulting email
Sendmail003.png

Properties

General
Mail Server The host name or IP address of an IMAP mail server.
User Name The user name to be used for accessing the Mail Server.
Password The password to be used for accessing the Mail Server.
Enable SSL Controls whether the connection to the Mail Server will be established using SSL.
Port No The port number on which the SMTP server is running.
Timeout The timeout, in seconds, to use when sending mail.
Mail Message
To The list of recipients for the mail message.
CC The list of CC recipients for the mail message.
Subject The subject line for the mail message.
Body The body of the mail message.
Attachments
Content File The content format to be used when generating the message attachment. Can be one of the following values:
  • Native Format - Outputs the native file associated with a Grooper document.
  • PDF Format - Outputs a PDF file representing the content of a Grooper document.
  • TIF Format - Outputs a TIF file representing the content of a Grooper document.
Metadata The format to be used when generating Metadata, to be attached to the message. Can be one of the following values:
  • Custom - Exports a custom named file, which was previously generated and saved by another activity.
  • Text - Exports metadata as a text file.
  • XML - Exports standard Grooper XML representing the document's metadata.
Text Content If enabled, a plain text version of the document will be included.