<cfftp>

Lets users implement File Transfer Protocol (FTP) operations.

Usage

<cfftp
    [failifexists=boolean]
    [item=string]
    [retrycount=number]
    [server=string]
    [proxyuser=string]
    [localfile=string]
    [fingerprint=string]
    [asciiextensionlist=string]
    [password=string]
    [name=string]
    [timeout=number]
    [result=string]
    [stoponerror=boolean]
    [connection=string]
    [username=string]
    [new=string]
    [remotefile=string]
    [existing=string]
    [proxyport=number]
    [proxypassword=string]
    [directory=string]
    [recurse=boolean]
    [transfermode=string]
    [proxyserver=string]
    [port=number]
    action=copy|exists|existsfile|existsdir|open|close|changedir|createdir|listdir|removedir|getfile|putfile|rename|remove|getcurrentdir|getcurrenturl
    [secure=boolean]
    [passive=boolean]
>

This tag cannot have a body.

This tag is also supported within cfscript

Attributes

Attribute Description
failifexists
(boolean, optional)

throw a error if local file already exist or overwrite it

item
(string, optional)

item on the server

retrycount
(number, optional)

retry count

server
(string, optional)

The Server to connect

proxyuser
(string, optional)

When required by a proxy server, a valid username.

localfile
(string, optional)

File on the current machine

fingerprint
(string, optional)

the ssh fingerprint

asciiextensionlist
(string, optional)

Delimited list of file extensions that force ASCII transfer mode, if transferMode = "auto".

password
(string, optional)

The Password for the connection

name
(string, optional)

name of the query for list directory

timeout
(number, optional)

timeout for the connection

result
(string, optional)

Name of the result value (default:cfftp)

stoponerror
(boolean, optional)

define if execution halt on error or not

connection
(string, optional)

the name for the connection, used to cache the connection

username
(string, optional)

The Username for the connection

new
(string, optional)

new name for file or directory

remotefile
(string, optional)

File on the Server

existing
(string, optional)

source or existing file or directory to rename

proxyport
(number, optional)

The port number on the proxy server from which the object is requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.

proxypassword
(string, optional)

When required by a proxy server, a valid password.

directory
(string, optional)

remote directory to list

recurse
(boolean, optional)

delete content of the directory

transfermode
(string, optional)

ASCII, binary or auto mode

proxyserver
(string, optional)

Host name or IP address of a proxy server.

port
(number, optional)

server port of the connection

action
(string, required)

the action that should be execute

secure
(boolean, optional)

Secure connection (sftp|shh) or not.

passive
(boolean, optional)

enable passive mode

Examples

There are currently no examples for this tag.