8.4.10 SFTP Directives

Data will be sent to the host using the SSH2 FTP protocol.

A SSH2 server must be running on the host side.

If no sftp.user or sftp.password properties are available then an authentication dialog is displayed with blank fields.

If sftp.user=*prompt or sftp.password=*prompt then an authentication dialog is displayed with blank fields.

If sftp.user=remoteuser then an authentication dialog is displayed with remoteuser in the user field.

If sftp.user=remoteuser and sftp.password=passphrase then no authentication dialog is displayed.

Keyword

Comments

sftp.name

Description name displayed in the User Agent's Send message box.

sftp.host

URL of the SSH2 server.
Example: sftp://server01:22

sftp.user

Logon user or *prompt.

sftp.password

Logon or private key file password or *prompt.

sftp.key

Private key file for public key authentication.
The specified value is the PEM encoded SSH private key file.
The private key file should have a .pem file extension.
The associated PEM encoded SECSH or SSH public key file should have a .pub file extension.
For example: remotecompany.pem and remotecompany.pub.

sftp.directory

The SSH2 server directory that will receive the uploaded file.
A trailing slash must be present.
The filename is the same as the source filename.
Example: /upload/

sftp.path

The SSH2 server file that will be downloaded when using the get method.
The SSH2 server file that will receive the uploaded file when using the put method. This allows a fixed filename to be used for the receive file.
Example: /upload/fixedname.txt

sftp.method

Get or put a file. The default is to put a file.
GET
PUT

sftp.compression

Enable or disable compression. The default is disabled.
Requires jsmzlib.jar file and Java runtime 1.5 or greater.

sftp.wait

Read timeout in milliseconds. The default is 0.

sftp.timeout

Connect timeout in milliseconds. The default is 0.