4D Internet Commands v14

MSG_GetBody

Home

 
4D Internet Commands v14
MSG_GetBody

MSG_GetBody 


 

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

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):

 
PROPERTIES 

Product: 4D Internet Commands
Theme: IC Downloaded Mail
Number: 88952

 
HISTORY 

Modified: 4D Internet Commands 6.8.1

 
SEE ALSO 

MSG_Charset
MSG_SetPrefs
POP3_Charset
POP3_SetPrefs

 
ARTICLE USAGE

4D Internet Commands ( 4D Internet Commands v11.4)
4D Internet Commands ( 4D v13.2)
4D Internet Commands ( 4D Internet Commands v12.1)
4D Internet Commands ( 4D Internet Commands v14 R2)
4D Internet Commands ( 4D Internet Commands v14)
4D Internet Commands ( 4D Internet Commands v14 R3)
4D Internet Commands ( 4D Internet Commands v14 R4)