Docs

IPWorks 2022 PHP Edition

Version 22.0 [Build 8171]

NNTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The NNTP Class is used to read, search, and post articles on Usenet news servers.

Class Name

IPWorks_NNTP

Procedural Interface

 ipworks_nntp_open();
 ipworks_nntp_close($res);
 ipworks_nntp_register_callback($res, $id, $function);
 ipworks_nntp_get_last_error($res);
 ipworks_nntp_get_last_error_code($res);
 ipworks_nntp_set($res, $id, $index, $value);
 ipworks_nntp_get($res, $id, $index);
 ipworks_nntp_do_changecurrentgroup($res, $group);

 ipworks_nntp_do_config($res, $configurationstring);

 ipworks_nntp_do_connect($res);

 ipworks_nntp_do_disconnect($res);

 ipworks_nntp_do_doevents($res);

 ipworks_nntp_do_fetcharticle($res);

 ipworks_nntp_do_fetcharticlebody($res);

 ipworks_nntp_do_fetcharticleheaders($res);

 ipworks_nntp_do_groupoverview($res);

 ipworks_nntp_do_groupsearch($res);

 ipworks_nntp_do_interrupt($res);

 ipworks_nntp_do_listgroups($res);

 ipworks_nntp_do_listnewgroups($res);

 ipworks_nntp_do_localizedate($res, $datetime);

 ipworks_nntp_do_postarticle($res);

 ipworks_nntp_do_reset($res);

 ipworks_nntp_do_resetheaders($res);

 ipworks_nntp_do_sendcommand($res, $command);

Remarks

The NNTP Class supports both plaintext and SSL/TLS connections. When connecting over 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 via the Config method.

The NNTP Class implements a standard Usenet news reader as specified in RFC 977. It can be used to browse Usenet news groups and read and post articles.

The CurrentGroup property sets the current newsgroup. From then on, news articles from that group can be read by setting the article number in CurrentArticle and then calling the appropriate method. Properties such as ArticleCount, FirstArticle, LastArticle provide information about the current state.

The headers and text of the articles are received respectively through the Header and Transfer events. Additionally, up to MaxLines from the article body are provided in the ArticleText property. The GroupOverview event returns information about a range of articles (OverviewRange) in CurrentGroup, and the GroupList event is used when listing newsgroup names. The PITrail event provides a trace of the interaction with the server.

The class supports posting of articles through the ArticleText and AttachedFile properties. The article text is specified in one or both of the above, and then the PostArticle method is called. Article headers are given in a series of properties like ArticleFrom, ArticleSubject, Organization, etc. that map directly to the USENET article header with the same name.

Property List


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

