cfftp

Overview ColdFusion Open BlueDragon Lucee

Lets users implement File Transfer Protocol (FTP) operations.

Attributes

	Name	Required	Type	Default	Description
	action	Yes	String		FTP operation to perform. open: create an FTP connection close: terminate an FTP connection
8	actionparam	No	String		Used only when action is quote, site, or acct. Specifies the command when action is quote or site; specifies account information when action is acct.
	asciiextensionlist	No	String		Delimited list of file extensions that force ASCII transfer mode, if transferMode = "auto".
8	attributes	No	String		Attributes of the current element: normal or Directory.
8	buffersize	No	Numeric		Buffer size in bytes.
	connection	No			Name of the FTP connection. If you specify the username, password, and server attributes, and if no connection exists for them, CFML creates one. Calls to cfftp with the same connection name reuse the connection.
	directory	No	String		Directory on which to perform an operation
	existing	No	String		Current name of the file or directory on the remote server.
	failifexists	No	Boolean	true	Yes: if a local file with same name exists, getFile fails
8	fingerprint	No	String		Fingerprint of the host key in the form ssh-dss.ssh-rsa, which is a 16-byte unique identifier for the server attribute that you specify.
	item	No	String		Object of these actions: file or directory.
8	key	No	String		Public-key-based authentication. Refers to the absolute path to the private key of the user. Possession of a private key provides authentication by sending a signature created with a private key. The server must ensure that the key is a valid authentication for the user and that the signature is valid. Both must be valid to accept the authentication.
	localfile	No	String		Name of the file on the local file system
	name	No	String		Query name of directory listing.
	new	No	String		New name of file or directory on the remote server
	passive	No	Boolean	false	Yes: enable passive mode
8	passphrase	No	String		Used when key is specified. Because private keys are stored in an encrypted form on the client host, the user must supply a passphrase to enable generating the signature.
	password	No	String		Overrides password specified in ODBC setup.
	port	No	Numeric	21	Remote port to which to connect
	proxypassword	No			When required by a proxy server, a valid password.
	proxyport	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	No	String		The proxy server required to access the URL.
	proxyuser	No			When required by a proxy server, a valid username.
	remotefile	No	String		Name of the file on the FTP server file system.
	result	No	String		Specifies a name for the structure in which cfftp stores the returnValue variable. If set, this value replaces cfftp as the prefix to use when accessing returnVariable.
	retrycount	No	Numeric	1	Number of retries until failure is reported.
8	secure	No	String	false	* yes: enables secure FTP * no
	server	No	String		FTP server to which to connect; for example, ftp.myserver.com
	stoponerror	No	Boolean	false	Yes: halts processing, displays an appropriate error. No: populates the error variables
	timeout	No	Numeric	30	Value in seconds for the timeout of all operations, including individual data request operations.
	transfermode	No	String	auto	ASCII FTP transfer mode Binary FTP transfer mode Auto FTP transfer mode
	username	No	String		Overrides username specified in ODBC setup.