XMPP Component

Properties   Methods   Events   Config Settings   Errors  

The XMPP Component is used to create a lightweight messaging client using the XMPP (Jabber) protocol.

Syntax

nsoftware.IPWorks.XMPP

Remarks

The XMPP component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

A call to the ConnectTo method will perform the entire logon process after which a Connected event will fire to indicate the connection status. For simplicity, the entire interface is synchronous; the component will not return until a call is completed.

After a successful connection, the component will automatically begin the process of receiving the user's buddy list. The component will parse the XML as it comes in from the server and will set the appropriate properties. Once the entire buddy list has been retrieved, a Sync event will fire.

Sending a message is as simple as calling a single method. One call to the SendMessage method will cause the component to connect if it has not already done so, send the specified message to a specified user, and return to the original connection state.

The XMPP Component interface supports messaging, list, and presence management. Other features of the XMPP protocol are supported through the SendCommand method and PITrail event.

Example 1. Connecting and Sending a Message:

IMControl.ConnectTo("myusername", "mypassword") IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser") Example 2. Sending a Single Message:

IMControl.User = "myusername" IMControl.Password = "mypassword" IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser")

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthDomainThis property includes the domain under which the user will be authenticated.
AuthMethodsThis property controls how the component authenticates itself with the XMPP server.
BuddiesThis property includes a collection of buddies in the buddy list.
ConnectedThis property indicates whether the component is connected and logged in.
FirewallA set of properties related to firewall access.
IMPortThis property includes the server port for XMPP (default 5222).
IMServerThis property is the instant messaging server.
LocalDirectoryThis property includes the directory to which received files are saved.
LocalFileThis property includes the path to the file that will be sent.
LocalHostThis property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageHTMLThis property includes the HTML version of the current message.
MessageOtherDataThis property contains extra data elements for the current message.
MessageSubjectThis property is the subject of the current message.
MessageTextThis property is the plaintext version of the current message.
MessageThreadThis property is the thread name of the current message.
MessageTypeThis property is the type of the current message.
PasswordThis property is the user's password.
PresenceThis property indicates the availability of the entity.
ResourceThis property is the resource for the current session.
ServerDomainThis property includes the XMPP server's domain.
SSLAcceptServerCertThis property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThis property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLEnabledThis property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
SSLProviderThis property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCertThis property includes the server certificate for the last established connection.
SSLStartModeThis property determines how the component starts the Secure Sockets Layer (SSL) negotiation.
StatusThis property holds the description of the availability of this entity.
TimeoutThis property includes the timeout for the component.
UserThis property includes the user portion of this entity's Jabber Id.
UserDomainThis property gets or sets the domain value used for Jabber Ids.
UserInfoThis property includes the collection of named registration fields.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddThis method will add an entity to this entity's roster.
CancelThis method will cancel another entity's subscription to this entity's presence.
ChangePasswordThis method will change the current user's password.
ChangePresenceThis method will set the availability and status of this entity.
ConfigSets or retrieves a configuration setting.
ConnectThis method will connect the component to the server.
ConnectToThis method will connect the component to the server.
DisconnectThis method disconnects the component from the server.
DoEventsThis method processes events from the internal message queue.
InterruptThis method interrupts the current method.
ProbePresenceUse this method to probe for another entity's presence.
QueryRegisterThis method queries a server for the necessary registration fields.
RegisterThis method registers an account with a server.
RemoveThis method will remove an entity from this entity's roster.
ResetThis method will reset the component.
RetrieveRosterThis method will retrieve this entity's roster from the server.
SendCommandThis method sends a command to the server.
SendFileThis method sends a file to the specified user.
SendMessageThis method will send a message to the specified user.
SetReceiveStreamThis method sets the stream to which the received file data will be written.
SetSendStreamThis method sets the stream to be sent.
SetUserInfoFieldThis method will add a user information field for registration.
SubscribeToUse this method to subscribe to another entity's presence.
UnregisterThis method cancels an account with the host.
UnsubscribeToThis method will cancel a subscription to another entity's presence.
UpdateBuddyGroupThis method updates the buddy's associated groups.

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.

BuddyUpdateThis event is fired whenever a roster entry is updated.
ConnectedThis event is fired when a connection to the IM server is completed.
ConnectionStatusThis event is fired to indicate changes in the connection state.
DisconnectedThis event is fired when the chat service connection is lost.
EndTransferThis event is fired when a file transfer completes.
ErrorThis event is fired when the server sends a protocol error message.
IQThis event is fired for IQ messages not normally supported by the component.
MessageInThis event is fired upon receipt of a message.
PITrailThis event is fired for all protocol messages.
PresenceThis event is fired when the presence of a subscribed entity changes.
ReadyToSendThis event is fired when the component is ready to send data.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferThis event is fired when a file transfer begins.
SubscriptionRequestThis event fires when a subscription request is received.
SyncThis event fires upon a complete information synchronization with the server.
TransferThis event is fired during file transfer.

Config Settings


