Search: 
Available in: IP*WORKS! | SSH | SSL
NNTP Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The NNTP 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 NNTP 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 further details.

ArticleCountThe estimated number of articles in CurrentGroup.
ArticleDateThe date of the current article.
ArticleFromThe email address of the author (for posting articles).
ArticleHeadersThe full headers of the article as retrieved from the server.
ArticleIdThe message-id of the current article.
ArticleListCollection of articles collected through GroupOverview or GroupSearch.
ArticleReferencesArticles the posted article follows up to.
ArticleReplyToThe address to reply to (for posting articles).
ArticleSubjectThe article subject (for posted articles).
ArticleTextThe full text of the article (without the headers).
AttachedFileA file name of which the contents will be appended to ArticleText when posting articles.
CheckDateThe date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.
CommandCan be used to send additional commands directly to the server.
ConnectedShows whether the component is connected.
CurrentArticleThe number or message Id of the current article.
CurrentGroupThe name of the current group.
FirewallA set of properties related to firewall access.
FirstArticleThe number of the first article in CurrentGroup.
GroupListCollection of newsgroups listed by ListGroups or ListNewGroups.
IdleThe current status of the component.
LastArticleThe number of the last article in CurrentGroup.
LastReplyThe last reply from the server.
LocalFileThe path to a local file for downloading the article body. If the file exists, it is overwritten (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxLinesThe maximum number of message lines besides headers to retrieve.
NewsgroupsA comma separated list of newsgroups in which to post the article.
NewsPortThe server port for NNTP (default 119).
NewsServerThe name or address of a news server.
OrganizationThe organization of the author (for posting articles).
OtherHeadersAn RFC850 compliant string consisting of extra headers (for posting articles).
OverviewRangeA range for the GroupOverview method (first-last).
ParsedHeadersA collection of headers returned from the last article retrieval.
PasswordA logon password for the NewsServer.
SearchHeaderA header for the GroupSearch method.
SearchPatternA search pattern for the GroupSearch method.
SearchRangeA range for the GroupSearch method (first-last).
TimeoutA timeout for the component.
UserA 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 further details.

ConfigSets or retrieves a configuration setting.
ConnectConnect to the news server.
DisconnectDisconnect from the news server.
DoEventsProcesses events from the internal message queue.
FetchArticleGet the headers and body of an article specified in CurrentArticle.
FetchArticleBodyGet only the body of an article specified in CurrentArticle.
FetchArticleHeadersGet only the headers of an article specified in CurrentArticle.
GroupOverviewReceive an overview for the articles in range OverviewRange in the CurrentGroup.
GroupSearchReceive an overview for the articles in range SearchRange in the CurrentGroup.
InterruptInterrupt the current method.
ListGroupsList all groups on the server.
ListNewGroupsList all new groups on the server.
LocalizeDateConverts a valid RFC 822 message date to local date and time.
PostArticlePost the current article and attached file.
ResetHeadersReset all of the article headers.
SetArticleStreamSets 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 further details.

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

Configuration Settings


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

ArticleInfoLimitInstructs component to save the amount of articles specified that are returned by the server when a GroupOverview event is fired
GroupInfoLimitInstructs component to save the amount of group info objects specified that are returned by the server after a ListGroups call has been made
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80)
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
TcpNoDelayWhether or not to delay when sending packets
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts
FirewallDataUsed to send extra data to the firewall
InBufferSizeThe size in bytes of the incoming queue of the socket
OutBufferSizeThe size in bytes of the outgoing queue of the socket
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only)

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