MSG_Delete

Home

4D v18

MSG_Delete


MSG_Delete ( fileName ; folder ) -> Function result

Parameter	Type	Description
fileName	Text	Filename (path defaults to message folder)
folder	Integer	0 = Message Folder, 1 = Attachment Folder
Function result	Integer	Error Code

Description

The MSG_Delete command deletes a local file.

fileName is the name of the file or the full path of the file to delete. If only a filename is given, the folder parameter is taken into account based on the following:

folder = 0: the file resides in the message folder specified by POP3_SetPrefs or MSG_SetPrefs.
folder = 1: the file resides in the attachment folder specified by POP3_SetPrefs or MSG_SetPrefs
In both cases, if no folder is defined by POP3_SetPrefs or MSG_SetPrefs, the path will default to the folder containing the structure of the database (with 4D single-user) or in the 4D Client folder (with 4D Server).

Compatibility note (version 6.8.1): If the MSG_SetPrefs command is not used, the POP3_SetPrefs msgFolder and attachFolder parameters are used; if MSG_SetPrefs is used, the POP3_SetPrefs parameters are ignored.

Warning: This command will delete ANY file passed to it. Be very careful when using this command.