The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AccessTokenThe OAuth access token used for authentication.
BlockSizeSpecifies the block size for file transfers.
ClientIdThe OAuth client Id used for authentication.
MessageIdSpecifies the number used in the message Id.
MessageXMLReturns the last root-level element received by the component.
OverwriteSpecifies whether or not to overwrite received files.
ParseHTMLTells XMPP whether or not to parse MessageHTML when it's set.
RetrieveRosterWhether to automatically retrieve the roster when logging in.
SendSubscriptionResponseDetermines whether a response will be sent to a Subscription Request.
UseCompressionSpecified whether or not stream compression is used.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (TCPClient only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to be included when performing an SSL handshake.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AuthDomain Property (XMPP Component)

This property includes the domain under which the user will be authenticated.

Syntax

public string AuthDomain { get; set; }
Public Property AuthDomain As String

Default Value

""

Remarks

Set this value if the user must authenticate through a third-party authentication service that requires a different domain than the XMPP user's registered domain.

AuthMethods Property (XMPP Component)

This property controls how the component authenticates itself with the XMPP server.

Syntax

public string AuthMethods { get; set; }
Public Property AuthMethods As String

Default Value

"*"

Remarks

AuthMethods is a comma-separated list of authentication methods to be enabled on the component, listed in order of preference. When authenticating, the component will pick the first method in the list that is supported by the server.

The special value * (default) may be supplied to cause the component to enable all supported authentication methods in order of presumed security. The XMPP component currently supports the following values for AuthMethods, listed in order of most secure to least secure:

  • SASL/DIGEST-MD5
  • AuthIQ/Digest
  • SASL/CRAM-MD5
  • SASL/PLAIN
  • AuthIQ/Plaintext
  • SASL/NTLM

Buddies Property (XMPP Component)

This property includes a collection of buddies in the buddy list.

Syntax

public XMPPBuddyList Buddies { get; }
Public ReadOnly Property Buddies As XMPPBuddyList

Remarks

After a Sync event is fired, this property will contain a collection of all buddies in the buddy list. The buddy list will be updated by the server when a successful call to RetrieveRoster has been made.

This collection is indexed from 0 to count -1.

This property is read-only.

Please refer to the XMPPBuddy type for a complete list of fields.

Connected Property (XMPP Component)

This property indicates whether the component is connected and logged in.

Syntax

public bool Connected { get; }
Public ReadOnly Property Connected As Boolean

Default Value

False

Remarks

This property indicates whether the component is connected and logged in to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Firewall Property (XMPP Component)

A set of properties related to firewall access.

Syntax

public Firewall Firewall { get; set; }
Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

IMPort Property (XMPP Component)

This property includes the server port for XMPP (default 5222).

Syntax

public int IMPort { get; set; }
Public Property IMPort As Integer

Default Value

5222

Remarks

For an implicit Secure Sockets Layer (SSL), use port 5223. For more information, please refer to the SSLStartMode property.

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.

IMServer Property (XMPP Component)

This property is the instant messaging server.

Syntax

public string IMServer { get; set; }
Public Property IMServer As String

Default Value

""

Remarks

This is the instant messaging server to which the component will connect when the Connect method is called. The IMServer property must contain a valid XMPP (Jabber) server, or any subsequent calls to the Connect method will fail.

LocalDirectory Property (XMPP Component)

This property includes the directory to which received files are saved.

Syntax

public string LocalDirectory { get; set; }
Public Property LocalDirectory As String

Default Value

""

Remarks

This property specifies the directory on disk to which received files will be saved. If this property is not set and a file is received, the file data will be available through the Transfer event parameters. This property may also be set when the StartTransfer event fires.

LocalFile Property (XMPP Component)

This property includes the path to the file that will be sent.

Syntax

public string LocalFile { get; set; }
Public Property LocalFile As String

Default Value

""

Remarks

This property specifies the local file that will be sent when calling SendFile. This property must be set before calling SendFile.

LocalHost Property (XMPP Component)

This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

public string LocalHost { get; set; }
Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost 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.

MessageHTML Property (XMPP Component)

This property includes the HTML version of the current message.

Syntax

public string MessageHTML { get; set; }
Public Property MessageHTML As String

Default Value

""

Remarks

If the user wishes to send any HTML as a part of the message, it must be set in the MessageHTML property. The HTML must be an entire HTML document, including the <html> and <body> tags. If the HTML has unbalanced tags, the XMPP component will fail with an error.

This property is not available at design time.

MessageOtherData Property (XMPP Component)

This property contains extra data elements for the current message.

Syntax

public string MessageOtherData { get; set; }
Public Property MessageOtherData As String

Default Value

""

Remarks

MessageOtherData will contain zero or more complete XML elements that are associated with the message but that are not defined in the Jabber specification.

MessageSubject Property (XMPP Component)

This property is the subject of the current message.

Syntax

public string MessageSubject { get; set; }
Public Property MessageSubject As String

Default Value

""

Remarks

MessageSubject will contain any subject associated with the message. Most Jabber clients will ignore the subject unless the message is of type "headline".

This property is not available at design time.

MessageText Property (XMPP Component)

This property is the plaintext version of the current message.

Syntax

public string MessageText { get; set; }
Public Property MessageText As String

Default Value

""

Remarks

MessageText is the plaintext version of the current message, taken from the message's "body" child element. The text in this property is automatically escaped to ensure valid XML parsing on the other end.

This property is not available at design time.

MessageThread Property (XMPP Component)

This property is the thread name of the current message.

Syntax

public string MessageThread { get; set; }
Public Property MessageThread As String

Default Value

""

Remarks

MessageThread will contain the name of the thread associated with the message. Threads are useful for tracking messages of type "chat" or "groupchat".

This property is not available at design time.

MessageType Property (XMPP Component)

This property is the type of the current message.

Syntax

public XMPPMessageTypes MessageType { get; set; }

enum XMPPMessageTypes { jmtNormal, jmtChat, jmtGroupChat, jmtHeadline, jmtError }
Public Property MessageType As XmppMessageTypes

Enum XMPPMessageTypes jmtNormal jmtChat jmtGroupChat jmtHeadline jmtError End Enum

Default Value

0

Remarks

MessageType is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:

normal (jmtNormal - 0)A single message.
chat (jmtChat - 1)A message sent in the context of a two-way chat between two entities.
groupchat (jmtGroupChat - 2)A message sent in the context of a multiuser chat among multiple entities.
headline (jmtHeadline - 3)A message that represents one of a list of items (e.g., in a news feed or information ticker).
error (jmtError - 4)A message returned to a sender specifying an error associated with a previous message sent by the sender to an intended recipient.

This property is not available at design time.

Password Property (XMPP Component)

This property is the user's password.

Syntax

public string Password { get; set; }
Public Property Password As String

Default Value

""

Remarks

This property must be set before a connection is attempted. If a call to the Connect method is made specifying a password, then the Password property will contain that password.

Presence Property (XMPP Component)

This property indicates the availability of the entity.

Syntax

public XMPPPresences Presence { get; }

enum XMPPPresences { pcOffline, pcChat, pcAway, pcXA, pcDND }
Public ReadOnly Property Presence As XmppPresences

Enum XMPPPresences pcOffline pcChat pcAway pcXA pcDND End Enum

Default Value

1

Remarks

When the component completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

By default, the component sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.

This property is read-only and not available at design time.

Resource Property (XMPP Component)

This property is the resource for the current session.

Syntax

public string Resource { get; set; }
Public Property Resource As String

Default Value

"IPWorks XMPP Agent"

Remarks

Whenever an entity logs in to an XMPP (Jabber) server, it must provide account information as well as a resource. Resources allow multiple clients to log in using the same account. The server will forward all messages and PI data aimed at a specific resource to that resource. If a command or message is to be sent to a Jabber Id with no specified resource, the server will push that command or message out to all connected resources.

ServerDomain Property (XMPP Component)

This property includes the XMPP server's domain.

Syntax

public string ServerDomain { get; set; }
Public Property ServerDomain As String

Default Value

""

Remarks

The domain of the XMPP server itself. Set this value if the domain of the server is different from the DNS name of the IMServer.

SSLAcceptServerCert Property (XMPP Component)

This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate

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 type for a complete list of fields.

SSLCert Property (XMPP Component)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate

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 field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLEnabled Property (XMPP Component)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

public bool SSLEnabled { get; set; }
Public Property SSLEnabled As Boolean

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. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

SSLProvider Property (XMPP Component)

This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

public XMPPSSLProviders SSLProvider { get; set; }

enum XMPPSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As XmppSSLProviders

Enum XMPPSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum

Default Value

0

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, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (XMPP Component)

This property includes the server certificate for the last established connection.

Syntax

public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert 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 type for a complete list of fields.

SSLStartMode Property (XMPP Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

public XMPPSSLStartModes SSLStartMode { get; set; }

enum XMPPSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone }
Public Property SSLStartMode As XmppSSLStartModes

Enum XMPPSSLStartModes sslAutomatic sslImplicit sslExplicit sslNone End Enum

Default Value

3

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.

Status Property (XMPP Component)

This property holds the description of the availability of this entity.

Syntax

public string Status { get; }
Public ReadOnly Property Status As String

Default Value

"Available for Chat."

Remarks

When the component completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

By default, the component sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.

This property is read-only and not available at design time.

Timeout Property (XMPP Component)

This property includes the timeout for the component.

Syntax

public int Timeout { get; set; }
Public Property Timeout As Integer

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 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 throws 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 (XMPP Component)

This property includes the user portion of this entity's Jabber Id.

Syntax

public string User { get; set; }
Public Property User As String

Default Value

""

Remarks

The User property is a unique username associated with this entity and is set at the time of registration under the field "user".

UserDomain Property (XMPP Component)

This property gets or sets the domain value used for Jabber Ids.

Syntax

public string UserDomain { get; set; }
Public Property UserDomain As String

Default Value

""

Remarks

A Jabber Id (JID) is a unique identifier of the format "User@Domain/Resource". user@domain denotes the account by username and domain. The Resource is given during the login process to distinguish individual connections under the same account. If the IMServer contains multiple domains, this property setting allows the user to specify the domain under which to log in.

If Domain is empty, the value in IMServer is used by default when creating the client's JID.

UserInfo Property (XMPP Component)

This property includes the collection of named registration fields.

Syntax

public XMPPUserInfoMap UserInfo { get; }
Public Property UserInfo As XMPPUserInfoMap

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for US citizens).
zipThe user's postal code (for US citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

