4D Doc Center : SMTP

Home

4D Internet Commands v14

SMTP_Encrypted


SMTP_Encrypted ( smtp_ID ; encrypted {; deleteOption} ) -> Function result

Parameter	Type	Description
smtp_ID	Longint	Message reference
encrypted	Text	Encryption method
deleteOption	Integer	0 = Replace (if encrypted not empty), 1 = Replace, 2 = Delete
Function result	Integer	Error code

Description

The SMTP_Encrypted command informs the user of the type of encryption used on the body of the message. 4D Internet Commands do not provide the ability to encrypt or decrypt mail messages. The encryption of a message body is left to the developer. If steps are taken to encrypt the message body (prior to its assignment via SMTP_Body), this command should be used to identify the encryption method employed.

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

encrypted is a text value which specifies the type of encryption method used to encrypt the body of the message. The recipients mail software, which determines the method needed to decrypt the message body uses the encrypted header. 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 "Encrypted" header:

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