<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>20.11. nntplib — NNTP protocol client — Python 2.7.17 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python 2.7.17 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="20.12. smtplib — SMTP protocol client" href="smtplib.html" />
<link rel="prev" title="20.10. imaplib — IMAP4 protocol client" href="imaplib.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<link rel="canonical" href="https://docs.python.org/2/library/nntplib.html" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="smtplib.html" title="20.12. smtplib — SMTP protocol client"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="imaplib.html" title="20.10. imaplib — IMAP4 protocol client"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://www.python.org/">Python</a> »</li>
<li>
<a href="../index.html">Python 2.7.17 documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
<li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">20. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-nntplib">
<span id="nntplib-nntp-protocol-client"></span><h1>20.11. <a class="reference internal" href="#module-nntplib" title="nntplib: NNTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code></a> — NNTP protocol client<a class="headerlink" href="#module-nntplib" title="Permalink to this headline">¶</a></h1>
<p id="index-0"><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/nntplib.py">Lib/nntplib.py</a></p>
<hr class="docutils" />
<p>This module defines the class <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> which implements the client side of
the NNTP protocol. It can be used to implement a news reader or poster, or
automated news processors. For more information on NNTP (Network News Transfer
Protocol), see Internet <span class="target" id="index-1"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc977.html"><strong>RFC 977</strong></a>.</p>
<p>Here are two small examples of how it can be used. To list some statistics
about a newsgroup and print the subjects of the last 10 articles:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">NNTP</span><span class="p">(</span><span class="s1">'news.gmane.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">resp</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">'gmane.comp.python.committers'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span> <span class="s1">'Group'</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="s1">'has'</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="s1">'articles, range'</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="s1">'to'</span><span class="p">,</span> <span class="n">last</span>
<span class="go">Group gmane.comp.python.committers has 1071 articles, range 1 to 1071</span>
<span class="gp">>>> </span><span class="n">resp</span><span class="p">,</span> <span class="n">subs</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">xhdr</span><span class="p">(</span><span class="s1">'subject'</span><span class="p">,</span> <span class="n">first</span> <span class="o">+</span> <span class="s1">'-'</span> <span class="o">+</span> <span class="n">last</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="nb">id</span><span class="p">,</span> <span class="n">sub</span> <span class="ow">in</span> <span class="n">subs</span><span class="p">[</span><span class="o">-</span><span class="mi">10</span><span class="p">:]:</span> <span class="nb">print</span> <span class="nb">id</span><span class="p">,</span> <span class="n">sub</span>
<span class="gp">...</span>
<span class="go">1062 Re: Mercurial Status?</span>
<span class="go">1063 Re: [python-committers] (Windows) buildbots on 3.x</span>
<span class="go">1064 Re: Mercurial Status?</span>
<span class="go">1065 Re: Mercurial Status?</span>
<span class="go">1066 Python 2.6.6 status</span>
<span class="go">1067 Commit Privileges for Ask Solem</span>
<span class="go">1068 Re: Commit Privileges for Ask Solem</span>
<span class="go">1069 Re: Commit Privileges for Ask Solem</span>
<span class="go">1070 Re: Commit Privileges for Ask Solem</span>
<span class="go">1071 2.6.6 rc 2</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>
<span class="go">'205 Bye!'</span>
</pre></div>
</div>
<p>To post an article from a file (this assumes that the article has valid
headers, and that you have right to post on the particular newsgroup):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">NNTP</span><span class="p">(</span><span class="s1">'news.gmane.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'articlefile'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
<span class="go">'240 Article posted successfully.'</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>
<span class="go">'205 Bye!'</span>
</pre></div>
</div>
<p>The module itself defines the following items:</p>
<dl class="class">
<dt id="nntplib.NNTP">
<em class="property">class </em><code class="descclassname">nntplib.</code><code class="descname">NNTP</code><span class="sig-paren">(</span><em>host[, port [, user[, password [, readermode] [, usenetrc]]]]</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a new instance of the <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> class, representing a connection
to the NNTP server running on host <em>host</em>, listening at port <em>port</em>. The
default <em>port</em> is 119. If the optional <em>user</em> and <em>password</em> are provided,
or if suitable credentials are present in <code class="file docutils literal notranslate"><span class="pre">/.netrc</span></code> and the optional
flag <em>usenetrc</em> is true (the default), the <code class="docutils literal notranslate"><span class="pre">AUTHINFO</span> <span class="pre">USER</span></code> and <code class="docutils literal notranslate"><span class="pre">AUTHINFO</span>
<span class="pre">PASS</span></code> commands are used to identify and authenticate the user to the server.
If the optional flag <em>readermode</em> is true, then a <code class="docutils literal notranslate"><span class="pre">mode</span> <span class="pre">reader</span></code> command is
sent before authentication is performed. Reader mode is sometimes necessary
if you are connecting to an NNTP server on the local machine and intend to
call reader-specific commands, such as <code class="docutils literal notranslate"><span class="pre">group</span></code>. If you get unexpected
<a class="reference internal" href="#nntplib.NNTPPermanentError" title="nntplib.NNTPPermanentError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NNTPPermanentError</span></code></a>s, you might need to set <em>readermode</em>.
<em>readermode</em> defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>. <em>usenetrc</em> defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.4: </span><em>usenetrc</em> argument added.</p>
</div>
</dd></dl>
<dl class="exception">
<dt id="nntplib.NNTPError">
<em class="property">exception </em><code class="descclassname">nntplib.</code><code class="descname">NNTPError</code><a class="headerlink" href="#nntplib.NNTPError" title="Permalink to this definition">¶</a></dt>
<dd><p>Derived from the standard exception <a class="reference internal" href="exceptions.html#exceptions.Exception" title="exceptions.Exception"><code class="xref py py-exc docutils literal notranslate"><span class="pre">Exception</span></code></a>, this is the base class for
all exceptions raised by the <a class="reference internal" href="#module-nntplib" title="nntplib: NNTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code></a> module.</p>
</dd></dl>
<dl class="exception">
<dt id="nntplib.NNTPReplyError">
<em class="property">exception </em><code class="descclassname">nntplib.</code><code class="descname">NNTPReplyError</code><a class="headerlink" href="#nntplib.NNTPReplyError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when an unexpected reply is received from the server. For
backwards compatibility, the exception <code class="docutils literal notranslate"><span class="pre">error_reply</span></code> is equivalent to this
class.</p>
</dd></dl>
<dl class="exception">
<dt id="nntplib.NNTPTemporaryError">
<em class="property">exception </em><code class="descclassname">nntplib.</code><code class="descname">NNTPTemporaryError</code><a class="headerlink" href="#nntplib.NNTPTemporaryError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when an error code in the range 400–499 is received. For
backwards compatibility, the exception <code class="docutils literal notranslate"><span class="pre">error_temp</span></code> is equivalent to this
class.</p>
</dd></dl>
<dl class="exception">
<dt id="nntplib.NNTPPermanentError">
<em class="property">exception </em><code class="descclassname">nntplib.</code><code class="descname">NNTPPermanentError</code><a class="headerlink" href="#nntplib.NNTPPermanentError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when an error code in the range 500–599 is received. For
backwards compatibility, the exception <code class="docutils literal notranslate"><span class="pre">error_perm</span></code> is equivalent to this
class.</p>
</dd></dl>
<dl class="exception">
<dt id="nntplib.NNTPProtocolError">
<em class="property">exception </em><code class="descclassname">nntplib.</code><code class="descname">NNTPProtocolError</code><a class="headerlink" href="#nntplib.NNTPProtocolError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when a reply is received from the server that does not begin
with a digit in the range 1–5. For backwards compatibility, the exception
<code class="docutils literal notranslate"><span class="pre">error_proto</span></code> is equivalent to this class.</p>
</dd></dl>
<dl class="exception">
<dt id="nntplib.NNTPDataError">
<em class="property">exception </em><code class="descclassname">nntplib.</code><code class="descname">NNTPDataError</code><a class="headerlink" href="#nntplib.NNTPDataError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when there is some error in the response data. For backwards
compatibility, the exception <code class="docutils literal notranslate"><span class="pre">error_data</span></code> is equivalent to this class.</p>
</dd></dl>
<div class="section" id="nntp-objects">
<span id="id1"></span><h2>20.11.1. NNTP Objects<a class="headerlink" href="#nntp-objects" title="Permalink to this headline">¶</a></h2>
<p>NNTP instances have the following methods. The <em>response</em> that is returned as
the first item in the return tuple of almost all methods is the server’s
response: a string beginning with a three-digit code. If the server’s response
indicates an error, the method raises one of the above exceptions.</p>
<dl class="method">
<dt id="nntplib.NNTP.getwelcome">
<code class="descclassname">NNTP.</code><code class="descname">getwelcome</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.getwelcome" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the welcome message sent by the server in reply to the initial
connection. (This message sometimes contains disclaimers or help information
that may be relevant to the user.)</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.set_debuglevel">
<code class="descclassname">NNTP.</code><code class="descname">set_debuglevel</code><span class="sig-paren">(</span><em>level</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.set_debuglevel" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the instance’s debugging level. This controls the amount of debugging
output printed. The default, <code class="docutils literal notranslate"><span class="pre">0</span></code>, produces no debugging output. A value of
<code class="docutils literal notranslate"><span class="pre">1</span></code> produces a moderate amount of debugging output, generally a single line
per request or response. A value of <code class="docutils literal notranslate"><span class="pre">2</span></code> or higher produces the maximum amount
of debugging output, logging each line sent and received on the connection
(including message text).</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.newgroups">
<code class="descclassname">NNTP.</code><code class="descname">newgroups</code><span class="sig-paren">(</span><em>date</em>, <em>time</em><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.newgroups" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">NEWGROUPS</span></code> command. The <em>date</em> argument should be a string of the
form <code class="docutils literal notranslate"><span class="pre">'yymmdd'</span></code> indicating the date, and <em>time</em> should be a string of the form
<code class="docutils literal notranslate"><span class="pre">'hhmmss'</span></code> indicating the time. Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">groups)</span></code> where
<em>groups</em> is a list of group names that are new since the given date and time. If
the <em>file</em> parameter is supplied, then the output of the <code class="docutils literal notranslate"><span class="pre">NEWGROUPS</span></code> command
is stored in a file. If <em>file</em> is a string, then the method will open a file
object with that name, write to it then close it. If <em>file</em> is a file object,
then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store the lines of the command
output. If <em>file</em> is supplied, then the returned <em>list</em> is an empty list.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.newnews">
<code class="descclassname">NNTP.</code><code class="descname">newnews</code><span class="sig-paren">(</span><em>group</em>, <em>date</em>, <em>time</em><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.newnews" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">NEWNEWS</span></code> command. Here, <em>group</em> is a group name or <code class="docutils literal notranslate"><span class="pre">'*'</span></code>, and
<em>date</em> and <em>time</em> have the same meaning as for <a class="reference internal" href="#nntplib.NNTP.newgroups" title="nntplib.NNTP.newgroups"><code class="xref py py-meth docutils literal notranslate"><span class="pre">newgroups()</span></code></a>. Return a pair
<code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">articles)</span></code> where <em>articles</em> is a list of message ids. If the
<em>file</em> parameter is supplied, then the output of the <code class="docutils literal notranslate"><span class="pre">NEWNEWS</span></code> command is
stored in a file. If <em>file</em> is a string, then the method will open a file
object with that name, write to it then close it. If <em>file</em> is a file object,
then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store the lines of the command
output. If <em>file</em> is supplied, then the returned <em>list</em> is an empty list.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.list">
<code class="descclassname">NNTP.</code><code class="descname">list</code><span class="sig-paren">(</span><span class="optional">[</span><em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.list" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">LIST</span></code> command. Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code> where <em>list</em> is a
list of tuples. Each tuple has the form <code class="docutils literal notranslate"><span class="pre">(group,</span> <span class="pre">last,</span> <span class="pre">first,</span> <span class="pre">flag)</span></code>, where
<em>group</em> is a group name, <em>last</em> and <em>first</em> are the last and first article
numbers (as strings), and <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">'y'</span></code> if posting is allowed, <code class="docutils literal notranslate"><span class="pre">'n'</span></code> if
not, and <code class="docutils literal notranslate"><span class="pre">'m'</span></code> if the newsgroup is moderated. (Note the ordering: <em>last</em>,
<em>first</em>.) If the <em>file</em> parameter is supplied, then the output of the <code class="docutils literal notranslate"><span class="pre">LIST</span></code>
command is stored in a file. If <em>file</em> is a string, then the method will open
a file object with that name, write to it then close it. If <em>file</em> is a file
object, then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store the lines of the
command output. If <em>file</em> is supplied, then the returned <em>list</em> is an empty
list.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.descriptions">
<code class="descclassname">NNTP.</code><code class="descname">descriptions</code><span class="sig-paren">(</span><em>grouppattern</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.descriptions" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">LIST</span> <span class="pre">NEWSGROUPS</span></code> command, where <em>grouppattern</em> is a wildmat string as
specified in RFC2980 (it’s essentially the same as DOS or UNIX shell wildcard
strings). Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code>, where <em>list</em> is a list of tuples
containing <code class="docutils literal notranslate"><span class="pre">(name,</span> <span class="pre">title)</span></code>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.4.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.description">
<code class="descclassname">NNTP.</code><code class="descname">description</code><span class="sig-paren">(</span><em>group</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.description" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a description for a single group <em>group</em>. If more than one group matches
(if ‘group’ is a real wildmat string), return the first match. If no group
matches, return an empty string.</p>
<p>This elides the response code from the server. If the response code is needed,
use <a class="reference internal" href="#nntplib.NNTP.descriptions" title="nntplib.NNTP.descriptions"><code class="xref py py-meth docutils literal notranslate"><span class="pre">descriptions()</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.4.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.group">
<code class="descclassname">NNTP.</code><code class="descname">group</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.group" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">GROUP</span></code> command, where <em>name</em> is the group name. Return a tuple
<code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">count,</span> <span class="pre">first,</span> <span class="pre">last,</span> <span class="pre">name)</span></code> where <em>count</em> is the (estimated) number
of articles in the group, <em>first</em> is the first article number in the group,
<em>last</em> is the last article number in the group, and <em>name</em> is the group name.
The numbers are returned as strings.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.help">
<code class="descclassname">NNTP.</code><code class="descname">help</code><span class="sig-paren">(</span><span class="optional">[</span><em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.help" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">HELP</span></code> command. Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code> where <em>list</em> is a
list of help strings. If the <em>file</em> parameter is supplied, then the output of
the <code class="docutils literal notranslate"><span class="pre">HELP</span></code> command is stored in a file. If <em>file</em> is a string, then the
method will open a file object with that name, write to it then close it. If
<em>file</em> is a file object, then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store
the lines of the command output. If <em>file</em> is supplied, then the returned <em>list</em>
is an empty list.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.stat">
<code class="descclassname">NNTP.</code><code class="descname">stat</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">STAT</span></code> command, where <em>id</em> is the message id (enclosed in <code class="docutils literal notranslate"><span class="pre">'<'</span></code> and
<code class="docutils literal notranslate"><span class="pre">'>'</span></code>) or an article number (as a string). Return a triple <code class="docutils literal notranslate"><span class="pre">(response,</span>
<span class="pre">number,</span> <span class="pre">id)</span></code> where <em>number</em> is the article number (as a string) and <em>id</em> is the
message id (enclosed in <code class="docutils literal notranslate"><span class="pre">'<'</span></code> and <code class="docutils literal notranslate"><span class="pre">'>'</span></code>).</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.next">
<code class="descclassname">NNTP.</code><code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.next" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">NEXT</span></code> command. Return as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.last">
<code class="descclassname">NNTP.</code><code class="descname">last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.last" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">LAST</span></code> command. Return as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.head">
<code class="descclassname">NNTP.</code><code class="descname">head</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.head" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">HEAD</span></code> command, where <em>id</em> has the same meaning as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.
Return a tuple <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">number,</span> <span class="pre">id,</span> <span class="pre">list)</span></code> where the first three are the
same as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>, and <em>list</em> is a list of the article’s headers (an
uninterpreted list of lines, without trailing newlines).</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.body">
<code class="descclassname">NNTP.</code><code class="descname">body</code><span class="sig-paren">(</span><em>id</em><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.body" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">BODY</span></code> command, where <em>id</em> has the same meaning as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.
If the <em>file</em> parameter is supplied, then the body is stored in a file. If
<em>file</em> is a string, then the method will open a file object with that name,
write to it then close it. If <em>file</em> is a file object, then it will start
calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store the lines of the body. Return as for
<a class="reference internal" href="#nntplib.NNTP.head" title="nntplib.NNTP.head"><code class="xref py py-meth docutils literal notranslate"><span class="pre">head()</span></code></a>. If <em>file</em> is supplied, then the returned <em>list</em> is an empty list.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.article">
<code class="descclassname">NNTP.</code><code class="descname">article</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.article" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an <code class="docutils literal notranslate"><span class="pre">ARTICLE</span></code> command, where <em>id</em> has the same meaning as for
<a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>. Return as for <a class="reference internal" href="#nntplib.NNTP.head" title="nntplib.NNTP.head"><code class="xref py py-meth docutils literal notranslate"><span class="pre">head()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.slave">
<code class="descclassname">NNTP.</code><code class="descname">slave</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.slave" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">SLAVE</span></code> command. Return the server’s <em>response</em>.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.xhdr">
<code class="descclassname">NNTP.</code><code class="descname">xhdr</code><span class="sig-paren">(</span><em>header</em>, <em>string</em><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.xhdr" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an <code class="docutils literal notranslate"><span class="pre">XHDR</span></code> command. This command is not defined in the RFC but is a
common extension. The <em>header</em> argument is a header keyword, e.g.
<code class="docutils literal notranslate"><span class="pre">'subject'</span></code>. The <em>string</em> argument should have the form <code class="docutils literal notranslate"><span class="pre">'first-last'</span></code>
where <em>first</em> and <em>last</em> are the first and last article numbers to search.
Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code>, where <em>list</em> is a list of pairs <code class="docutils literal notranslate"><span class="pre">(id,</span>
<span class="pre">text)</span></code>, where <em>id</em> is an article number (as a string) and <em>text</em> is the text of
the requested header for that article. If the <em>file</em> parameter is supplied, then
the output of the <code class="docutils literal notranslate"><span class="pre">XHDR</span></code> command is stored in a file. If <em>file</em> is a string,
then the method will open a file object with that name, write to it then close
it. If <em>file</em> is a file object, then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it
to store the lines of the command output. If <em>file</em> is supplied, then the
returned <em>list</em> is an empty list.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.post">
<code class="descclassname">NNTP.</code><code class="descname">post</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.post" title="Permalink to this definition">¶</a></dt>
<dd><p>Post an article using the <code class="docutils literal notranslate"><span class="pre">POST</span></code> command. The <em>file</em> argument is an open file
object which is read until EOF using its <a class="reference internal" href="stdtypes.html#file.readline" title="file.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> method. It should be
a well-formed news article, including the required headers. The <a class="reference internal" href="#nntplib.NNTP.post" title="nntplib.NNTP.post"><code class="xref py py-meth docutils literal notranslate"><span class="pre">post()</span></code></a>
method automatically escapes lines beginning with <code class="docutils literal notranslate"><span class="pre">.</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.ihave">
<code class="descclassname">NNTP.</code><code class="descname">ihave</code><span class="sig-paren">(</span><em>id</em>, <em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.ihave" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an <code class="docutils literal notranslate"><span class="pre">IHAVE</span></code> command. <em>id</em> is a message id (enclosed in <code class="docutils literal notranslate"><span class="pre">'<'</span></code> and
<code class="docutils literal notranslate"><span class="pre">'>'</span></code>). If the response is not an error, treat <em>file</em> exactly as for the
<a class="reference internal" href="#nntplib.NNTP.post" title="nntplib.NNTP.post"><code class="xref py py-meth docutils literal notranslate"><span class="pre">post()</span></code></a> method.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.date">
<code class="descclassname">NNTP.</code><code class="descname">date</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.date" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a triple <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">date,</span> <span class="pre">time)</span></code>, containing the current date and time
in a form suitable for the <a class="reference internal" href="#nntplib.NNTP.newnews" title="nntplib.NNTP.newnews"><code class="xref py py-meth docutils literal notranslate"><span class="pre">newnews()</span></code></a> and <a class="reference internal" href="#nntplib.NNTP.newgroups" title="nntplib.NNTP.newgroups"><code class="xref py py-meth docutils literal notranslate"><span class="pre">newgroups()</span></code></a> methods. This
is an optional NNTP extension, and may not be supported by all servers.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.xgtitle">
<code class="descclassname">NNTP.</code><code class="descname">xgtitle</code><span class="sig-paren">(</span><em>name</em><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.xgtitle" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an <code class="docutils literal notranslate"><span class="pre">XGTITLE</span></code> command, returning a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code>, where
<em>list</em> is a list of tuples containing <code class="docutils literal notranslate"><span class="pre">(name,</span> <span class="pre">title)</span></code>. If the <em>file</em> parameter
is supplied, then the output of the <code class="docutils literal notranslate"><span class="pre">XGTITLE</span></code> command is stored in a file.
If <em>file</em> is a string, then the method will open a file object with that name,
write to it then close it. If <em>file</em> is a file object, then it will start
calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store the lines of the command output. If <em>file</em>
is supplied, then the returned <em>list</em> is an empty list. This is an optional NNTP
extension, and may not be supported by all servers.</p>
<p>RFC2980 says “It is suggested that this extension be deprecated”. Use
<a class="reference internal" href="#nntplib.NNTP.descriptions" title="nntplib.NNTP.descriptions"><code class="xref py py-meth docutils literal notranslate"><span class="pre">descriptions()</span></code></a> or <a class="reference internal" href="#nntplib.NNTP.description" title="nntplib.NNTP.description"><code class="xref py py-meth docutils literal notranslate"><span class="pre">description()</span></code></a> instead.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.xover">
<code class="descclassname">NNTP.</code><code class="descname">xover</code><span class="sig-paren">(</span><em>start</em>, <em>end</em><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.xover" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a pair <code class="docutils literal notranslate"><span class="pre">(resp,</span> <span class="pre">list)</span></code>. <em>list</em> is a list of tuples, one for each
article in the range delimited by the <em>start</em> and <em>end</em> article numbers. Each
tuple is of the form <code class="docutils literal notranslate"><span class="pre">(article</span> <span class="pre">number,</span> <span class="pre">subject,</span> <span class="pre">poster,</span> <span class="pre">date,</span> <span class="pre">id,</span> <span class="pre">references,</span>
<span class="pre">size,</span> <span class="pre">lines)</span></code>. If the <em>file</em> parameter is supplied, then the output of the
<code class="docutils literal notranslate"><span class="pre">XOVER</span></code> command is stored in a file. If <em>file</em> is a string, then the method
will open a file object with that name, write to it then close it. If <em>file</em>
is a file object, then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on it to store the
lines of the command output. If <em>file</em> is supplied, then the returned <em>list</em> is
an empty list. This is an optional NNTP extension, and may not be supported by
all servers.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.xpath">
<code class="descclassname">NNTP.</code><code class="descname">xpath</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.xpath" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a pair <code class="docutils literal notranslate"><span class="pre">(resp,</span> <span class="pre">path)</span></code>, where <em>path</em> is the directory path to the
article with message ID <em>id</em>. This is an optional NNTP extension, and may not
be supported by all servers.</p>
</dd></dl>
<dl class="method">
<dt id="nntplib.NNTP.quit">
<code class="descclassname">NNTP.</code><code class="descname">quit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.quit" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a <code class="docutils literal notranslate"><span class="pre">QUIT</span></code> command and close the connection. Once this method has been
called, no other methods of the NNTP object should be called.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">20.11. <code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code> — NNTP protocol client</a><ul>
<li><a class="reference internal" href="#nntp-objects">20.11.1. NNTP Objects</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="imaplib.html"
title="previous chapter">20.10. <code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code> — IMAP4 protocol client</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="smtplib.html"
title="next chapter">20.12. <code class="xref py py-mod docutils literal notranslate"><span class="pre">smtplib</span></code> — SMTP protocol client</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/nntplib.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="smtplib.html" title="20.12. smtplib — SMTP protocol client"
>next</a> |</li>
<li class="right" >
<a href="imaplib.html" title="20.10. imaplib — IMAP4 protocol client"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://www.python.org/">Python</a> »</li>
<li>
<a href="../index.html">Python 2.7.17 documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
<li class="nav-item nav-item-2"><a href="internet.html" >20. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Oct 19, 2019.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 2.0.1.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
e1011ddec34cda34f3a002b121247943
>
files
>
859
