SNNTP Class
Properties Methods Events Config Settings Errors
The SNNTP Class is used to read, search, and post articles on Usenet news servers.
Syntax
ipworkssmime.Snntp
Remarks
The SNNTP Class is the S/MIME enabled equivalent of the IPWorks NNTP class. In addition to standard NNTP functions the SNNTP class can sign, encrypt, decrypt, and verify message signatures. The methods and properties for encrypting, signing, decrypting, and verifying signatures are identical to those provided with the S/MIME class. After setting the certificate properties, and specifying ArticleText, call the Encrypt, Sign or SignAndEncrypt method before posting, and the result will be stored in ArticleText. When attempting to verify a signed message or when decrypting a message, call the Decrypt, VerifySignature, or DecryptAndVerifySignature methods and the resulting text will be replaced in ArticleText.
The SNNTP Class implements a standard Usenet news reader as specified in RFC 977. It can be used to browse Usenet news groups and to 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, and LastArticle, provide information about the current state.
The headers and text of the articles are received through the Header and Transfer events, respectively. 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, such as ArticleFrom, ArticleSubject, and Organization, 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.
ArticleCount | This property includes the estimated number of articles in CurrentGroup . |
ArticleDate | This property includes the date of the current article. |
ArticleFrom | This property includes the email address of the author (for posting articles). |
ArticleHeaders | This property includes the full headers of the article as retrieved from the server. |
ArticleId | This property includes the message identifier of the current article. |
ArticleList | This property includes a collection of articles collected through GroupOverview or GroupSearch . |
ArticleReferences | This property includes articles to which the posted article follows up. |
ArticleReplyTo | This property includes the address to reply to (for posting articles). |
ArticleSubject | This property includes the article subject (for posted articles). |
ArticleText | This property includes the full text of the article (without the headers). |
AttachedFile | This property includes a filename for which the contents will be appended to the ArticleText when posting articles. |
Certificate | This property includes the current selected certificate. |
CheckDate | This property includes the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new. |
Command | This property is used to send additional commands directly to the server. |
Connected | This shows whether the class is connected. |
CurrentArticle | This property includes the number or message identifier of the current article. |
CurrentGroup | This property includes the name of the current group. |
EncryptingAlgorithm | The property includes textual description of the encrypting algorithm. |
Firewall | A set of properties related to firewall access. |
FirstArticle | This property includes the number of the first article in CurrentGroup . |
GroupList | This property includes a collection of newsgroups listed by ListGroups or ListNewGroups . |
Idle | The current status of the class. |
IncludeCertificate | This property specifies whether to include the signer's certificate with the signed message. |
IncludeChain | This property specifies whether to include the signer's certificate chain with the signed message. |
LastArticle | This property includes the number of the last article in CurrentGroup . |
LastReply | The last reply from the server. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MaxLines | This property includes the maximum number of message lines aside from headers to retrieve. |
Newsgroups | This property includes a comma-separated list of newsgroups in which to post the article. |
NewsPort | This property includes the server port for the secure Network News Transfer Protocol (NNTP) (default 119). |
NewsServer | This property includes the name or address of a news server. |
Organization | This property includes the organization of the author (for posting articles). |
OtherHeaders | This property includes an RFC 850-compliant string consisting of extra headers (for posting articles). |
OverviewRange | This property includes the range for the GroupOverview method (first-last). |
ParsedHeaders | This property includes a collection of headers returned from the last article retrieval. |
Password | This property includes the logon password for the NewsServer . |
RecipientCerts | This property includes a collection of recipient certificates of the message. |
SearchHeader | This property includes a header for the GroupSearch method. |
SearchPattern | This property includes a search pattern for the GroupSearch method. |
SearchRange | This property includes the range for the GroupSearch method (first-last). |
SignerCert | This property contains the certificate of the message signer. |
SigningAlgorithm | This property includes a textual description of the signature hash algorithm. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLEnabled | Whether TLS/SSL is enabled. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
SSLStartMode | Determines how the class starts the SSL negotiation. |
Timeout | A timeout for the class. |
User | This property includes a 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.
AddRecipientCert | This method is used to add recipient certificates used to encrypt messages. |
ChangeCurrentGroup | This method changes the current group. |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to the news server. |
Decrypt | This method decrypts the current Message . |
DecryptAndVerifySignature | This method decrypts and verifies the signature of the current message. |
Disconnect | This method disconnects from the news server. |
DoEvents | Processes events from the internal message queue. |
Encrypt | This method encrypts the message. |
FetchArticle | This method gets the headers and body of an article specified in CurrentArticle . |
FetchArticleBody | This method gets only the body of an article specified in CurrentArticle . |
FetchArticleHeaders | This method gets only the headers of an article specified in CurrentArticle . |
GroupOverview | This method receives an overview for the articles in range OverviewRange in the CurrentGroup . |
GroupSearch | This method receives an overview for the articles in the range SearchRange in the CurrentGroup . |
Interrupt | Interrupt the current method. |
ListGroups | This method lists all newsgroups on the server. |
ListNewGroups | This method lists all newgroups on the server. |
LocalizeDate | This method converts a valid RFC 822 message date to a local date and time. |
PostArticle | This method posts the current article and attached file. |
Reset | This method resets the class. |
ResetHeaders | This method resets all of the article headers. |
SendCommand | Sends the exact command directly to the server. |
SetArticleStream | This method sets the stream to which the article downloaded from the server will be written. |
Sign | Signs the current message. |
SignAndEncrypt | Signs and encrypts the current message. |
VerifySignature | This method verifies the signature of the current message. |
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.
ConnectionStatus | This event is fired to indicate changes in the connection state. |
EndTransfer | This event is fired when the article text completes transferring. |
Error | Information about errors during data delivery. |
GroupList | This event is fired while group data transfers (during group listings). |
GroupOverview | This event is fired for each line of article overview data (during group overviews). |
GroupSearch | This event is fired for each line of group search data (during group searches). |
Header | This event is fired for every article header being retrieved during article retrieval. |
PITrail | This event traces the commands sent to the news server, and the respective replies. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | This event is fired when the article text starts transferring. |
Transfer | This event is fired while the article text gets transferred (to or from the NewsServer ). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ArticleInfoLimit | Instructs class to save the amount of articles specified that are returned by the server when a GroupOverview event is fired. |
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. |
HeaderLimit | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHeaderLength | Maximum length for headers to avoid line folding (default 80). |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
ArticleCount Property (SNNTP Class)
This property includes the estimated number of articles in CurrentGroup .
Syntax
public long getArticleCount();
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.
ArticleDate Property (SNNTP Class)
This property includes the date of the current article.
Syntax
public String getArticleDate();
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.
ArticleFrom Property (SNNTP Class)
This property includes the email address of the author (for posting articles).
Syntax
public String getArticleFrom(); public void setArticleFrom(String articleFrom);
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.
ArticleHeaders Property (SNNTP Class)
This property includes the full headers of the article as retrieved from the server.
Syntax
public String getArticleHeaders();
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.
ArticleId Property (SNNTP Class)
This property includes the message identifier of the current article.
Syntax
public String getArticleId();
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.
ArticleList Property (SNNTP Class)
This property includes a collection of articles collected through GroupOverview or GroupSearch .
Syntax
public ArticleInfoList getArticleList();
Remarks
This property contains a collection of articles collected through GroupOverview or GroupSearch. This collection consists of a list of ArticleInfo objects. The returned list contains information about each article in the OverviewRange or SearchRange when either GroupOverview or GroupSearch is called.
ArticleInfoLimit can be used to control the number of articles saved.
This collection is indexed from 0 to size -1.
This property is read-only and not available at design time.
Please refer to the ArticleInfo type for a complete list of fields.ArticleReferences Property (SNNTP Class)
This property includes articles to which the posted article follows up.
Syntax
public String getArticleReferences(); public void setArticleReferences(String articleReferences);
Default Value
""
Remarks
This property contains articles to which the posted article follows up. If this property contains a nonempty 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.
ArticleReplyTo Property (SNNTP Class)
This property includes the address to reply to (for posting articles).
Syntax
public String getArticleReplyTo(); public void setArticleReplyTo(String articleReplyTo);
Default Value
""
Remarks
This property contains the address to reply to (for posting articles). If this property contains a nonempty string, a Reply-To article header is created for the article. This header shows the address to use for replies, which is 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.
ArticleSubject Property (SNNTP Class)
This property includes the article subject (for posted articles).
Syntax
public String getArticleSubject(); public void setArticleSubject(String articleSubject);
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.
ArticleText Property (SNNTP Class)
This property includes the full text of the article (without the headers).
Syntax
public String getArticleText(); public void setArticleText(String articleText);
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.
AttachedFile Property (SNNTP Class)
This property includes a filename for which the contents will be appended to the ArticleText when posting articles.
Syntax
public String getAttachedFile(); public void setAttachedFile(String attachedFile);
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 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 sent successfully 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.
Certificate Property (SNNTP Class)
This property includes the current selected certificate.
Syntax
public Certificate getCertificate(); public void setCertificate(Certificate certificate);
Remarks
This property is populated when a specified certificate is found or loaded by the class. This property is used to specify private keys. Set this property to a valid Certificate object to perform different operations, such as Sign, Decrypt, SignAndEncrypt, or DecryptAndVerifySignature.
Please refer to the Certificate type for a complete list of fields.CheckDate Property (SNNTP Class)
This property includes the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new.
Syntax
public String getCheckDate(); public void setCheckDate(String checkDate);
Default Value
"000101 000000"
Remarks
This property contains the date (format YYMMDD HHMMSS) to check for the 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.
Command Property (SNNTP Class)
This property is used to send additional commands directly to the server.
Syntax
public void setCommand(String command);
Default Value
""
Remarks
This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.
This property is write-only and not available at design time.
Connected Property (SNNTP Class)
This shows whether the class is connected.
Syntax
public boolean isConnected(); public void setConnected(boolean connected);
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.
CurrentArticle Property (SNNTP Class)
This property includes the number or message identifier of the current article.
Syntax
public String getCurrentArticle(); public void setCurrentArticle(String currentArticle);
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.
CurrentGroup Property (SNNTP Class)
This property includes the name of the current group.
Syntax
public String getCurrentGroup(); public void setCurrentGroup(String currentGroup);
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 a Network News Transfer Protocol (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 it is changed to another group).
Note: It is recommended to use the ChangeCurrentGroup method instead of setting this property.
EncryptingAlgorithm Property (SNNTP Class)
The property includes textual description of the encrypting algorithm.
Syntax
public String getEncryptingAlgorithm(); public void setEncryptingAlgorithm(String encryptingAlgorithm);
Default Value
"3DES"
Remarks
This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.
Possible values are as follows:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
Firewall Property (SNNTP Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Please refer to the Firewall type for a complete list of fields.FirstArticle Property (SNNTP Class)
This property includes the number of the first article in CurrentGroup .
Syntax
public long getFirstArticle();
Default Value
0
Remarks
This property contains the number of the first article in CurrentGroup. The value of this property is zero if there is no current group (CurrentGroup is "").
This property is read-only.
GroupList Property (SNNTP Class)
This property includes a collection of newsgroups listed by ListGroups or ListNewGroups .
Syntax
public GroupInfoList getGroupList();
Remarks
This property contains a collection of newsgroups listed by ListGroups or ListNewGroups. This collection consists of a list of GroupInfo objects. These objects contain information about each group such as the name, first and last article, and whether or not you can post to the group.
GroupInfoLimit can be used to control the number of groups saved.
This collection is indexed from 0 to size -1.
This property is read-only and not available at design time.
Please refer to the GroupInfo type for a complete list of fields.Idle Property (SNNTP Class)
The current status of the class.
Syntax
public boolean isIdle();
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.
IncludeCertificate Property (SNNTP Class)
This property specifies whether to include the signer's certificate with the signed message.
Syntax
public boolean isIncludeCertificate(); public void setIncludeCertificate(boolean includeCertificate);
Default Value
True
Remarks
If this property is set to True, the certificate used to sign the message will be encoded and included in a message signature when calling Sign or SignAndEncrypt.
Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.
IncludeChain Property (SNNTP Class)
This property specifies whether to include the signer's certificate chain with the signed message.
Syntax
public boolean isIncludeChain(); public void setIncludeChain(boolean includeChain);
Default Value
False
Remarks
If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature when calling Sign or SignAndEncrypt.
Note: To include the chain, the IncludeCertificate property must also be set to true.
LastArticle Property (SNNTP Class)
This property includes the number of the last article in CurrentGroup .
Syntax
public long getLastArticle();
Default Value
0
Remarks
This property contains the number of the last article in CurrentGroup. The value of this property is zero if there is no current group (CurrentGroup is "").
This property is read-only.
LastReply Property (SNNTP Class)
The last reply from the server.
Syntax
public String getLastReply();
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.
LocalHost Property (SNNTP Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public String getLocalHost(); public void setLocalHost(String localHost);
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.
MaxLines Property (SNNTP Class)
This property includes the maximum number of message lines aside from headers to retrieve.
Syntax
public long getMaxLines(); public void setMaxLines(long maxLines);
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.
Note: Because of the Network News Transfer Protocol (NNTP) 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 zero. In this case, the entire message will be retrieved, without interruptions.
This property is not available at design time.
Newsgroups Property (SNNTP Class)
This property includes a comma-separated list of newsgroups in which to post the article.
Syntax
public String getNewsgroups(); public void setNewsgroups(String newsgroups);
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.
NewsPort Property (SNNTP Class)
This property includes the server port for the secure Network News Transfer Protocol (NNTP) (default 119).
Syntax
public int getNewsPort(); public void setNewsPort(int newsPort);
Default Value
119
Remarks
For implicit Secure Sockets Layer (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.
NewsServer Property (SNNTP Class)
This property includes the name or address of a news server.
Syntax
public String getNewsServer(); public void setNewsServer(String newsServer);
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. 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.
Organization Property (SNNTP Class)
This property includes the organization of the author (for posting articles).
Syntax
public String getOrganization(); public void setOrganization(String organization);
Default Value
""
Remarks
This property contains the organization of the article's author. If this property contains a nonempty 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.
OtherHeaders Property (SNNTP Class)
This property includes an RFC 850-compliant string consisting of extra headers (for posting articles).
Syntax
public String getOtherHeaders(); public void setOtherHeaders(String otherHeaders);
Default Value
""
Remarks
This property contains a string of headers to be appended to the message headers created from other properties like From and Subject.
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 (e.g., carriage return line feed, CRLF), then the value of this property is used instead of the normally computed article headers.
This property is not available at design time.
OverviewRange Property (SNNTP Class)
This property includes the range for the GroupOverview method (first-last).
Syntax
public String getOverviewRange(); public void setOverviewRange(String overviewRange);
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.
ParsedHeaders Property (SNNTP Class)
This property includes a collection of headers returned from the last article retrieval.
Syntax
public HeaderList getParsedHeaders();
Remarks
This property contains a collection of headers returned from the last article retrieval. This property is populated when either FetchArticle or FetchArticleHeaders is called. It contains a list of all of the headers from the article fetched.
If the header line being retrieved is a continuation header line, then the field parameter contains "" (empty string).
MaxHeaders can be used to control the number of headers saved.
This collection is indexed from 0 to size -1.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.Password Property (SNNTP Class)
This property includes the logon password for the NewsServer .
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
This property contains a logon password for the NewsServer. If this property is set to a nonempty string, then when connecting to the NewsServer an AUTHINFO PASS command is sent to provide authentication information for the user. This command is not part of the Network News Transfer Protocol (NNTP), but it is widely used by popular news servers.
RecipientCerts Property (SNNTP Class)
This property includes a collection of recipient certificates of the message.
Syntax
public CertificateList getRecipientCerts(); public void setRecipientCerts(CertificateList recipientCerts);
Remarks
This property is used to specify the certificates of the intended recipients of the encrypted message. This property must be set before calling Encrypt or SignAndEncrypt methods.
This property's collection must be filled out with valid public key Certificate type objects. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.
This collection is indexed from 0 to size -1.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.SearchHeader Property (SNNTP Class)
This property includes a header for the GroupSearch method.
Syntax
public String getSearchHeader(); public void setSearchHeader(String searchHeader);
Default Value
""
Remarks
This property specifies the header to search for SearchPattern (e.g., Subject).
This property is not available at design time.
SearchPattern Property (SNNTP Class)
This property includes a search pattern for the GroupSearch method.
Syntax
public String getSearchPattern(); public void setSearchPattern(String searchPattern);
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.
SearchRange Property (SNNTP Class)
This property includes the range for the GroupSearch method (first-last).
Syntax
public String getSearchRange(); public void setSearchRange(String searchRange);
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.
SignerCert Property (SNNTP Class)
This property contains the certificate of the message signer.
Syntax
public Certificate getSignerCert(); public void setSignerCert(Certificate signerCert);
Remarks
This property contains the certificate of the message signer. When calling VerifySignature or DecryptAndVerifySignature, this property will contain the certificate of the sender, if attached.
To verify messages without an attached certificate, set this property before calling VerifySignature or DecryptAndVerifySignature.
Please refer to the Certificate type for a complete list of fields.SigningAlgorithm Property (SNNTP Class)
This property includes a textual description of the signature hash algorithm.
Syntax
public String getSigningAlgorithm(); public void setSigningAlgorithm(String signingAlgorithm);
Default Value
"SHA256"
Remarks
This property specifies the hash algorithm used to prepare the message digest for signature.
This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:
- sha1
- md5
- sha-256 (default)
- sha-384
- sha-512
- sha-224
When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.
SSLAcceptServerCert Property (SNNTP Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (SNNTP Class)
The certificate to be used during SSL negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLEnabled Property (SNNTP Class)
Whether TLS/SSL is enabled.
Syntax
public boolean isSSLEnabled(); public void setSSLEnabled(boolean SSLEnabled);
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.
SSLProvider Property (SNNTP Class)
This specifies the SSL/TLS implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
SSLServerCert Property (SNNTP Class)
The server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SSLStartMode Property (SNNTP Class)
Determines how the class starts the SSL negotiation.
Syntax
public int getSSLStartMode(); public void setSSLStartMode(int SSLStartMode); Enumerated values: public final static int sslAutomatic = 0; public final static int sslImplicit = 1; public final static int sslExplicit = 2; public final static int sslNone = 3;
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. |
Timeout Property (SNNTP Class)
A timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the 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 throws an exception.
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.
User Property (SNNTP Class)
This property includes a user identifier to login as in the NewsServer .
Syntax
public String getUser(); public void setUser(String user);
Default Value
""
Remarks
This property contains a user identifier to login as in the NewsServer. If this property is set to a nonempty string, then when connecting to the NewsServer an AUTHINFO USER command is sent to provide authentication information for the user. Although this command is not part of the Network News Transfer Protocol (NNTP), it is widely used by news servers for authentication purposes.
AddRecipientCert Method (Snntp Class)
This method is used to add recipient certificates used to encrypt messages.
Syntax
public void addRecipientCert(byte[] certEncoded);
Remarks
This method is used to add recipient certificates to the internal MessageRecipients collection used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.
The CertMgr class may be used to retrieve the appropriate certificate from the system.
This method is used to add recipient certificates to the internal MessageRecipients collection used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.
The CertMgr class may be used to retrieve the appropriate certificate from the system.
ChangeCurrentGroup Method (Snntp Class)
This method changes the current group.
Syntax
public void changeCurrentGroup(String group);
Remarks
This method changes the current group. When calling this method, the class sends a Network News Transfer Protocol (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 (Snntp Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String 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 (Snntp Class)
This method connects to the news server.
Syntax
public void connect();
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.
Decrypt Method (Snntp Class)
This method decrypts the current Message .
Syntax
public void decrypt();
Remarks
This method attempts to decrypt the encrypted message using the certificate in Certificate.
DecryptAndVerifySignature Method (Snntp Class)
This method decrypts and verifies the signature of the current message.
Syntax
public void decryptAndVerifySignature();
Remarks
This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.
Note: This function does not attempt to check the validity of the signing certificate.
Disconnect Method (Snntp Class)
This method disconnects from the news server.
Syntax
public void disconnect();
Remarks
This method is used to disconnect from the NewsServer. The class first attempts to send a QUIT command, and if that fails, the connection is broken.
DoEvents Method (Snntp Class)
Processes events from the internal message queue.
Syntax
public void doEvents();
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.
Encrypt Method (Snntp Class)
This method encrypts the message.
Syntax
public void encrypt();
Remarks
This method encrypts the input message in a Public Key Cryptography Standards (PKCS)-encoded envelope with all of the recipient certificates specified in the MessageRecipients collection.
Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.
FetchArticle Method (Snntp Class)
This method gets the headers and body of an article specified in CurrentArticle .
Syntax
public void fetchArticle();
Remarks
This method gets the headers and body of the article specified in CurrentArticle. The headers are delivered through the Header event, and the article body is delivered through the Transfer event.
If a connection to the NewsServer does not already exist, a new one is created.
FetchArticleBody Method (Snntp Class)
This method gets only the body of an article specified in CurrentArticle .
Syntax
public void fetchArticleBody();
Remarks
This method gets only the body of the article specified in CurrentArticle. The body is delivered through the Transfer event.
If a connection to the NewsServer does not already exist, a new one is created.
FetchArticleHeaders Method (Snntp Class)
This method gets only the headers of an article specified in CurrentArticle .
Syntax
public void fetchArticleHeaders();
Remarks
This method gets only the headers of the article specified in CurrentArticle. The headers are delivered through the Header event.
If a connection to the NewsServer does not already exist, a new one is created.
GroupOverview Method (Snntp Class)
This method receives an overview for the articles in range OverviewRange in the CurrentGroup .
Syntax
public void groupOverview();
Remarks
This method receives an overview for the articles in range OverviewRange in the CurrentGroup. The overview data are delivered through the GroupOverview event.
If a connection to the NewsServer does not already exist, a new one is created.
GroupSearch Method (Snntp Class)
This method receives an overview for the articles in the range SearchRange in the CurrentGroup .
Syntax
public void groupSearch();
Remarks
This method searches the current newsgroup for articles in the range SearchRange in the CurrentGroup, where SearchHeader matches SearchPattern. The results are delivered through the GroupSearch event.
If a connection to the NewsServer does not already exist, a new one is created.
Interrupt Method (Snntp Class)
Interrupt the current method.
Syntax
public void interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListGroups Method (Snntp Class)
This method lists all newsgroups on the server.
Syntax
public void listGroups();
Remarks
This method asks the server to list all of its newsgroups. Use this method with caution as listing groups may take quite a long time over slow links. The group names and other information are returned via the GroupList event.
If a connection to the NewsServer does not already exist, a new one is created.
ListNewGroups Method (Snntp Class)
This method lists all newgroups on the server.
Syntax
public void listNewGroups();
Remarks
This method asks the server to list all of 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 does not already exist, a new one is created.
LocalizeDate Method (Snntp Class)
This method converts a valid RFC 822 message date to a local date and time.
Syntax
public String localizeDate(String dateTime);
Remarks
This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.
Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".
PostArticle Method (Snntp Class)
This method posts the current article and attached file.
Syntax
public void postArticle();
Remarks
This method posts the current article and attached file (if any). If a connection to the NewsServer does not already exist, a new one is created.
Reset Method (Snntp Class)
This method resets the class.
Syntax
public void reset();
Remarks
This method will reset the class's properties to their default values.
ResetHeaders Method (Snntp Class)
This method resets all of the article headers.
Syntax
public void resetHeaders();
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 (Snntp Class)
Sends the exact command directly to the server.
Syntax
public void sendCommand(String 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.
SetArticleStream Method (Snntp Class)
This method sets the stream to which the article downloaded from the server will be written.
Syntax
public void setArticleStream(java.io.OutputStream articleStream);
Remarks
This method sets the stream to which the article downloaded from the server will be written. If a download stream is set before the FetchArticle or FetchArticleBody methods are called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is set to True (default). If the stream is closed, you will need to call SetArticleStream again before calling FetchArticle or FetchArticleBody again. The downloaded content will be written starting at the current position in the stream.
Note: SetArticleStream and LocalFile will reset the other.
Sign Method (Snntp Class)
Signs the current message.
Syntax
public void sign();
Remarks
This method digitally signs the input data with the certificate provided. Certificates are provided by specifying the Certificate property. The IncludeCertificate property allows you to specify whether to include the certificate when signing the message.
SignAndEncrypt Method (Snntp Class)
Signs and encrypts the current message.
Syntax
public void signAndEncrypt();
Remarks
This method both signs and encrypts the input message into a single PKCS encoded envelope.
Please note that the message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.
VerifySignature Method (Snntp Class)
This method verifies the signature of the current message.
Syntax
public void verifySignature();
Remarks
This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the class throws an exception.
If this method is successful, the SignerCert property will contain the certificate information of the message signer.
Note: This function does not attempt to check the validity of the signing certificate.
ConnectionStatus Event (Snntp Class)
This event is fired to indicate changes in the connection state.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void connectionStatus(SnntpConnectionStatusEvent e) {} ... } public class SnntpConnectionStatusEvent { public String connectionEvent; public int statusCode; public String description; }
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
EndTransfer Event (Snntp Class)
This event is fired when the article text completes transferring.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void endTransfer(SnntpEndTransferEvent e) {} ... } public class SnntpEndTransferEvent { public int direction; }
Remarks
The purpose of the EndTransfer event is twofold: (1) during article retrieval, it fires when the article body finishes transferring from the NewsServer to the local host; and (2) 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 through the AttachedFile property, then EndTransfer fires again when the file finishes transferring. Please see 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 (Snntp Class)
Information about errors during data delivery.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void error(SnntpErrorEvent e) {} ... } public class SnntpErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
GroupList Event (Snntp Class)
This event is fired while group data transfers (during group listings).
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void groupList(SnntpGroupListEvent e) {} ... } public class SnntpGroupListEvent { public String group; public long firstArticle; public long lastArticle; public boolean 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 (Snntp Class)
This event is fired for each line of article overview data (during group overviews).
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void groupOverview(SnntpGroupOverviewEvent e) {} ... } public class SnntpGroupOverviewEvent { public long articleNumber; public String subject; public String from; public String articleDate; public String messageId; public String references; public long articleSize; public long articleLines; public String 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 (Snntp Class)
This event is fired for each line of group search data (during group searches).
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void groupSearch(SnntpGroupSearchEvent e) {} ... } public class SnntpGroupSearchEvent { public long articleNumber; public String header; }
Remarks
ArticleNumber contains the number of the article within the group.
Header contains the matching header.
Header Event (Snntp Class)
This event is fired for every article header being retrieved during article retrieval.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void header(SnntpHeaderEvent e) {} ... } public class SnntpHeaderEvent { public String field; public String value; }
Remarks
The Field parameter contains the name of the header (In the same case as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
PITrail Event (Snntp Class)
This event traces the commands sent to the news server, and the respective replies.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void PITrail(SnntpPITrailEvent e) {} ... } public class SnntpPITrailEvent { public int direction; public String 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 (Snntp Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void SSLServerAuthentication(SnntpSSLServerAuthenticationEvent e) {} ... } public class SnntpSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; }
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Snntp Class)
Shows the progress of the secure connection.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void SSLStatus(SnntpSSLStatusEvent e) {} ... } public class SnntpSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (Snntp Class)
This event is fired when the article text starts transferring.
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void startTransfer(SnntpStartTransferEvent e) {} ... } public class SnntpStartTransferEvent { public int 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 (Snntp Class)
This event is fired while the article text gets transferred (to or from the NewsServer ).
Syntax
public class DefaultSnntpEventListener implements SnntpEventListener { ... public void transfer(SnntpTransferEvent e) {} ... } public class SnntpTransferEvent { public int direction; public long bytesTransferred; public int percentDone; public byte[] text; public boolean 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: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
ArticleInfo Type
This is an article listed as a result of a GroupOverview or GroupSearch .
Remarks
This type describes information about an article as returned by the server after a GroupOverview or GroupSearch. It includes fields to denote detailed information about the article.
Fields
ArticleLines
long (read-only)
Default Value: 0
This is the number of lines of an article in a newsgroup overview.
ArticleNumber
long (read-only)
Default Value: 0
This is the number of an article in a newsgroup overview.
ArticleSize
long (read-only)
Default Value: 0
This is the size of an article in a newsgroup overview.
Date
String (read-only)
Default Value: ""
This is the date of an article in a newsgroup overview.
From
String (read-only)
Default Value: ""
This is the sender of an article in a newsgroup overview.
MessageId
String (read-only)
Default Value: ""
This is the unique message Id of an article in a newsgroup overview.
OtherHeaders
String (read-only)
Default Value: ""
This is the remaining headers of an article in a newsgroup overview.
References
String (read-only)
Default Value: ""
This is the references of an article in a newsgroup overview.
Subject
String (read-only)
Default Value: ""
This is the subject of an article in a newsgroup overview.
Constructors
public ArticleInfo();
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
String (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
Encoded
String
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte[]
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
ExpirationDate
String (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
String
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
String (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
String (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
String (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
String (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
String
Default Value: ""
This is the password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.
Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.
PrivateKey
String (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
String (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
String
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte[]
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
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 field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Subject
String
Default Value: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SubjectAltNames
String (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
String (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
String (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
String
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signatures
- Key Authentication
- Key Encryption
- Data Encryption
- Key Agreement
- Certificate Signing
- Key Signing
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signatures |
0x40 | Key Authentication (Non-Repudiation) |
0x20 | Key Encryption |
0x10 | Data Encryption |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | Key Signing |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate( certificateData);
Parses CertificateData as an X509 public key.
public Certificate( certStoreType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate( certStoreType, storeBlob, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
Firewall Type
This is the firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
boolean
Default Value: False
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.
If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).
FirewallType
int
Default Value: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
String
Default Value: ""
This field contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.
Password
String
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.
Port
int
Default Value: 0
This field contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
String
Default Value: ""
This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.
Constructors
public Firewall();
GroupInfo Type
This is a group listed by the Network News Transfer Protocol (NNTP) server.
Remarks
This type describes information about a group as returned by the server. The GroupInfo fields contain information about each group, such as the name, first and last article, and whether or not you can post to the group.
Fields
CanPost
boolean (read-only)
Default Value: False
This field indicates whether a group in a newsgroup listing allows postings or articles.
FirstArticle
long (read-only)
Default Value: 0
This field shows the first available article in a newsgroup listing.
Group
String (read-only)
Default Value: ""
This field shows the group name in a newsgroup listing.
LastArticle
long (read-only)
Default Value: 0
This field shows the last available article in a newsgroup listing.
Constructors
public GroupInfo();
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.
Fields
Field
String
Default Value: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
String
Default Value: ""
This field contains the Header contents.
Constructors
public Header();
public Header( field, value);
Config Settings (Snntp 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 Config Settings
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any to the collection. The default for this configuration setting is 0, so no items will be included in the collection.
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.
TCPClient Config Settings
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.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect 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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 SSLProvider is set to Platform.
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.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
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.
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.
Note: This value must be set after SSLProvider is set.
Example values:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values when SSLProvider is set to latform include:
- SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_WITH_DES_CBC_SHA
- SSL_RSA_WITH_NULL_MD5
- SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
- SSL_DHE_RSA_WITH_DES_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
- SSL_RSA_WITH_NULL_SHA
- SSL_DH_anon_WITH_RC4_128_MD5
- SSL_RSA_WITH_RC4_128_MD5
- SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_NULL_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
- TLS_ECDH_anon_WITH_RC4_128_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_EXPORT_WITH_RC4_40_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_RC4_128_SHA
- TLS_ECDH_ECDSA_WITH_RC4_128_SHA
- TLS_ECDH_anon_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_NULL_SHA256
- TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
- TLS_KRB5_WITH_RC4_128_MD5
- TLS_ECDHE_ECDSA_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_RC4_128_SHA
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV
- TLS_KRB5_WITH_3DES_EDE_CBC_MD5
- TLS_KRB5_WITH_RC4_128_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_NULL_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_DES_CBC_MD5
- TLS_KRB5_EXPORT_WITH_RC4_40_MD5
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
- TLS_ECDH_anon_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_WITH_DES_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_NULL_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
Possible values when SSLProvider is set to Internal 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 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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.
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.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is 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.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
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 SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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-----
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 throws an exception.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this 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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
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.
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 Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (Snntp Class)
NNTP Errors
118 Firewall Error. Error message contains detailed description. | |
181 Network News Transfer Protocol (NNTP) 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 Cannot open local file. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the 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. | |
303 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on 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). |