MSG_SetPrefs

Home

4D Internet Commands v16

MSG_SetPrefs


MSG_SetPrefs ( stripLineFeed ; msgFolder ; attachFolder ) -> Function result

Parameter	Type	Description
stripLineFeed	Integer	0 = Do not strip LineFeeds, 1 = Strip LineFeeds, -1 = No Change
msgFolder	Text	Messages folder path (“” = no change)
attachFolder	Text	Attachments folder path (“” = no change)
Function result	Integer	Error code

Description

The MSG_SetPrefs command sets the preferences for all MSG commands.

stripLineFeed is an integer value specifying how LineFeed characters will be handled in downloaded messages. Most Internet messages combine Carriage Return and Line Feed characters to indicate the end of a line. Macintosh applications prefer a carriage return only as the end-of-line character. This option lets users strip the linefeed character from their message text. A value of zero will leave the message “as is”. A value of 1 will strip linefeed characters from messages. A value of -1 will leave this preference as it has been set previously. The default option defaults to 1 and will automatically strip any linefeeds found in messages.

msgFolder is a text value indicating the local pathname to a folder in which retrieved messages are stored by default.

Compatibility note (version 6.8.1): If the MSG_SetPrefs command is not used, the stripLineFeed and msgFolder parameters of the POP3_SetPrefs command will be taken into account if this command has been used previously. If the MSG_SetPrefs command is used, the POP3_SetPrefs parameters are ignored.

attachFolder is a text value containing the local pathname to a folder in which attachments are stored when the MSG_Extract command separates the attachments from the main body of a message.

Compatibility note (version 6.8.1): This parameter is also found in POP3_SetPrefs and MSG_SetPrefs; therefore, you can modify it using either of these two commands.
We strongly recommend that you use the MSG_SetPrefs command. The POP3_SetPrefs parameter is used for compatibility reasons and will no longer be used in the future. The attachFolder parameter of the POP3_SetPrefs command is optional; therefore, we recommend that you do not use this parameter. This recommendation also applies to POP3_GetPrefs.