NNTP Bean
Properties Methods Events Configuration Settings Errors
The NNTP Component is used to read, search, and post articles on Usenet news servers.
Syntax
IPWorks.Nntp
Remarks
The NNTP Bean 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 bean 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 bean with short descriptions. Click on the links for further details.
| 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 identifier of the current article. |
| ArticleList | Collection of articles collected through GroupOverview or GroupSearch . |
| ArticleReferences | Articles to which the posted article follows up. |
| 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 which the contents of will be appended to the 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 | Used to send additional commands directly to the server. |
| Connected | Shows whether the component is connected. |
| CurrentArticle | The number or message identifier 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 aside from headers to retrieve. |
| Newsgroups | A comma separated list of newsgroups in which to post the article. |
| NewsPort | The server port for NNTP (default 119). |
| NewsServer | The name or address of a news server. |
| 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 logon password for the NewsServer . |
| 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 identifier to login as in the NewsServer . |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting . |
| connect | Connects to the news server. |
| disconnect | Disconnects 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 | Gets only the body of an article specified in CurrentArticle . |
| fetchArticleHeaders | Gets only the headers of an article specified in CurrentArticle . |
| groupOverview | Receives an overview for the articles in range OverviewRange in the CurrentGroup . |
| groupSearch | Receives an overview for the articles in range SearchRange in the CurrentGroup . |
| interrupt | Interrupt the current method. |
| listGroups | Lists all groups on the server. |
| listNewGroups | Lists all new groups on the server. |
| localizeDate | Converts a valid RFC 822 message date to local date and time. |
| postArticle | Posts the current article and attached file. |
| resetHeaders | Resets 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 bean with short descriptions. Click on the links for further details.
| 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. |
| StartTransfer | Fired when the article text starts transferring. |
| Transfer | Fired while the article text gets transferred (to or from the NewsServer ). |
Configuration Settings
The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.
| ArticleInfoLimit | Instructs component to save the amount of articles specified that are returned by the server when a GroupOverview event is fired. |
| 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. |
| MaxHeaderLength | Maximum length for headers to avoid line folding (default 80). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |