MSG_GetBody

Home

4D v20

MSG_GetBody


MSG_GetBody ( fileName ; offset ; length ; bodyText ) -> Function result

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

Description

The MSG_GetBody command returns just the text of the message. It will not include enclosure text and will strip all MIME headers.

fileName is the name of the file or the full path of the file of which to extract the body of the message. If only a filename is given, the path will default to the folder set by POP3_SetPrefs or MSG_SetPrefs (see Compatibility notes). If no folder has been specified by POP3_SetPrefs, 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 body information at which to begin the retrieval.

length is the number of characters to return.

bodyText receives the text of the message body. Since the bodyText parameter can include extended characters, you can automate their management using the POP3_Charset or MSG_Charset command (see Compatibility notes). This parameter takes the stripLineFeed parameter set by POP3_SetPrefs or MSG_SetPrefs into account (see Compatibility notes).

Compatibility notes (version 6.8.1):

If the MSG_SetPrefs command is not used, the POP3_SetPrefs msgFolder and stripLineFeed parameters will be taken into account. If MSG_SetPrefs is used, the POP3_SetPrefs msgFolder and stripLineFeed parameters are ignored.
If the MSG_Charset command is not used, the POP3_Charset bodyCharset parameter will be used; if MSG_Charset is used, the POP3_Charset bodyCharset parameter is ignored.