ch17_02.htm

by Randal L. Schwartz and Tom Phoenix ISBN 0-596-00132-0 Third Edition, published July 2001. (See

</pre><p><a name="INDEX-2226" />Sets the current article pointer to the
previous article in the current newsgroup. Returns the
article's message ID.
</p></div>

<a name="INDEX-2227" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>list</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;list(  )
</pre><p><a name="INDEX-2227" />Returns information about all active
newsgroups. The result is a reference to a hash in which the key is a
newsgroup name, and each value is a reference to an array. The
elements in the array are the first article number in the group, the
last article number in the group, and any information flags.
</p></div>

<a name="INDEX-2228" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>listgroup</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;listgroup([<em class="replaceable">group</em>])
</pre><p><a name="INDEX-2228" />Returns a reference to a list of
all active messages in newsgroup <em class="replaceable"><tt>group</tt></em>, or
the current newsgroup if <em class="replaceable"><tt>group</tt></em> is not
specified (an extension).
</p></div>

<a name="INDEX-2229" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>newgroups</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;newgroups(<em class="replaceable">since</em>[, <em class="replaceable">distributions</em>])
</pre><p><a name="INDEX-2229" />Like <tt class="literal">list</tt>, but
returns groups created after a certain time and optionally in one of
a set of distribution areas. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>since</tt></em></i></dt>
<dd>
Time value; only groups created after this time should be returned.</p>
</dd>


<dt><i><em class="replaceable"><tt>distributions</tt></em></i></dt>
<dd>
Optional distribution pattern or reference to a list of distribution
patterns. If present, only groups matching a specified distribution
area should be returned.
</p>
</dd>

</dl></div>

<a name="INDEX-2230" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>newnews</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;newnews(<em class="replaceable">since</em>[, <em class="replaceable">groups</em>[, <em class="replaceable">distributions</em>]])
</pre><p><a name="INDEX-2230" />Returns a reference to a list
containing the message IDs of all news posted after
<em class="replaceable"><tt>since</tt></em> that are in newsgroups matching
<em class="replaceable"><tt>groups</tt></em>, with a distribution that matches
<em class="replaceable"><tt>distributions</tt></em>. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>since</tt></em></i></dt>
<dd>
Time value; only groups created after this time should be returned.</p>
</dd>


<dt><i><em class="replaceable"><tt>groups</tt></em></i></dt>
<dd>
Optional group pattern or reference to a list of group patterns
indicating which groups should be checked for new messages.
</p>
</dd>


<dt><i><em class="replaceable"><tt>distributions</tt></em></i></dt>
<dd>
Optional distribution pattern or reference to a list of distribution
patterns. If present, only groups matching a specified distribution
area should be returned.
</p>
</dd>

</dl></div>

<a name="INDEX-2231" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>newsgroups</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;newsgroups([<em class="replaceable">pattern</em>])
</pre><p><a name="INDEX-2231" />Returns a reference to a hash in
which the keys are all newsgroup names that match
<em class="replaceable"><tt>pattern</tt></em>, or all newsgroups if no pattern
is specified, and each value contains the description text for the
group (an extension).
</p></div>

<a name="INDEX-2232" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>next</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;next(  )
</pre><p><a name="INDEX-2232" />Sets the current article pointer to the
next article in the current newsgroup. Returns the message ID of the
article.
</p></div>

<a name="INDEX-2233" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>nntpstat</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;nntpstat([<em class="replaceable">msgid</em>|<em class="replaceable">msgnum</em>])
</pre><p><a name="INDEX-2233" />Similar to
<tt class="literal">article</tt>, except that no text is returned. When
selecting by message number within a newsgroup, sets the current
article pointer without sending text. Selecting by message ID is
valid, but doesn't alter the current article pointer
and therefore is of little use. Returns the message ID of the current
article.
</p></div>

<a name="INDEX-2234" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>overview_fmt</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;overview_fmt(  )
</pre><p><a name="INDEX-2234" />Returns a reference to an array
containing the names of the fields returned by
<tt class="literal">xover</tt> (an extension).
</p></div>

<a name="INDEX-2235" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>post</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;post([<em class="replaceable">message</em>])
</pre><p><a name="INDEX-2235" />Posts a new article to the news
server. If <em class="replaceable"><tt>message</tt></em> is specified and
posting is allowed, then the message is sent. If
<em class="replaceable"><tt>message</tt></em> is not specified, the message must
be sent using the Net::Cmd <tt class="literal">datasend</tt> and
<tt class="literal">dataend</tt> methods.
<em class="replaceable"><tt>message</tt></em> can be either an array of lines or
a reference to an array.
</p></div>

<a name="INDEX-2236" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>postok</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;postok(  )
</pre><p><a name="INDEX-2236" />Returns true if the
server's initial response indicated that it allows
posting.
</p></div>

<a name="INDEX-2237" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>quit</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;quit(  )
</pre><p><a name="INDEX-2237" />Quits the remote server and closes the
socket connection.
</p></div>

<a name="INDEX-2238" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>reader</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;reader(  )
</pre><p><a name="INDEX-2238" />Tells the server that you are a
reader and not another server; required by some servers (an
extension).
</p></div>

<a name="INDEX-2239" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>slave</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;slave(  )
</pre><p><a name="INDEX-2239" />Tells the remote server that this
is not a user client, but is probably another news server.
</p></div>

<a name="INDEX-2240" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>subscriptions</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;subscriptions(  )
</pre><p><a name="INDEX-2240" />Returns a reference to a default
list of newsgroups recommended for new users to subscribe to (an
extension).
</p></div>

<a name="INDEX-2241" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>xgtitle</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;xgtitle(<em class="replaceable">pattern</em>)
</pre><p><a name="INDEX-2241" />Returns a reference to a hash in
which the keys are all the newsgroup names that match
<em class="replaceable"><tt>pattern</tt></em>, and each value is the text of the
newsgroup's description (an extension).
</p></div>

<a name="INDEX-2242" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>xhdr</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;xhdr(<em class="replaceable">header</em>, <em class="replaceable">message-spec</em>)
</pre><p><a name="INDEX-2242" />Gets the header field
<em class="replaceable"><tt>header</tt></em> for all the messages specified in
<em class="replaceable"><tt>message-spec</tt></em>. Returns a reference to a
hash in which the keys are the message numbers, and each value
contains the text of the requested header for that message (an
extension).
</p></div>

<a name="INDEX-2243" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>xover</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;xover(<em class="replaceable">message-spec</em>)
</pre><p><a name="INDEX-2243" />Returns a reference to a hash in
which the keys are the message numbers, and each value contains a
reference to an array of the overview fields for that message (an
extension).
</p><p>The names of the fields can be obtained by calling
<tt class="literal">overview_fmt</tt>.
</p></div>

<a name="INDEX-2244" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>xpat</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;xpat(<em class="replaceable">header</em>, <em class="replaceable">pattern</em>, <em class="replaceable">message-spec</em>)
</pre><p><a name="INDEX-2244" />Like <tt class="literal">xhdr</tt>, but
returns only headers in which the text of the header matches
<em class="replaceable"><tt>pattern</tt></em> (an extension).
</p></div>

<a name="INDEX-2245" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>xpath</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;xpath(<em class="replaceable">message-id</em>)
</pre><p><a name="INDEX-2245" />Returns the path to the file on
the server that contains the specified message (an extension).
</p></div>

<a name="INDEX-2246" /><a name="INDEX-2247" /><a name="INDEX-2248" /><a name="INDEX-2249" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>xrover</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">nntp</em>-&gt;xrover(<em class="replaceable">message-spec</em>)
</pre><p><a name="INDEX-2246" />Returns reference information for
the article(s) specified. Returns a reference to a hash in which the
keys are the message numbers, and the values are the
<tt class="literal">References</tt>: lines from the articles (an
extension).<a name="INDEX-2247" /><a name="INDEX-2248" /><a name="INDEX-2249" />
</p></div>
</div>


<hr width="684" align="left" />
<div class="navbar"><table width="684" border="0"><tr><td align="left" valign="top" width="228"><a href="ch17_01.htm"><img src="../gifs/txtpreva.gif" alt="Previous" border="0" /></a></td><td align="center" valign="top" width="228"><a href="index.htm"><img src="../gifs/txthome.gif" alt="Home" border="0" /></a></td><td align="right" valign="top" width="228"><a href="ch17_03.htm"><img src="../gifs/txtnexta.gif" alt="Next" border="0" /></a></td></tr><tr><td align="left" valign="top" width="228">17. Usenet News</td><td align="center" valign="top" width="228"><a href="index/index.htm"><img src="../gifs/index.gif" alt="Book Index" border="0" /></a></td><td align="right" valign="top" width="228">17.3. The News::Newsrc Module</td></tr></table></div>
<hr width="684" align="left" />

<img src="../gifs/navbar.gif" usemap="#library-map" border="0" alt="Library Navigation Links" />
<p><p><font size="-1"><a href="copyrght.htm">Copyright &copy; 2002</a> O'Reilly &amp; Associates. All rights reserved.</font></p>

<map name="library-map">
<area shape="rect" coords="1,0,85,94" href="../index.htm"><area shape="rect" coords="86,1,178,103" href="../lwp/index.htm"><area shape="rect" coords="180,0,265,103" href="../lperl/index.htm"><area shape="rect" coords="267,0,353,105" href="../perlnut/index.htm"><area shape="rect" coords="354,1,446,115" href="../prog/index.htm"><area shape="rect" coords="448,0,526,132" href="../tk/index.htm"><area shape="rect" coords="528,1,615,119" href="../cookbook/index.htm"><area shape="rect" coords="617,0,690,135" href="../pxml/index.htm">
</map>

</body></html>