MSG_GetHeaders

Home

4D Internet Commands v16

MSG_GetHeaders


MSG_GetHeaders ( fileName ; offset ; length ; headerText ) -> Function result

Parameter	Type	Description
fileName	Text	Filename (path defaults to message folder)
offset	Longint	Starting offset into headers (0 = start of header)
length	Longint	Number of characters
headerText	Text	Header text (removes linefeeds if Prefs ON)
Function result	Integer	Error Code

Description

The MSG_GetHeaders command returns the raw text of the entire header section of the message. The header portion of a POP3 message is defined as the text from the beginning of the message to the first occurrence of two consecutive carriage return/line feed sequences.

fileName is the name of the file or the full path of the file of which to extract the header. If only a fileName is given, the path will default to the folder set by POP3_SetPrefs or MSG_SetPrefs (see Compatibility note). If no folder has been specified, the path will default to the folder containing the structure of the database (with 4D single-user) or to the 4D Client folder (with 4D Server).

offset is the character position within the source header information at which to begin the retrieval.

length is the number of characters to return. The length of the header section can be determined with MSG_MessageSize.

headerText receives the text of the header. This parameter takes the stripLineFeed parameter set by POP3_SetPrefs or MSG_SetPrefs into account.

Compatibility note (version 6.8.1): If the MSG_SetPrefs command is not used, the POP3_SetPrefs msgFolder parameter will be used; if MSG_SetPrefs is used, the POP3_SetPrefs msgFolder parameter is ignored.