JavaScript

SFTP Download Files Matching a Pattern

See more SFTP Examples

Demonstrates how to download files in a directory matching one or more patterns (such as "*.zip" or "abc*_*0719.csv". JavaScript

var success = false;

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

var sftp = new CkSFtp();

success = sftp.Connect("my-ssh-server.com",22);
if (success == true) {
    success = sftp.AuthenticatePw("mySshLogin","mySshPassword");
}

if (success == true) {
    success = sftp.InitializeSftp();
}

if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// The SyncTreeDownload method can be used non-recursively to download all files matching a set of patterns.

// This example will download all files, but only those files having filenames
// that match *.csv and *.eml
sftp.SyncMustMatch = "*.eml; *.gif";

var remoteDir = "syncDownloadTest/someDir";
var localDir = "qa_output";

// mode=0: Download all matching files according to SyncMustMatch
var mode = 0;

// do not recursively traverse the remote directory tree.
var recursive = false;

success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive);
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("Success.");