(JavaScript) FTP Non-Recursive Sync Directory (Download)

See more FTP Examples

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var ftp = new CkFtp2();

ftp.Hostname = "ftp.example.com";
ftp.Username = "myUsername";
ftp.Password = "myPassword";
ftp.Port = 21;
ftp.AuthTls = true;

// Connect and login to the FTP server.
success = ftp.Connect();
if (success !== true) {
    console.log(ftp.LastErrorText);
    return;
}

// Change to the remote directory where the files are located.
// This step is only necessary if the files are not in the root directory
// of the FTP account.
success = ftp.ChangeRemoteDir("qa");
if (success !== true) {
    console.log(ftp.LastErrorText);
    return;
}

// Indicate that we only want to download files with filenames ending in ".txt"
ftp.SyncMustMatch = "*.txt";

// Modes for synchronization are as follows:
// mode=0: Download all files
// mode=1: Download all files that do not exist on the local filesystem.
// mode=2: Download newer or non-existant files.
// mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
// mode=5: Download only missing files or files with size differences.
// mode=6: Same as mode 5, but also download newer files.
// mode=99: Do not download files, but instead delete remote files that do not exist locally.
var mode = 1;

// Download all files matching "*.txt" from the current remote ftp directory.
// The files are downloaded into c:/temp/qa_output
success = ftp.SyncLocalDir("c:/temp/qa_output",mode);
if (success !== true) {
    console.log(ftp.LastErrorText);
    return;
}

// Perhaps we wish to delete the files we just downloaded from the server..
var st = new CkStringTable();
ftp.GetSyncedFiles(st);

var numFiles = st.Count;
var i = 0;
var remoteFilename;
while (i < numFiles) {
    remoteFilename = st.StringAt(i);
    console.log("Deleting " + remoteFilename + " from the FTP server");
    success = ftp.DeleteRemoteFile(remoteFilename);
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    i = i+1;
}

success = ftp.Disconnect();