python-mailmanclient-doc 3.1.1-5 / usr / share / doc / python-mailmanclient / html / _modules / mailmanclient / restobjects / mailinglist.html

This file is indexed.

/usr/share/doc/python-mailmanclient/html/_modules/mailmanclient/restobjects/mailinglist.html is in python-mailmanclient-doc 3.1.1-5.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>mailmanclient.restobjects.mailinglist &#8212; Mailman Client 3.1.1 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">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../',
        VERSION:     '3.1.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </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>
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" /> 
  </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="nav-item nav-item-0"><a href="../../../README.html">Mailman Client 3.1.1 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <h1>Source code for mailmanclient.restobjects.mailinglist</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright (C) 2010-2017 The Free Software Foundation, Inc.</span>
<span class="c1">#</span>
<span class="c1"># This file is part of mailmanclient.</span>
<span class="c1">#</span>
<span class="c1"># mailmanclient is free software: you can redistribute it and/or modify it</span>
<span class="c1"># under the terms of the GNU Lesser General Public License as published by the</span>
<span class="c1"># Free Software Foundation, version 3 of the License.</span>
<span class="c1">#</span>
<span class="c1"># mailmanclient is distributed in the hope that it will be useful, but</span>
<span class="c1"># WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span>
<span class="c1"># or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public</span>
<span class="c1"># License for more details.</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU Lesser General Public License</span>
<span class="c1"># along with mailmanclient.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">operator</span> <span class="k">import</span> <span class="n">itemgetter</span>
<span class="kn">from</span> <span class="nn">six.moves.urllib_error</span> <span class="k">import</span> <span class="n">HTTPError</span>
<span class="kn">from</span> <span class="nn">six.moves.urllib_parse</span> <span class="k">import</span> <span class="n">urlencode</span>

<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.header_match</span> <span class="k">import</span> <span class="n">HeaderMatches</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.archivers</span> <span class="k">import</span> <span class="n">ListArchivers</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.member</span> <span class="k">import</span> <span class="n">Member</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.settings</span> <span class="k">import</span> <span class="n">Settings</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.held_message</span> <span class="k">import</span> <span class="n">HeldMessage</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restbase.base</span> <span class="k">import</span> <span class="n">RESTObject</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restbase.page</span> <span class="k">import</span> <span class="n">Page</span>

<span class="n">__metaclass__</span> <span class="o">=</span> <span class="nb">type</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
    <span class="s1">&#39;MailingList&#39;</span>
<span class="p">]</span>


<div class="viewcode-block" id="MailingList"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList">[docs]</a><span class="k">class</span> <span class="nc">MailingList</span><span class="p">(</span><span class="n">RESTObject</span><span class="p">):</span>

    <span class="n">_properties</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;display_name&#39;</span><span class="p">,</span> <span class="s1">&#39;fqdn_listname&#39;</span><span class="p">,</span> <span class="s1">&#39;list_id&#39;</span><span class="p">,</span> <span class="s1">&#39;list_name&#39;</span><span class="p">,</span>
                   <span class="s1">&#39;mail_host&#39;</span><span class="p">,</span> <span class="s1">&#39;member_count&#39;</span><span class="p">,</span> <span class="s1">&#39;volume&#39;</span><span class="p">,</span> <span class="s1">&#39;self_link&#39;</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">MailingList</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span> <span class="o">=</span> <span class="kc">None</span>

    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="s1">&#39;&lt;List &quot;</span><span class="si">{0}</span><span class="s1">&quot;&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">owners</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_url</span> <span class="o">+</span> <span class="s1">&#39;/roster/owner&#39;</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
        <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;email&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">]]</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">moderators</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_url</span> <span class="o">+</span> <span class="s1">&#39;/roster/moderator&#39;</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
        <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;email&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">]]</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">members</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/roster/member&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">)</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
        <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">return</span> <span class="p">[</span><span class="n">Member</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;self_link&#39;</span><span class="p">],</span> <span class="n">entry</span><span class="p">)</span>
                <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">],</span>
                                    <span class="n">key</span><span class="o">=</span><span class="n">itemgetter</span><span class="p">(</span><span class="s1">&#39;address&#39;</span><span class="p">))]</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">nonmembers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;members/find&#39;</span>
        <span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;role&#39;</span><span class="p">:</span> <span class="s1">&#39;nonmember&#39;</span><span class="p">,</span>
                <span class="s1">&#39;list_id&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">}</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
        <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">return</span> <span class="p">[</span><span class="n">Member</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;self_link&#39;</span><span class="p">],</span> <span class="n">entry</span><span class="p">)</span>
                <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">],</span>
                                    <span class="n">key</span><span class="o">=</span><span class="n">itemgetter</span><span class="p">(</span><span class="s1">&#39;address&#39;</span><span class="p">))]</span>

<div class="viewcode-block" id="MailingList.get_member_page"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.get_member_page">[docs]</a>    <span class="k">def</span> <span class="nf">get_member_page</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/roster/member&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">Page</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">Member</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">page</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.find_members"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.find_members">[docs]</a>    <span class="k">def</span> <span class="nf">find_members</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">role</span><span class="o">=</span><span class="s1">&#39;member&#39;</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">50</span><span class="p">):</span>
        <span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
            <span class="s1">&#39;subscriber&#39;</span><span class="p">:</span> <span class="n">address</span><span class="p">,</span>
            <span class="s1">&#39;role&#39;</span><span class="p">:</span> <span class="n">role</span><span class="p">,</span>
            <span class="s1">&#39;list_id&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">,</span>
        <span class="p">}</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;members/find?</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">urlencode</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">doseq</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
        <span class="k">if</span> <span class="n">page</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
            <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
                <span class="k">return</span> <span class="p">[]</span>
            <span class="k">return</span> <span class="p">[</span><span class="n">Member</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;self_link&#39;</span><span class="p">],</span> <span class="n">entry</span><span class="p">)</span>
                    <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">]]</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">Page</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">Member</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">page</span><span class="p">)</span></div>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">settings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span> <span class="o">=</span> <span class="n">Settings</span><span class="p">(</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span>
                <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/config&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">))</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">held</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Return a list of dicts with held message information.&quot;&quot;&quot;</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span>
            <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/held&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">),</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;GET&#39;</span><span class="p">)</span>
        <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">return</span> <span class="p">[</span><span class="n">HeldMessage</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;self_link&#39;</span><span class="p">],</span> <span class="n">entry</span><span class="p">)</span>
                <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">]]</span>

