Show TOC

Function documentationSend Mail Locate this document in the navigation structure

 

You use this action to send an e-mail through a Simple Mail Transfer Protocol (SMTP) server.

Features

For the mail server, there are a number of predefined global variables and account values that are set once and can be linked into the mail action.

The properties in the Link Editor for this action are listed in the following table:

Property

Data Type

Access

Use

ConnPropAlias

String

In and out

Defines the alias for the e-mail server connection information.

CredPropAlias

String

In and out

Defines the alias for the credentials used to authenticate the request to the e-mail server.

Mail Server

String

In and out

Defines the name of the outgoing SMTP mail server.

Mail Account

String

In and out

Controls the mail account name for SMTP servers that require authentication. The entered string should correspond to a valid mail account on the mail server. Mail Account is only useful if the SMTP server requires authentication. Some SMTP servers require that you to check mail before you can send it. If this is the case, you must call the Read Mail action before you call the SendMail action in your transaction.

MailAccountPassword

String

In and out

Provides the password for the MailAccount property for SMTP servers that require authentication.

FromAddress

String

In and out

Identifies the sender of the e-mail. All replies to the e-mail come to this address, so the SMTP server requires that the sender has a valid mail account.

ToAddress

String

In and out

Identifies the e-mail recipient.

Subject

String

In and out

Defines the subject of the e-mail.

Attachment

String

In and out

Defines the fully qualified path to the file that is attached in the e-mail. Make sure the Internet Guest Account user has read privileges to the file, which should look like C:\InetPub\wwwroot\Attachments\MyFile.zip.

AttachmentContent

String

In and out

Identifies the content of the attachment file. This property overrides the Attachment property and is an encoded string. Use this property with EncodedImage property of the Chart, SPC/SQC Chart, and Image Loader actions.

Ensure that you set the AttachmentMimeType to the correct image Multipurpose Internet Mail Extensions (MIME) type.

AttachmentMimeType

String

In and out

Specifies the MIME type of the attachment, such as the following:

  • text/csv

  • text/csv (with byte order mark)

    When an attachment is added to the AttachmentContent field, it includes the byte order mark (BOM). Other linked content is not affected.

  • text/plain

  • text/html

  • text/xml

  • application/zip

  • application/pdf

  • image/bmp

  • image/gif

  • image/jpeg

  • image/png

  • image/svg+xml

    Additional types can be entered. For example, to attach a Microsoft Word document, use application/msword.

ConnectionTimeout

Integer

In and out

Time to wait for the mail server response before canceling the request. If the request times out, the success flag is set to false.

SendTimeout

Integer

In and out

Time to wait for the message to be sent through the established mail server connection.

Port

Integer

In and out

Mail server connection TCP/IP port

Message

String

In and out

Identifies the e-mail message.

MessageMimeType

Choice

In and out

Specifies the MIME type of the message. Use text/html to include hyperlinks or other HTML content in your e-mail. If not all of your users support HTML e-mail, use text/plain.

Success

Boolean

Out

Indicates whether the action succeeded or failed. If it failed, errors are displayed in the server trace log.

Charset

String

In and out

Encoding character set for the attachment