SendSMTP
Use the SendSMTP pipeline component to send an e-mail message to a specified recipient.
Intended use: Order Processing pipeline, Accept stage.
Configuration Values
You can specify where the SendSMTP pipeline component sends the message and the information that it sends by setting component properties. Use the following boxes on the Send SMTP tab of the Component Properties dialog box to provide this information.
Box |
Description |
---|---|
From (required) |
The e-mail address from which the message is sent. This is the actual e-mail address instead of a key that contains the e-mail address. |
SMTP Host (required) |
The name or Internet Protocol (IP) address of the Simple Mail Transfer Protocol (SMTP) mail server that will transmit the object. This is the actual name of the server instead of a key that contains the name. |
To (required) |
The key in the Order dictionary that contains the e-mail address to which to send the message. |
Cc |
The key in the Order dictionary that contains the e-mail addresses to which to send copies of the message. |
Subject |
The key in the Order dictionary that contains the text to display in the Subject box of the e-mail message. |
Character Set for Subject |
The character set to use to encode the subject of this e-mail message. This drop-down list displays the character sets currently installed on this computer. |
Message Body |
The key in the Order dictionary that contains the message to include in the body of the e-mail message. |
MIME header and body |
Indicates the business data object is already encapsulated in a Multipurpose Internet Mail Extensions (MIME) header. If you select this option, the component uses the character set and header already encapsulated with the message instead of generating its own MIME header and using the character set specified in the Character Set for Subject box. |
Text Body |
Indicates the business data object consists of straight ASCII text and no additional processing is needed. |
Binary body |
Specifies that the business data object is a binary blob. The SendSMTP pipeline component will base64-encode it before it sends. |
Values Read
None.
Values Written
None.
Remarks
The SendSMTP pipeline component sends a business data object as an e-mail message to an SMTP mail server. If you are using Microsoft Exchange and Outlook, you can run a Visual Basic script to start an OrderPipeline Object (but not an MtsPipeline Object or MtsTxPipeline Object) on the Exchange server to process the received messages.
For the SendSMTP pipeline component to correctly support character set conversion, the corresponding code page must be installed on the computer. For information about how to install a code page, see Microsoft Knowledge Base article Q164948.
Programmatic Use
To use the SendSMTP pipeline component, you must configure it by assigning values to keys in the Configuration dictionary. The keys correspond to the indicated boxes in the Component Properties dialog box.
Key |
Box |
Type |
---|---|---|
From |
From |
String |
SMTPHost |
SMTP Host |
String |
ToField |
To |
String |
CCField |
CC |
String |
SubjectField |
Subject |
String |
CharSet |
Character Set for Subject |
String |
BodyType |
Message Body contains option buttons |
Numeric:
|