NNTP Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorks_NNTP

Procedural Interface

 ipworks_nntp_open();
 ipworks_nntp_close($res);
 ipworks_nntp_register_callback($res, $id, $function);
 ipworks_nntp_get_last_error($res);
 ipworks_nntp_get_last_error_code($res);
 ipworks_nntp_set($res, $id, $index, $value);
 ipworks_nntp_get($res, $id, $index);
 ipworks_nntp_do_config($res, $configurationstring);
 ipworks_nntp_do_connect($res);
 ipworks_nntp_do_disconnect($res);
 ipworks_nntp_do_doevents($res);
 ipworks_nntp_do_fetcharticle($res);
 ipworks_nntp_do_fetcharticlebody($res);
 ipworks_nntp_do_fetcharticleheaders($res);
 ipworks_nntp_do_groupoverview($res);
 ipworks_nntp_do_groupsearch($res);
 ipworks_nntp_do_interrupt($res);
 ipworks_nntp_do_listgroups($res);
 ipworks_nntp_do_listnewgroups($res);
 ipworks_nntp_do_localizedate($res, $datetime);
 ipworks_nntp_do_postarticle($res);
 ipworks_nntp_do_resetheaders($res);

Remarks

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

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

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

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