FtpDownload

The FtpDownload command allows you to copy a specified file to another location using FTP or SFTP transfer protocols.

Command Syntax

FtpDownload:[SourceFileName(s)],[TargetFolder],[Host],[Port],[UserName],[Password],[Protocol]

The colon after the command and the commas between parameters are compulsory. Any additional spaces or characters will cause an error to be thrown. The command itself is not case sensitive, but parameters may be depending on the operating system and locale.

Parameters:

SourceFileName(s): The fully qualified path and file name(s) identifying the file(s) to copy, separated by Pipe characters if there are multiple files. Each value must be enclosed in quotes if more than one file is specified or there are spaces in any of the the path and file names.

TargetFolder: The fully qualified location on the local machine to which the file(s) should be Downloaded. This value must be enclosed in quotes if there are any spaces in any of the the path.

Host:The FTP or SFTP server to receive the Download

Port: The port on which the server will communicate

UserName: The username for the server

Password: The password for the server

Protocol: A string representing a valid transport protocol, currently one of the following values: FTP, FTPS, SFTP

FtpDownloadOptions: A string representing a valid member of the FtpDownloadOptions enumeration, currently one of the following values: None, SkipMissingFiles

All parameters are compulsory. If any parameter is missing or invalid an error will be thrown.

Example:

FtpDownload:"/home/www/test/files/Test Text.txt","C:\Test",my.server.com,22,MyUserName,mypassword,SFTP,None

See Also: FtpUpload FtpDeleteFile