4D Doc Center : MSG

4D v13.2

MSG_MessageSize


MSG_MessageSize ( fileName ; headerSize ; bodySize ; msgSize ) -> Function result

Parameter	Type	Description
fileName	Text	Filename (path defaults to message folder)
headerSize	Longint	Header size (subtracts linefeeds if Prefs ON)
bodySize	Longint	Body size (subtracts linefeeds if Prefs ON)
msgSize	Longint	Entire message or file size (ignores Prefs)
Function result	Integer	Error Code

Description

Given the fileName of a message document retrieved to disk by the POP3_Download command, the MSG_MessageSize command returns information about the sizes of the various portions of the message.

fileName is the name of the file or the full path of the file of which to return message information. 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 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).

headerSize is the long integer variable returned containing the size of the header.
bodySize is the long integer variable returned containing the size of the body.
These two parameters take 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 and stripLineFeed parameters will be taken into account if the POP3_SetPrefs command has been used previously; if MSG_SetPrefs is used, the POP3_SetPrefs msgFolder and stripLineFeed parameters are ignored.

msgSize is the long integer variable returned containing the size of the message.