Remove Directory

Overview

The Remove Directory Component allows users to delete a directory from an FTP or SFTP server. It ensures efficient directory management within automated workflows.

Usage

This component connects to an FTP/SFTP server and removes the specified directory.

Properties

Property
Type
Description

path

string

The directory path to be removed.

Input Ports

Port
Description

in

Accepts the directory path for removal.

Output Ports

Port
Description

out

Emits success confirmation when the directory is removed.

notFound

Emits an error if the directory does not exist or permission is denied.

Processing Logic

  1. Establishes FTP/SFTP Connection: Securely connects to the remote server using provided authentication credentials.

  2. Attempts to Remove Directory:

    • Tries to delete the directory at the specified path.

    • Ensures proper handling of directory permissions.

  3. Handles Success & Errors:

    • If successful, sends confirmation to the out port.

    • If the directory does not exist or permission is denied, emits an error to notFound.

  4. Closes Connection: Ensures the FTP/SFTP session is properly terminated.

Output Data Schema

Property
Type
Description

path

string

The directory path that was processed.

errorCode (if error)

string

FTP/SFTP error code.

errorMessage (if error)

string

Description of the error encountered.

Notes

  • Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.

  • Error Handling: Properly manages missing directories and permission-related issues.

  • Efficient Directory Management: Enables automated cleanup of remote directories.

This component is essential for workflows that require automated directory management and cleanup on remote servers.

Last updated