Tip: For detailed documentation refer to the IntelliSense tips that appear when you call a given API method.

These methods currently support the rule engine.

• UploadDirectory()

• DownloadDirectory()

• DownloadDirectoryWithRules.cs
• UploadDirectoryWithRules.cs

• DownloadDirectoryWithRules.vb
• UploadDirectoryWithRules.vb

Rules allow you to declaratively specify which files and folders should be copied and which should be skipped. There are rules that let you filter on file extension (eg: upload only PDF files) or file size (eg: upload files smaller than 100 MB) and various other parameters.

Only files that pass all the rules are copied from the source to the target. If you are using Mirror mode then the files that fail the rules will be also deleted from the target.

The rules that are supported are listed here:

Declare the rules and then call DownloadDirectory or UploadDirectory with those rules:

var rules = new List<FtpRule>{
   new FtpFileExtensionRule(true, new List<string>{ "pdf" }),  // only allow PDF files
   new FtpSizeRule(FtpOperator.LessThan, 1000000000)           // only allow files <1 GB
};

client.DownloadDirectory(@"C:\website\attachments\", @"/public_html/attachments",
    FtpFolderSyncMode.Update, FtpLocalExists.Skip, FtpVerify.None, rules);

Declare the rules and then call DownloadDirectory or UploadDirectory with those rules:

// this uses the pre-defined blacklist that skips directories named `.git`, `.svn`, `node_modules` etc
var rules = new List<FtpRule>{
   new FtpFolderNameRule(false, FtpFolderNameRule.CommonBlacklistedFolders),
};

client.DownloadDirectory(@"C:\project\src\", @"/project/src",
    FtpFolderSyncMode.Update, FtpLocalExists.Skip, FtpVerify.None, rules);