Indy 9 | Content | Index | Reference

TIdFtpProxySettings
Hierarchy, Properties, Methods, See Also, Unit: IdFTP
Represents settings for procied connections to an FTP server.

    TIdFtpProxySettings = class(TPersistent)

Unit
IdFTP
Description
TIdFtpProxySettings is a TPersistent descendant that represents settings used for proxied connections to an FTP server in TIdFTP. TIdFtpProxySettings includes properties that identify the proxy connection type, Host and Port for the control channel connection, and Username and Password for login authentication. TIdFtpProxySettings is the type used to represent the TIdFTP.ProxySettings property.

TIdFtpProxySettings.Host
TIdFtpProxySettings, See Also
Represents the address of the proxy server for FTP client connections.

    property Host: String;

Description
Host is a String property that represents the IP address or host name for the computer acting as a proxy server for FTP client connections. Values in Host and Port are used in TIdFTP.Connect when ProxyType contains a TIdFtpProxyType value other than fpcmNone.

TIdFtpProxySettings.Password
TIdFtpProxySettings, See Also
User identity for authenticating a client connection to an FTP proxy server.

    property Password: String;

Description
Password is a String property that represents the user authorization provided for authentication of client connections to an FTP proxy server. Values in UserName and Password are used in TIdFTP.Login when ProxyType contains a TIdFtpProxyType value other than fpcmNone.

TIdFtpProxySettings.Port
TIdFtpProxySettings, See Also
Port number used for connection to the FTP proxy server.

    property Port: Integer;

Description
Port is an Integer property that represents the port number used for connections to the computer acting as a proxy server for FTP client connections. Values in Host and Port are used in TIdFTP.Connect when ProxyType contains a TIdFtpProxyType value other than fpcmNone.

TIdFtpProxySettings.ProxyType
TIdFtpProxySettings, See Also
Connection mode to use for connections to the FTP proxy server.

    property ProxyType: TIdFtpProxyType;

Description
ProxyType is a TIdFtpProxyType property that represents the connection and authentication methods permitted for proxied connections to an FTP server. ProxyType is used in TIdFTP.Login to determine the method and values used for authenticating the proxied connection to the FTP server, according to the following proxy type values and methodologies:

- fpcmNone - Sends the FTP client Username and optional Password.

- fpcmUserSite - Sends the ProxySettings Username and optional Password, followed immediately by the FTP client Username and optional Password.

- fpcmSite - Sends the ProxySettings Username and optional Password, sends the SITE command and the FTP Host property, and the FTP client Username and optional Password.

- fpcmOpen - Sends the ProxySettings Username and optional Password, sends the OPEN command with the FTP Host property, and the FTP client Username and optional Password.

- fpcmUserPass - Calls SendCmd with the command USER user@proxyuser@host, calls SendCmd with the command PASS pwd@proxypwd, or optionally PASS pwd.

- fpcmTransparent - Sends the ProxySettings Username and optional Password, followed immediately by the FTP client Username and optional password.

- fpcmHttpProxyWithFtp - Not implemented at this time.

TIdFtpProxySettings.UserName
TIdFtpProxySettings, See Also
User identity for authenticating a client connection to an FTP proxy server.

    property UserName: String;

Description
UserName is a String property that represents the user name provided for authentication of client connections to an FTP proxy server. Values in UserName and Password are used in TIdFTP.Login when ProxyType contains a TIdFtpProxyType value other than fpcmNone.

TIdFtpProxySettings.Assign
TIdFtpProxySettings, See Also
Assigns values from a persistent object to the current object instance.

    procedure Assign(Source: TPersistent); override;

Parameters
Source: TPersistent
Persistent object to use as the source for property values.
Description
Assign is a procedure that assigns values from the persistent object instance in Source to the current object instance. When Source is an instance of TIdFtpProxySettings, the following property values are assigned to the current object instance:

- ProxyType

- UserName

- Password

- Host

- Port

When Source is not an instance of TIdFtpProxySettings, Assign calls the inherited method using Source as an argument.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.