This collection is a hash-table type of collection in which the field string is used as the key to the desired XMPP user info object.

Example. Setting New User Information:

xmpp1.QueryRegister("server"); xmpp1.UserInfo["Username"].Value = "newuser"; xmpp1.UserInfo["Password"].Value = "newpass"; xmpp1.Register("server");

This property is not available at design time.

Please refer to the XMPPUserInfo type for a complete list of fields.

Add Method (XMPP Component)

This method will add an entity to this entity's roster.

Syntax

public void Add(string jabberId, string name, string groups);

Async Version
public async Task Add(string jabberId, string name, string groups);
public async Task Add(string jabberId, string name, string groups, CancellationToken cancellationToken);
Public Sub Add(ByVal JabberId As String, ByVal Name As String, ByVal Groups As String)

Async Version
Public Sub Add(ByVal JabberId As String, ByVal Name As String, ByVal Groups As String) As Task
Public Sub Add(ByVal JabberId As String, ByVal Name As String, ByVal Groups As String, cancellationToken As CancellationToken) As Task

Remarks

JabberId is the Jabber Id of the entity to be added. It should be of form "user@host". If no hostname is specified, the component will assume the user's account is with the server in IMServer, and will append that hostname to JabberId before sending the request.

Name will contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".

Groups is either the empty string ("") or a comma- separated list of groups to which the JabberId is to be added. If JabberId already exists in the buddy list, it will be updated to exist only in the specified groups. A buddy's group list can also be modified by the Buddies property.

The Add method will make a subscription request to the presence of the specified JabberId. Upon receiving this request, the server will add an entry into this user's buddy list with a subscription of type subscriptionNone (0) if there was no previous entry (if this user has already allowed JabberId to subscribe to this user's presence, there will already be an entry of type subscriptionFrom (2)). If the contact chooses to allow the subscription, the server will update the entry and a BuddyUpdate event will fire with the new subscription value (subscriptionTo (1) if this is a new contact, or subscriptionBoth (3) if the contact is now mutual).

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.

Cancel Method (XMPP Component)

This method will cancel another entity's subscription to this entity's presence.

Syntax

public void Cancel(string jabberId);

Async Version
public async Task Cancel(string jabberId);
public async Task Cancel(string jabberId, CancellationToken cancellationToken);
Public Sub Cancel(ByVal JabberId As String)

Async Version
Public Sub Cancel(ByVal JabberId As String) As Task
Public Sub Cancel(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

Remarks

If for any reason the user should want to undo a previously granted subscription, this can be achieved through the Cancel method. The method will unsubscribe the target from this user's presence, thus preventing the target from seeing this user in the future.

ChangePassword Method (XMPP Component)

This method will change the current user's password.

Syntax

public void ChangePassword(string password);

Async Version
public async Task ChangePassword(string password);
public async Task ChangePassword(string password, CancellationToken cancellationToken);
Public Sub ChangePassword(ByVal Password As String)

Async Version
Public Sub ChangePassword(ByVal Password As String) As Task
Public Sub ChangePassword(ByVal Password As String, cancellationToken As CancellationToken) As Task

Remarks

This method changes the current user's password to the password that is specified. The component must be connected to the server when this method is called.

ChangePresence Method (XMPP Component)

This method will set the availability and status of this entity.

Syntax

public void ChangePresence(int presenceCode, string status);

Async Version
public async Task ChangePresence(int presenceCode, string status);
public async Task ChangePresence(int presenceCode, string status, CancellationToken cancellationToken);
Public Sub ChangePresence(ByVal PresenceCode As Integer, ByVal Status As String)

Async Version
Public Sub ChangePresence(ByVal PresenceCode As Integer, ByVal Status As String) As Task
Public Sub ChangePresence(ByVal PresenceCode As Integer, ByVal Status As String, cancellationToken As CancellationToken) As Task

Remarks

PresenceCode should correspond to the possible values of the Presence property:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

By default, the component sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status can be any random string, including the empty string "".

Config Method (XMPP Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (XMPP Component)

This method will connect the component to the server.

Syntax

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);
Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

Remarks

The Connect method performs the entire connection routine. This includes connection to the IMServer, authenticating with the specified User and Password, and session initialization.

The Connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

ConnectTo Method (XMPP Component)

This method will connect the component to the server.

Syntax

public void ConnectTo(string user, string password);

Async Version
public async Task ConnectTo(string user, string password);
public async Task ConnectTo(string user, string password, CancellationToken cancellationToken);
Public Sub ConnectTo(ByVal User As String, ByVal Password As String)

Async Version
Public Sub ConnectTo(ByVal User As String, ByVal Password As String) As Task
Public Sub ConnectTo(ByVal User As String, ByVal Password As String, cancellationToken As CancellationToken) As Task

Remarks

The ConnectTo method performs the entire connection routine. This includes connection to the IMServer, user logon and authentication, and session initialization.

The Connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

Because ConnectTo is called with a user and password specified, the User and Password properties will updated accordingly.

Disconnect Method (XMPP Component)

This method disconnects the component from the server.

Syntax

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);
Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

