Node.js

Rename or Move a Remote FTP File

Demonstrates the Chilkat Ftp2.RenameRemoteFile method, which renames or moves a remote file or directory using the FTP RNFR/RNTO sequence. The first argument is the existing path and the second is the new path.

Background: Rename and move are the same RNFR/RNTO operation: changing only the final path component renames in place, while including directory components in the new path relocates the item within the same server. It is a metadata operation, so even a large file moves instantly — but both paths must be on the same server, and moving onto an existing target may fail depending on the server.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the Ftp2.RenameRemoteFile method, which renames or moves a remote file or
    //  directory using the FTP RNFR/RNTO sequence.  The 1st argument is the existing path and the 2nd
    //  is the new path.

    var ftp = new chilkat.Ftp2();

    ftp.Hostname = "ftp.example.com";
    ftp.Username = "myFtpLogin";

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    ftp.Password = "myPassword";

    success = ftp.Connect();
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }

    success = ftp.ChangeRemoteDir("public_html");
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }

    //  Rename a file in place.
    success = ftp.RenameRemoteFile("report.pdf","report_final.pdf");
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }

    //  Include directory components in the new path to move the item within the same server.
    success = ftp.RenameRemoteFile("report_final.pdf","archive/report_final.pdf");
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }

    console.log("Renamed and moved.");

    success = ftp.Disconnect();
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }


}

chilkatExample();