SMTP_References

Home

4D v20

SMTP_References


SMTP_References ( smtp_ID ; references {; deleteOption} ) -> Function result

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

Description

The SMTP_References command identifies additional correspondences that the message references.

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

references is a text value containing the reference text. 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 "References" header:

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