Remarks

The Disconnect method will send the disconnect command to the notification server. Upon disconnection, a Disconnected event will be fired.

DoEvents Method (XMPP Component)

This method processes events from the internal message queue.

Syntax

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);
Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

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 (XMPP Component)

This method interrupts the current method.

Syntax

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ProbePresence Method (XMPP Component)

Use this method to probe for another entity's presence.

Syntax

public void ProbePresence(string jabberId);

Async Version
public async Task ProbePresence(string jabberId);
public async Task ProbePresence(string jabberId, CancellationToken cancellationToken);
Public Sub ProbePresence(ByVal JabberId As String)

Async Version
Public Sub ProbePresence(ByVal JabberId As String) As Task
Public Sub ProbePresence(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

Remarks

In the case that the user needs to update a particular entity's presence, this method can be used to retrieve it. After a successful call, the server will either respond with the last known presence for Jabber or will send a presence element of type "error". In either case, the respond will be returned by a Presence event.

QueryRegister Method (XMPP Component)

This method queries a server for the necessary registration fields.

Syntax

public void QueryRegister(string XMPPServer);

Async Version
public async Task QueryRegister(string XMPPServer);
public async Task QueryRegister(string XMPPServer, CancellationToken cancellationToken);
Public Sub QueryRegister(ByVal XMPPServer As String)

Async Version
Public Sub QueryRegister(ByVal XMPPServer As String) As Task
Public Sub QueryRegister(ByVal XMPPServer As String, cancellationToken As CancellationToken) As Task

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for US citizens).
zipThe user's postal code (for US citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Register Method (XMPP Component)

This method registers an account with a server.

Syntax

public void Register(string XMPPServer);

Async Version
public async Task Register(string XMPPServer);
public async Task Register(string XMPPServer, CancellationToken cancellationToken);
Public Sub Register(ByVal XMPPServer As String)

Async Version
Public Sub Register(ByVal XMPPServer As String) As Task
Public Sub Register(ByVal XMPPServer As String, cancellationToken As CancellationToken) As Task

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for US citizens).
zipThe user's postal code (for US citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

A new account can be registered at any time, including while the component is logged into the host under an existing account.

Remove Method (XMPP Component)

This method will remove an entity from this entity's roster.

Syntax

public void Remove(string jabberId, string name, string group);

Async Version
public async Task Remove(string jabberId, string name, string group);
public async Task Remove(string jabberId, string name, string group, CancellationToken cancellationToken);
Public Sub Remove(ByVal JabberId As String, ByVal Name As String, ByVal Group As String)

Async Version
Public Sub Remove(ByVal JabberId As String, ByVal Name As String, ByVal Group As String) As Task
Public Sub Remove(ByVal JabberId As String, ByVal Name As String, ByVal Group As String, cancellationToken As CancellationToken) As Task

Remarks

JabberId is the Jabber Id of the entity to be removed. It should be in the form of "user@host". If no hostname is specified, the component will assume the user's account is with the server in IMServer, and it will append that hostname to JabberId before sending the request.

Name should contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".

Groups may be either the empty string ("") or a comma- separated list of groups from which JabberId is to be removed. If no group is specified, the buddy will be completely removed from the buddy list.

After calling the Remove method, the server will remove the entry from the server-side roster and will push the result out to all connected resources. A BuddyUpdate event will fire with a subscription of type subscriptionRemove, and the entry will be removed from the Jabber component's internally stored list.

Reset Method (XMPP Component)

This method will reset the component.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

RetrieveRoster Method (XMPP Component)

This method will retrieve this entity's roster from the server.

Syntax

public void RetrieveRoster();

Async Version
public async Task RetrieveRoster();
public async Task RetrieveRoster(CancellationToken cancellationToken);
Public Sub RetrieveRoster()

Async Version
Public Sub RetrieveRoster() As Task
Public Sub RetrieveRoster(cancellationToken As CancellationToken) As Task

Remarks

After the component connects, it will automatically send a request to the server to retrieve the roster. If, however, the user or application wish to update the entire roster, this method may be used to do so.

After a successful call to the RetrieveRoster method, the server will respond with this entity's roster. The component will parse the roster and fire the Sync event once per item. This event may also fire for each entity added to or removed from the roster.

SendCommand Method (XMPP Component)

This method sends a command to the server.

Syntax

public void SendCommand(string command);

Async Version
public async Task SendCommand(string command);
public async Task SendCommand(string command, CancellationToken cancellationToken);
Public Sub SendCommand(ByVal Command As String)

Async Version
Public Sub SendCommand(ByVal Command As String) As Task
Public Sub SendCommand(ByVal Command As String, cancellationToken As CancellationToken) As Task

Remarks

The SendCommand method will send the Command parameter to the server. The command must be in valid XML format and must be recognizable to the IMServer.

The SendCommand method should be used only by programmers or users who are connecting to nonstandard servers whose command list is not covered by the component. Any responses that are defined in the protocol specification will be returned by the appropriate event. Any nonstandard IQ message will be returned by the IQ event. All other responses will be returned by the PITrail event.

SendFile Method (XMPP Component)

This method sends a file to the specified user.

Syntax

public void SendFile(string jabberId);

Async Version
public async Task SendFile(string jabberId);
public async Task SendFile(string jabberId, CancellationToken cancellationToken);
Public Sub SendFile(ByVal JabberId As String)

