Get-NNTP Cmdlet

Parameters   Output Objects   Configuration Settings  

The Get-NNTP cmdlet is used to read articles on Usenet news servers.

Syntax

Get-NNTP [parameters]

Remarks

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

To get a listing of all available news groups on a server, set the Server parameter. The Credential parameter can be used optionally for authentication. This will return a separate Newsgroup object for each newsgroup found on the server.

Setting the Newsgroup parameter will instruct the cmdlet to obtain a listing of the most recent articles in the server, resulting in a separate NNTPArticleHeaders object for each message found. The list can be filtered by setting the Range parameter to the range of articles to retrieve or by setting the List parameter to the number of most recent articles to be listed. If neither is set, all messages in the newsgroup will be listed.

To view the contents of an article, set the View parameter to the article number of the message to retrieve. This will return an NNTPArticle object containing the contents of the message.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new NNTP connection, use the Connect-NNTP cmdlet. To close the connection, use the Disconnect-NNTP cmdlet.