SMTP_To

Home

4D v20

SMTP_To


SMTP_To ( smtp_ID ; msgTo {; deleteOption} ) -> Function result

Parameter	Type	Description
smtp_ID	Longint	Message reference
msgTo	Text	MailAddress or AddressList
deleteOption	Integer	0 = Add, 1 = Replace, 2 = Delete
Function result	Integer	Error Code

Description

The SMTP_To command adds the identity of the primary recipients of the message. All addresses listed in the "To" and "cc" headers in a mail message are visible to each recipient of the message.

smtp_ID is the long integer reference to the mail message created with the SMTP_New command.

msgTo is a text value containing an AddressList of one or more mail addresses.

deleteOption is an integer value which specifies whether to add or delete the "To" header:

A value of zero will add the new value to the "To" field.
A value of 1 will set the "To" field to the new value, overriding any prior settings (if you pass an empty string in msgTo, the header will be removed from the mail envelope).
A value of 2 will delete any address previously defined for the "To" field and remove the header from the mail envelope.
deleteOption is an optional parameter which will default to zero if not otherwise specified.

Example

See the example for the command SMTP_Body.