Async Version
Public Sub SendFile(ByVal JabberId As String) As Task
Public Sub SendFile(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends the file specified by LocalFile to the user specified by the JabberId parameter.

JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

If SetSendStream is called, the stream will be used as the source when sending the file.

The component supports sending files using In-Band Bystestreams as defined in XEP-0047 and XEP-0096.

SendMessage Method (XMPP Component)

This method will send a message to the specified user.

Syntax

public string SendMessage(string jabberId);

Async Version
public async Task<string> SendMessage(string jabberId);
public async Task<string> SendMessage(string jabberId, CancellationToken cancellationToken);
Public Function SendMessage(ByVal JabberId As String) As String

Async Version
Public Function SendMessage(ByVal JabberId As String) As Task(Of String)
Public Function SendMessage(ByVal JabberId As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

The component associates several properties with messages it receives and sends. When it receives a message, the component will parse out the corresponding values and set these properties before firing a MessageIn event. After the event returns control to the component, the properties will be cleared (i.e., they will be set to the empty string, "").

Before sending a message, the application should set the appropriate properties to be associated with the message. The component will send only properties with nonempty string values ("") and will clear all properties after a successful send.

The associated properties are the following:

MessageTypeThe type of message to be sent.
MessageSubjectFor "headline" type messages, this is the subject.
MessageThreadFor "chat" type messages, this is the thread on which the current message is a follow-up.
MessageTextThe plaintext of the message.
MessageHTMLThe HTML version of the message.
MessageOtherDataAny extra data associated with the message but not required by the protocol.

If the parameter passed to SendMessage is prefixed with "@" the component will interpret the value as a domain when constructing the message. This allows for sending directly to subdomains.

Note: The XMPP component will generate and return a unique identifier for each message sent. This identifier can be used to track messages in conjunction with various Jabber Extension Protocols.

SetReceiveStream Method (XMPP Component)

This method sets the stream to which the received file data will be written.

Syntax

public void SetReceiveStream(System.IO.Stream receiveStream);

Async Version
public async Task SetReceiveStream(System.IO.Stream receiveStream);
public async Task SetReceiveStream(System.IO.Stream receiveStream, CancellationToken cancellationToken);
Public Sub SetReceiveStream(ByVal ReceiveStream As System.IO.Stream)

Async Version
Public Sub SetReceiveStream(ByVal ReceiveStream As System.IO.Stream) As Task
Public Sub SetReceiveStream(ByVal ReceiveStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream to which the incoming file will be written. This can be set from within the StartTransfer event when a file is received.

The file 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 is True (default). The downloaded content will be written starting at the current position in the stream.

If a download stream is set, the incoming file will not be written to LocalDirectory.

SetSendStream Method (XMPP Component)

This method sets the stream to be sent.

Syntax

public void SetSendStream(System.IO.Stream sendStream, string fileName);

Async Version
public async Task SetSendStream(System.IO.Stream sendStream, string fileName);
public async Task SetSendStream(System.IO.Stream sendStream, string fileName, CancellationToken cancellationToken);
Public Sub SetSendStream(ByVal SendStream As System.IO.Stream, ByVal FileName As String)

Async Version
Public Sub SetSendStream(ByVal SendStream As System.IO.Stream, ByVal FileName As String) As Task
Public Sub SetSendStream(ByVal SendStream As System.IO.Stream, ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream to be sent to the recipient. FileName specifies the name of the file. If an upload stream is set before the SendFile method is called, the content of the stream will be read by the component and sent. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetSendStream again before calling SendFile again.

The content of the stream will be read from the current position all the way to the end.

Note: SetSendStream and LocalFile will reset the other.

SetUserInfoField Method (XMPP Component)

This method will add a user information field for registration.

Syntax

public void SetUserInfoField(string field, string value);

Async Version
public async Task SetUserInfoField(string field, string value);
public async Task SetUserInfoField(string field, string value, CancellationToken cancellationToken);
Public Sub SetUserInfoField(ByVal Field As String, ByVal Value As String)

Async Version
Public Sub SetUserInfoField(ByVal Field As String, ByVal Value As String) As Task
Public Sub SetUserInfoField(ByVal Field As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method will search through UserInfo for the field name in Field and set the corresponding value to Value. If the field was not previously contained in UserInfo, it will automatically be added.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for US citizens).
zipThe user's postal code (for US citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

SubscribeTo Method (XMPP Component)

Use this method to subscribe to another entity's presence.

Syntax

public void SubscribeTo(string jabberId);

Async Version
public async Task SubscribeTo(string jabberId);
public async Task SubscribeTo(string jabberId, CancellationToken cancellationToken);
Public Sub SubscribeTo(ByVal JabberId As String)

Async Version
Public Sub SubscribeTo(ByVal JabberId As String) As Task
Public Sub SubscribeTo(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

Remarks

This method will send a request for a subscription to JabberId's presence. If the entity allows the subscription, a new item will be stored in the buddy list with the appropriate subscription type. Otherwise, no change will take place.

Unregister Method (XMPP Component)

This method cancels an account with the host.

Syntax

public void Unregister();

Async Version
public async Task Unregister();
public async Task Unregister(CancellationToken cancellationToken);
Public Sub Unregister()

Async Version
Public Sub Unregister() As Task
Public Sub Unregister(cancellationToken As CancellationToken) As Task

Remarks

If the user or application wishes to terminate an account with the IMServer it should make a call to this method. After a successful call, the account will be canceled and the component will be logged off the server, but not disconnected.

UnsubscribeTo Method (XMPP Component)

This method will cancel a subscription to another entity's presence.

Syntax

public void UnsubscribeTo(string jabberId);

Async Version
public async Task UnsubscribeTo(string jabberId);
public async Task UnsubscribeTo(string jabberId, CancellationToken cancellationToken);
Public Sub UnsubscribeTo(ByVal JabberId As String)

Async Version
Public Sub UnsubscribeTo(ByVal JabberId As String) As Task
Public Sub UnsubscribeTo(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

Remarks

This method will inform the server of the cancellation of a subscription to JabberId's presence. After a successful call, the subscription type of the associated buddy list item will be updated.

UpdateBuddyGroup Method (XMPP Component)

This method updates the buddy's associated groups.

Syntax

public void UpdateBuddyGroup(int buddyIndex, string group);

Async Version
public async Task UpdateBuddyGroup(int buddyIndex, string group);
public async Task UpdateBuddyGroup(int buddyIndex, string group, CancellationToken cancellationToken);
Public Sub UpdateBuddyGroup(ByVal BuddyIndex As Integer, ByVal Group As String)

Async Version
Public Sub UpdateBuddyGroup(ByVal BuddyIndex As Integer, ByVal Group As String) As Task
Public Sub UpdateBuddyGroup(ByVal BuddyIndex As Integer, ByVal Group As String, cancellationToken As CancellationToken) As Task

Remarks

This method updates the associated groups for the buddy specified by BuddyIndex.

After the Sync event has fired, the Group field is populated with a comma-separated list of groups for each buddy. To update the groups for a buddy, call this method with the buddy's index and the comma-separated list of groups the buddy should be associated with. Setting Group to an empty string ("") will cause the buddy to be completely disassociated from all groups.

BuddyUpdate Event (XMPP Component)

This event is fired whenever a roster entry is updated.

Syntax

public event OnBuddyUpdateHandler OnBuddyUpdate;

public delegate void OnBuddyUpdateHandler(object sender, XMPPBuddyUpdateEventArgs e);

public class XMPPBuddyUpdateEventArgs : EventArgs {
  public int BuddyIdx { get; }
}
Public Event OnBuddyUpdate As OnBuddyUpdateHandler

Public Delegate Sub OnBuddyUpdateHandler(sender As Object, e As XMPPBuddyUpdateEventArgs)

Public Class XMPPBuddyUpdateEventArgs Inherits EventArgs
  Public ReadOnly Property BuddyIdx As Integer
End Class

Remarks

The BuddyUpdate event will fire whenever a new buddy list entry is added or an old entry is updated. The updated information can be retrieved through the Buddies collection property. The BuddyIdx parameter of this event will be the index of that XMPPBuddy in the collection.

Connected Event (XMPP Component)

This event is fired when a connection to the IM server is completed.

Syntax

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, XMPPConnectedEventArgs e);

public class XMPPConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As XMPPConnectedEventArgs)

Public Class XMPPConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, 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.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (XMPP Component)

This event is fired to indicate changes in the connection state.

Syntax

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, XMPPConnectionStatusEventArgs e);

public class XMPPConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}
Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As XMPPConnectionStatusEventArgs)

Public Class XMPPConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The ConnectionStatus 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.

Disconnected Event (XMPP Component)

This event is fired when the chat service connection is lost.

Syntax

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, XMPPDisconnectedEventArgs e);

