FTP Log On Icon

FTP - Remove Folder

Declaration

<AMFTP ACTIVITY="remove_folder" FOLDER="text" SESSION="text" />

See Also

FTP - Advanced | FTP - Change Folder | FTP - Create Folder | FTP - Delete | FTP - Download | FTP - FXP | FTP - Log Off | FTP - Log On | FTP - Remove Folder | FTP - Rename | FTP - Synchronize Folders | FTP - Upload

Description

Deletes the folder(s) specified from the FTP server. To specify more than one folder, use wildcards (Example: * or ?). To specify multiple folders or wildcard masks, separate them with a vertical bar (Example: *Folder1|*Folder2).

NOTE: If any files are contained in the folder(s) to be deleted, those files will be deleted as well.

Practical Usage

Used to delete one or more folders residing in the FTP server that are no longer necessary or no longer needed.

Parameters

Folder Properties

Property

Type

Req'd

Default

Markup

Description

Remote Folder

Text

Yes

(Empty)

FOLDER="/home/ftpfolder"

Specifies a fully qualified UNIX style path to the FTP folder(s) to remove.

Match Case

Indicates whether the properties set within this activity should be case sensitive in relation to the FTP server. The default value is NO. This is a visual mode parameter used only during design time, therefore, contains no markup.

 

Session Properties

Property
Type
Req'd
Default
Markup
Description

Session

Text

Yes

FTPSession

SESSION="SessionName"

Specifies the session name (created in a previous FTP Log On step) that this activity should originate from. This permits several FTP activities to be linked to a specific session, thus, allowing multiple simultaneous FTP transfers to take place within a single task.  

 

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Notes

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: This sample step deletes folder "/home/ftp/" via FTP, session name "FTPSession2".

 

<AMFTP ACTIVITY="remove_folder" FOLDER="/home/ftp/" SESSION="FTPSession2" />

 

↑ Top of Page