PowerShell

Enable FTP MODE Z Compression

Demonstrates the Chilkat Ftp2.SetModeZ method, which enables MODE Z compression for subsequent data connections. It takes no arguments. Call it after connecting and only when the HasModeZ property is true.

Background: MODE Z compresses data on the fly (using zlib) as it crosses the wire, which can meaningfully speed up transfers of compressible content — text, HTML, logs — over a slow link. It is a server extension, so check HasModeZ first and expect it to be unavailable on many servers. There is little benefit for already-compressed data such as images or archives, where the CPU cost of compression buys almost nothing.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

#  Demonstrates the Ftp2.SetModeZ method, which enables MODE Z compression for subsequent data
#  connections.  It takes no arguments.  Call it after connecting, and only when the HasModeZ
#  property indicates the server supports it.

$ftp = New-Object 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 -eq $false) {
    $($ftp.LastErrorText)
    exit
}

$success = $ftp.ChangeRemoteDir("public_html")
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}

#  Only enable compression if the server advertises MODE Z support.
if ($ftp.HasModeZ) {
    $success = $ftp.SetModeZ()
    if ($success -eq $false) {
        $($ftp.LastErrorText)
        exit
    }

    $("MODE Z compression enabled.")
}
else {
    $("The server does not support MODE Z.")
}

#  Subsequent uploads, downloads, and listings are transferred compressed.

$success = $ftp.Disconnect()
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}