public class XMPPDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As XMPPDisconnectedEventArgs)

Public Class XMPPDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (XMPP Component)

This event is fired when a file transfer completes.

Syntax

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, XMPPEndTransferEventArgs e);

public class XMPPEndTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string FileId { get; }
  public string FileName { get; }
  public bool Success { get; }
}
Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As XMPPEndTransferEventArgs)

Public Class XMPPEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property FileId As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Success As Boolean
End Class

Remarks

When a file transfer completes, this event will fire.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (XMPP Component)

This event is fired when the server sends a protocol error message.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, XMPPErrorEventArgs e);

public class XMPPErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As XMPPErrorEventArgs)

Public Class XMPPErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event is fired whenever there is a protocol error. ErrorCode will contain the error code string sent by the server. Description will contain the Xmpp component's interpretation of the code.

IQ Event (XMPP Component)

This event is fired for IQ messages not normally supported by the component.

Syntax

public event OnIQHandler OnIQ;

public delegate void OnIQHandler(object sender, XMPPIQEventArgs e);

public class XMPPIQEventArgs : EventArgs {
  public string Iq { get; }
  public string Id { get; }
  public string From { get; }
  public string IqType { get; }
  public bool Ignore { get; set; }
}
Public Event OnIQ As OnIQHandler

Public Delegate Sub OnIQHandler(sender As Object, e As XMPPIQEventArgs)

Public Class XMPPIQEventArgs Inherits EventArgs
  Public ReadOnly Property Iq As String
  Public ReadOnly Property Id As String
  Public ReadOnly Property From As String
  Public ReadOnly Property IqType As String
  Public Property Ignore As Boolean
End Class

Remarks

Some servers may wish to gather some data from the client in ways not specified by the XMPP RFC. This event will contain any IQ message that is not a part of the Jabber specification. The Iq parameter will contain an entire XML entity, and thus it will require both knowledge of XML and knowledge of the possible contents of the IQ message to parse. Id will contain the transaction Id of the IQ message. From will contain the sender's Jabber Id. IqType will have one of the following values:

"get"The IQ is requesting information from this XMPP client.
"set"The IQ is attempting to set a value.
"result"The IQ is a success response to a previous IQ.
"error"The IQ is an error response to a previous IQ.

Note: To respond to these IQs, you may use the SendCommand method.

MessageIn Event (XMPP Component)

This event is fired upon receipt of a message.

Syntax

public event OnMessageInHandler OnMessageIn;

public delegate void OnMessageInHandler(object sender, XMPPMessageInEventArgs e);

public class XMPPMessageInEventArgs : EventArgs {
  public string MessageId { get; }
  public string From { get; }
  public string Domain { get; }
  public string Resource { get; }
  public int MessageType { get; }
  public string Subject { get; }
  public string MessageThread { get; }
  public string MessageText { get; }
  public string MessageHTML { get; }
  public string Other { get; }
}
Public Event OnMessageIn As OnMessageInHandler

Public Delegate Sub OnMessageInHandler(sender As Object, e As XMPPMessageInEventArgs)

Public Class XMPPMessageInEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As String
  Public ReadOnly Property From As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Resource As String
  Public ReadOnly Property MessageType As Integer
  Public ReadOnly Property Subject As String
  Public ReadOnly Property MessageThread As String
  Public ReadOnly Property MessageText As String
  Public ReadOnly Property MessageHTML As String
  Public ReadOnly Property Other As String
End Class

Remarks

When a message is received, the XMPP component will parse the sender's Jabber Id into the From, Domain, and Resource fields. These parameters can be used to track the exact instance of a user's account that originated the message.

MessageId can be used with Jabber extension protocols. The MessageText parameter is the plaintext portion of the message body. MessageHTML will contain any HTML from the message.

Type is the type of message received. See MessageType for a list of possible values. For a message of type "headline", Subject will reflect the subject of the message. For a message of type "chat", Thread will report the conversation thread for which the current message is a follow-up.

Other will contain any extra data associated with the message but not defined by the XMPP-IM protocol.

PITrail Event (XMPP Component)

This event is fired for all protocol messages.

Syntax

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, XMPPPITrailEventArgs e);

public class XMPPPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Pi { get; }
}
Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As XMPPPITrailEventArgs)

Public Class XMPPPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Pi As String
End Class

Remarks

The PITrail event is useful for debugging purposes. It shows all the interactions between the client and the server, line by line.

SessionId will hold the session number that originated the PI. A value of 0 is reserved for all PI dealing with the IMServer.

The direction parameter shows the originator of the message:

0 (Client)Pi originates from the client.
1 (Server)Pi originates from the server.
2 (Info)Pi is an informative message originating from within the component.

The Pi parameter contains the PI message.

Presence Event (XMPP Component)

This event is fired when the presence of a subscribed entity changes.

Syntax

public event OnPresenceHandler OnPresence;

