4D Doc Center : MSG

Home

4D Internet Commands v14

MSG_GetMessage


MSG_GetMessage ( fileName ; offset ; length ; rawText ) -> Function result

Parameter	Type	Description
fileName	Text	Filename (path defaults to message folder)
offset	Longint	Starting offset into message file (0 = start of file)
length	Longint	Number of characters
rawText	Text	Raw text (ignores Prefs)
Function result	Integer	Error Code

Description

The MSG_GetMessage command returns the raw text of the message regardless of enclosures. It does not strip 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 note). If no folder has been specified, the path will default to the folder containing the structure of the database.

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.

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

length is the number of characters to return.

rawText receives the text of the entire message. The preference settings for linefeed stripping are ignored and no effort is taken to strip any attachment that may be embedded within the message body.