Send an e-mail message.
| Overload Name | Description |
|---|---|
| General | Send an e-mail message using Windows Simple MAPI, which supports the option to display the default email client dialog to allow the user to specify recipients and other send options. |
| SMTP | Send an e-mail message via SMTP. This is the preferred overload. |
| ServletSMTP | Send an e-mail message via the Dodeca servlet using SMTP. |
Send an e-mail message using Windows Simple MAPI, which supports the option to display the default email client dialog to allow the user to specify recipients and other send options.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| To | E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| cc | E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| bcc | E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| Subject | The subject of the message. |
| Message | The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE. |
| Prompt |
Whether to prompt the user before sending the message. The default is TRUE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachView |
Whether to attach the view to the e-mail message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachViewAsPDF |
Whether to attach the view as a PDF to the e-mail message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachViewAsPDF_Compliance (8.1) |
Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.
Specify one of the following values or an arbitrary value:
<blank>NonePDF/A-1b
|
| AttachViewAsPDF_Optimization (8.1) |
Indicates whether to produce a standard or size-optimized PDF. The default is Standard.
Specify one of the following values or an arbitrary value:
<blank>StandardMinimumSize
|
| ZipAttachments (7.3) |
Whether to add all attachments to a .zip file when composing the message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ZipFileName (8.1) | The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view's name will be used. |
| ZipCompression (7.3) |
The compression level to use when sending attachments as a .zip file. The default is Normal.
Specify one of the following values or an arbitrary value:
<blank>HighestNormalLowestNone
|
Send an e-mail message via SMTP. This is the preferred overload.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| From | The address from which the email will be sent. |
| FromDisplayName | The displayed address from which the email will be sent. |
| To | E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| cc | E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| bcc | E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| Subject | The subject of the message. |
| IsHtmlMessage (8.0) |
Whether the message body contains HTML. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Message | The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE. |
| Host | The SMTP hostname which will send the email. |
| Port | The SMTP port number on the SMTP host computer. |
| Security |
The connection security type to use when connecting to the server and sending e-mail. The default is None.
Specify one of the following values or an arbitrary value:
<blank>NoneSSL/TLSSTARTTLS
|
| Username | The username of the SMTP account used to send the email. |
| Password | The password of the SMTP account used to send the email. |
| AttachView |
Whether to attach the view to the e-mail message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachViewAsPDF |
Whether to attach the view as a PDF to the e-mail message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachViewAsPDF_Compliance (8.1) |
Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.
Specify one of the following values or an arbitrary value:
<blank>NonePDF/A-1b
|
| AttachViewAsPDF_Optimization (8.1) |
Indicates whether to produce a standard or size-optimized PDF. The default is Standard.
Specify one of the following values or an arbitrary value:
<blank>StandardMinimumSize
|
| AttachmentFilenames | Specify the name(s) of the file(s) to attach. To attach multiple files, the filenames must be delimited with the vertical bar (|) character or each filename must be specified on a separate line. |
| AttachmentFolder | Specify the folder that contains the attachment file(s). |
| ZipAttachments (7.3) |
Whether to add all attachments to a .zip file when composing the message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ZipFileName (8.1) | The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view's name will be used. |
| ZipCompression (7.3) |
The compression level to use when sending attachments as a .zip file. The default is Normal.
Specify one of the following values or an arbitrary value:
<blank>HighestNormalLowestNone
|
| SnapshotRange (8.0) | The range or ranges (separated by comma) to snapshot. |
| SnapshotAttachOrEmbed (8.0) |
Whether to attach the snapshot images to the email message or embed them. If embed is used then IsHtmlMessage will be forced to TRUE.
Specify one of the following values or an arbitrary value:
<blank>AttachEmbed
|
| SnapshotFilename (8.0) | The name to use for the snapshot file. "Snapshot" will be used if left blank. |
| SnapshotImageFormat (8.0) |
The format of the image file (If left blank Bmp will be used.): Bmp Bitmap Gif Graphics Interchange Format Jpeg Joint Photographic Experts Group Png W3C Portable Network Graphics Tiff Tagged Image File Format
Specify one of the following values or an arbitrary value:
BmpGifJpegPngTiff
|
| SnapshotInsertToken (8.0) | If AttachOrEmbed=Embed then the snapshot(s) will be inserted into the message in place of the specified token. If InsertToken is blank then snapshot(s) will be appended to the end of the message. |
| SnapshotScalePercent (8.0) | Scale the snapshot image with a value between 10 and 400 percent. If left blank 100 will be used. |
Send an e-mail message via the Dodeca servlet using SMTP.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| From | The address from which the email will be sent. |
| FromDisplayName | The displayed address from which the email will be sent. |
| To | E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| cc | E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| bcc | E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon. |
| BounceAddress | E-mail address to which bounce messages are delivered. |
| Subject | The subject of the message. |
| IsHtmlMessage |
Whether the message body contains HTML. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ImageBaseURL | When IsHtmlMessage is TRUE, the domain from which images included in the Message will be served. |
| Message | The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE. |
| AlternateText | Alternate text to be used for clients who do not support HTML messages, when IsHtmlMessage is TRUE. |
| Host | The SMTP hostname which will send the email. |
| Port | The SMTP port number on the SMTP host computer. |
| Security |
The connection security type to use when connecting to the server and sending e-mail. The default is None.
Specify one of the following values or an arbitrary value:
<blank>NoneSSL/TLSSTARTTLS
|
| Username | The username of the SMTP account used to send the email. |
| Password | The password of the SMTP account used to send the email. |
| EnableLogging |
Whether to log the message details in the server log. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachView |
Whether to attach the view to the e-mail message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachViewAsPDF |
Whether to attach the view as a PDF to the e-mail message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AttachViewAsPDF_Compliance (8.1) |
Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.
Specify one of the following values or an arbitrary value:
<blank>NonePDF/A-1b
|
| AttachViewAsPDF_Optimization (8.1) |
Indicates whether to produce a standard or size-optimized PDF. The default is Standard.
Specify one of the following values or an arbitrary value:
<blank>StandardMinimumSize
|
| AttachmentFilenames | Specify the name(s) of the file(s) to attach. To attach multiple files, the filenames must be delimited with the vertical bar (|) character or each filename must be specified on a separate line. |
| AttachmentFolder | Specify the folder that contains the attachment file(s). |
| ZipAttachments (7.3) |
Whether to add all attachments to a .zip file when composing the message. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ZipFileName (8.1) | The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view's name will be used. |
| ZipCompression (7.3) |
The compression level to use when sending attachments as a .zip file. The default is Normal.
Specify one of the following values or an arbitrary value:
<blank>HighestNormalLowestNone
|