4D Doc Center : POP3

Home

4D Internet Commands v14

POP3_SetPrefs


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

Parameter	Type	Description
stripLineFeed	Integer	0 = Don't 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 POP3_SetPrefs command sets the preferences for all POP3 commands.

stripLineFeed is an integer value specifying how LineFeed characters will be treated in saved messages. Most POP3 servers 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 retrieved messages in the format as stored on the POP3 server. A value of 1 will strip linefeed characters from retrieved messages. A value of -1 will leave this preference as it has been previously set. The default option defaults to 1 and will automatically strip linefeeds found in messsages.

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

Compatibility note (version 6.8.1): the stripLineFeed and msgFolder parameters were previously applied to MSG_Commands. This is no longer the case when the MSG_SetPrefs command is used.

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): the attachFolder parameter is also found in POP3_SetPrefs and MSG_SetPrefs therefore you can modify it using either of these two commands. Using the MSG_SetPrefs command is strongly recommended; the POP3_SetPrefs parameter, used for compatibility reasons, will not be used in the future. The attachFolder of the POP3_SetPrefs command is optional therefore we recommend that you do not pass this parameter. This recommendation also applies to POP3_GetPrefs.