cfftp: Connection: File and directory operations

Description

Use this form of the cfftp tag to perform file and directory operations with cfftp.

Syntax

<cfftp 
  action = "action"
  username = "name"
  password = "password"
  name = "query_name"
  server = "server"
  ASCIIExtensionList = "extensions"
  transferMode = "mode"
  failIfExists = "Yes" or "No"
  directory = "directory name"
  localFile = "filename"
  remoteFile = "filename"
  item = "directory or file"
  existing = "file or directory name"
  new = "file or directory name"
  proxyServer = "proxyserver"
  passive = "Yes" or "No">

Attributes

Attribute Req/Opt Default Description

action
Required if connection is not cached

FTP operation to perform.

changedir

createDir

listDir

removeDir

getFile

putFile

rename

remove

getCurrentDir

getCurrentURL

existsDir

existsFile

exists

username
Required if connection is not cached

User name to pass in the FTP operation.

password
Required if action = "open"

Password to log in the user.

name
Required if action = "listDir"

Query name of directory listing.

server
Required if FTP connection is not cached

FTP server to which to connect; for example, ftp.myserver.com.

ASCIIExtensionList
Optional
txt;htm;html;cfm;cfml;
shtm;shtml;
css;asp;asa
Delimited list of file extensions that force ASCII transfer mode, if transferMode = "auto".

transferMode
Optional
Auto

ASCII FTP transfer mode

Binary FTP transfer mode

Auto FTP transfer mode

failIfExists
Optional
Yes

Yes: if a local file with same name exists, getFile fails

No

directory
Required if action = "changedir", "createDir", "listDir", or "existsDir"

Directory on which to perform an operation.

localFile
Required if action = "getFile" or putFile

Name of the file on the local file system.

remoteFile
Required if action = "getFile", "putFile", or "existsFile"

Name of the file on the FTP server file system.

item
Required if action = "exists" or "remove"

Object of these actions: file or directory.

existing
Required if action = "rename"

Current name of the file or directory on the remote server.

new
Required if action = "rename"

New name of file or directory on the remote server

proxyServer
Optional

String. Name of the proxy server (s) to use, if proxy access is specified

passive
Optional
No

Yes: enable passive mode

No

Attribute	Req/Opt	Default	Description
action	Required if connection is not cached		FTP operation to perform. changedir createDir listDir removeDir getFile putFile rename remove getCurrentDir getCurrentURL existsDir existsFile exists
username	Required if connection is not cached		User name to pass in the FTP operation.
password	Required if `action = "open"`		Password to log in the user.
name	Required if `action = "listDir"`		Query name of directory listing.
server	Required if FTP connection is not cached		FTP server to which to connect; for example, `ftp.myserver.com`.
ASCIIExtensionList	Optional	txt;htm;html;cfm;cfml; shtm;shtml; css;asp;asa	Delimited list of file extensions that force ASCII transfer mode, if `transferMode = "auto"`.
transferMode	Optional	Auto	ASCII FTP transfer mode Binary FTP transfer mode Auto FTP transfer mode
failIfExists	Optional	Yes	Yes: if a local file with same name exists, getFile fails No
directory	Required if `action = "changedir"`, "`createDir", "listDir", or "existsDir"`		Directory on which to perform an operation.
localFile	Required if `action = "getFile" or putFile`		Name of the file on the local file system.
remoteFile	Required if `action = "getFile"`, "`putFile`", or "`existsFile`"		Name of the file on the FTP server file system.
item	Required if `action = "exists`" or "`remove`"		Object of these actions: file or directory.
existing	Required if `action = "rename"`		Current name of the file or directory on the remote server.
new	Required if `action = "rename"`		New name of file or directory on the remote server
proxyServer	Optional		String. Name of the proxy server (s) to use, if proxy access is specified
passive	Optional	No	Yes: enable passive mode No

Usage

If you use connection caching to an active FTP connection, you do not have to respecify the username, password, or server connection attributes:

Changing a cached connection, such as changing retryCount or timeout values, might require reestablishing the connection.

If action = "listDir", the attributes column returns directory or normal. Other platform-specific values, such as hidden and system, are no longer supported.

If action = "listDir", a mode column is returned. The column contains an octal string representation of UNIX permissions; for example, "777."

The cfftp.returnValue variable provides the return value for these actions:

getCurrentDir
getCurrentURL
existsDir
existsFile
exists

For more information, see Developing ColdFusion MX Applications with CFML.

Caution: Object (file and directory) names are case-sensitive.

Action (cfftp.ReturnValue variable)

The results of an action determine the value of the cfftp.returnValue variable.

cfftp action Value of cfftp.returnValue

getCurrentDir
String. Current directory.

getCurrentURL
String. Current URL.

existsDir
Yes or No.

existsFile
Yes or No.

exists
Yes or No.