Framework EDI Reference. Methods and Properties
ediSmtpCfg. AddTo

Adds a recipient of the message.

Syntax:

• <lRetVal> = object.AddTo(<sRecipientTo>, [<sDisplayName>], [<sRcptToParameter>])

Parameters:

• sRecipientTo – Email address of blind copy recipient.  This address identifies only one recipient.  If this string contains more than one email address then an error is generated.  This email address should conform to the syntax specified by the forward-path ABNF.
• sDisplayName – Optional.  Display name of recipient.
• sRcptToParameter – Optional.  SMTP server-specific parameter.

Returns:

Returns 1 if successful; otherwise returns 0 if operation failed.

Remarks

The email address specified in sRecipientTo and the parameter sRcptToParameter are used in the SMTP command RCPT TO for specifying the address of the recipient that is to receive the SMTP message.  The syntax of the command is as follows:

RCPT TO:<forward-path> [ <space> <rcpt-parameters> ] CRLF

Where:

• forward-path is the email address specified by sRecipientTo, and
• rcpt-parameters is the server-specific parameter specified by sRcptToParameter.
• CRLF is carriage-return-line-feed.

When Framework EDI automatically generates and sends the message during the DATA communication phase, the message will contain a TO header showing the sRecipientTo address.

To export the message sent to the server to a file, specify the full path name of the export file in the SendFileOutput property. 

For additional information, see RFC 2821: Simple Mail Transfer Protocol.

Samples

• M_AddTo.zip