Setting FTP.remoteFile tells the plugin where to create the file being uploaded, or where to get the file to be downloaded.


First available in version 3.0 build 2039.

Input Parameters:

remoteFile - Path to the remote file on the FTP server.

Output Parameters:

No output parameters.

Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FTP.remoteFile( paramsObject [, callbackParamsObject] [, errorParamsObject] );

Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FTP.remoteFile( paramsObject );


The remoteFile is assumed to be a reference to a file in the current directory on the FTP server, but you specify absolute paths as well.

If the first two characters in the remoteFile path are ".." it is a reference to one level above the current directory.

Set the first character of the remoteFile path to "/" to specify an absolute directory.

Before you upload to the remoteFile, you must create the destination directory. If the directory does not exist, FTP.transfer will fail (the error code will be set to "12", indicating the file could not be opened).