# POP Component The POP Component is used to easily retrieve electronic mail from internet post office servers (POP). ## Syntax ```text TipwPOP ``` ## Remarks The POP Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [SSLServerAuthentication](#sslserverauthentication-event-pop-component) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-pop-component) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-pop-component) method. The POP Component implements a standard internet post office (POP3) client as specified in RFC 1725. To connect to a [MailServer](#mailserver-property-pop-component), first set the appropriate [User](#user-property-pop-component) and [Password](#password-property-pop-component) and then connect by calling the [Connect](#connect-method-pop-component) method. Upon successful connection to the [MailServer](#mailserver-property-pop-component), the number of waiting messages is shown by the [MessageCount](#messagecount-property-pop-component) property. A message is selected by setting the [MessageNumber](#messagenumber-property-pop-component) property to a number between 1 and [MessageCount](#messagecount-property-pop-component) (inclusive). Then, the message text and headers are received by calling the [Retrieve](#retrieve-method-pop-component) method. The message text is received through the [Transfer](#transfer-event-pop-component) event, whereas the message headers are received through the [Header](#header-event-pop-component) event. Additionally, up to [MaxLines](#maxlines-property-pop-component) from the message body are provided in the [MessageText](#messagetext-property-pop-component) property. The body of the message is also saved in the file specified by the [LocalFile](#localfile-property-pop-component) property. [StartTransfer](#starttransfer-event-pop-component) and [EndTransfer](#endtransfer-event-pop-component) events are fired at the beginning and end of message transmission. The [PITrail](#pitrail-event-pop-component) event provides a trace of the interaction between the client and server (excluding message transfers). ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthMechanism](#authmechanism-property-pop-component) | This property includes the authentication mechanism to be used when connecting to the mail server. | | [Connected](#connected-property-pop-component) | Whether the component is connected. | | [Firewall](#firewall-property-pop-component) | A set of properties related to firewall access. | | [Idle](#idle-property-pop-component) | The current status of the component. | | [IncludeHeaders](#includeheaders-property-pop-component) | This property instructs the component to include the headers in the MessageText and LocalFile. | | [LastReply](#lastreply-property-pop-component) | This property indicates the last reply received from the server. | | [LocalFile](#localfile-property-pop-component) | This property includes the path to a local file to download the message body. If the file exists, it is overwritten (optional). | | [LocalHost](#localhost-property-pop-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [MailPort](#mailport-property-pop-component) | This property includes the server port for POP (default 110). | | [MailServer](#mailserver-property-pop-component) | This property includes the name or address of a mail server (internet post office server). | | [MaxLines](#maxlines-property-pop-component) | This property includes the maximum number of message lines other than headers to retrieve. | | [Message](#message-property-pop-component) | This property provides the raw message content. | | [MessageCc](#messagecc-property-pop-component) | This property includes the value of the CC header of the last retrieved message. | | [MessageCount](#messagecount-property-pop-component) | This property includes the number of messages in the mailbox. | | [MessageDate](#messagedate-property-pop-component) | This property includes the value of the date header of the last retrieved message. | | [MessageFrom](#messagefrom-property-pop-component) | This property includes the value of the from header of the last retrieved message. | | [MessageHeaders](#messageheaders-property-pop-component) | This property includes a collection of the message headers as retrieved from the server. | | [MessageHeadersString](#messageheadersstring-property-pop-component) | This property includes a string representation of the full headers of the message as retrieved from the server. | | [MessageNumber](#messagenumber-property-pop-component) | This property includes the current (selected) message. | | [MessageRecipients](#messagerecipients-property-pop-component) | This property includes a collection of recipients for the current message. | | [MessageReplyTo](#messagereplyto-property-pop-component) | This property includes the value of the Reply-To header of the last retrieved message. | | [MessageSubject](#messagesubject-property-pop-component) | This property includes the value of the Subject header of the last retrieved message. | | [MessageText](#messagetext-property-pop-component) | This property includes the full text of the message as retrieved from the server. | | [MessageTo](#messageto-property-pop-component) | This property includes the value of the To header of the last retrieved message. | | [OAuth](#oauth-property-pop-component) | The OAuth settings. | | [Password](#password-property-pop-component) | This property includes the password for the mailbox user. | | [SSLAcceptServerCert](#sslacceptservercert-property-pop-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-pop-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLEnabled](#sslenabled-property-pop-component) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [SSLProvider](#sslprovider-property-pop-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-pop-component) | The server certificate for the last established connection. | | [SSLStartMode](#sslstartmode-property-pop-component) | This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. | | [Timeout](#timeout-property-pop-component) | The timeout for the component. | | [User](#user-property-pop-component) | This property includes the user identifier for the mailbox. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-pop-component) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-pop-component) | This method connects to the mail server and attempts to log in. | | [Delete](#delete-method-pop-component) | This method deletes a message specified by MessageNumber on the server. | | [Disconnect](#disconnect-method-pop-component) | This method disconnects from the mail server. | | [DoEvents](#doevents-method-pop-component) | This method processes events from the internal message queue. | | [Interrupt](#interrupt-method-pop-component) | This method interrupts the current method. | | [ListMessageSizes](#listmessagesizes-method-pop-component) | This method retrieves a list of all message sizes from the server. | | [ListMessageUIDs](#listmessageuids-method-pop-component) | This method retrieves a list of all message UIDs from the server. | | [LocalizeDate](#localizedate-method-pop-component) | This method converts a valid RFC 822 message date to a local date and time. | | [QueryMessageSize](#querymessagesize-method-pop-component) | This method returns the size in bytes of the current message. | | [QueryMessageUID](#querymessageuid-method-pop-component) | This method returns the unique identifier (UID) of the message as specified by the server. | | [QueryTotalSize](#querytotalsize-method-pop-component) | This method returns the cumulative size in bytes of messages in the mailbox (including headers). | | [Reset](#reset-method-pop-component) | This method will reset the component. | | [ResetState](#resetstate-method-pop-component) | Resets all changes and reverts back to the state the component was in when the user first connected. | | [Retrieve](#retrieve-method-pop-component) | This method retrieves a message specified by MessageNumber from the server. | | [RetrieveHeaders](#retrieveheaders-method-pop-component) | This method retrieves headers for a message specified by MessageNumber . | | [SendCommand](#sendcommand-method-pop-component) | This method sends the exact command directly to the server. | | [SetMessageStream](#setmessagestream-method-pop-component) | This method sets the stream to which the message downloaded from the server will be written. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ConnectionStatus](#connectionstatus-event-pop-component) | Fired to indicate changes in the connection state. | | [EndTransfer](#endtransfer-event-pop-component) | This event is fired when the message completes transferring. | | [Error](#error-event-pop-component) | Fired when information is available about errors during data delivery. | | [Header](#header-event-pop-component) | This event is fired for every message header being retrieved. | | [LaunchBrowser](#launchbrowser-event-pop-component) | Fires before launching a browser with the authorization URL. | | [Log](#log-event-pop-component) | Fired once for each log message. | | [MessageList](#messagelist-event-pop-component) | This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs . | | [PITrail](#pitrail-event-pop-component) | This event traces the commands sent to the mail server, and the respective replies. | | [SSLServerAuthentication](#sslserverauthentication-event-pop-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-pop-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-pop-component) | This event is fired when the message starts transferring. | | [Transfer](#transfer-event-pop-component) | This event is fired when the message is transferred from MailServer . | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. | | [AutoDecodeSubject](#AutoDecodeSubject) | Instructs the component to automatically decode message subjects. | | [GetMessageSize](#GetMessageSize) | Whether to poll the server for the message size prior to retrieving it. | | [MaxLineLength](#MaxLineLength) | The maximum expected length for message lines. | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the component binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AuthMechanism Property ([POP](#pop-component) Component) This property includes the authentication mechanism to be used when connecting to the mail server. ## Syntax *Delphi Syntax* ```text property AuthMechanism: TipwTAuthMechanisms read get_AuthMechanism write set_AuthMechanism; TipwTAuthMechanisms = ( amUserPassword, amCRAMMD5, amNTLM, amAPOP, amSASLPlain, amSASLDigestMD5, amKerberos, amXOAUTH2 ); ``` ## Default Value amUserPassword ## Remarks This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to log in to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication. amSASLPlain (4) is also available, but most servers require a Secure Sockets Layer (SSL) connection when utilizing this authentication mechanism. amKerberos (6) is for Kerberos authentication. NOTE: This functionality is available only in Windows. # Connected Property ([POP](#pop-component) Component) Whether the component is connected. ## Syntax *Delphi Syntax* ```text property Connected: Boolean read get_Connected; ``` ## Default Value false ## Remarks This property is used to determine whether or not the component is connected to the remote host. Use the [Connect](#connect-method-pop-component) and [Disconnect](#disconnect-method-pop-component) methods to manage the connection. This property is read-only and not available at design time. # Firewall Property ([POP](#pop-component) Component) A set of properties related to firewall access. ## Syntax *Delphi Syntax* ```text property Firewall: TipwFirewall read get_Firewall write set_Firewall; ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # Idle Property ([POP](#pop-component) Component) The current status of the component. ## Syntax *Delphi Syntax* ```text property Idle: Boolean read get_Idle; ``` ## Default Value true ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # IncludeHeaders Property ([POP](#pop-component) Component) This property instructs the component to include the headers in the MessageText and LocalFile. ## Syntax *Delphi Syntax* ```text property IncludeHeaders: Boolean read get_IncludeHeaders write set_IncludeHeaders; ``` ## Default Value false ## Remarks This property instructs the component to include the headers in the MessageText and LocalFile. If set to True, the headers for the message being retrieved will be placed before the message body in the [MessageText](#messagetext-property-pop-component) property;. If [LocalFile](#localfile-property-pop-component) is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the [MIME](MIME.md#MIME) component for further message processing. # LastReply Property ([POP](#pop-component) Component) This property indicates the last reply received from the server. ## Syntax *Delphi Syntax* ```text property LastReply: String read get_LastReply; ``` ## Default Value '' ## Remarks This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the [PITrail](#pitrail-event-pop-component) event. This property is read-only. # LocalFile Property ([POP](#pop-component) Component) This property includes the path to a local file to download the message body. If the file exists, it is overwritten (optional). ## Syntax *Delphi Syntax* ```text property LocalFile: String read get_LocalFile write set_LocalFile; ``` ## Default Value '' ## Remarks This property is used when retrieving a message. If this property is empty, then the received data are provided through the parameters of the [Transfer](#transfer-event-pop-component) event. Note: If you are not retrieving the entire message ([MaxLines](#maxlines-property-pop-component) is nonzero), no data will be written to LocalFile. # LocalHost Property ([POP](#pop-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Delphi Syntax* ```text property LocalHost: String read get_LocalHost write set_LocalHost; ``` ## Default Value '' ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # MailPort Property ([POP](#pop-component) Component) This property includes the server port for POP (default 110). ## Syntax *Delphi Syntax* ```text property MailPort: Integer read get_MailPort write set_MailPort; ``` ## Default Value 110 ## Remarks This property contains the server port for POP (default 110). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. For implicit Secure Sockets Layer (SSL), use port 995 (please refer to the [SSLStartMode](#sslstartmode-property-pop-component) property for more information). This property is not available at design time. # MailServer Property ([POP](#pop-component) Component) This property includes the name or address of a mail server (internet post office server). ## Syntax *Delphi Syntax* ```text property MailServer: String read get_MailServer write set_MailServer; ``` ## Default Value '' ## Remarks This property specifies the IP address (IP number in dotted internet format) or the domain name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress. If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception. If the component is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. # MaxLines Property ([POP](#pop-component) Component) This property includes the maximum number of message lines other than headers to retrieve. ## Syntax *Delphi Syntax* ```text property MaxLines: Integer read get_MaxLines write set_MaxLines; ``` ## Default Value 0 ## Remarks This property is used to limit the number of text lines other than headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message. The default value of the property is 0. In this case, the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to [LocalFile](#localfile-property-pop-component). # Message Property ([POP](#pop-component) Component) This property provides the raw message content. ## Syntax *Delphi Syntax* ```text property Message: String read get_Message; property MessageB: TBytes read get_MessageB; ``` ## Default Value '' ## Remarks This property is populated after calling [Retrieve](#retrieve-method-pop-component) and holds the raw message content. This can be used to access the data before any processing is done by the component. This property is read-only and not available at design time. # MessageCc Property ([POP](#pop-component) Component) This property includes the value of the CC header of the last retrieved message. ## Syntax *Delphi Syntax* ```text property MessageCc: String read get_MessageCc; ``` ## Default Value '' ## Remarks This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the [Header](#header-event-pop-component) event. This property is read-only. # MessageCount Property ([POP](#pop-component) Component) This property includes the number of messages in the mailbox. ## Syntax *Delphi Syntax* ```text property MessageCount: Integer read get_MessageCount; ``` ## Default Value 0 ## Remarks This property contains the number of messages in the mailbox. When the component is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server. This property is read-only. # MessageDate Property ([POP](#pop-component) Component) This property includes the value of the date header of the last retrieved message. ## Syntax *Delphi Syntax* ```text property MessageDate: String read get_MessageDate; ``` ## Default Value '' ## Remarks This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the [Header](#header-event-pop-component) event. This property is read-only. # MessageFrom Property ([POP](#pop-component) Component) This property includes the value of the from header of the last retrieved message. ## Syntax *Delphi Syntax* ```text property MessageFrom: String read get_MessageFrom; ``` ## Default Value '' ## Remarks This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the [Header](#header-event-pop-component) event. This property is read-only. # MessageHeaders Property ([POP](#pop-component) Component) This property includes a collection of the message headers as retrieved from the server. ## Syntax *Delphi Syntax* ```text property MessageHeaders: TipwHeaderList read get_MessageHeaders; ``` ## Remarks This property contains a collection of the message headers as retrieved from the server. If the component is not connected, or [MessageNumber](#messagenumber-property-pop-component) does not contain a valid message number, the value of this property is an empty collection. Otherwise, it contains a parsed collection of the full headers of the mail message as reported by the server. The [MailServer](#mailserver-property-pop-component) is asked about the headers of the message only if the [MessageNumber](#messagenumber-property-pop-component) property has changed. If [MessageNumber](#messagenumber-property-pop-component) has not changed, the component returns a cached value. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders ``` This property is read-only. Please refer to the [Header](#header-type) type for a complete list of fields. # MessageHeadersString Property ([POP](#pop-component) Component) This property includes a string representation of the full headers of the message as retrieved from the server. ## Syntax *Delphi Syntax* ```text property MessageHeadersString: String read get_MessageHeadersString; ``` ## Default Value '' ## Remarks This property contains a string representation of the full headers of the message as retrieved from the server. If the component is not connected, or [MessageNumber](#messagenumber-property-pop-component) does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server. The [MailServer](#mailserver-property-pop-component) is asked about the headers of the message only if the [MessageNumber](#messagenumber-property-pop-component) property has changed. If [MessageNumber](#messagenumber-property-pop-component) has not changed, the component returns a cached value. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeadersString = POPControl.MessageHeadersString ``` This property is read-only. # MessageNumber Property ([POP](#pop-component) Component) This property includes the current (selected) message. ## Syntax *Delphi Syntax* ```text property MessageNumber: Integer read get_MessageNumber write set_MessageNumber; ``` ## Default Value 1 ## Remarks This property indicates the current (selected) message. This property specifies a message number in between 1 and [MessageCount](#messagecount-property-pop-component). The various component methods related to single messages use this property as a message pointer (see method descriptions and the [QueryMessageSize](#querymessagesize-method-pop-component) method). # MessageRecipients Property ([POP](#pop-component) Component) This property includes a collection of recipients for the current message. ## Syntax *Delphi Syntax* ```text property MessageRecipients: TipwMessageRecipientList read get_MessageRecipients; ``` ## Remarks This property contains a collection of recipients for the current message. This collection describes all of the people to whom the last retrieved message was sent. Each [MessageRecipient](#messagerecipient-type) contains information describing that recipient, and what type of recipient it is. This property is read-only and not available at design time. Please refer to the [MessageRecipient](#messagerecipient-type) type for a complete list of fields. # MessageReplyTo Property ([POP](#pop-component) Component) This property includes the value of the Reply-To header of the last retrieved message. ## Syntax *Delphi Syntax* ```text property MessageReplyTo: String read get_MessageReplyTo; ``` ## Default Value '' ## Remarks This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the [Header](#header-event-pop-component) event. This property is read-only. # MessageSubject Property ([POP](#pop-component) Component) This property includes the value of the Subject header of the last retrieved message. ## Syntax *Delphi Syntax* ```text property MessageSubject: String read get_MessageSubject; ``` ## Default Value '' ## Remarks This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the [Header](#header-event-pop-component) event. This property is read-only. # MessageText Property ([POP](#pop-component) Component) This property includes the full text of the message as retrieved from the server. ## Syntax *Delphi Syntax* ```text property MessageText: String read get_MessageText; ``` ## Default Value '' ## Remarks This property contains the full text of the message as retrieved from the server. If the component is not connected, or [MessageNumber](#messagenumber-property-pop-component) does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of [MaxLines](#maxlines-property-pop-component)). The [MailServer](#mailserver-property-pop-component) is asked about the text of the message only if the [MessageNumber](#messagenumber-property-pop-component) property has changed. If [MessageNumber](#messagenumber-property-pop-component) has not changed, the component returns a cached value. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders ``` This property is read-only. # MessageTo Property ([POP](#pop-component) Component) This property includes the value of the To header of the last retrieved message. ## Syntax *Delphi Syntax* ```text property MessageTo: String read get_MessageTo; ``` ## Default Value '' ## Remarks This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the [Header](#header-event-pop-component) event. This property is read-only. # OAuth Property ([POP](#pop-component) Component) The OAuth settings. ## Syntax *Delphi Syntax* ```text property OAuth: TipwMailOAuthSettings read get_OAuth; ``` ## Remarks This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information. This property is read-only and not available at design time. Please refer to the [MailOAuthSettings](#mailoauthsettings-type) type for a complete list of fields. # Password Property ([POP](#pop-component) Component) This property includes the password for the mailbox user. ## Syntax *Delphi Syntax* ```text property Password: String read get_Password write set_Password; ``` ## Default Value '' ## Remarks This property contains the password for the mailbox user. This property must be set before the component connects to the [MailServer](#mailserver-property-pop-component). # SSLAcceptServerCert Property ([POP](#pop-component) Component) Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax *Delphi Syntax* ```text property SSLAcceptServerCert: TipwCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert; ``` ## Remarks If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([POP](#pop-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax *Delphi Syntax* ```text property SSLCert: TipwCertificate read get_SSLCert write set_SSLCert; ``` ## Remarks This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLEnabled Property ([POP](#pop-component) Component) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax *Delphi Syntax* ```text property SSLEnabled: Boolean read get_SSLEnabled write set_SSLEnabled; ``` ## Default Value false ## Remarks This property specifies whether TLS/SSL is enabled in the component. When False (default), the component operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting [SSLStartMode](#sslstartmode-property-pop-component). Setting [SSLStartMode](#sslstartmode-property-pop-component) will automatically update this property value. This property is not available at design time. # SSLProvider Property ([POP](#pop-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Delphi Syntax* ```text property SSLProvider: TipwTSSLProviders read get_SSLProvider write set_SSLProvider; TipwTSSLProviders = ( sslpAutomatic, sslpPlatform, sslpInternal ); ``` ## Default Value sslpAutomatic ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform. When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([POP](#pop-component) Component) The server certificate for the last established connection. ## Syntax *Delphi Syntax* ```text property SSLServerCert: TipwCertificate read get_SSLServerCert; ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLStartMode Property ([POP](#pop-component) Component) This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. ## Syntax *Delphi Syntax* ```text property SSLStartMode: TipwTSSLStartModes read get_SSLStartMode write set_SSLStartMode; TipwTSSLStartModes = ( sslAutomatic, sslImplicit, sslExplicit, sslNone ); ``` ## Default Value sslNone ## Remarks The SSLStartMode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the component will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). | | 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. | | 2 (sslExplicit) | The component will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. | # Timeout Property ([POP](#pop-component) Component) The timeout for the component. ## Syntax *Delphi Syntax* ```text property Timeout: Integer read get_Timeout write set_Timeout; ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the component will wait for the operation to complete before returning control. The component will use [DoEvents](#doevents-method-pop-component) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the component raises an exception. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # User Property ([POP](#pop-component) Component) This property includes the user identifier for the mailbox. ## Syntax *Delphi Syntax* ```text property User: String read get_User write set_User; ``` ## Default Value '' ## Remarks This property contains the user identifier for the mailbox. This property must be set before the component connects to the [MailServer](#mailserver-property-pop-component). # Config Method ([POP](#pop-component) Component) Sets or retrieves a configuration setting. ## Syntax *Delphi Syntax* ```text function Config(ConfigurationString: String): String; ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-pop-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-pop-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([POP](#pop-component) Component) This method connects to the mail server and attempts to log in. ## Syntax *Delphi Syntax* ```text procedure Connect(); ``` ## Remarks This method connects to the mail server and attempts to log in using the current [User](#user-property-pop-component) and [Password](#password-property-pop-component). Then it retrieves the initial statistics about the mailbox contents ([MessageCount](#messagecount-property-pop-component) and [QueryTotalSize](#querytotalsize-method-pop-component)). **Example. Connect to POP Mailbox:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders ``` # Delete Method ([POP](#pop-component) Component) This method deletes a message specified by MessageNumber on the server. ## Syntax *Delphi Syntax* ```text procedure Delete(); ``` ## Remarks This method asks the [MailServer](#mailserver-property-pop-component) to delete the message specified by [MessageNumber](#messagenumber-property-pop-component). The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the [Reset](#reset-method-pop-component) method. # Disconnect Method ([POP](#pop-component) Component) This method disconnects from the mail server. ## Syntax *Delphi Syntax* ```text procedure Disconnect(); ``` ## Remarks This method makes the component disconnect from the [MailServer](#mailserver-property-pop-component) by sending the *QUIT* command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection. # DoEvents Method ([POP](#pop-component) Component) This method processes events from the internal message queue. ## Syntax *Delphi Syntax* ```text procedure DoEvents(); ``` ## Remarks When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Interrupt Method ([POP](#pop-component) Component) This method interrupts the current method. ## Syntax *Delphi Syntax* ```text procedure Interrupt(); ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListMessageSizes Method ([POP](#pop-component) Component) This method retrieves a list of all message sizes from the server. ## Syntax *Delphi Syntax* ```text procedure ListMessageSizes(); ``` ## Remarks This message retrieves a list of all message sizes from the server. For each message listed, a [MessageList](#messagelist-event-pop-component) event will fire containing the number and size of the message. # ListMessageUIDs Method ([POP](#pop-component) Component) This method retrieves a list of all message UIDs from the server. ## Syntax *Delphi Syntax* ```text procedure ListMessageUIDs(); ``` ## Remarks This method retrieves a list of all message UIDs from the server. For each message listed, a [MessageList](#messagelist-event-pop-component) event will fire containing the number and UID of the message. # LocalizeDate Method ([POP](#pop-component) Component) This method converts a valid RFC 822 message date to a local date and time. ## Syntax *Delphi Syntax* ```text function LocalizeDate(DateTime: String): String; ``` ## Remarks This method can be used to convert an RFC 822 date and time string to the corresponding local date and time. NOTE: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss". # QueryMessageSize Method ([POP](#pop-component) Component) This method returns the size in bytes of the current message. ## Syntax *Delphi Syntax* ```text function QueryMessageSize(): Int64; ``` ## Remarks This method queries the server for the size in bytes of the message specified by [MessageNumber](#messagenumber-property-pop-component). The method returns the size (in bytes) of the message. If the component is not connected, or [MessageNumber](#messagenumber-property-pop-component) does not contain a valid message number, the return value is *0*. Otherwise, it returns the size of the mail message (including headers) as reported by the server. The [MailServer](#mailserver-property-pop-component) is asked about the size of the message only if the [MessageNumber](#messagenumber-property-pop-component) property has changed. If [MessageNumber](#messagenumber-property-pop-component) has not changed, the component returns a cached value. # QueryMessageUID Method ([POP](#pop-component) Component) This method returns the unique identifier (UID) of the message as specified by the server. ## Syntax *Delphi Syntax* ```text function QueryMessageUID(): String; ``` ## Remarks This method returns the unique identifier (UID) of the message specified by [MessageNumber](#messagenumber-property-pop-component). If the component is not connected, or [MessageNumber](#messagenumber-property-pop-component) does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server. The [MailServer](#mailserver-property-pop-component) is asked about the UID of the message only if the [MessageNumber](#messagenumber-property-pop-component) property has changed. If [MessageNumber](#messagenumber-property-pop-component) has not changed, the component returns a cached value. # QueryTotalSize Method ([POP](#pop-component) Component) This method returns the cumulative size in bytes of messages in the mailbox (including headers). ## Syntax *Delphi Syntax* ```text function QueryTotalSize(): Int64; ``` ## Remarks This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the component is not connected to the server, the return value of this method is *0*. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server. # Reset Method ([POP](#pop-component) Component) This method will reset the component. ## Syntax *Delphi Syntax* ```text procedure Reset(); ``` ## Remarks This method will reset the component's properties to their default values. # ResetState Method ([POP](#pop-component) Component) Resets all changes and reverts back to the state the component was in when the user first connected. ## Syntax *Delphi Syntax* ```text procedure ResetState(); ``` ## Remarks This method is used to reset all changes and revert the component back to the state it was in when the user first connected. # Retrieve Method ([POP](#pop-component) Component) This method retrieves a message specified by MessageNumber from the server. ## Syntax *Delphi Syntax* ```text procedure Retrieve(); ``` ## Remarks This method is used to retrieve a message specified by [MessageNumber](#messagenumber-property-pop-component) from the server. It asks the [MailServer](#mailserver-property-pop-component) to retrieve the message specified by [MessageNumber](#messagenumber-property-pop-component). The message headers will arrive in the [Header](#header-event-pop-component) event, and the message text will arrive in the [Transfer](#transfer-event-pop-component) event. The [MaxLines](#maxlines-property-pop-component) property defines the number of lines retrieved. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() ``` # RetrieveHeaders Method ([POP](#pop-component) Component) This method retrieves headers for a message specified by MessageNumber . ## Syntax *Delphi Syntax* ```text procedure RetrieveHeaders(); ``` ## Remarks Calling this method will retrieve the headers for the message specified by the [MessageNumber](#messagenumber-property-pop-component) property. The message headers will be provided by the [Header](#header-event-pop-component) event and also stored in the [MessageHeaders](#messageheaders-property-pop-component) property. **Example. Connect and Retrieve Message Headers:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders() ``` # SendCommand Method ([POP](#pop-component) Component) This method sends the exact command directly to the server. ## Syntax *Delphi Syntax* ```text procedure SendCommand(Command: String); ``` ## Remarks This method sends the command specified by *Command* to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server. After calling this method, check the [LastReply](#lastreply-property-pop-component) property or monitor the [PITrail](#pitrail-event-pop-component) event to obtain the server's response. # SetMessageStream Method ([POP](#pop-component) Component) This method sets the stream to which the message downloaded from the server will be written. ## Syntax *Delphi Syntax* ```text procedure SetMessageStream(MessageStream: TStream); ``` ## Remarks This method sets the stream to which the message downloaded from the server will be written. If a download stream is set before the [Retrieve](#retrieve-method-pop-component) method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position *0*. The component will automatically close this stream if [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) is set to True (default). If the stream is closed, you will need to call SetMessageStream again before calling [Retrieve](#retrieve-method-pop-component) again. The downloaded content will be written starting at the current position in the stream. NOTE: SetMessageStream and [LocalFile](#localfile-property-pop-component) will reset the other. # ConnectionStatus Event ([POP](#pop-component) Component) Fired to indicate changes in the connection state. ## Syntax *Delphi Syntax* ```text type TConnectionStatusEvent = procedure ( Sender: TObject; const ConnectionEvent: String; StatusCode: Integer; const Description: String ) of Object; property OnConnectionStatus: TConnectionStatusEvent read FOnConnectionStatus write FOnConnectionStatus; ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # EndTransfer Event ([POP](#pop-component) Component) This event is fired when the message completes transferring. ## Syntax *Delphi Syntax* ```text type TEndTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer; ``` ## Remarks The EndTransfer event is fired when the message body completes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([POP](#pop-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Delphi Syntax* ```text type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object; property OnError: TErrorEvent read FOnError write FOnError; ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-pop-component) section. # Header Event ([POP](#pop-component) Component) This event is fired for every message header being retrieved. ## Syntax *Delphi Syntax* ```text type THeaderEvent = procedure ( Sender: TObject; const Field: String; const Value: String ) of Object; property OnHeader: THeaderEvent read FOnHeader write FOnHeader; ``` ## Remarks The *Field* parameter contains the name of the header (in the same case as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains '' (empty string). # LaunchBrowser Event ([POP](#pop-component) Component) Fires before launching a browser with the authorization URL. ## Syntax *Delphi Syntax* ```text type TLaunchBrowserEvent = procedure ( Sender: TObject; var URL: String; var Command: String ) of Object; property OnLaunchBrowser: TLaunchBrowserEvent read FOnLaunchBrowser write FOnLaunchBrowser; ``` ## Remarks When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the component will fire this event with the *Command*, which will be executed by the component. The *URL* parameter will be the authorization URL that the user will be directed to authenticate. Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the component will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *Command* is not empty, the URL will be appended to the end. In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to: - edit - explore - find - open - print # Log Event ([POP](#pop-component) Component) Fired once for each log message. ## Syntax *Delphi Syntax* ```text type TLogEvent = procedure ( Sender: TObject; LogLevel: Integer; const Message: String; const LogType: String ) of Object; property OnLog: TLogEvent read FOnLog write FOnLog; ``` ## Remarks This event is fired once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # MessageList Event ([POP](#pop-component) Component) This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs . ## Syntax *Delphi Syntax* ```text type TMessageListEvent = procedure ( Sender: TObject; MessageNumber: Integer; const MessageUID: String; MessageSize: Integer ) of Object; property OnMessageList: TMessageListEvent read FOnMessageList write FOnMessageList; ``` ## Remarks When [ListMessageSizes](#listmessagesizes-method-pop-component) is called, *MessageSize* is valid, and *MessageUID* is always an empty string. When [ListMessageUIDs](#listmessageuids-method-pop-component) is called, *MessageUID* is valid, and *MessageSize* is 0. # PITrail Event ([POP](#pop-component) Component) This event traces the commands sent to the mail server, and the respective replies. ## Syntax *Delphi Syntax* ```text type TPITrailEvent = procedure ( Sender: TObject; Direction: Integer; const Message: String ) of Object; property OnPITrail: TPITrailEvent read FOnPITrail write FOnPITrail; ``` ## Remarks The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers. The *Message* parameter contains the full text of the message. The *Direction* parameter shows the originator of the message: | | | | --- | --- | | 0 (Client) | The Message originates from the client. | | 1 (Server) | The Message originates from the server. | | 2 (Info) | The Message is an informative message originating from the client software (the component code). | # SSLServerAuthentication Event ([POP](#pop-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Delphi Syntax* ```text type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; const CertEncoded: String; const CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object; property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication; ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([POP](#pop-component) Component) Fired when secure connection progress messages are available. ## Syntax *Delphi Syntax* ```text type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object; property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus; ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([POP](#pop-component) Component) This event is fired when the message starts transferring. ## Syntax *Delphi Syntax* ```text type TStartTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer; ``` ## Remarks The StartTransfer event is fired when the message body starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Transfer Event ([POP](#pop-component) Component) This event is fired when the message is transferred from MailServer . ## Syntax *Delphi Syntax* ```text type TTransferEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; PercentDone: Integer; const Text: String; const TextB: TBytes; EOL: Boolean ) of Object; property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer; ``` ## Remarks The *Text* parameter contains the portion of the message data to be retrieved. The *BytesTransferred* parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last Transfer event is fired), *BytesTransferred* equals the value of the [QueryMessageSize](#querymessagesize-method-pop-component) method. The Transfer event is fired for every line of the message. For complete lines, there is no terminating newline at the end of the *Text* parameter, and *EOL* is True. The *EOL* parameter is False when a line is broken (usually for being too long). A faster way to retrieve a message is to assign a value to the [LocalFile](#localfile-property-pop-component) property and use the Transfer event to check the progress rather than to get the actual data. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. NOTE: For the *PercentDone* parameter value to be correct, the [GetMessageSize](#GetMessageSize) configuration setting must be set to True. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [Encoded](#Certificate_f_Encoded) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [Subject](#Certificate_f_Subject) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *TBytes* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *Boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *Integer (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *TBytes* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *TipwCertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *Integer (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) property for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". ## Constructors > *Delphi Syntax* ```text constructor Create(); ``` Creates a instance whose properties can be set. > *Delphi Syntax* ```text constructor Create(valEncoded: TBytes); ``` Parses * Encoded * as an X.509 public key. > *Delphi Syntax* ```text constructor Create(valStoreType: TipwCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. > *Delphi Syntax* ```text constructor Create(valStoreType: TipwCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # Firewall Type The firewall the component will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *TipwFirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. **Port** *Integer* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) property for details. NOTE: This property is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) property for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this property and the [Password](#Firewall_f_Password) property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component raises an exception. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` # Header Type This is an HTTP header as it is received from the server. ## Remarks When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value). The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *String* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *String* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valField: String; valValue: String); ``` # MailOAuthSettings Type The settings used to authenticate with the service provider. ## Remarks This type is used to give the component the necessary information needed to complete the OAuth process. The following fields are available: - [AccessToken](#MailOAuthSettings_f_AccessToken) - [AuthorizationScope](#MailOAuthSettings_f_AuthorizationScope) - [ClientId](#MailOAuthSettings_f_ClientId) - [ClientSecret](#MailOAuthSettings_f_ClientSecret) - [RefreshToken](#MailOAuthSettings_f_RefreshToken) - [ReturnURL](#MailOAuthSettings_f_ReturnURL) - [ServerAuthURL](#MailOAuthSettings_f_ServerAuthURL) - [ServerTokenURL](#MailOAuthSettings_f_ServerTokenURL) ## Fields **AccessToken** *String* *Default Value: ""* The access token returned by the authorization server. This is set when the component makes a request to the token server. **AuthorizationScope** *String* *Default Value: ""* The scope request or response parameter used during authorization. **ClientId** *String* *Default Value: ""* The id of the client assigned when registering the application. **ClientSecret** *String* *Default Value: ""* The secret value for the client assigned when registering the application. **RefreshToken** *String* *Default Value: ""* Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens. **ReturnURL** *String* *Default Value: ""* The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. **ServerAuthURL** *String* *Default Value: ""* The URL of the authorization server. **ServerTokenURL** *String* *Default Value: ""* The URL of the token server used to obtain the access token. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` # MessageRecipient Type This types describes the message recipient. ## Remarks This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the component is sending the message. The following fields are available: - [Address](#MessageRecipient_f_Address) - [Name](#MessageRecipient_f_Name) - [Options](#MessageRecipient_f_Options) - [RecipientType](#MessageRecipient_f_RecipientType) ## Fields **Address** *String* *Default Value: ""* This property contains the email address of the recipient. **Name** *String* *Default Value: ""* This property contains the name of the recipient. **Options** *String* *Default Value: ""* This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by [SMTP](SMTP.md#SMTP)). One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891. ```text component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY"; ``` **RecipientType** *TipwEmailRecipientTypes* *Default Value: 0* This property contains the recipient type: To, Cc, or Bcc. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valAddress: String); ``` # Config Settings ([POP](#pop-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-pop-component) method. ### POP Config Settings **AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used. When [AuthMechanism](#authmechanism-property-pop-component) is set to amSASLPlain or amSASLDigestMD5, this configuration setting may specify an authorization identity to be used when authenticating. **AutoDecodeSubject**: Instructs the component to automatically decode message subjects.Subjects that have been Quoted-Printable or Base64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded. **GetMessageSize**: Whether to poll the server for the message size prior to retrieving it.By default, this value is False. When set to True, the component will retrieve the message size from the server before downloading it and the *PercentDone* parameter of the [Transfer](#transfer-event-pop-component) event will be populated. When this value is False (default), the *PercentDone* parameter of the [Transfer](#transfer-event-pop-component) event will not be updated and will evaluate to -1. **MaxLineLength**: The maximum expected length for message lines.Normally, internet mail message lines are up to 80 bytes long; however, different mail systems might use other values. Change the value of this property if you are expecting longer lines. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use [Timeout](#timeout-property-pop-component) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-pop-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. If the component is connected, the [LocalHost](#localhost-property-pop-component) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the component will use IPv4 exclusively. When set to *1*, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-pop-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-pop-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-pop-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the component will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the component is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-pop-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-pop-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component raises an exception. When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component raises an exception. When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-pop-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the component will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-pop-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-pop-component) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-pop-component) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-pop-component) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-pop-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-pop-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the component when the [SSLProvider](#sslprovider-property-pop-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-pop-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-pop-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-pop-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-pop-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-pop-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-pop-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-pop-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component raises an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-pop-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-pop-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the component will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the component to use the internal implementation instead of using the system security libraries. This setting is set to *False* by default on all platforms. # Trappable Errors ([POP](#pop-component) Component) ### POP Errors | | | | --- | --- | | 116 | [MailPort](#mailport-property-pop-component) cannot be zero. Please specify a valid service port number. | | 118 | Firewall error. Error message contains detailed description. | | 171 | POP protocol error. Description contains the server reply. | | 172 | Error communicating with server. Error text is attached. | | 173 | Please specify a valid [MailServer](#mailserver-property-pop-component). | | 174 | Busy executing current method. | The component may also return one of the following error codes, which are inherited from other components. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-pop-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the component is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |