4D Doc Center : SMTP

4D v13.2

SMTP_Keywords


SMTP_Keywords ( smtp_ID ; keywords ; deleteOption ) -> Function result

Parameter	Type	Description
smtp_ID	Longint	Message reference
keywords	Text	Keywords List
deleteOption	Integer	0 = Replace (if keywords not empty), 1 = Replace, 2 = Delete
Function result	Integer	Error Code

Description

The SMTP_Keywords command is used to insert keywords into the "Keywords" header of the message designated by the smtp_ID field.

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

keywords is a text value which contains a keyword or keyword list. For specific formatting requirements, please consult RFC#822.

Warning: The text should not contain a line feed (ascii=10). Doing so would signify the end of the header section and the beginning of the body. Subsequent header items could be pushed into the body and not recognized properly by the server or client software. For more information regarding the headers, please refer to RFC#822.

deleteOption is an integer value which specifies whether to replace or delete the "Keywords" header:

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