MibToId
Determines the smaller of two Integer values. function Min AValueOne Integer AValueTwo Integer Integer Unit IdGlobal IE Parameters AValueOne Integer The first Integer value. AValueTwo Integer The second Integer value. Return Value Integer - The smaller of the two Integer values. Description Min is an Integer function used to determine the smaller of two Integer values. Min is provided to avoid any dependency on the Borland Math.pas unit. Converts an ordinal facility number to its...
TldMailBoxCreate
Constructor for the object instance. constructor Create AOwner TComponent override Parameters AOwner TComponent Owner of the object instance. Description Create is the Constructor for the object instance, and relies on the inherited Create method to initialize properties. Create also initializes the TldMessageCollection instance used in the MessageList propertie, using TldMessageltem C as the collection item class. Create calls Clear C to insure that other properties in the instance are reset...
FirstUnseenMsg [C
. ChangeableFlags C - empty set Clear also removes the contents of the DeleteMsgs, SearchResult, and MessageList C container properties. See Also TldlMAP4 C , TIdMailBoxAttributes C , TIdMessageFlagsSet C , TIdMessageFlagsSet C , TldMessageCollection C , TldMailBoxState C
IdCookieU TIdNetscapeCookie Members Properties
ClientCookie Represents the Cookie name and value. Represents the textual representation for a Cookie including attribute Indicates the life time of the Cookie. Secure Indicates the Cookie requires a secure communications channel. Value Represents persistent state data associated with a Cookie name. Methods Copies property values to the current object instance. Represents the identity for a Cookie header. Indicates the host system where a Cookie is valid. Path Specifies the subset of URLs valid...
GAntiFreeze
Application global variable containing an instance of a TldAntiFreezeBase descendant. GAntiFreeze TIdAntiFreezeBase nil Unit TIdAntiFreezeBase C uses the global variable GAntiFreeze, declared in the TIdAntiFreezeBase C unit, to determine if another instance has already been created. Note Only one instance of TIdAntiFreezeBase C is allowed per application. GAntiFreeze is initialized in the Create constructor of the first instance of TAntiFreezeBase used in the application. GAntiFreeze is set to...
TIdTCPServerOnBeforeCommandHandler
Represents the event handler signalled before CommandHandler usgage. property OnBeforeCommandHandler TIdBeforeCommandHandlerEvent Description OnBeforeCommandHandler is a TIdBeforeCommandHandlerEvent property that represents the event handler signalled before CommandHandlers is used to service an executing peer thread connection. Note OnBeforeCommandHandler does not indicate that a TldCommandHandler will located for a command from the client. Use OnNoCommandHandler to respond to event...
TIdMailBoxUIDNext
Indicates the next UID value for a messaged added to the mailbox. property UIDNext String Description UIDNext is a String property that indicates the next Unique Identifier value UID that will be assigned to a new message added to the currently selected mailbox. UIDNext is used with UIDValidity to determine the permanent Uniqueness identifier for a message in the currently selected mailbox. UIDNext is updatd when the IMAP4 client executes the TldlMAP4.StatusMailBox C method. See Also...
IdRexecServerpas
Unit Overview Classes in Unit IdRexecServer Implements a Remote Execution REXEC daemon. Types in Unit IdRexecServer Event type signalled to perform authentication and execution of the RExec session. IdRexecServer.pas contains types and classes neede to implement a multi-threaded TCP-based Remote Execution Protocol REXEC server. IdRexec.pas C , TldRexecServer C , TIdRexec C , Technical Support CI
EncodeJP
Converts Shift_JIS to IS0-2022-JP character set encoding. function Encode2022JP const S string string Unit const S string Values to be converted. String - Values in IS0-2022-JP character set. Description Decode2022JP C is a String function that converts Shift_JIS character set encodings to the ISO-2022-JP character set, in accordance with the operation described in the Internet Standards document , RFC 1468 - Japanese Character Encoding for Internet Messages
TIdTelnetDataAvailEvent
Event type that occurs when data is received by the TELNET client. TIdTelnetDataAvailEvent procedure Sender TIdTelnet const Buffer String of object Unit IdTelnet U Parameters Buffer Data read from the host. Description TIdTelnetDataAvailEvent is the event type triggered when data is read from the host connection for a TIdTelnet C client. Buffer represents the data read from the TldTelnetReadThread C and provided to the OnDataAvailable event handler in TIdTelnet
TWorkEvent
Indicates that the read or write operation is being performed. TWorkEvent procedure Sender TObject AWorkMode TWorkMode const AWorkCount Integer of object Number of bytes affected by the event. AWorkMode The operation to be performed. Object instance triggering the event. Description This event often fires when a component is receiving or sending data and this event is often used to update progress indicators. AWorkMode indicates if the component is receiving or sending data and can be one of...
ldSMTPServer[C TldSMTPServer Members Properties
Indicates if the server implements the EHLO command. Messages Indicates Authorization is used for the client connection prior to accepting MAIL data from the client connection. Represents replies that can be sent in responses to SMTP command verbs. Indicates if the server can parse incoming message headers. Indicates if encoding is allowed when processing mail data from a client connection. Indicates the method used to receive and process incoming mail data. Events Event handler signalled when...
TIdSSLSocket
Implements a socket connection for the SSL transport protocol. TIdSSLSocket class TObject Class Hierarchy TObject TIdSSLSocket IdSSLOpenSSLlU TIdSSLSocket Members Properties X.509 certificate fora peer on the SSL socket ICI connection. Creates and binds a new SSL socket CI. Create Constructor for the object instance. GetSessionID SSL session identifier for the SSL socket m SetCipherList SetCipherList is not currently implemented. Creates and binds a new client SSL socket CI. Destroy...
TIdThreadSafe
Implements the ancestor for thread-safe data types. TIdThreadSafe class Class Hierarchy IdThreadSafe U TIdThreadSafe Members Methods Constructor for the object instance. Frees the object instance. Enables resource protection for the associated data type. Disables resource protection for the associated data type. TIdThreadSafe is a TObject descendant that represents the base class for thread-safe data types in Indy applications. TIdThreadSafe uses a protected TCriticalSection to provide resource...
TIdCustomThreadComponentData
Provides object data for the internal thread of execution. property Data TObject Description Data is a TObject property used to provide optional values to the internal thread used in executing the threaded component object. Read and Write access to the Data property is delegated to Data property in the underlying TldThread instance. Note Data is not maintained in either Create or Destroy Applications must allocate and free the TObject descendant used in the Data property.
Fetch
Parses a value from the delimited input string. function Fetch var AInput string const ADelim string IdFetchDelimDefault const ADelete Boolean IdFetchDeleteDefault const ACaseSensitive Boolean IdFetchCaseSensitiveDefault string Value to be parsed. const ADelim string IdFetchDelimDefault Delimiter character s . Default value is IdFetchDelimDefault IC1. const ADelete Boolean IdFetchDeleteDefault Remove the parsed value from the input string. Default value is IdFetchDeleteDefault C . const...
TidTelnetServerDoAuthenticate
Implements user authentication for a connection. function DoAuthenticate AThread TIdPeerThread const AUsername string const APassword string boolean virtual The connection to authenticate. const AUsername string The authentication user name. const APassword string THe authentication password. Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site. DoAuthenticate is a Boolean function used to implement authentication for a TELNET connection....
IdTelnetServerpas
Unit Overview Classes in Unit IdTelnetServer Implements a thread client for TELNET server connections. TTelnetData Cl Encapsulates storage for information used by a Telnet connection. Types in Unit IdTelnetServer Specifies the event type for user authentication in a TELNET connection. Constants in Unit IdTelnetServer Maximum login attempts for a threaded connection to the Telnet server. Specifies a Telnet Protocol server architecture. Specifies an event type for TELNET option negotiation....
TldAuthenticationManaaerAddAuthentication
Adds a new authentication mechanism to the collection for the component, procedure AddAuthentication AAuthtetication TIdAuthentication AURL TIdURI Parameters AAuthtetication TIdAuthentication Authentication mechanism to add. AURL TIdURI Resource locator for the authentication. Description AddAuthentication is a convenience procedure that creates a new authentication class instance in the Authentications HI collection maintained by the component. AddAuthentication calls the Add method for the...
TIdPOPRetrieveMailBoxSize
Gets the mailbox size on the POP3 server. function RetrieveMailBoxSize integer Return Value Integer - Mailbox size in bytes, or -1 on error. Description RetrieveMailBoxSize is an Integer function that retrieves the total size of the mailbox on the POP server. The value is returned in bytes. RetrieveMailBoxSize will return 0 when the mailbox is empty, or -1 when an exception is raised. RetrieveMailBoxSize uses the POP3 LIST command to accumulate the total mailbox size from the values returned...
IdSSPIpas
Unit Overview Classes in Unit IdSSPI SEC_NEGOTIATION_INFO C SEC_WINNT_AUTH_IDENTITY_EXA ICl SEC_WINNT_AUTH_IDENTITY_W C SecBufferDesc H SecHandle m SecPkgContextAuthorityW ICl SecPkgContext_Flags H SecPknContext KevlnfowlCl SecPkgContext_NamesA H SecPkgContext_NativeNamesA m SecPkgContextNegotiationlnfoA m SecPkgContext_PackageInfoA m SecPkgContextPasswordExpiry Cl SecPkgContextProtolnfoW Cl SecPkgContext_Sizes SecPkgContextUserFlags C SecPkgCredentialsNamesW Cl SecPkalnfowlCl...
TIdTCPConnectionRaiseExceptionForLastCmdResult
Handles creating an exception when an error occurs during response processing. procedure RaiseExceptionForLastCmdResult virtual overload Parameters Exception class tyope to use for creating this exception. Description RaiseExceptionForLastCmdResult is an overloaded procedure in TldTCPConnection that allows the client or descendant classes to create an exception using another Indy exception class type and or the values in LastCmdResult ICI. When the TCIassldException C variant is used, an...
TidTCPConnectionGetinternalResponse
Impelements reading of response detail lines from a peer connection. procedure GetInternalResponse Description GetInternalResponse is a public procedure used to implement the processing required for the GetResponse C method. GetInternalResponse clears the values in CmdResultDetails, and reads one or more reponse lines from a peer connection using ReadLnWait C The initial response line is expected to contain the 3-digit response code and text. Additional response lines are read when the initial...
TIdSMTPConnect
Opens a connection to the SMTP server. procedure Connect const ATimeout Integer IdTimeoutDefault override Parameters const ATimeout Integer IdTimeoutDefault Connection timeout in milliseconds. Default value is IdTimeoutDefault CI. Description Connect is a procedure that opens a connection to the SMTP server using the Host and Port properties. An exception will be raised if the connection fails or returns an invalid SMTP response code. After establishing the socket E connection, Connect will...
TldMappedPortTCPOnOutboundData
Event handler signalled when data is available to send C to the remote computer system, property OnOutboundData TIdMappedPortThreadEvent Description OnOutboundData is a TIdMappedPortThreadEvent C property that represents the event handler signalled when data has been read from the local client connection to the port-based proxy server. OnOutboundData is used during execution of the client thread after the local and remote connections have been established, after data has been read from the...
TidTCPConnectionLastCmdResult
Represents response code and text values for the last command requested. property LastCmdResult TIdRFCReply Description LastCmdResult is a read-only TIdRFCReply property that represents the complete response message received during execution of a command request on the client connection. LastCmdResult contains the response code, in numeric and text form, and one or more lines of text from the response message. LastCmdResult is updated when SendCmd sends the client request on the connection, and...
TIdTrivialFTPServer
Implements a Trivial File Transfer Protocol server. TIdTrivialFTPServer class TIdUDPServer Class Hierarchy TComponent TldBaseComponent TldComponent ICI TldUDPBaselCl TIdUDPServer CI TIdTrivialFTPServer IdTrivialFTPServer C TIdTrivialFTPServer Members Events Event handler signalled to read a file on the local file system. Specifies an event handler for completed TFTP transfers. Specifies the event handler for client Put operations. Methods TIdTrivialFTPServer is a TIdUDPServer C descendant that...
IdTCPServerll TIdCommand Members Properties
Represents the command handler that generated the object instance. PerformReply Indicates that the Reply E should be sent to the peer prior to the response. Reply Contains the numeric and text content of an RFC reply. Thread Represents the thread of execution for the peer connection in the command. Methods Constructor for the object instance. SendReply Sends the contents of the RFC reply to the peer connection. Contains parsed parameter values for the command object. RawLine Text data read from...
IdNetworkCalculatorpas
Unit Overview Classes in Unit IdNetworkCalculator Represents the class type for an IP address. Provides persistent storage and manipulation for network address and mask values. Specifies valid network class values used by TldNetworkCalculator CI. Constants in Unit IdNetworkCalculator ID_NC_MASK_LENGTH CI Default length of network masks for TldNetworkCalculatorlE object instances. TIdNetworkCalculator IE Implements an IP address calculator. Provides storage for the components of an IP address or...
TIdIMAPRetrieveAllHeaders
Retrieves headers for all messages in a mailbox and populates the specified message collection. function RetrieveAllHeaders AMsgList TIdMessageCollection Boolean Parameters AMessageList Message collection to be populated. Return Value Boolean - True on success. Description RetrieveAllHeaders is a Boolean function that retrieves headers for all messages in the currently selected mailbox, and populates the message collection specified in AMessageList with message instances to store the headers....
TIdAntiFreezeBaseOnlyWhenIdle
Specifies the component should yield when the main thread is idle. property OnlyWhenIdle Boolean Description OnlyWhenIdle is a Boolean property that indicates when TldAntiFreezeBase HI should yield when the Application main thread is idle. Set OnlyWhenIdle to True to prevent the component from yielding when the application main thread is not idle in DoProcess HI- Set OnlyWhenIdle to False to allow the component to yield when ShouldUse HI is True. The default value for OnlyWhenIdle is HI as...
TOnListDirectoryEvent
Event type signalled when a directory listing is needed for an FTP client connection. TOnListDirectoryEvent procedure ASender TIdFTPServerThread const APath string ADirectoryListing TIdFTPListItems of object ADirectoryListing Collection of file items for the listing. File system directory for the listing. Client connection for the event notification. TOnListDirectoryEvent is an event type signalled when an FTP server implementation needs to prepare and process a directory listing for the client...
ldFTPServer[C TldFTPServerThread Members Properties
Indicates space tpo reserve for new files stored on the FTP server. CurrentDir Indicates the currently selected directory path for the FTP client. DataMode Indicates if the FTP client has successfully authenticated the user account for DataChannelThread Represents the threaded data channel used for data transmission for an FTP client connection. Represents the transmission mode requested for an FTP client connection. Indicates the port number for the DataChannel in an FTP client connection....
IdSNTP [ Description
The TLr structure is an internal packed record structure used to handle the byte order of LongInt values received in a TNTPGram datagram. TLr is used to flip the order of bytes when TTIdSNTP.DateTime updates the value of Originate, Destination, Transmit, and Receive timestamps. L1 is used to store the value of byte 1 of 4 bytes in the TLr structure. L2 is used to store the value of byte 2 of 4 bytes in the TLr structure. L3 is used to store the value of byte 3 of 4 bytes in the TLr structure....
Parameters Tys
Response line to be parsed. var ANewsGroup String Newsgroup name from the response line. var AHi Integer Highest message number from the response line. var ALo Integer Lowest message number from the response line. var AStatus String Posting status information for the newsgroup. Description ParseNewsGroup is a procedure used to parse values returned in an NNTP response that includes associated information about one or more newsgroups on the NNTP server. ParseNewsGroup is used to decode an...
IdGlobalU Description Uon
TIdReuseSocket is an enumerated type that represents the manner in which socket C reuse is supported in Indy TCP servers. TIdReuseSocket can contain one of the following values and associated meanings a rsOSDependent - Reuse IP addersses and port numbers when the OS platform is Linux. a rsTrue - Always resuse IP addersses and port numbers. a rsFalse - Never resuse IP addersses and port numbers. TIdReuseSocket is the type used to represent the TldTCPServer.ReuseSocket 3 property, and indicates...
TldCustomHTTPServerOnCommandOther
Represents the event handler for unknown HTTP commands. property OnCommandOther TIdHTTPOtherEvent Parameters The command from the HTTP request. asData The data from the HTTP request. asVersion The version number from the HTTP request. The peer thread generating the event. Description OnCommandOther is the TIdHTTPOtherEvent event handler used to respond to unknown HTTP commands. OnCommandOther is used during execution of the threaded client connection when a command other than GET, POST, or HEAD...
OnFTPStatus
Event handler used to signal a change in the FTP connection status. Description OnFTPStatus is a TldFTPStatusEvent property that represents the event handler signalled when the state of the FTP client connection is changed. OnFTPStatus is signalled in Connect, after successfully opening the client connection, to indicate the value ftpReady. OnFTPStatus is used in the internal implementation of Get and Put to indicate the status of the connection at various times. OnFTPStatus is signalled using...
TldThread
Ancestor for all Indy threads. TIdThread class TIdBaseThread Class Hierarchy TThread TIdBaseThread 11 TldThread IC1 IdThreadH TldThread Members Properties Storage slot for data used by a thread. Stopped Indicates whether a thread is stopped. TerminatingExceptionClass Represents the class type for an exception raised during Execute. Events Handles exceptions raised in the thread of execution. Methods Create is the constructor for the TldThread j instance. Start Starts or resumes iteration of the...
TIdIMAPServerOnCommandSTORE
Event handler for the IMAP4 STORE command. property OnCommandSTORE TCommandEvent Parameters Indicates the command has been handled in the event handler. Client thread for the event notification. Description OnCommandSTORE is a TCommandEvent C property that represents the event handler triggered when a client issues the IMAP4 STORE command. OnCommandSTORE allows the server to perform processing required to store message data for the message set and data items specified in CmdStr in the currently...
TIdHeaderList
Implements a collection of header names and values. TIdHeaderList class TStringList Class Hierarchy ldHeaderList C TIdHeaderList Members Properties Indicates if header name comparisons are case sensitive. Indicates that header lines can be folded when the maximum length is Delimiters used to separate header names and header values. Allows access to header values by name. Methods Converts text line in NAME VALUE form to their TIdHeaderList Constructor for the object instance. IndexOfName Returns...
Description Gpa
This class implements Unix Remote Execution Rexec as a client. The Rexec protocol is sometimes used to run tasks from remote locations while requiring password authentication. This protocol was originally intended as a temporary hack in some older Berkeley Unix Distributions that came into wide usage. Note that while this protocol is a little more secure than RSH, it still can pose a security hazard on the Internet because the User ID and password are sent in plain-text and that can easily be...
Description Xzo
GetBody is an overloaded Boolean function in TldNNTP used to retrieve the message body for a NNTP article. GetBody ICI calls SendCmd C using the NNTP BODY command to retrieve body lines. The overloaded functions provide for retrieving the body for the article using a numeric message number, a message identifier string, or the NNTP current article pointer. The overloaded GetBody C functions also provide for storing the body lines for the selected article in a TIdMessage C instance, as text in a...
IdTunnelMasterpas
Performs communication with service threads. TSIaveData IC1 Represents a service thread for a tunnel server. Types in Unit IdTunnelMaster TldSendMsgEvent C TldSendTrnEvent C1 TldTunnelEventC C IdTunnelMaster.pas contains Classes, Types, Procedures, and Functions needed to define and implement the master controller for IP tunnel connections.
TIdIcmpClientPin
Sends an echo request and receives an echo response. procedure Ping ABuffer String '' SequenceID word 0 Description Ping is used to prepare and send C and echo request, and to receive the echo response. Ping sends the echo request to the computer identified in Host C , and gets the response to the echo request datagram. Set ReceiveTimeout C to indicate the time to wait for a response to the echo request datagram. Use ReplyStatus C to access the TReplyStatus C received as a response to the echo...
TIdFTPTransferMode
procedure TransferMode ATransferMode TIdFTPTransferMode Parameters ATransferMode TIdFTPTransferMode Transfer mode for the connection. Description TransferMode is a procedure that implements the FTP MODE command. TransferMode sends the character representation of the TIdFTPTransferMode Rvalue specified in ATransferMode. Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site. TransferMode has no effecet if the client is not Connected. See Also...
TIdHashMessageDigest
Specifies the abstract base class for Indy message digest classes. TIdHashMessageDigest class TIdHash128 Class Hierarchy TObject TldHash TldHash128 TIdHashMessageDigest TIdHashMessageDigest is a TldHash128 descendant that acts an abstract base class for Indy classes that use a message digest algorithm to produce a 128-bit fingerprint for arbitrary bytes values in an input stream. TldHashMessageDigest2 TldHashMessageDigest4 TldHashMessageDigest5
TIdHashMessageDigest Quc
Implements the MD4 message digest encryption algorithm. TIdHashMessageDigest4 class TIdHashMessageDigest Class Hierarchy TObject TldHash C TldHash128 j TIdHashMessageDigest IQ TldHashMessageDigest4 P I IdHashMessageDigest Q TIdHashMessageDigest4 Members Methods Implements calculation of the 128-bit 'fingerprint or message digest for the MD4 message digest algorithm. TldHashMessageDigest4 is a TIdHashMessageDigest descendant that implements the RSA-MD4 encryption algorithm as described in the...
TIdTelnetOnDataAvailable
Specifies the event handler for processing data received from the host. property OnDataAvailable TIdTelnetDataAvailEvent Description OnDataAvailable is the TIdTelnetDataAvailEvent event handler used to handle data received from the host. OnDataAvailable processes and applies the data read with TelnetThread Applications must assign a procedure to the OnDataAvailable event handler to allow the TIdTelnet object to determine how data from the host is applied. TIdTelnetDataAvailEvent ,...
RegisterAuthenticationMethod
Associates an authentication class instance with a given method name. procedure String AuthClass TIdAuthenticationClass Unit Authentication Parameters MethodName String Name that represents the authentication scheme. AuthClass TIdAuthenticationClass Class instance to associate with the specified name. Description RegisterAuthenticationMethod is a procedure that registers the authentication class instance in AuthClass using the scheme name in MethodName. RegisterAuthenticationMethod stores the...