IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

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.

Property List


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

ArticleCountThe estimated number of articles in CurrentGroup .
ArticleDateThe date of the current article.
ArticleFromThe email address of the author (for posting articles).
ArticleHeadersThe full headers of the article as retrieved from the server.
ArticleIdThe message identifier of the current article.
GroupOverviewCountThe number of records in the GroupOverview arrays.
GroupOverviewArticleLinesThe number of lines of an article in a newsgroup overview.
GroupOverviewArticleNumberThe number of an article in a newsgroup overview.
GroupOverviewArticleSizeThe size of an article in a newsgroup overview.
GroupOverviewDateThe date of an article in a newsgroup overview.
GroupOverviewFromThe sender of an article in a newsgroup overview.
GroupOverviewMessageIdThe unique message id of an article in a newsgroup overview.
GroupOverviewOtherHeadersThe remaining headers of an article in a newsgroup overview.
GroupOverviewReferencesThe references of an article in a newsgroup overview.
GroupOverviewSubjectThe subject of an article in a newsgroup overview.
ArticleReferencesArticles to which the posted article follows up.
ArticleReplyToThe address to reply to (for posting articles).
ArticleSubjectThe article subject (for posted articles).
ArticleTextThe full text of the article (without the headers).
AttachedFileA file name which the contents of will be appended to the ArticleText when posting articles.
CheckDateThe date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the component is connected.
CurrentArticleThe number or message identifier of the current article.
CurrentGroupThe name of the current group.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FirstArticleThe number of the first article in CurrentGroup .
GroupListCountThe number of records in the GroupList arrays.
GroupListCanPostThis property indicates whether a group in a newsgroup listing allows postings or articles.
GroupListFirstArticleThis property shows the first available article in a newsgroup listing.
GroupListGroupThis property shows the group name in a newsgroup listing.
GroupListLastArticleThis property shows the last available article in a newsgroup listing.
IdleThe current status of the 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 aside from 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).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA logon password for the NewsServer .
SearchHeaderA header for the GroupSearch method.
SearchPatternA search pattern for the GroupSearch method.
SearchRangeA range for the GroupSearch method (first-last).
TimeoutA timeout for the component.
UserA user identifier to login as in the NewsServer .

Method List


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

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

Event List


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

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

Configuration Settings


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

ArticleInfoLimitInstructs 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).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
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.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0