wodImapServer ActiveX Component - DeleteFolder Method
 DeleteFolder Method
      
 

Description

Called when user wants to delete subfolder.


Return Type

None  


Syntax

object.DeleteFolder Owner, User, ParentFolder, Folder, Action



The DeleteFolder Method syntax has these parts:

Part Description
object An expression evaluating to an object of type IwodImapNotify.
Owner Required. A wodImapServer object.
User Required. An ImapUser object. Reference to user who wants to delete folder.
ParentFolder Required. An ImapFolder object. Reference to parent folder where folder that will be deleted currently exists.
Folder Required. An ImapFolder object. Reference to folder that should be deleted.
Action Required. An ImapActions enumeration, as described in settings. Return value you should fill with either Allow or Deny value, depending if you will allow user to delete the folder or not.

Settings

The settings for Action are:

Constant Value Description
 Deny 0 Deny execution of the action.
 Allow 1 Allow to execute action.

Remarks
NOTE: This method is called only if you implemented IwodImapNotify interface in your application, and wodImapServer1.Notification property has received reference to instance of your implementation.
 
When user decides to delete certain folder, DeleteFolder notification method is called for you to decide if you will allow such action or not. If you don't want folder to be deleted, you should set Action = Deny, and wodImapServer will return error message to the client.

If you want to allow this action, then you should delete all subfolders and all messages from the folder, and set Action = Allow.