EmailRemoveFolder (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

For an Outlook server

EmailReadMessageHeader

EmailReadNext

EmailReadNextHeader

EmailReadPrevious

EmailReadPreviousHeader

EmailStartIMAPSession

EmailStartNotesSession

EmailStartOutlookSession

EmailStartPOP3Session

EmailStartSMTPSession

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

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

// Start the session
SessionID = EmailStartOutlookSession("MyProfile")
...
// Delete a folder
EmailRemoveFolder(SessionID, "Personal folders\Inbox\Work")

// Delete a folder from the current folder
EmailRemoveFolder(SessionID, EmailCurrentFolder(SessionID) + "\Work")

// IMAP protocol
MySession is emailIMAPSession
...
// Delete a folder from the current folder
EmailRemoveFolder(MySession, EmailCurrentFolder(MySession) + "\Work")

// Delete a folder from the custom folder
EmailRemoveFolder(MySession, "Personal folders\Inbox\MyOwnWork")

Syntax

<Result> = EmailRemoveFolder(<Session> , <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>: Character string, integer, or emailOutlookSession or emailIMAPSession variable

Identifier of current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
Versions 15 and later
an emailOutlookSession variable.
New in version 15
an emailOutlookSession variable.
an emailOutlookSession variable.
Versions 15 and later
a emailIMAPSession variable.
New in version 15
a emailIMAPSession variable.
a emailIMAPSession variable.
Versions 15 and later
the user name passed to EmailStartIMAPSession.
New in version 15
the user name passed to EmailStartIMAPSession.
the user name passed to EmailStartIMAPSession.

<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 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 a folder from the Outlook Express messaging software.

Component: wd260com.dll