public delegate void OnPresenceHandler(object sender, XMPPPresenceEventArgs e);

public class XMPPPresenceEventArgs : EventArgs {
  public string User { get; }
  public string Domain { get; }
  public string Resource { get; }
  public int Availability { get; }
  public string Status { get; }
}
Public Event OnPresence As OnPresenceHandler

Public Delegate Sub OnPresenceHandler(sender As Object, e As XMPPPresenceEventArgs)

Public Class XMPPPresenceEventArgs Inherits EventArgs
  Public ReadOnly Property User As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Resource As String
  Public ReadOnly Property Availability As Integer
  Public ReadOnly Property Status As String
End Class

Remarks

This event contains the availability and status information of a particular Jabber entity to whom this entity has a subscription.

Because a user can log in multiple times using the same account, the XMPP component will parse the user's Jabber Id into the User, Domain, and Resource parameters so that the client can easily track which instance of the account sent the presence.

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.

Availability corresponds to the Presence property of the component, with the same possible values:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

By default, the component sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status corresponds to the Status property. This value may be any random string, including the empty string, "".

ReadyToSend Event (XMPP Component)

This event is fired when the component is ready to send data.

Syntax

public event OnReadyToSendHandler OnReadyToSend;

public delegate void OnReadyToSendHandler(object sender, XMPPReadyToSendEventArgs e);

public class XMPPReadyToSendEventArgs : EventArgs {
}
Public Event OnReadyToSend As OnReadyToSendHandler

Public Delegate Sub OnReadyToSendHandler(sender As Object, e As XMPPReadyToSendEventArgs)

Public Class XMPPReadyToSendEventArgs Inherits EventArgs
End Class

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed SendBytes. This event also is fired immediately after a connection to the remote host is established.

SSLServerAuthentication Event (XMPP Component)

Fired after the server presents its certificate to the client.

Syntax

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, XMPPSSLServerAuthenticationEventArgs e);

public class XMPPSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As XMPPSSLServerAuthenticationEventArgs)

Public Class XMPPSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class

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 (XMPP Component)

Fired when secure connection progress messages are available.

Syntax

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, XMPPSSLStatusEventArgs e);

public class XMPPSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}
Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As XMPPSSLStatusEventArgs)

Public Class XMPPSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (XMPP Component)

This event is fired when a file transfer begins.

Syntax

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, XMPPStartTransferEventArgs e);

public class XMPPStartTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string FileId { get; }
  public string User { get; }
  public string Domain { get; }
  public string Resource { get; }
  public string FileName { get; set; }
  public string Datetime { get; }
  public long Size { get; }
  public bool Accept { get; set; }
}
Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As XMPPStartTransferEventArgs)

Public Class XMPPStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property FileId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Resource As String
  Public Property FileName As String
  Public ReadOnly Property Datetime As String
  Public ReadOnly Property Size As Long
  Public Property Accept As Boolean
End Class

Remarks

When a file is received, the XMPP component will parse the sender's Jabber Id into the User, Domain, and Resource fields. The FileId and FileName parameters identify the current transfer. Within this event, you may override the FileName by setting the FileName parameter. At this time, you may also set LocalDirectory if it is not already set or call SetReceiveStream.

When sending a file, the XMPP component will parse the receiver's Jabber Id into the User, Domain, and Resource fields.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

SubscriptionRequest Event (XMPP Component)

This event fires when a subscription request is received.

Syntax

public event OnSubscriptionRequestHandler OnSubscriptionRequest;

public delegate void OnSubscriptionRequestHandler(object sender, XMPPSubscriptionRequestEventArgs e);

public class XMPPSubscriptionRequestEventArgs : EventArgs {
  public string From { get; }
  public string Domain { get; }
  public bool Accept { get; set; }
}
Public Event OnSubscriptionRequest As OnSubscriptionRequestHandler

Public Delegate Sub OnSubscriptionRequestHandler(sender As Object, e As XMPPSubscriptionRequestEventArgs)

Public Class XMPPSubscriptionRequestEventArgs Inherits EventArgs
  Public ReadOnly Property From As String
  Public ReadOnly Property Domain As String
  Public Property Accept As Boolean
End Class

Remarks

This event fires whenever another XMPP entity requests a subscription to this entity's presence. The XMPP component will parse the requesting entity's Jabber Id into the From and Domain parameters. It is not necessary to know which resource sent the request, because all instances of the requesting entity's account have access to the same roster.

Accept will initially be False, but setting it to True will cause the XMPP component to allow the remote subscription. Otherwise, the XMPP component will actively deny the subscription request.

Sync Event (XMPP Component)

This event fires upon a complete information synchronization with the server.

Syntax

public event OnSyncHandler OnSync;

public delegate void OnSyncHandler(object sender, XMPPSyncEventArgs e);

public class XMPPSyncEventArgs : EventArgs {
}
Public Event OnSync As OnSyncHandler

Public Delegate Sub OnSyncHandler(sender As Object, e As XMPPSyncEventArgs)

Public Class XMPPSyncEventArgs Inherits EventArgs
End Class

Remarks

The Sync event will fire after each successful call to the RetrieveRoster method. When the event fires, the buddy list, or roster, will be completely retrieved and the Buddies collection will be filled out accordingly:

IdThe Jabber Ids associated with the buddies.
GroupThe group associated with each entry (if a buddy is in more than one group, they will have multiple entries in the buddy list).
SubscriptionThe subscription type for each buddy.

Note: Please refer to Buddies collection property for more information.

Transfer Event (XMPP Component)

This event is fired during file transfer.

Syntax

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, XMPPTransferEventArgs e);

public class XMPPTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string FileId { get; }
  public string FileName { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
public byte[] TextB { get; } public bool Cancel { get; set; } }
Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As XMPPTransferEventArgs)

Public Class XMPPTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property FileId As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
Public ReadOnly Property TextB As Byte() Public Property Cancel As Boolean End Class

Remarks

This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.

The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

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 cannot be calculated, the value will be -1.

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.

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.

Fields

EffectiveDate
string (read-only)

Default: ""

This is 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.

ExpirationDate
string (read-only)

Default: ""

This is the date 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: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
string (read-only)

Default: ""

This is 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: ""

This is 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: ""

This is 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: ""

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
string (read-only)

Default: ""

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
bool (read-only)

Default: False

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)

Default: ""

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
string (read-only)

Default: ""

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
string (read-only)

Default: ""

This field contains 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
int (read-only)

Default: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
string (read-only)

Default: ""

This is 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: ""

The field contains 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: "MY"

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
byte []

Default: "MY"

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
string

Default: ""

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

StoreType
CertStoreTypes

