RPA.FTP

Abort a file transfer in progress

return:true or false based on success or failure

Close connection to the server unilaterally

Connect to FTP server

Arguments

ArgumentTypeDefault valueDescription
hoststrnulladdress of the server
portint21port of the server, defaults to 21
userstr, NoneNonelogin name, defaults to None
passwordstr, NoneNonelogin password, defaults to None
tlsboolFalseconnect using TLS support, defaults to False
transferstrpassivemode of the transfer, defaults to "passive"
keyfilestr, NoneNonepath to private key file
certfilestr, NoneNonepath to certificate file
timeoutint, NoneNonea timeout in seconds for the connection attempt
source_addressTuple[str, int], NoneNonesocket to bind to as its source address before connecting
param host:address of the server
param port:port of the server, defaults to 21
param user:login name, defaults to None
param password:login password, defaults to None
param tls:connect using TLS support, defaults to False
param transfer:mode of the transfer, defaults to "passive"
param keyfile:path to private key file
param certfile:path to certificate file
param timeout:a timeout in seconds for the connection attempt
param source_address:
 socket to bind to as its source address before connecting
raises AuthenticationException:
 on authentication error with the server
return:true if the connnection completes and an error code if it fails

Change working directory on the server

Arguments

ArgumentTypeDefault valueDescription
dirnamestrnullname of the directory
param dirname:name of the directory
return:true or false based on success or failure

Delete file on the server

Arguments

ArgumentTypeDefault valueDescription
filepathstrnullpath to server file
param filepath:path to server file
return:true or false based on success or failure

Download file from FTP server

Arguments

ArgumentTypeDefault valueDescription
remotefilestrnullpath to remote file on the server
localfilestr, NoneNonename of the downloaded file on the local filesystem, if None will have same name as remote file
param remotefile:
 path to remote file on the server
param localfile:
 name of the downloaded file on the local filesystem, if None will have same name as remote file
return:true or false based on success or failure

Return byte size of the file on the server

Arguments

ArgumentTypeDefault valueDescription
filepathstrnullpath to server file
param filepath:path to server file
return:byte size as an int

Get server welcome message

return:welcome message as a string

List files on the server directory

Arguments

ArgumentTypeDefault valueDescription
dirnamestrname of the directory
param dirname:name of the directory
return:list of files present in the server directory

Create a new directory on the server

Arguments

ArgumentTypeDefault valueDescription
dirnamestrnullname of the directory
param dirname:name of the directory
return:true or false based on success or failure

Get current working directory on the server

return:current working directory name as a string

Send QUIT command to the server and close connection

Rename file on the server

Arguments

ArgumentTypeDefault valueDescription
fromnamestrnullcurrent name of the file
tonamestrnullnew name for the file
param fromname:current name of the file
param toname:new name for the file
return:true or false based on success or failure

Remove directory on the server

Arguments

ArgumentTypeDefault valueDescription
dirnamestrnullname of the directory
param dirname:name of the directory
return:true or false based on success or failure

Execute command on the server

Arguments

ArgumentTypeDefault valueDescription
commandstrnullname of the command to send

List of FTP commands: https://en.wikipedia.org/wiki/List_of_FTP_commands

param command:name of the command to send
return:true or false based on success or failure

Set transfer mode to ASCII

return:true or false based on success or failure

Set transfer mode to BINARY

return:true or false based on success or failure

Set debug level for the library

Arguments

ArgumentTypeDefault valueDescription
levelint0integer value of debug level, defaults to 0
param level:integer value of debug level, defaults to 0
return:true or false based on success or failure

0 - no debugging output 1 - moderate amount of debugging 2+ - higher amount of debugging

Upload file to FTP server

Arguments

ArgumentTypeDefault valueDescription
localfilestrnullpath to file to upload
remotefilestrnullname of uploaded file in the server
param localfile:
 path to file to upload
param remotefile:
 name of uploaded file in the server
return:true or false based on success or failure