Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

FtpHelper

Contains helpers which allow to upload a whole folder/specific file into a FTP Server. Uses Passive Mode FTP and handles all files as binary (and not ASCII). Assumes direct network connectivity to destination FTP server (not via a proxy). Does not support FTPS and SFTP.

Nested types and modules

TypeDescription
FtpServerInfo
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Functions and values

Function or valueDescription
checkInExistingDirList(...)
Signature: server:string -> user:string -> pwd:string -> destPath:string -> fname:string -> bool

Given a folder name, will check if that folder is present at a given root directory of a FTP server.

Parameters

  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
createAFolder server user pwd destPath
Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Creates a matching folder in FTP folder, if not already present.

Parameters

  • destPath - The full name of folder which needs to be created, including all its parent folders
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
deleteAFile server user pwd destPath
Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Deletes a single file from remote FTP folder.

Parameters

  • destPath - The full path to the file which needs to be deleted, including all its parent folders
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
deleteAFolder server user pwd destPath
Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Deletes a single folder from remote FTP folder.

Parameters

  • destPath - The full path to the folder which needs to be deleted, including all its parent folders
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
deleteEmptyFolder(...)
Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
dirNameIsValid(dirName)
Signature: dirName:string -> bool

Partial validation for folder name, based on http://msdn.microsoft.com/en-us/library/aa365247.aspx

getFolderContents(...)
Signature: server:string -> user:string -> pwd:string -> destPath:string -> string list
getFtpDirContents(...)
Signature: server:string -> user:string -> pwd:string -> dirPath:string -> string
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Gets the contents/listing of files and folders in a given FTP server folder

Parameters

  • dirPath - The full name of folder whose content need to be listed
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
getServerInfo(...)
Signature: serverNameIp:string -> user:string -> password:string -> ftpMethod:string -> FtpServerInfo
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Gets a connection to the FTP server

getSubstring fromPos str toPos
Signature: fromPos:int -> str:string -> toPos:int -> string
isFolderPresent server user pwd destPath
Signature: server:string -> user:string -> pwd:string -> destPath:string -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Given a folder path, will check if that folder is present at a given root directory of a FTP server.

Parameters

  • destPath - The full name of folder which needs to be checked for existance, including all its parent folders
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
lastSlashPos(str)
Signature: str:string -> int
regexCheck fname ftpContents
Signature: fname:string -> ftpContents:string -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Checks to see if the ftp content string containts the string Given_Folder_Name

upload server user pwd fsi rootDir
Signature: server:string -> user:string -> pwd:string -> fsi:FileSystemInfo -> rootDir:string -> unit
uploadAFile(...)
Signature: server:string -> user:string -> pwd:string -> destPath:string -> srcPath:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Uploads a single file from local directory into remote FTP folder.

Parameters

  • destPath - The full local file path that needs to be uploaded
  • srcPath - The full path to file which needs to be created, including all its parent folders
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
uploadAFolder(...)
Signature: server:string -> user:string -> pwd:string -> srcPath:string -> rootDir:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Uploads a given local folder to a given root dir on a FTP server.

Parameters

  • srcPath - The local server path from which files need to be uploaded
  • rootDir - The remote root dir where files need to be uploaded, leave this as empty, if files need to be uploaded to root dir of FTP server
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • user - FTP Server login name (ex: "joebloggs")
  • pwd - FTP Server login password (ex: "J0Eblogg5")
writeChunkToReqStream chunk reqStrm br
Signature: chunk:byte [] -> reqStrm:Stream -> br:BinaryReader -> unit

Writes given byte array into the given stream