SendEmail

Send an e-mail message.

The following overloads are available:

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.

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.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
This option is limited one of the following values: <blank> SheetName SheetNumber AllSheets Workbook
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy.
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
ZipAttachments 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> FALSE TRUE
ZipCompression 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> Highest Normal Lowest None

SMTP

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.
This option is limited one of the following values: <blank> SheetName SheetNumber AllSheets Workbook
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy.
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> FALSE TRUE
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> FALSE TRUE
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.
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.
This option is limited one of the following values: <blank> None SSL/TLS STARTTLS
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> FALSE TRUE
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> FALSE TRUE
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 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> FALSE TRUE
ZipCompression 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> Highest Normal Lowest None

ServletSMTP

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.
This option is limited one of the following values: <blank> SheetName SheetNumber AllSheets Workbook
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy.
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
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.
This option is limited one of the following values: <blank> None SSL/TLS STARTTLS
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
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 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> FALSE TRUE
ZipCompression 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> Highest Normal Lowest None