Search: 
Available in: SSH | SSL
Nntps Class
NNTPS Component [IP*Works! SSL V8]

Properties   Methods   Events   Configuration Settings  

The NNTPS component is used to read and post articles on Usenet news servers.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The NNTPS component is the SSL-enabled equivalent of the IP*Works! NNTP component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The SSLCert property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

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

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

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

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

Property List


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

ArticleCount The estimated number of articles in CurrentGroup.
ArticleDate The date of the current article.
ArticleFrom The email address of the author (for posting articles).
ArticleHeaders The full headers of the article as retrieved from the server.
ArticleId The message-id of the current article.
ArticleList Collection of articles collected through GroupOverview or GroupSearch.
ArticleReferences Articles the posted article follows up to.
ArticleReplyTo The address to reply to (for posting articles).
ArticleSubject The article subject (for posted articles).
ArticleText The full text of the article (without the headers).
AttachedFile A file name of which the contents will be appended to ArticleText when posting articles.
CheckDate The date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.
Command Can be used to send additional commands directly to the server.
Connected Shows whether the component is connected.
CurrentArticle The number or message-id of the current article.
CurrentGroup The name of the current group.
Firewall A set of properties related to firewall access.
FirstArticle The number of the first article in CurrentGroup.
GroupList Collection of newsgroups listed by ListGroups or ListNewGroups.
Idle The current status of the component.
LastArticle The number of the last article in CurrentGroup.
LastReply The last reply from the server.
LocalFile The path to a local file for downloading the article body. If the file exists, it is overwritten. (optional)
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxLines The maximum number of message lines besides headers to retrieve.
NewsPort The server port for secure NNTP (default 563).
NewsServer The name or address of a news server.
Newsgroups A comma separated list of newsgroups in which to post the article.
Organization The organization of the author (for posting articles).
OtherHeaders An RFC850 compliant string consisting of extra headers (for posting articles).
OverviewRange A range for the GroupOverview method (first-last).
ParsedHeaders A collection of headers returned from the last article retrieval.
Password A login password to login with in the NewsServer.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert The certificate to be used during ssl negotiation.
SSLServerCert The server certificate for the last established connection.
SSLStartMode Determines how the component starts the SSL negotiation.
SearchHeader A header for the GroupSearch method.
SearchPattern A search pattern for the GroupSearch method.
SearchRange A range for the GroupSearch method (first-last).
Timeout A timeout for the component.
User A user id to login as in the NewsServer.

Method List


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

Config Sets or retrieves a component configuration setting.
Connect Connect to the news server.
Disconnect Disconnect from the news server.
DoEvents Processes events from the internal message queue.
FetchArticle Get the headers and body of an article specified in CurrentArticle.
FetchArticleBody Get only the body of an article specified in CurrentArticle.
FetchArticleHeaders Get only the headers of an article specified in CurrentArticle.
GroupOverview Receive an overview for the articles in range OverviewRange in the CurrentGroup.
GroupSearch Receive an overview for the articles in range SearchRange in the CurrentGroup.
Interrupt Interrupt the current method.
ListGroups List all groups on the server.
ListNewGroups List all new groups on the server.
LocalizeDate Converts a valid RFC 822 message date to local date and time.
PostArticle Post the current article and attached file.
ResetHeaders Reset all of the article headers.
SetArticleStream Sets the stream to which the article downloaded from the server will be written.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

ConnectionStatus Fired to indicate changes in connection state.
EndTransfer Fired when the article text completes transferring.
Error Information about errors during data delivery.
GroupList Fired while group data transfers (during group listings).
GroupOverview Fired for each line of article overview data (during group overviews).
GroupSearch Fired for each line of group search data (during group searches).
Header Fired for every article header being retrieved during article retrieval.
PITrail 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 Fired when the article text starts transferring.
Transfer Fired while the article text gets transferred (to or from the ).

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptAnyServerCert If set the component will accept any certificate presented by the server
ArticleInfoLimit Instructs component to save the amount of articles specified that are returned by the server when a GroupOverview event is fired.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
GroupInfoLimit Instructs component to save the amount of group info objects specified that are returned by the server after a ListGroups call has been made.
InBufferSize The size in bytes of the incoming queue of the socket.
MaxHeaderLength Maximum length for headers to avoid line folding (default 80)
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OpenSSLCADir The path to a directory containing CA certificates.
OpenSSLCAFile Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData The data to seed the pseudo random number generator(PRNG).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ReuseSSLSession Determines if the SSL session is reused.
SSLCipherStrength The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols Used to enable/disable the supported security protocols.
SSLProvider The name of the security provider to use.
SSLSecurityFlags Flags that control certificate verification
TcpNoDelay Whether or not to delay when sending packets
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.