ArticleCountThe estimated number of articles in CurrentGroup .
ArticleDateThe date of the current article.
ArticleFromThe email address of the author (for posting articles).
ArticleHeadersThe full headers of the article as retrieved from the server.
ArticleIdThe message identifier of the current article.
GroupOverviewCountThe number of records in the GroupOverview arrays.
GroupOverviewArticleLinesThis is the number of lines of an article in a newsgroup overview.
GroupOverviewArticleNumberThis is the number of an article in a newsgroup overview.
GroupOverviewArticleSizeThis is the size of an article in a newsgroup overview.
GroupOverviewDateThis is the date of an article in a newsgroup overview.
GroupOverviewFromThis is the sender of an article in a newsgroup overview.
GroupOverviewMessageIdThis is the unique message Id of an article in a newsgroup overview.
GroupOverviewOtherHeadersThis is the remaining headers of an article in a newsgroup overview.
GroupOverviewReferencesThis is the references of an article in a newsgroup overview.
GroupOverviewSubjectThis is the subject of an article in a newsgroup overview.
ArticleReferencesArticles to which the posted article follows up.
ArticleReplyToThe address to reply to (for posting articles).
ArticleSubjectThe article subject (for posted articles).
ArticleTextThe full text of the article (without the headers).
AttachedFileA file name which the contents of will be appended to the ArticleText when posting articles.
CheckDateThe date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.
ConnectedShows whether the class is connected.
CurrentArticleThe number or message identifier of the current article.
CurrentGroupThe name of the current group.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FirstArticleThe number of the first article in CurrentGroup .
GroupListCountThe number of records in the GroupList arrays.
GroupListCanPostThis property indicates whether a group in a newsgroup listing allows postings or articles.
GroupListFirstArticleThis property shows the first available article in a newsgroup listing.
GroupListGroupThis property shows the group name in a newsgroup listing.
GroupListLastArticleThis property shows the last available article in a newsgroup listing.
IdleThe current status of the class.
LastArticleThe number of the last article in CurrentGroup .
LastReplyThe last reply from the server.
LocalFileThe path to a local file for downloading the article body. If the file exists, it is overwritten (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxLinesThe maximum number of message lines aside from headers to retrieve.
NewsgroupsA comma separated list of newsgroups in which to post the article.
NewsPortThe server port for secure NNTP (default 119).
NewsServerThe name or address of a news server.
OrganizationThe organization of the author (for posting articles).
OtherHeadersAn RFC850 compliant string consisting of extra headers (for posting articles).
OverviewRangeA range for the GroupOverview method (first-last).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA logon password for the NewsServer .
SearchHeaderA header for the GroupSearch method.
SearchPatternA search pattern for the GroupSearch method.
SearchRangeA range for the GroupSearch method (first-last).
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderTBD.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLStartModeDetermines how the class starts the SSL negotiation.
TimeoutA timeout for the class.
UserA user identifier to login as in the NewsServer .

Method List


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

ChangeCurrentGroupChanges the current group.
ConfigSets or retrieves a configuration setting.
ConnectConnects to the news server.
DisconnectDisconnects from the news server.
DoEventsProcesses events from the internal message queue.
FetchArticleGet the headers and body of an article specified in CurrentArticle .
FetchArticleBodyGets only the body of an article specified in CurrentArticle .
FetchArticleHeadersGets only the headers of an article specified in CurrentArticle .
GroupOverviewReceives an overview for the articles in range OverviewRange in the CurrentGroup .
GroupSearchReceives an overview for the articles in range SearchRange in the CurrentGroup .
InterruptInterrupt the current method.
ListGroupsLists all groups on the server.
ListNewGroupsLists all new groups on the server.
LocalizeDateConverts a valid RFC 822 message date to local date and time.
PostArticlePosts the current article and attached file.
ResetReset the class.
ResetHeadersResets all of the article headers.
SendCommandSends the exact command directly to the server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the article text completes transferring.
ErrorInformation about errors during data delivery.
GroupListFired while group data transfers (during group listings).
GroupOverviewFired for each line of article overview data (during group overviews).
GroupSearchFired for each line of group search data (during group searches).
HeaderFired for every article header being retrieved during article retrieval.
PITrailTraces the commands sent to the news server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when the article text starts transferring.
TransferFired while the article text gets transferred (to or from the NewsServer ).

Configuration Settings


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

ArticleInfoLimitInstructs class to save the amount of articles specified that are returned by the server when a GroupOverview event is fired.
GroupInfoLimitInstructs class to save the amount of group info objects specified that are returned by the server after a ListGroups call has been made.
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
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 class 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.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
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 ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13ProviderThe TLS 1.3 implementation to be used.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

ArticleCount Property (IPWorks_NNTP Class)

The estimated number of articles in CurrentGroup .

Object Oriented Interface


public function getArticleCount();


Procedural Interface


ipworks_nntp_get($res, 1 );


Default Value

0

Remarks

This property contains the estimated number of articles in CurrentGroup The value of this property is 0 if there is no current group (CurrentGroup is ""). Otherwise, when CurrentGroup is set it is the number of articles in the group as shown by the news server. For most news servers, this is an estimated value of the number of the articles, rather than the exact value.

This property is read-only.

Data Type

Long64

ArticleDate Property (IPWorks_NNTP Class)

The date of the current article.

Object Oriented Interface


public function getArticleDate();


Procedural Interface


ipworks_nntp_get($res, 2 );


Default Value

''

Remarks

This property contains the date of the current article. If the class is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the date of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

ArticleFrom Property (IPWorks_NNTP Class)

The email address of the author (for posting articles).

Object Oriented Interface


public function getArticleFrom();


public function setArticleFrom($value);

Procedural Interface


ipworks_nntp_get($res, 3 );


ipworks_nntp_set($res, 3, $value );

Default Value

''

Remarks

This property contains the email address of the author (for posting articles). The string in this property is posted with a From article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleHeaders Property (IPWorks_NNTP Class)

The full headers of the article as retrieved from the server.

Object Oriented Interface


public function getArticleHeaders();


Procedural Interface


ipworks_nntp_get($res, 4 );


Default Value

''

Remarks

This property contains the full headers of the article as retrieved from the server. If the class is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full headers of the article as reported by the server.

The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

ArticleId Property (IPWorks_NNTP Class)

The message identifier of the current article.

Object Oriented Interface


public function getArticleId();


Procedural Interface


ipworks_nntp_get($res, 5 );


Default Value

''

Remarks

This property contains the message identifier of the current article. If the class is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the message identifier of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If the CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

GroupOverviewCount Property (IPWorks_NNTP Class)

The number of records in the GroupOverview arrays.

Object Oriented Interface


public function getGroupOverviewCount();


Procedural Interface


ipworks_nntp_get($res, 6 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at GroupOverviewCount - 1.

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

Data Type

Integer

GroupOverviewArticleLines Property (IPWorks_NNTP Class)

This is the number of lines of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewArticleLines($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 7 , $groupoverviewindex);


Default Value

0

Remarks

This is the number of lines of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

Long64

GroupOverviewArticleNumber Property (IPWorks_NNTP Class)

This is the number of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewArticleNumber($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 8 , $groupoverviewindex);


Default Value

0

Remarks

This is the number of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

Long64

GroupOverviewArticleSize Property (IPWorks_NNTP Class)

This is the size of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewArticleSize($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 9 , $groupoverviewindex);


Default Value

0

Remarks

This is the size of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

Long64

GroupOverviewDate Property (IPWorks_NNTP Class)

This is the date of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewDate($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 10 , $groupoverviewindex);


Default Value

''

Remarks

This is the date of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewFrom Property (IPWorks_NNTP Class)

This is the sender of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewFrom($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 11 , $groupoverviewindex);


Default Value

''

Remarks

This is the sender of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewMessageId Property (IPWorks_NNTP Class)

This is the unique message Id of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewMessageId($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 12 , $groupoverviewindex);


Default Value

''

Remarks

This is the unique message Id of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewOtherHeaders Property (IPWorks_NNTP Class)

This is the remaining headers of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewOtherHeaders($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 13 , $groupoverviewindex);


Default Value

''

Remarks

This is the remaining headers of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewReferences Property (IPWorks_NNTP Class)

This is the references of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewReferences($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 14 , $groupoverviewindex);


Default Value

''

Remarks

This is the references of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewSubject Property (IPWorks_NNTP Class)

This is the subject of an article in a newsgroup overview.

Object Oriented Interface


public function getGroupOverviewSubject($groupoverviewindex);


Procedural Interface


ipworks_nntp_get($res, 15 , $groupoverviewindex);


Default Value

''

Remarks

This is the subject of an article in a newsgroup overview.

The $groupoverviewindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

ArticleReferences Property (IPWorks_NNTP Class)

Articles to which the posted article follows up.

Object Oriented Interface


public function getArticleReferences();


public function setArticleReferences($value);

Procedural Interface


ipworks_nntp_get($res, 16 );


ipworks_nntp_set($res, 16, $value );

Default Value

''

Remarks

This property contains articles to which the posted article follows up. If this property contains a non-empty string, a References article header is created for the article. This header shows the article identifiers for the posted article to which it refers.

The references must be separated by space characters.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleReplyTo Property (IPWorks_NNTP Class)

The address to reply to (for posting articles).

Object Oriented Interface


public function getArticleReplyTo();


public function setArticleReplyTo($value);

Procedural Interface


ipworks_nntp_get($res, 17 );


ipworks_nntp_set($res, 17, $value );

Default Value

''

Remarks

This property contains the address to reply to (for posting articles). If this property contains a non-empty string, a Reply-To article header is created for the article. This header shows the address to use for replies (useful if this address is different from the one in ArticleFrom).

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleSubject Property (IPWorks_NNTP Class)

The article subject (for posted articles).

Object Oriented Interface


public function getArticleSubject();


public function setArticleSubject($value);

Procedural Interface


ipworks_nntp_get($res, 18 );


ipworks_nntp_set($res, 18, $value );

Default Value

''

Remarks

The string in this property is posted with a Subject article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleText Property (IPWorks_NNTP Class)

The full text of the article (without the headers).

Object Oriented Interface


public function getArticleText();


public function setArticleText($value);

Procedural Interface


ipworks_nntp_get($res, 19 );


ipworks_nntp_set($res, 19, $value );

Default Value

''

Remarks

This property contains the full text of the article (without the headers). If the class is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full text of the article as reported by the server.

The NewsServer is asked about the text of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

When posting articles, this property contains the full text of the article to post.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the article lines must contain 7-bit characters so that the article can be successfully transferred through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another "." as specified in RFC 977. The article text is unescaped by the news server, so the process is fully transparent.

This property is not available at design time.

Data Type

String

AttachedFile Property (IPWorks_NNTP Class)

A file name which the contents of will be appended to the ArticleText when posting articles.

Object Oriented Interface


public function getAttachedFile();


public function setAttachedFile($value);

Procedural Interface


ipworks_nntp_get($res, 20 );


ipworks_nntp_set($res, 20, $value );

Default Value

''

Remarks

The content of this property is appended to the text in ArticleText (if any) and sent to the news server. This property is useful for posting arbitrarily large articles and/or sending MIME attachments.

It is advisable that the text contained in the file be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the message lines must contain only 7-bit characters so that the message may be successfully sent through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another as specified in RFC 822. The article text is unescaped by the news server, so the process is fully transparent.

This property is not available at design time.

Data Type

String

CheckDate Property (IPWorks_NNTP Class)

The date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.

Object Oriented Interface


public function getCheckDate();


public function setCheckDate($value);

Procedural Interface


ipworks_nntp_get($res, 21 );


ipworks_nntp_set($res, 21, $value );

Default Value

'000101 000000'

Remarks

This property contains the date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new. The value of this property is used as an argument for the ListNewGroups method.

This property is not available at design time.

Data Type

String

Connected Property (IPWorks_NNTP Class)

Shows whether the class is connected.

Object Oriented Interface


public function getConnected();


public function setConnected($value);

Procedural Interface


ipworks_nntp_get($res, 23 );


ipworks_nntp_set($res, 23, $value );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

CurrentArticle Property (IPWorks_NNTP Class)

The number or message identifier of the current article.

Object Oriented Interface


public function getCurrentArticle();


public function setCurrentArticle($value);

Procedural Interface


ipworks_nntp_get($res, 24 );


ipworks_nntp_set($res, 24, $value );

Default Value

''

Remarks

This property specifies either a message identifier or an article number uniquely identifying a particular article. It is then used as an argument to methods such as FetchArticle.

Data Type

String

CurrentGroup Property (IPWorks_NNTP Class)

The name of the current group.

Object Oriented Interface


public function getCurrentGroup();


public function setCurrentGroup($value);

Procedural Interface


ipworks_nntp_get($res, 25 );


ipworks_nntp_set($res, 25, $value );

Default Value

''

Remarks

This property contains the name of the current group. When this property is set to a valid group name, the class sends an NNTP GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle, LastArticle, and ArticleCount are set to the reported values for the group. This property is then used for all references to articles (until changed to another group).

Note: It is recommended to use the ChangeCurrentGroup method instead of setting this property.

Data Type

String

FirewallAutoDetect Property (IPWorks_NNTP Class)

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

Object Oriented Interface


public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface


ipworks_nntp_get($res, 26 );


ipworks_nntp_set($res, 26, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorks_NNTP Class)

This property determines the type of firewall to connect through.

Object Oriented Interface


public function getFirewallType();


public function setFirewallType($value);

Procedural Interface


ipworks_nntp_get($res, 27 );


ipworks_nntp_set($res, 27, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are the following:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (IPWorks_NNTP Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface


public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface


ipworks_nntp_get($res, 28 );


ipworks_nntp_set($res, 28, $value );

Default Value

''

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorks_NNTP Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface


public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface


ipworks_nntp_get($res, 29 );


ipworks_nntp_set($res, 29, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorks_NNTP Class)

This property contains the TCP port for the firewall Host .

Object Oriented Interface


public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface


ipworks_nntp_get($res, 30 );


ipworks_nntp_set($res, 30, $value );

Default Value

0

Remarks

This property contains the TCP port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note that this property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorks_NNTP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface


public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface


ipworks_nntp_get($res, 31 );


ipworks_nntp_set($res, 31, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirstArticle Property (IPWorks_NNTP Class)

The number of the first article in CurrentGroup .

Object Oriented Interface


public function getFirstArticle();


Procedural Interface


ipworks_nntp_get($res, 32 );


Default Value

0

Remarks

This property contains the number of the first article in CurrentGroup. The value of this property is 0 if there is no current group (CurrentGroup is "").

This property is read-only.

Data Type

Long64

GroupListCount Property (IPWorks_NNTP Class)

The number of records in the GroupList arrays.

Object Oriented Interface


public function getGroupListCount();


Procedural Interface


ipworks_nntp_get($res, 33 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at GroupListCount - 1.

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

Data Type

Integer

GroupListCanPost Property (IPWorks_NNTP Class)

This property indicates whether a group in a newsgroup listing allows postings or articles.

Object Oriented Interface


public function getGroupListCanPost($grouplistindex);


Procedural Interface


ipworks_nntp_get($res, 34 , $grouplistindex);


Default Value

false

Remarks

This property indicates whether a group in a newsgroup listing allows postings or articles.

The $grouplistindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

Boolean

GroupListFirstArticle Property (IPWorks_NNTP Class)

This property shows the first available article in a newsgroup listing.

Object Oriented Interface


public function getGroupListFirstArticle($grouplistindex);


Procedural Interface


ipworks_nntp_get($res, 35 , $grouplistindex);


Default Value

0

Remarks

This property shows the first available article in a newsgroup listing.

The $grouplistindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

Long64

GroupListGroup Property (IPWorks_NNTP Class)

This property shows the group name in a newsgroup listing.

Object Oriented Interface


public function getGroupListGroup($grouplistindex);


Procedural Interface


ipworks_nntp_get($res, 36 , $grouplistindex);


Default Value

''

Remarks

This property shows the group name in a newsgroup listing.

The $grouplistindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

String

GroupListLastArticle Property (IPWorks_NNTP Class)

This property shows the last available article in a newsgroup listing.

Object Oriented Interface


public function getGroupListLastArticle($grouplistindex);


Procedural Interface


ipworks_nntp_get($res, 37 , $grouplistindex);


Default Value

0

Remarks

This property shows the last available article in a newsgroup listing.

The $grouplistindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

Long64

Idle Property (IPWorks_NNTP Class)

The current status of the class.

Object Oriented Interface


public function getIdle();


Procedural Interface


ipworks_nntp_get($res, 38 );


Default Value

true

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LastArticle Property (IPWorks_NNTP Class)

The number of the last article in CurrentGroup .

Object Oriented Interface


public function getLastArticle();


Procedural Interface


ipworks_nntp_get($res, 39 );


Default Value

0

Remarks

This property contains the number of the last article in CurrentGroup. The value of this property is 0 if there is no current group (CurrentGroup is "").

This property is read-only.

Data Type

Long64

LastReply Property (IPWorks_NNTP Class)

The last reply from the server.

Object Oriented Interface


public function getLastReply();


Procedural Interface


ipworks_nntp_get($res, 40 );


Default Value

''

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalFile Property (IPWorks_NNTP Class)

The path to a local file for downloading the article body. If the file exists, it is overwritten (optional).

Object Oriented Interface


public function getLocalFile();


public function setLocalFile($value);

Procedural Interface


ipworks_nntp_get($res, 41 );


ipworks_nntp_set($res, 41, $value );

Default Value

''

Remarks

This property is used when retrieving an article. If this property is empty then the received data is provided through the parameters of the Transfer event

Data Type

String

LocalHost Property (IPWorks_NNTP Class)

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

Object Oriented Interface


public function getLocalHost();


public function setLocalHost($value);

Procedural Interface


ipworks_nntp_get($res, 42 );


ipworks_nntp_set($res, 42, $value );

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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 multi-homed 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.

Data Type

String

MaxLines Property (IPWorks_NNTP Class)

The maximum number of message lines aside from headers to retrieve.

Object Oriented Interface


public function getMaxLines();


public function setMaxLines($value);

Procedural Interface


ipworks_nntp_get($res, 43 );


ipworks_nntp_set($res, 43, $value );

Default Value

0

Remarks

This property is used to limit the number of text lines aside from headers retrieved for messages. This property is used in conjunction with the ArticleText property. Please note that due to NNTP protocol limitations, the full text of the article is always retrieved from the server, but only MaxLines will be stored in ArticleText.

The default value of the property is 0. In this case the entire message will be retrieved, without interruptions.

This property is not available at design time.

Data Type

Long64

Newsgroups Property (IPWorks_NNTP Class)

A comma separated list of newsgroups in which to post the article.

Object Oriented Interface


public function getNewsgroups();


public function setNewsgroups($value);

Procedural Interface


ipworks_nntp_get($res, 44 );


ipworks_nntp_set($res, 44, $value );

Default Value

''

Remarks

The string in this property is posted with a Newsgroups article header to the news server. It specifies the list of groups where the article is posted (comma separated).

If this property contains "" (empty string), then the value of the CurrentGroup property is used to specify the target newsgroup for the posted article.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

NewsPort Property (IPWorks_NNTP Class)

The server port for secure NNTP (default 119).

Object Oriented Interface


public function getNewsPort();


public function setNewsPort($value);

Procedural Interface


ipworks_nntp_get($res, 45 );


ipworks_nntp_set($res, 45, $value );

Default Value

119

Remarks

For implicit SSL, use port 563 (please refer to the SSLStartMode property for more information).

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.

This property is not available at design time.

Data Type

Integer

NewsServer Property (IPWorks_NNTP Class)

The name or address of a news server.

Object Oriented Interface


public function getNewsServer();


public function setNewsServer($value);

Procedural Interface


ipworks_nntp_get($res, 46 );


ipworks_nntp_set($res, 46, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or the Domain Name for the news server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

Organization Property (IPWorks_NNTP Class)

The organization of the author (for posting articles).

Object Oriented Interface


public function getOrganization();


public function setOrganization($value);

Procedural Interface


ipworks_nntp_get($res, 47 );


ipworks_nntp_set($res, 47, $value );

Default Value

''

Remarks

This property contains the organization of the article's author. If this property contains a non-empty string, an Organization article header is created for the article. This header shows the organization of the author and is used for information purposes only.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

OtherHeaders Property (IPWorks_NNTP Class)

An RFC850 compliant string consisting of extra headers (for posting articles).

Object Oriented Interface


public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface


ipworks_nntp_get($res, 48 );


ipworks_nntp_set($res, 48, $value );

Default Value

''

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like From, Subject, etc.

The headers must be of the format "header: value" as specified in RFC 850. [Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, article posting might not be successful.

This property is useful for extending the functionality of the class. A good example is posting of MIME attachments.

SPECIAL CASE: if this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed article headers.

This property is not available at design time.

Data Type

String

OverviewRange Property (IPWorks_NNTP Class)

A range for the GroupOverview method (first-last).

Object Oriented Interface


public function getOverviewRange();


public function setOverviewRange($value);

Procedural Interface


ipworks_nntp_get($res, 49 );


ipworks_nntp_set($res, 49, $value );

Default Value

'-'

Remarks

This property specifies a range of articles for which to retrieve article overviews from the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end.

The default value of this property is '-', meaning 'all articles in the group'.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (IPWorks_NNTP Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface


public function getParsedHeaderCount();


Procedural Interface


ipworks_nntp_get($res, 50 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (IPWorks_NNTP Class)

This property contains the name of the HTTP header (same case as it is delivered).

Object Oriented Interface


public function getParsedHeaderField($parsedheaderindex);


Procedural Interface


ipworks_nntp_get($res, 51 , $parsedheaderindex);


Default Value

''

Remarks

This property contains the name of the HTTP Header (same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (IPWorks_NNTP Class)

This property contains the header contents.

Object Oriented Interface


public function getParsedHeaderValue($parsedheaderindex);


Procedural Interface


ipworks_nntp_get($res, 52 , $parsedheaderindex);


Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

Password Property (IPWorks_NNTP Class)

A logon password for the NewsServer .

Object Oriented Interface


public function getPassword();


public function setPassword($value);

Procedural Interface


ipworks_nntp_get($res, 53 );


ipworks_nntp_set($res, 53, $value );

Default Value

''

Remarks

This property contains a logon password for the NewsServer. If this property is set to a non-empty string, then when connecting to the NewsServer an AUTHINFO PASS command is sent in order to provide authentication information for the user. This command is not part of the NNTP protocol, but it is widely used by popular news servers.

Data Type

String

SearchHeader Property (IPWorks_NNTP Class)

A header for the GroupSearch method.

Object Oriented Interface


public function getSearchHeader();


public function setSearchHeader($value);

Procedural Interface


ipworks_nntp_get($res, 54 );


ipworks_nntp_set($res, 54, $value );

Default Value

''

Remarks

This property specifies the header to search for SearchPattern (e.g. "Subject").

This property is not available at design time.

Data Type

String

SearchPattern Property (IPWorks_NNTP Class)

A search pattern for the GroupSearch method.

Object Oriented Interface


public function getSearchPattern();


public function setSearchPattern($value);

Procedural Interface


ipworks_nntp_get($res, 55 );


ipworks_nntp_set($res, 55, $value );

Default Value

''

Remarks

This property contains a search pattern for the GroupSearch method. The format of the pattern is the same as the patterns used by the UNIX 'find' command.

As an example, "* new *" will match all headers that contain the word "new".

This property is not available at design time.

Data Type

String

SearchRange Property (IPWorks_NNTP Class)

A range for the GroupSearch method (first-last).

Object Oriented Interface


public function getSearchRange();


public function setSearchRange($value);

Procedural Interface


ipworks_nntp_get($res, 56 );


ipworks_nntp_set($res, 56, $value );

Default Value

'-'

Remarks

This property specifies a range of articles for which to do a search on the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end.

The default value of the property is '-', meaning 'search all articles in the group'.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_NNTP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


ipworks_nntp_get($res, 58 );


ipworks_nntp_set($res, 58, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (IPWorks_NNTP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


ipworks_nntp_get($res, 86 );


ipworks_nntp_set($res, 86, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (IPWorks_NNTP Class)

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

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


ipworks_nntp_get($res, 102 );


ipworks_nntp_set($res, 102, $value );

Default Value

'MY'

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorks_NNTP Class)

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

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


ipworks_nntp_get($res, 103 );


ipworks_nntp_set($res, 103, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (IPWorks_NNTP Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


ipworks_nntp_get($res, 104 );


ipworks_nntp_set($res, 104, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property 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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; 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.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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

Data Type

Integer

SSLCertSubject Property (IPWorks_NNTP Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


ipworks_nntp_get($res, 105 );


ipworks_nntp_set($res, 105, $value );

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

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

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

Data Type

String

SSLEnabled Property (IPWorks_NNTP Class)

Whether TLS/SSL is enabled.

Object Oriented Interface


public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface


ipworks_nntp_get($res, 113 );


ipworks_nntp_set($res, 113, $value );

Default Value

false

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class 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.

Data Type

Boolean

SSLProvider Property (IPWorks_NNTP Class)

TBD.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


ipworks_nntp_get($res, 114 );


ipworks_nntp_set($res, 114, $value );

Default Value

0

Remarks

TBD.

Data Type

Integer

SSLServerCertEncoded Property (IPWorks_NNTP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


ipworks_nntp_get($res, 116 );


Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

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

Data Type

Binary String

SSLStartMode Property (IPWorks_NNTP Class)

Determines how the class starts the SSL negotiation.

Object Oriented Interface


public function getSSLStartMode();


public function setSSLStartMode($value);

Procedural Interface


ipworks_nntp_get($res, 143 );


ipworks_nntp_set($res, 143, $value );

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 class 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 class will first connect in plaintext, and then 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.

Data Type

Integer

Timeout Property (IPWorks_NNTP Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


ipworks_nntp_get($res, 144 );


ipworks_nntp_set($res, 144, $value );

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

Data Type

Integer

User Property (IPWorks_NNTP Class)

A user identifier to login as in the NewsServer .

Object Oriented Interface


public function getUser();


public function setUser($value);

Procedural Interface


ipworks_nntp_get($res, 145 );


ipworks_nntp_set($res, 145, $value );

Default Value

''

Remarks

This property contains a user identifier to login as in the NewsServer. If this property is set to a non-empty string, then when connecting to the NewsServer an AUTHINFO USER command is sent in order to provide authentication information for the user. Although this command is not part of the NNTP protocol, it is widely used by news servers for authentication purposes.

Data Type

String

ChangeCurrentGroup Method (IPWorks_NNTP Class)

Changes the current group.

Object Oriented Interface

public function doChangeCurrentGroup($group);

Procedural Interface

ipworks_nntp_do_changecurrentgroup($res, $group);

Remarks

This method changes the current group. When calling this method the class sends an NNTP GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle, LastArticle, and ArticleCount are set to the reported values for the group.

Config Method (IPWorks_NNTP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_nntp_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (IPWorks_NNTP Class)

Connects to the news server.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworks_nntp_do_connect($res);

Remarks

This method is used to connect to the news server. If the User and/or Password are set, then corresponding AUTHINFO commands are sent to the NewsServer as well.

Disconnect Method (IPWorks_NNTP Class)

Disconnects from the news server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworks_nntp_do_disconnect($res);

Remarks

This method is used to disconnect from the NewsServer. First the class attempts to send a QUIT command, and if that fails, the connection is broken.

DoEvents Method (IPWorks_NNTP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_nntp_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FetchArticle Method (IPWorks_NNTP Class)

Get the headers and body of an article specified in CurrentArticle .

Object Oriented Interface

public function doFetchArticle();

Procedural Interface

ipworks_nntp_do_fetcharticle($res);

Remarks

This method gets the headers and body of the article specified in CurrentArticle. The headers are delivered via the Header event, and the article body via the Transfer event.

If a connection to the NewsServer doesn't already exist, a new one is created.

FetchArticleBody Method (IPWorks_NNTP Class)

Gets only the body of an article specified in CurrentArticle .

Object Oriented Interface

public function doFetchArticleBody();

Procedural Interface

ipworks_nntp_do_fetcharticlebody($res);

Remarks

This method gets only the body of the article specified in CurrentArticle. The body via the Transfer event.

If a connection to the NewsServer doesn't already exist, a new one is created.

FetchArticleHeaders Method (IPWorks_NNTP Class)

Gets only the headers of an article specified in CurrentArticle .

Object Oriented Interface

public function doFetchArticleHeaders();

Procedural Interface

ipworks_nntp_do_fetcharticleheaders($res);

Remarks

This method gets only the headers of the article specified in CurrentArticle. The headers are delivered via the Header event.

If a connection to the NewsServer doesn't already exist, a new one is created.

GroupOverview Method (IPWorks_NNTP Class)

Receives an overview for the articles in range OverviewRange in the CurrentGroup .

Object Oriented Interface

public function doGroupOverview();

Procedural Interface

ipworks_nntp_do_groupoverview($res);

Remarks

This method receives an overview for the articles in range OverviewRange in the CurrentGroup. The overview data is delivered via the GroupOverview event.

If a connection to the NewsServer doesn't already exist, a new one is created.

GroupSearch Method (IPWorks_NNTP Class)

Receives an overview for the articles in range SearchRange in the CurrentGroup .

Object Oriented Interface

public function doGroupSearch();

Procedural Interface

ipworks_nntp_do_groupsearch($res);

Remarks

This method searches the current newsgroup for articles in range SearchRange in the CurrentGroup, where SearchHeader matches SearchPattern. The results are delivered via the GroupSearch event.

If a connection to the NewsServer doesn't already exist, a new one is created.

Interrupt Method (IPWorks_NNTP Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_nntp_do_interrupt($res);

Remarks

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

ListGroups Method (IPWorks_NNTP Class)

Lists all groups on the server.

Object Oriented Interface

public function doListGroups();

Procedural Interface

ipworks_nntp_do_listgroups($res);

Remarks

This method asks the server to list all its newsgroups. Use this method with caution as listing groups may take quite a long over slow links. The group names and other information are returned via the GroupList event.

If a connection to the NewsServer doesn't already exist, a new one is created.

ListNewGroups Method (IPWorks_NNTP Class)

Lists all new groups on the server.

Object Oriented Interface

public function doListNewGroups();

Procedural Interface

ipworks_nntp_do_listnewgroups($res);

Remarks

This method asks the server to list all the newsgroups created since CheckDate. The group names (if any) and other information are returned via the GroupList event.

If a connection to the NewsServer doesn't already exist, a new one is created.

LocalizeDate Method (IPWorks_NNTP Class)

Converts a valid RFC 822 message date to local date and time.

Object Oriented Interface

public function doLocalizeDate($datetime);

Procedural Interface

ipworks_nntp_do_localizedate($res, $datetime);

Remarks

This method can be used to convert an RFC 822 date/time string to the corresponding local date and time.

Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

PostArticle Method (IPWorks_NNTP Class)

Posts the current article and attached file.

Object Oriented Interface

public function doPostArticle();

Procedural Interface

ipworks_nntp_do_postarticle($res);

Remarks

This method posts the current article and attached file (if any). If a connection to the NewsServer doesn't already exist, a new one is created.

Reset Method (IPWorks_NNTP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_nntp_do_reset($res);

Remarks

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

ResetHeaders Method (IPWorks_NNTP Class)

Resets all of the article headers.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

ipworks_nntp_do_resetheaders($res);

Remarks

This method resets all the article headers to "" (empty string). Use this method before posting a new article, so that headers from the previous article are not carried over to the next one.

SendCommand Method (IPWorks_NNTP Class)

Sends the exact command directly to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

ipworks_nntp_do_sendcommand($res, $command);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the LastReply property and/or monitor the PITrail event to obtain the server's response.

ConnectionStatus Event (IPWorks_NNTP Class)

Fired to indicate changes in connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworks_nntp_register_callback($res, 1, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
'statuscode'
'description'

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

The ConnectionEvent parameter indicates the type of connection event. Values may include:

Firewall connection complete.
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 TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (IPWorks_NNTP Class)

Fired when the article text completes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_nntp_register_callback($res, 2, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The purpose of the EndTransfer event is twofold: during article retrieval it fires when the article body finishes transferring from the NewsServer to the local host, and during article posting it fires after the article body has been sent to the NewsServer.

If ArticleText is not empty, the EndTransfer event is fired when the ArticleText finishes transferring from the local host to the NewsServer. If ArticleText is empty, the event is not fired.

If a file is attached to the ArticleText via the AttachedFile property, then EndTransfer fires again when the file finishes transferring. Please go to the description of the AttachedFile property for more information.

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

Error Event (IPWorks_NNTP Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_nntp_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

GroupList Event (IPWorks_NNTP Class)

Fired while group data transfers (during group listings).

Object Oriented Interface

public function fireGroupList($param);

Procedural Interface

ipworks_nntp_register_callback($res, 4, array($this, 'fireGroupList'));

Parameter List

 'group'
'firstarticle'
'lastarticle'
'canpost'

Remarks

The GroupList event is fired for every group reported by the NewsServer when the ListGroups or ListNewGroups method is called.

The Group parameter shows the name of the group.

The FirstArticle and LastArticle parameters contain the article numbers for the first and last articles in the group.

The CanPost is True or False depending on whether article posting is allowed in the group specified by Group.

GroupOverview Event (IPWorks_NNTP Class)

Fired for each line of article overview data (during group overviews).

Object Oriented Interface

public function fireGroupOverview($param);

Procedural Interface

ipworks_nntp_register_callback($res, 5, array($this, 'fireGroupOverview'));

Parameter List

 'articlenumber'
'subject'
'from'
'articledate'
'messageid'
'references'
'articlesize'
'articlelines'
'otherheaders'

Remarks

ArticleNumber contains the number of the article within the group.

Subject contains the subject of the article.

From contains the email address of the article author.

ArticleDate contains the date the article was posted.

MessageId contains the unique message id for the article.

References contains the message ids for the articles this article refers to (separated by spaces).

ArticleSize contains the size of the article in bytes.

ArticleLines contains the number of lines in the article.

OtherHeaders contains any other article headers that NewsServer chooses to display for the article.

GroupSearch Event (IPWorks_NNTP Class)

Fired for each line of group search data (during group searches).

Object Oriented Interface

public function fireGroupSearch($param);

Procedural Interface

ipworks_nntp_register_callback($res, 6, array($this, 'fireGroupSearch'));

Parameter List

 'articlenumber'
'header'

Remarks

ArticleNumber contains the number of the article within the group.

Header contains the matching header.

Header Event (IPWorks_NNTP Class)

Fired for every article header being retrieved during article retrieval.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_nntp_register_callback($res, 7, array($this, 'fireHeader'));

Parameter List

 'field'
'value'

Remarks

The Field parameter contains the name of the header (same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

PITrail Event (IPWorks_NNTP Class)

Traces the commands sent to the news server, and the respective replies.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworks_nntp_register_callback($res, 8, array($this, 'firePITrail'));

Parameter List

 'direction'
'message'

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line, except for group listings, group overviews, article header, and article body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

0 (Client)The Message originates from the client.
1 (Server)The Message originates from the server.
2 (Info)The Message is an informative message originating from the client software (the class code).

SSLServerAuthentication Event (IPWorks_NNTP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_nntp_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (IPWorks_NNTP Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_nntp_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (IPWorks_NNTP Class)

Fired when the article text starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_nntp_register_callback($res, 11, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The purpose of the StartTransfer event is twofold: during article retrieval it fires when the article body starts transferring from the NewsServer to the local host, and during article posting it fires before the article body is sent to the NewsServer.

If ArticleText is not empty, the StartTransfer event is fired when the ArticleText starts transferring from the local host to the NewsServer. If ArticleText is empty, the event is not fired.

If a file is attached to the ArticleText via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.

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

Transfer Event (IPWorks_NNTP Class)

Fired while the article text gets transferred (to or from the NewsServer ).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_nntp_register_callback($res, 12, array($this, 'fireTransfer'));

Parameter List

 'direction'
'bytestransferred'
'percentdone'
'text'
'eol'

Remarks

One or more Transfer events are fired during article retrieval. The Text parameter contains the portion of article data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the article, including header bytes.

One or more Transfer events are also fired during article posting. Articles consist of ArticleText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of ArticleText and/or AttachedFile.

The Transfer event is fired for every line of the article. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

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 that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Configuration Settings (NNTP Class)

The class 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 class, access to these internal properties is provided through the Config method.

NNTP Configuration Settings

ArticleInfoLimit:   Instructs class to save the amount of articles specified that are returned by the server when a GroupOverview event is fired.

This config should be set when the ArticleList properties will be populated after a call to either GroupOverview or GroupSearch. This value represents the number of articles that are to be saved in the properties.

To save all items to the properties, set this config to -1. If no items are wanted, set this to 0, which will not save any to the properties. The default for this config is -1, so all items will be included in the properties.

GroupInfoLimit:   Instructs class to save the amount of group info objects specified that are returned by the server after a ListGroups call has been made.

This config should be set when the GroupList properties will be populated after a call to ListGroups. This value represents the number of group info objects that are to be saved in the properties.

To save all items to the properties, set this config to -1. If no items are wanted, set this to 0, which will not save any to the properties. The default for this config is -1, so all items will be included in the properties.

MaxHeaderLength:   Maximum length for headers to avoid line folding (default 80).

The MaxHeaderLength specifies the maximum line length supported by the news delivery system. Any headers longer than MaxHeaderLength are folded as specified in RFC 850.

It is generally a good idea to use a MaxHeaderLength of less than 100 bytes, although different news servers have different requirements for header lengths.

IPPort Configuration Settings

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 class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This setting is provided for use by classs 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 classs that do not directly expose Firewall properties.

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 class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This setting is provided for use by classs 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 classs 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 class fails with an error.

NOTE: This setting is provided for use by classs 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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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 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), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 class returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), 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, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class 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; setting is useful when trying to connect to services that require a trusted port in 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 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 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 true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class 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:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Configuration Settings

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

When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful 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 setting has no effect if UseInternalSecurityAPI is False.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class 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 class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class 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 certificates.

The default value is:

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

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to true the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class 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 class fails with an error.

When set to false (default) the CRL check will not be performed by the class.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength 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.

Please note that this 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 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 config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled 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 class 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 UseInternalSecurityAPI is False (default): obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when UseInternalSecurityAPI is False (default) include:

  • 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 UseInternalSecurityAPI is True: 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_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when UseInternalSecurityAPI is True include:
  • 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_DH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384
  • 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.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList setting.

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when UseInternalSecurityAPI is set to true.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

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

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class 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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when UseInternalSecurityAPI is set to True.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedProtocol:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedProtocol[connId]");

SSLProvider:   The name of the security provider to use.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed .

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed 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 not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when 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 setting should only be set 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 setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: IPPort.Config("UseInternalSecurityAPI=true"); IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this 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.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This 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 UseInternalSecurityAPI is set to True, 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 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 round trip 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 setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified 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"

TLS13Provider:   The TLS 1.3 implementation to be used.

This setting specifies the TLS 1.3 implementation which will be used when TLS 1.3 is enabled via SSLEnabledProtocols. Possible values are:

  • 0 (Internal - Default)
  • 1 (Platform)

The platform provider is only supported 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 only available 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 the above 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.

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "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 setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified 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 Configuration Settings

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

If AbsoluteTimeout is set to True, any method which 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 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class 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).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (NNTP Class)

NNTP Errors

118   Firewall Error. Error message contains detailed description.
181   NNTP protocol error. The error message contains the description.
182   Communication error. The error message contains the description.
183   No NewsServer specified.
184   Please specify a sender (From).
185   Please specify a subject (Subject).
186   Please specify at least a newsgroup to post to (CurrentGroup or Newsgroups).
187   Busy executing current method.
301   Operation interrupted.
302   Can't open local file.

The class may also return one of the following error codes, which are inherited from other classes.

IPPort 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   Cannot change UseConnection option while the class is Active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 PHP Edition - Version 22.0 [Build 8171]