EmailRemoveFolder (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Managing emails

For an Outlook server

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailRemoveFolder (Function)

In french: EmailSupprimeDossier

Deletes a folder from the Outlook messaging software or from an IMAP server.

Example

// Ouverture de la session
IDSession = EmailStartOutlookSession("MonProfil")
...
// Suppression d'un dossier
EmailRemoveFolder(IDSession, "Dossiers personnels\Boîte de réception\Travail")

// Suppression d'un dossier dans le dossier en cours
EmailRemoveFolder(IDSession, EmailCurrentFolder(IDSession) + "\Travail")

// Protocole IMAP
MaSession is emailIMAPSession
...
// Suppression d'un dossier dans le dossier en cours 
EmailRemoveFolder(MaSession, EmailCurrentFolder(MaSession) + "\Travail")

// Suppression d'un dossier dans le dossier personnel
EmailRemoveFolder(MaSession, "Dossiers personnels\Boîte de réception\TravailPerso")

Syntax

<Result> = EmailRemoveFolder(<Session> , <Folder path>)

<Result>: Boolean

True if deleted successfully,
False otherwise. If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.

<Session>: Character string, integer, or emailOutlookSession or emailIMAPSession variable

Identifier of the current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
a variable of type emailOutlookSession.
a variable of type emailIMAPSession.
the username passed to EmailStartIMAPSession.

<Folder path>: Unicode string

Path of folder to delete.

Remarks

For an Outlook server

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

During the call to EmailRemoveFolder, 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 an Outlook Express folder.

Component: wd300com.dll