| Name | FTPit_GetAccountOption |
|---|
| Description | This function retrieves specific options out of the account you specify.
|
|---|
| Return Type | Varies |
|---|
| Format | FTPit_GetAccountOption ( AccountName ; OptionName ) |
|---|
| Required Parameters | AccountName The Name of the Account to return the Option from.
OptionName
- Host - The domain name or IP address of the FTP server for this account.
- Port - An alternate Port to use to connect to the FTP server for this account.
- Timeout - A Timeout setting in seconds to wait for the FTP server to respond to commands.
- Username - The Username to use when connecting to the FTP server.
- Password - The Password to use when connecting to the FTP server.
- PromptForPassword - Specifies whether or not FTPit Pro should Prompt the user for their Password instead of storing it with the rest of the Account information.
- SecureType - The type of secure connection to use when connecting to the FTP Server.
- SSLVerifyPeer - Whether or not the plug-in tries to verify the server certificate has been signed by a known certificate authority.
- SSLVerifyHost - Whether or not the plug-in tries to verify that the host you are connecting to is the host defined in the SSL certificate returned by the server.
- TLSVersion - The version of TLS to use when connecting. The default is TLS v1.2.
- SSHPublicKeyFile - The full path to your SSH Public Key file.
- SSHPrivateKeyFile - The full path to your SSH Private Key file.
- SSHKnownHostsFile - The full path to your SSH Known Hosts file.
- SSHKeyPassword - The password for your SSH Private Key file, if one is set.
- DataPortRangeStart - Starting TCP/IP Port number for the Data Port Connection. This is an advanced setting for when you must connect to the internet through a firewall. You will most likely never need to use this.
- DataPortRangeEnd - Ending TCP/IP Port number for the Data Port Connection. This is an advanced setting for when you must connect to the internet through a firewall. You will most likely never need to use this.
- Passive - Specifies if the connection type is Passive or not.
- DefaultCompletedScript - The name of the script that is used as the default for when FTPit Pro has completed a transfer.
- DefaultMode - Specifies whether transfers are done in "ASCII" or "Binary" mode by default.
- Json - Returns the entire account information as a json block. Useful for storing the account information in your database for transferring to another machine.
|
|---|
| Examples | - Example 1
This returns the Domain Name or IP Address of the ftp server for the "work ftp" account. FTPit_GetAccountOption( "work ftp" ; "Host" )
- Example 2
This would return 1 if the Account is set to use Passive mode or 0 if Passive mode is turned off. FTPit_GetAccountOption( "work ftp" ; "Passive" )
- Example 3
This will return all account options as a json block. FTPit_GetAccountOption ( "work ftp" ; "json" )
|
|---|
