<EmailOutlookSession variable>.RemoveFolder (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

For an Outlook server

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<EmailOutlookSession variable>.RemoveFolder (Function)

In french: <Variable EmailSessionOutlook>.SupprimeDossier

Deletes a folder from the Outlook messaging software.

Example

// Start the Outlook session
SessionID is emailOutlookSession
...
// Delete a folder
SessionID.RemoveFolder("Personal folders\Inbox\Work")
// Delete a folder from the current folder
SessionID.RemoveFolder(SessionID.CurrentFolder() + "\Work")

Syntax

<Result> = <Session>.RemoveFolder(<Folder path>)

<Result>: Boolean

True if the deletion was performed,
False otherwise. The ErrorOccurred variable is set to True if an error occurred. To get the details of the error, use ErrorInfo with the errMessage constant.

<Session>: emailOutlookSession variable

Name of the emailOutlookSession variable corresponding to the email session to use.

<Folder path>: Unicode character string (with quotes)

Path of folder to delete.

Remarks

For an Outlook server

The folder must be found in the "Personal folders" branch.

During the call to <EmailOutlookSession variable>.RemoveFolder, the following operations are automatically performed:

the messages found in the folder to delete are moved into the bin ("Deleted elements" folder).
the sub-folders of the folder to delete as well as their content are moved into the bin ("Deleted elements" folder).
the folder to delete is permanently deleted.

If the folder to delete is already found in the bin, the folder and its content are permanently deleted.

Reminder: This function cannot be used to delete a folder from the Outlook Express messaging software.

Component : wd260com.dll