Delete Folder

Deletes a mail folder

Common Properties

• Name - The custom name of the node.
• Color - The custom color of the node.
• Delay Before (sec) - Waits in seconds before executing the node.
• Delay After (sec) - Waits in seconds after executing node.
• Continue On Error - Automation will continue regardless of any error. The default value is false.

info

if ContinueOnError property is true, no error is caught when the project is executed even if Catch node is used.

Input

• Client Id - Id of the email client. The ID is created by the Connect node.
• Folder Name - The name of the folder to be deleted

Options

• Credentials - Credentials used for deleting the folder. Required if there is no Client Id.

How It Works

The Delete Folder node removes a mailbox folder using IMAP DELETE command. Here's the process:

1. Authentication - Uses Client ID or direct credentials
2. Folder Name Validation - Validates folder name is not empty
3. IMAP DELETE Command - Executes DELETE command on mail server
4. Folder Removal - Mail server deletes the folder
5. Confirmation - Returns success when folder is deleted

Requirements

• Client ID from Connect node OR Credentials from vault with IMAP access
• Folder Name - Valid existing folder name
• Empty Folder - Folder should be empty (server-dependent requirement)

Error Handling

Error Code	Description	Resolution
Core.Mail.DeleteFolder.ErrOnCreate	Config parse error	Check node configuration
Core.Mail.DeleteFolder.ErrCredentials	Invalid credentials	Verify vault credentials
Core.Mail.DeleteFolder.ErrFolder	Folder name is empty	Provide folder name
Core.Mail.DeleteFolder.ErrClientId	Client ID not found	Ensure Connect node executed
Core.Mail.DeleteFolder.Delete	Folder deletion failed	Folder may not exist, not empty, or is protected
Core.Mail.ErrConn	Connection missing	Ensure Connect executed

Usage Examples

Example 1: Delete Empty Folder

{
  "client_id": "{{client_id}}",
  "folder_name": "OldArchive"
}
// Deletes "OldArchive" folder

Example 2: Delete Subfolder

{
  "client_id": "{{client_id}}",
  "folder_name": "Archive/2020"
}
// Deletes "2020" subfolder within "Archive"

Example 3: Cleanup Old Folders

// List all folders first
var folders = {{folders}};

// Delete old year folders
var oldYears = ["Archive/2020", "Archive/2021"];
for (var folder of oldYears) {
  if (folders.includes(folder)) {
    // Use Delete Folder node
  }
}

Usage Notes

• Folder Must Exist: Deleting non-existent folder may fail or succeed silently
• Empty Folder: Most servers require folder to be empty before deletion
• Protected Folders: System folders (INBOX, Sent, Trash) cannot be deleted
• Permanent Action: Folder deletion is permanent and cannot be undone
• Subfolders: May need to delete subfolders first (server-dependent)

Tips

• Move Emails First: Use Move Mail to relocate emails before deleting folder
• List Folders First: Verify folder exists before attempting deletion
• Backup Important Data: Archive emails before deleting folders
• Use with Caution: Always confirm folder name before deletion
• Test in Development: Test deletion logic with non-critical folders first

Related Nodes

• List Folders - Check if folder exists
• Create Folder - Create new folders
• Move Mail - Move emails before deletion
• Delete Mail - Delete emails from folder