Perl Requires Chilkat v9.5.0.76+

SFTP Sync Download Tree w/ Must-Match Filename Constraints

See more SFTP Examples

Demonstrates how synchronize a directory tree in the download direction, but only download files matching a set of wildcard filenames. Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

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

my $sftp = Chilkat2::SFtp->new;

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

if ($success) {
    $success = $sftp->InitializeSftp();
}

if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Possible synchronization modes are:
# 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.

# This example will download all files, but only those files having filenames
# that match *.gif and *.eml

# Imagine our remote directory tree has these files and directories:

#     accentedLatin1.txt
#     accentedUtf8.txt
#     alice.key
#     anter_cert.pem
#     chiliPepper.gif
#     helloWorld.pdf
#     abc/chiliPepper.gif
#     abc/ghk/
#     data/chiliPepper.gif
#     data/xyz/dkimHtmlBody.txt
#     data/xyz/dkimVerifyTest.eml
#     data/xyz/emailForCreateDsn.eml
#     text/frenchUtf8.txt
#     text/helloWorld.txt
#     text/PolishEmailBody.txt
#     text/something/

# Indicate that we only want to create auto-create local directories (if needed)
# for the files that are actually downloaded.  If SyncCreateAllLocalDirs remains
# 1, then the corresponding local directory is created for each remote directory
# traversed regardless of whether files within are downloaded.
$sftp->SyncCreateAllLocalDirs(0);

$sftp->SyncMustMatch('*.eml; *.gif');

my $remoteDir = 'syncDownloadTest/someDir';
my $localDir = 'qa_output';
my $mode = 0;
my $recursive = 1;
$success = $sftp->SyncTreeDownload($remoteDir, $localDir, $mode, $recursive);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# The following files were downloaded:

# chiliPepper.gif
# abc/chiliPepper.gif
# data/chiliPepper.gif
# data/xyz/dkimVerifyTest.eml
# data/xyz/emailForCreateDsn.eml

print "Success.\n";