FtpUpload

Top Previous Next

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

Command Syntax

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

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. Wildcard characters are supported for file names, as are multiple files separated by Pipe characters.

TargetFolder: The fully qualified location on the server to which the file(s) should be uploaded

Host:The FTP or SFTP server to receive the upload

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

FtpUploadOptions: A string representing a valid member of the FtpUploadOptions 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.

Examples:

Single File:

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

All files in a directory:

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