FTP Download  Icon

FTP Download

Declaration

<AMFTPDOWNLOAD SOURCE="text" DEST="text" EXCLUDE="text" TRANSFERTYPE="ASCII" SUBFOLDERS="yes/no" KEEPFOLDERSTRUCT="yes/no" ONLYFOLDERSTRUCT="yes/no" OVERWRITE="yes/no" ONLYIFEXIST="yes/no" SESSION="text">

See Also

FTP Log On, FTP Upload, FTP Download, FTP Delete, FTP Rename, FTP Create Folder, FTP Remove Folder, FTP Change Folder, HTTP Post

Description

Downloads the file(s) specified from the FTP server. To specify more than one file use wildcards ( e.g. * or ? ). To specify multiple files or wildcard masks, separate them with a vertical bar. Example: /*.txt|*.bak.

Practical Usage

Downloading files from FTP Servers such as program updates, databases etc.

Parameters

General Tab

Remote Files
Text, Required
MARKUP:
a) SOURCE="/sourcefoldername/file.txt"
b) SOURCE="/sourcefoldername/*.txt"
c) SOURCE="/sourcefoldername/*.txt|/sourcefoldername/*.doc"
c) SOURCE="file.txt"

Specifies the file(s) to download. This can be a fully qualified UNIX style path and filename (preferred) or a single file (requires use of the FTP Change Folder action). Wildcards ( e.g. *.* or ? ) may be used to download files matching a certain mask. Multiple file and/or file masks may be specified by separating the entries with the | symbol.

Destination
Text, Required
MARKUP:
a) DEST="c:\foldername\file.txt"
b) DEST="c:\foldername\*.txt"
c) DEST="file.txt"

Specifies the destination folder and (optional) filename for the file(s) being downloaded. This can be a fully qualified path or a filename. Folders that do not exist will be automatically created at runtime.

Session Name
Text, Optional default="default"
MARKUP: SESSION="SeverB"

Specifies the session (created in a previous FTP Log On action) that should be used to perform the download. This allows for multiple simultaneous FTP transfers to take place.

Options Tab

Include subfolders
Yes/No, Optional default - NO
MARKUP: SUBFOLDERS="YES"

When set to YES, specifies that, if present, subfolders should be searched for files matching the mask specified in the "Source" [SOURCE] parameter

Preserve Folder Structure
Yes/No, Optional default - YES
MARKUP: KEEPFOLDERSTRUCT="NO"

Valid only if the "Include subfolder" [SUBFOLDERS] parameter is YES. When set to YES, specifies that subfolders found in the source folder should be created in the destination folder and source files should be copied into their respective folders rather than directly into the root of the target folder specified in "Destination" [DEST] parameter. If the "Include subfolders" [SUBFOLDERS] parameter is set to NO this parameter is ignored.

Only folder structure
Yes/No, Optional default - NO
MARKUP: ONLYFOLDERSTRUCT="YES"

Valid only if the "Include subfolder" [SUBFOLDERS] parameter is YES. When set to YES, specifies that subfolders found in the source folder should be created in the destination folder but no files will be copied. Enabling this option causes any file-specific parameters to be ignored.

Overwrite Existing Files
Yes/No, Optional default - NO
MARKUP: OVERWRITE="YES"

When set to YES, specifies that, if files already exist they should be overwritten.

Only if exist in destination
Yes/No, Optional default - NO
MARKUP: EMPTYFOLDERS="YES"

Valid only if the "Include subfolder" [SUBFOLDERS] parameter is YES. When set to YES, specifies that only files that already exist in the destination will be copied from the source. All other files, regardless of whether they match the mask or other parameter settings will be bypassed.

Exclude Mask
Text, Optional default - (blank)
MARKUP: EXCLUDE="*.txt"

Causes the action to not upload files matching the mask(s) specified. Filenames or wildcard ( e.g. * or ? ) masks may be used, multiple entries may be specified by separating them with the | symbol (e.g. *.txt|*.bak)

Notes

Standard Error Handling Options
This action also includes the standard "Error Causes" and "On Error" failure handling options/tabs

More on Error Handling Options

Variables and Expressions
All text fields allow the use of expressions by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, a popup expression builder is available in all these fields by pressing F2.
More on variables...
More on expressions...
More on the expression builder...

Example