Default: 0

This is 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 field can take one of the following values:

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, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: 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);

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.

SubjectAltNames
string (read-only)

Default: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)

Default: ""

This field contains 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: ""

This field contains 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: ""

This field contains 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: ""

This field contains the text description of UsageFlags.

This value will be of 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
int (read-only)

Default: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
string (read-only)

Default: ""

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
string

Default: ""

This is the subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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=support@nsoftware.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, it must be quoted.

Encoded
string

Default: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

EncodedB
byte []

Default: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

public Certificate();
Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())

Parses Encoded as an X.509 public key.

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType 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.

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. 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.

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType 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 load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) 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.

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) 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.

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

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 and the FirewallType.

Fields

AutoDetect
bool

Default: False

This field tells the component whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes

Default: 0

This field determines 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 is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
string

Default: ""

This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.

Password
string

Default: ""

This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Port
int

Default: 0

This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
string

Default: ""

This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.

Constructors

public Firewall();
Public Firewall()

XMPPBuddy Type

This type describes a buddy in the XMPP buddy list.

Remarks

This type describes a buddy in the user's buddy list. Each buddy in the list has certain properties associated with it, such as names and Id.

Fields

Group
string (read-only)

Default: ""

This field holds a comma-separated list of the buddy's associated groups.

After the Sync event has fired, this field will contain a comma-separated list of groups for the associated Id. Call the UpdateBuddyGroup method to update the buddy's group associations.

Id
string (read-only)

Default: ""

This field is the jabber Id of the buddy.

After a Sync event is fired, this field will contain the user Id associated with the corresponding entry in the buddy list. If a buddy has multiple entries (e.g., if the buddy is listed in several groups), more than one entry will be the same.

NickName
string

Default: ""

This field includes the nickname of the buddy, if one exists.

RealName
string (read-only)

Default: ""

This field includes the real name of the buddy.

Subscription
XMPPBuddySubscriptions (read-only)

Default: 0

This field includes a list of the buddy's subscription status types.

After a Sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:

stNone (0) no subscription
stTo (1) the buddy has a subscription to this entity
stFrom (2) this entity has a subscription to the buddy
stBoth (3) subscription is both to and from
stRemove (4) the item is to be removed from the list

Constructors

public XMPPBuddy();
Public XMPPBuddy()

XMPPUserInfo Type

This type describes a named registration field.

Remarks

This type describes the user information that must be sent to the server during registration.

Fields

Field
string

Default: ""

This field includes the name of the current field necessary for registration.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for US citizens).
zipThe user's postal code (for US citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Value
string

Default: ""

This field includes the value of the current registration field. It should be set after calling QueryRegister and before calling Register.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for US citizens).
zipThe user's postal code (for US citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Constructors

public XMPPUserInfo();
Public XMPPUserInfo()
public XMPPUserInfo(string field, string value);
Public XMPPUserInfo(ByVal Field As String, ByVal Value As String)

Config Settings (XMPP 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 method.

XMPP Config Settings

AccessToken:   The OAuth access token used for authentication.

This configuration setting specifies the OAuth access token used during authentication. This can be used when connecting to Facebook or Windows Live Messenger.

BlockSize:   Specifies the block size for file transfers.

This configuration setting specifies the size in bytes of the block size used when sending files. The default value is 4096. Increasing this value may improve performance. However, some servers may not support larger block sizes.

ClientId:   The OAuth client Id used for authentication.

This configuration setting specifies the OAuth client Id used during authentication. This can be used when connecting to Facebook. Windows Live Messenger does not require this value.

MessageId:   Specifies the number used in the message Id.

The value that is then converted to hex and appended to the XMPPMessage Id.

MessageXML:   Returns the last root-level element received by the component.

This configuration setting returns the last root-level element received by the component. This could be a message, IQ, presence, or any other element type.

Overwrite:   Specifies whether or not to overwrite received files.

The default value of configuration setting is False. If set to True, the component will overwrite the existing files in LocalDirectory if another file with the same name is received. This is applicable only when receiving file transfers.

ParseHTML:   Tells XMPP whether or not to parse MessageHTML when it's set.

If ParseHTML is True, the component will take any value sent to MessageHTML, compute a plaintext version of the text, and put it into the MessageText property.

RetrieveRoster:   Whether to automatically retrieve the roster when logging in.

When this configuration setting is set to True (default), the component will automatically retrieve the roster from the server when logging in. Setting this to False will cause the component to not request the roster, which can be useful when interacting with some nonstandard XMPP servers.

SendSubscriptionResponse:   Determines whether a response will be sent to a Subscription Request.

When this configuration setting is set to True, a response will be sent to a subscription request based on the Accept parameter value of the SubscriptionRequest event. When set to False, a response will not be sent. Therefore, a response can be created and sent using SendCommand outside of the SubscriptionRequest event. The default value is True.

UseCompression:   Specified whether or not stream compression is used.

The default value of this configuration setting is False. If set to True, the component will use stream compression when communicating with the IMServer.

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 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 is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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.

FirewallListener:   If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws 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 is set automatically when 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.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. 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 is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws 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 will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by 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 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 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 is a positive value, the system will attempt to send pending data until the specified 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 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 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 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 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 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 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.nsoftware.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 and 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 False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

CACertFilePaths:   The paths to CA certificate files when using Mono on Unix/Linux.

This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider 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 event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

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 certificate to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert 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:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermedaite 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 throws 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 throws 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 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 is currently not supported. This functionality is instead made available through the 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 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:

-----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 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 is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider 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 is set to Internalinclude the following: 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 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), only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with 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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default - Client and Server)
TLS1.1768 (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 use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
  • If 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 is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider 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 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 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 event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

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 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: 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: 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: 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: 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: 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: 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:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown certificate authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown certificate authority revocation status.
0x00000800Ignore unknown root revocation status.
0x00008000Allow test root certificate.
0x00004000Trust test root certificate.
0x80000000Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available in Java or 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 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:

-----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 is set to Internal and 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 throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance: 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 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 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

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)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout 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.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

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.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (XMPP Component)

XMPP Errors

202   Invalid argument.
432   Array index out of bounds.
600   XMPP protocol error (server returned an error code; description follows).
601   Server disconnected.
602   Cannot change this property while connected.
603   Invalid XML received from server.
604   Invalid response received from server.
605   Server indicates Transport Layer Security (TLS) is required.
606   User requested Secure Sockets Layer (SSL), but the server does not support it.
607   Cannot authenticate.
620   Error hashing password.

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 at this time. A connection is in progress.
112   You cannot change 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.
303   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).