Lucee Tag Reference

<cfftp>

Lets users implement File Transfer Protocol (FTP) operations.

Body

This tag can't have a body.

Example

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

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
action string Yes the action that should be execute 
asciiextensionlist string No Delimited list of file extensions that force ASCII transfer mode, if transferMode = "auto". 
connection string No the name for the connection, used to cache the connection 
directory string No remote directory to list 
existing string No source or existing file or directory to rename 
failifexists boolean No throw an error if local file already exists or overwrite it 
fingerprint string No the ssh fingerprint 
item string No item on the server 
key string No the ssh private key 
localfile string No File on the current machine 
name string No name of the query for list directory 
new string No new name for file or directory 
passive boolean No enable passive mode 
passphrase string No the passphrase that protects ssh private key 
password string No The Password for the connection 
port number No server port of the connection 
proxypassword string No When required by a proxy server, a valid password. 
proxyport number No 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. 
proxyserver string No Host name or IP address of a proxy server. 
proxyuser string No When required by a proxy server, a valid username. 
recurse boolean No delete content of the directory 
remotefile string No File on the Server 
result string No Name of the result value (default:cfftp) 
retrycount number No retry count 
secure boolean No Secure connection (sftp|shh) or not. 
server string No The Server to connect 
stoponerror boolean No define if execution halt on error or not 
timeout number No timeout for the connection 
transfermode string No ASCII, binary or auto mode 
username string No The Username for the connection