<div class="viewcode-block" id="MailingList.get_held_page"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.get_held_page">[docs]</a>    <span class="k">def</span> <span class="nf">get_held_page</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/held&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">Page</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">HeldMessage</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">page</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.get_held_message"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.get_held_message">[docs]</a>    <span class="k">def</span> <span class="nf">get_held_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">held_id</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/held/</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">,</span> <span class="n">held_id</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">HeldMessage</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span></div>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">requests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Return a list of dicts with subscription requests.&quot;&quot;&quot;</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span>
            <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/requests&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">),</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;GET&#39;</span><span class="p">)</span>
        <span class="k">if</span> <span class="s1">&#39;entries&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">entries</span> <span class="o">=</span> <span class="p">[]</span>
            <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;entries&#39;</span><span class="p">]:</span>
                <span class="n">request</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">email</span><span class="o">=</span><span class="n">entry</span><span class="p">[</span><span class="s1">&#39;email&#39;</span><span class="p">],</span>
                               <span class="n">token</span><span class="o">=</span><span class="n">entry</span><span class="p">[</span><span class="s1">&#39;token&#39;</span><span class="p">],</span>
                               <span class="n">token_owner</span><span class="o">=</span><span class="n">entry</span><span class="p">[</span><span class="s1">&#39;token_owner&#39;</span><span class="p">],</span>
                               <span class="n">list_id</span><span class="o">=</span><span class="n">entry</span><span class="p">[</span><span class="s1">&#39;list_id&#39;</span><span class="p">],</span>
                               <span class="n">request_date</span><span class="o">=</span><span class="n">entry</span><span class="p">[</span><span class="s1">&#39;when&#39;</span><span class="p">])</span>
                <span class="n">entries</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">entries</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">archivers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/archivers&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">ListArchivers</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>

    <span class="nd">@archivers</span><span class="o">.</span><span class="n">setter</span>
    <span class="k">def</span> <span class="nf">archivers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_value</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/archivers&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">)</span>
        <span class="n">archivers</span> <span class="o">=</span> <span class="n">ListArchivers</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
        <span class="n">archivers</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">new_value</span><span class="p">)</span>
        <span class="n">archivers</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>

<div class="viewcode-block" id="MailingList.add_owner"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.add_owner">[docs]</a>    <span class="k">def</span> <span class="nf">add_owner</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">add_role</span><span class="p">(</span><span class="s1">&#39;owner&#39;</span><span class="p">,</span> <span class="n">address</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.add_moderator"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.add_moderator">[docs]</a>    <span class="k">def</span> <span class="nf">add_moderator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">add_role</span><span class="p">(</span><span class="s1">&#39;moderator&#39;</span><span class="p">,</span> <span class="n">address</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.add_role"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.add_role">[docs]</a>    <span class="k">def</span> <span class="nf">add_role</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">role</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">list_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">,</span>
                    <span class="n">subscriber</span><span class="o">=</span><span class="n">address</span><span class="p">,</span>
                    <span class="n">role</span><span class="o">=</span><span class="n">role</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;members&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.remove_owner"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.remove_owner">[docs]</a>    <span class="k">def</span> <span class="nf">remove_owner</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">remove_role</span><span class="p">(</span><span class="s1">&#39;owner&#39;</span><span class="p">,</span> <span class="n">address</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.remove_moderator"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.remove_moderator">[docs]</a>    <span class="k">def</span> <span class="nf">remove_moderator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">remove_role</span><span class="p">(</span><span class="s1">&#39;moderator&#39;</span><span class="p">,</span> <span class="n">address</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.remove_role"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.remove_role">[docs]</a>    <span class="k">def</span> <span class="nf">remove_role</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">role</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">%s</span><span class="s1">/</span><span class="si">%s</span><span class="s1">/</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">,</span> <span class="n">role</span><span class="p">,</span> <span class="n">address</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;DELETE&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.moderate_message"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.moderate_message">[docs]</a>    <span class="k">def</span> <span class="nf">moderate_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Moderate a held message.</span>

<span class="sd">        :param request_id: Id of the held message.</span>
<span class="sd">        :type request_id: Int.</span>
<span class="sd">        :param action: Action to perform on held message.</span>
<span class="sd">        :type action: String.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">path</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/held/</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">request_id</span><span class="p">))</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span>
            <span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">(</span><span class="n">action</span><span class="o">=</span><span class="n">action</span><span class="p">),</span> <span class="s1">&#39;POST&#39;</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">response</span></div>

<div class="viewcode-block" id="MailingList.discard_message"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.discard_message">[docs]</a>    <span class="k">def</span> <span class="nf">discard_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut for moderate_message.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_message</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;discard&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.reject_message"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.reject_message">[docs]</a>    <span class="k">def</span> <span class="nf">reject_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut for moderate_message.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_message</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;reject&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.defer_message"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.defer_message">[docs]</a>    <span class="k">def</span> <span class="nf">defer_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut for moderate_message.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_message</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;defer&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.accept_message"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.accept_message">[docs]</a>    <span class="k">def</span> <span class="nf">accept_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut for moderate_message.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_message</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;accept&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.moderate_request"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.moderate_request">[docs]</a>    <span class="k">def</span> <span class="nf">moderate_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Moderate a subscription request.</span>

<span class="sd">        :param action: accept|reject|discard|defer</span>
<span class="sd">        :type action: str.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">path</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/requests/</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">,</span> <span class="n">request_id</span><span class="p">)</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="p">{</span><span class="s1">&#39;action&#39;</span><span class="p">:</span> <span class="n">action</span><span class="p">})</span>
        <span class="k">return</span> <span class="n">response</span></div>

<div class="viewcode-block" id="MailingList.manage_request"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.manage_request">[docs]</a>    <span class="k">def</span> <span class="nf">manage_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Alias for moderate_request, kept for compatibility&quot;&quot;&quot;</span>
        <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
            <span class="s1">&#39;The `manage_request()` method has been replaced by &#39;</span>
            <span class="s1">&#39;`moderate_request()` and will be removed in the future.&#39;</span><span class="p">,</span>
            <span class="ne">DeprecationWarning</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">token</span><span class="p">,</span> <span class="n">action</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.accept_request"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.accept_request">[docs]</a>    <span class="k">def</span> <span class="nf">accept_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut to accept a subscription request.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;accept&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.reject_request"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.reject_request">[docs]</a>    <span class="k">def</span> <span class="nf">reject_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut to reject a subscription request.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;reject&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.discard_request"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.discard_request">[docs]</a>    <span class="k">def</span> <span class="nf">discard_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut to discard a subscription request.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;discard&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.defer_request"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.defer_request">[docs]</a>    <span class="k">def</span> <span class="nf">defer_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Shortcut to defer a subscription request.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_id</span><span class="p">,</span> <span class="s1">&#39;defer&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="MailingList.get_member"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.get_member">[docs]</a>    <span class="k">def</span> <span class="nf">get_member</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">email</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Get a membership.</span>

<span class="sd">        :param address: The email address of the member for this list.</span>
<span class="sd">        :return: A member proxy object.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="c1"># In order to get the member object we query the REST API for</span>
        <span class="c1"># the member. Incase there is no matching subscription, an</span>
        <span class="c1"># HTTPError is returned instead.</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">path</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/member/</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">,</span> <span class="n">email</span><span class="p">)</span>
            <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
            <span class="k">return</span> <span class="n">Member</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;self_link&#39;</span><span class="p">],</span> <span class="n">content</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">HTTPError</span><span class="p">:</span>
            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1"> is not a member address of </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span>
                             <span class="p">(</span><span class="n">email</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">))</span></div>

<div class="viewcode-block" id="MailingList.subscribe"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.subscribe">[docs]</a>    <span class="k">def</span> <span class="nf">subscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">display_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                  <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">pre_approved</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Subscribe an email address to a mailing list.</span>

<span class="sd">        :param address: Email address to subscribe to the list.</span>
<span class="sd">        :type address: str</span>
<span class="sd">        :param display_name: The real name of the new member.</span>
<span class="sd">        :param pre_verified: True if the address has been verified.</span>
<span class="sd">        :type pre_verified: bool</span>
<span class="sd">        :param pre_confirmed: True if membership has been approved by the user.</span>
<span class="sd">        :type pre_confirmed: bool</span>
<span class="sd">        :param pre_approved: True if membership is moderator-approved.</span>
<span class="sd">        :type pre_approved: bool</span>
<span class="sd">        :type display_name: str</span>
<span class="sd">        :return: A member proxy object.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
            <span class="n">list_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">,</span>
            <span class="n">subscriber</span><span class="o">=</span><span class="n">address</span><span class="p">,</span>
            <span class="n">display_name</span><span class="o">=</span><span class="n">display_name</span><span class="p">,</span>
        <span class="p">)</span>
        <span class="k">if</span> <span class="n">pre_verified</span><span class="p">:</span>
            <span class="n">data</span><span class="p">[</span><span class="s1">&#39;pre_verified&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
        <span class="k">if</span> <span class="n">pre_confirmed</span><span class="p">:</span>
            <span class="n">data</span><span class="p">[</span><span class="s1">&#39;pre_confirmed&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
        <span class="k">if</span> <span class="n">pre_approved</span><span class="p">:</span>
            <span class="n">data</span><span class="p">[</span><span class="s1">&#39;pre_approved&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
        <span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;members&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
        <span class="c1"># If a member is not immediately subscribed (i.e. verificatoin,</span>
        <span class="c1"># confirmation or approval need), the response content is returned.</span>
        <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">202</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">content</span>
        <span class="c1"># I the subscription is executed immediately, a member object</span>
        <span class="c1"># is returned.</span>
        <span class="k">return</span> <span class="n">Member</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">response</span><span class="p">[</span><span class="s1">&#39;location&#39;</span><span class="p">])</span></div>

<div class="viewcode-block" id="MailingList.unsubscribe"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.unsubscribe">[docs]</a>    <span class="k">def</span> <span class="nf">unsubscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">email</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Unsubscribe an email address from a mailing list.</span>

<span class="sd">        :param address: The address to unsubscribe.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="c1"># In order to get the member object we need to</span>
        <span class="c1"># iterate over the existing member list</span>

        <span class="k">try</span><span class="p">:</span>
            <span class="n">path</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/member/</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">,</span> <span class="n">email</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;DELETE&#39;</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">HTTPError</span><span class="p">:</span>
            <span class="c1"># The member link does not exist, i.e. he is not a member</span>
            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1"> is not a member address of </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span>
                             <span class="p">(</span><span class="n">email</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">))</span></div>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">bans</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="kn">from</span> <span class="nn">mailmanclient.restobjects.ban</span> <span class="k">import</span> <span class="n">Bans</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/bans&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">Bans</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">mlist</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>

<div class="viewcode-block" id="MailingList.get_bans_page"><a class="viewcode-back" href="../../../src/mailmanclient/docs/apiref.html#mailmanclient._client.MailingList.get_bans_page">[docs]</a>    <span class="k">def</span> <span class="nf">get_bans_page</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
        <span class="kn">from</span> <span class="nn">mailmanclient.restobjects.ban</span> <span class="k">import</span> <span class="n">BannedAddress</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/bans&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">Page</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">BannedAddress</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">page</span><span class="p">)</span></div>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">header_matches</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;lists/</span><span class="si">{0}</span><span class="s1">/header-matches&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list_id</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">HeaderMatches</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../../../search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</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="nav-item nav-item-0"><a href="../../../README.html">Mailman Client 3.1.1 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2012-2018, The Free Software Foundation.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.