/usr/share/doc/python-mailmanclient/html/_modules/mailmanclient/client.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 | <!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.client — 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> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for mailmanclient.client</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 <http://www.gnu.org/licenses/>.</span>
<span class="sd">"""Client code."""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">unicode_literals</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">mailmanclient.constants</span> <span class="k">import</span> <span class="p">(</span><span class="n">MISSING</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.address</span> <span class="k">import</span> <span class="n">Address</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="p">,</span> <span class="n">BannedAddress</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.configuration</span> <span class="k">import</span> <span class="n">Configuration</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.domain</span> <span class="k">import</span> <span class="n">Domain</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.mailinglist</span> <span class="k">import</span> <span class="n">MailingList</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.preferences</span> <span class="k">import</span> <span class="n">Preferences</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.queue</span> <span class="k">import</span> <span class="n">Queue</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restobjects.user</span> <span class="k">import</span> <span class="n">User</span>
<span class="kn">from</span> <span class="nn">mailmanclient.restbase.connection</span> <span class="k">import</span> <span class="n">Connection</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">'Client'</span>
<span class="p">]</span>
<span class="c1">#</span>
<span class="c1"># --- The following classes are part of the API</span>
<span class="c1">#</span>
<div class="viewcode-block" id="Client"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client">[docs]</a><span class="k">class</span> <span class="nc">Client</span><span class="p">:</span>
<span class="sd">"""Access the Mailman REST API root."""</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">baseurl</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Initialize client access to the REST API.</span>
<span class="sd"> :param baseurl: The base url to access the Mailman 3 REST API.</span>
<span class="sd"> :param name: The Basic Auth user name. If given, the `password` must</span>
<span class="sd"> also be given.</span>
<span class="sd"> :param password: The Basic Auth password. If given the `name` must</span>
<span class="sd"> also be given.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_connection</span> <span class="o">=</span> <span class="n">Connection</span><span class="p">(</span><span class="n">baseurl</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">password</span><span class="p">)</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">'<Client (</span><span class="si">{0.name}</span><span class="s1">:</span><span class="si">{0.password}</span><span class="s1">) </span><span class="si">{0.baseurl}</span><span class="s1">>'</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">_connection</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">system</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</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">'system/versions'</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">preferences</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">Preferences</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">'system/preferences'</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">configuration</span><span class="p">(</span><span class="bp">self</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="s1">'system/configuration'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">{</span><span class="n">section</span><span class="p">:</span> <span class="n">Configuration</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">section</span><span class="p">)</span> <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s1">'sections'</span><span class="p">]}</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">pipelines</span><span class="p">(</span><span class="bp">self</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="s1">'system/pipelines'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">content</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">chains</span><span class="p">(</span><span class="bp">self</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="s1">'system/chains'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">content</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">queues</span><span class="p">(</span><span class="bp">self</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="s1">'queues'</span><span class="p">)</span>
<span class="n">queues</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">'entries'</span><span class="p">]:</span>
<span class="n">queues</span><span class="p">[</span><span class="n">entry</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]]</span> <span class="o">=</span> <span class="n">Queue</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">'self_link'</span><span class="p">],</span> <span class="n">entry</span><span class="p">)</span>
<span class="k">return</span> <span class="n">queues</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">lists</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_lists</span><span class="p">()</span>
<div class="viewcode-block" id="Client.get_lists"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_lists">[docs]</a> <span class="k">def</span> <span class="nf">get_lists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">advertised</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">url</span> <span class="o">=</span> <span class="s1">'lists'</span>
<span class="k">if</span> <span class="n">advertised</span><span class="p">:</span>
<span class="n">url</span> <span class="o">+=</span> <span class="s1">'?advertised=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="n">url</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'entries'</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">MailingList</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">'self_link'</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">'entries'</span><span class="p">]]</span></div>
<div class="viewcode-block" id="Client.get_list_page"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_list_page">[docs]</a> <span class="k">def</span> <span class="nf">get_list_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">advertised</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">url</span> <span class="o">=</span> <span class="s1">'lists'</span>
<span class="k">if</span> <span class="n">advertised</span><span class="p">:</span>
<span class="n">url</span> <span class="o">+=</span> <span class="s1">'?advertised=true'</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">MailingList</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">domains</span><span class="p">(</span><span class="bp">self</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="s1">'domains'</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'entries'</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">Domain</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">'self_link'</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">'entries'</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">'mail_host'</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">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">'members'</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'entries'</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">'self_link'</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">'entries'</span><span class="p">]]</span>
<div class="viewcode-block" id="Client.get_member"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.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">fqdn_listname</span><span class="p">,</span> <span class="n">subscriber_address</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="n">fqdn_listname</span><span class="p">)</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="n">subscriber_address</span><span class="p">)</span></div>
<div class="viewcode-block" id="Client.get_member_page"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.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="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="s1">'members'</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">users</span><span class="p">(</span><span class="bp">self</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="s1">'users'</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'entries'</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">User</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">'self_link'</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">'entries'</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">'self_link'</span><span class="p">))]</span>
<div class="viewcode-block" id="Client.get_user_page"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_user_page">[docs]</a> <span class="k">def</span> <span class="nf">get_user_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="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="s1">'users'</span><span class="p">,</span> <span class="n">User</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="Client.create_domain"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.create_domain">[docs]</a> <span class="k">def</span> <span class="nf">create_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mail_host</span><span class="p">,</span> <span class="n">base_url</span><span class="o">=</span><span class="n">MISSING</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">owner</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="n">base_url</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">MISSING</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s1">'The `base_url` parameter in the `create_domain()` method is '</span>
<span class="s1">'deprecated. It is not used any more and will be removed in '</span>
<span class="s1">'the future.'</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="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">mail_host</span><span class="o">=</span><span class="n">mail_host</span><span class="p">)</span>
<span class="k">if</span> <span class="n">description</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span> <span class="o">=</span> <span class="n">description</span>
<span class="k">if</span> <span class="n">owner</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s1">'owner'</span><span class="p">]</span> <span class="o">=</span> <span class="n">owner</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">'domains'</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Domain</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">'location'</span><span class="p">])</span></div>
<div class="viewcode-block" id="Client.delete_domain"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.delete_domain">[docs]</a> <span class="k">def</span> <span class="nf">delete_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mail_host</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="s1">'domains/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">mail_host</span><span class="p">),</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">'DELETE'</span><span class="p">)</span></div>
<div class="viewcode-block" id="Client.get_domain"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_domain">[docs]</a> <span class="k">def</span> <span class="nf">get_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mail_host</span><span class="p">,</span> <span class="n">web_host</span><span class="o">=</span><span class="n">MISSING</span><span class="p">):</span>
<span class="sd">"""Get domain by its mail_host or its web_host."""</span>
<span class="k">if</span> <span class="n">web_host</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">MISSING</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s1">'The `web_host` parameter in the `get_domain()` method is '</span>
<span class="s1">'deprecated. It is not used any more and will be removed in '</span>
<span class="s1">'the future.'</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="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">'domains/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">mail_host</span><span class="p">))</span>
<span class="k">return</span> <span class="n">Domain</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">'self_link'</span><span class="p">])</span></div>
<div class="viewcode-block" id="Client.create_user"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.create_user">[docs]</a> <span class="k">def</span> <span class="nf">create_user</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="n">password</span><span class="p">,</span> <span class="n">display_name</span><span class="o">=</span><span class="s1">''</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="s1">'users'</span><span class="p">,</span> <span class="nb">dict</span><span class="p">(</span><span class="n">email</span><span class="o">=</span><span class="n">email</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="n">password</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="k">return</span> <span class="n">User</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">'location'</span><span class="p">])</span></div>
<div class="viewcode-block" id="Client.get_user"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_user">[docs]</a> <span class="k">def</span> <span class="nf">get_user</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">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">'users/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">address</span><span class="p">))</span>
<span class="k">return</span> <span class="n">User</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">'self_link'</span><span class="p">],</span> <span class="n">content</span><span class="p">)</span></div>
<div class="viewcode-block" id="Client.get_address"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_address">[docs]</a> <span class="k">def</span> <span class="nf">get_address</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">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">'addresses/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">address</span><span class="p">))</span>
<span class="k">return</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="p">,</span> <span class="n">content</span><span class="p">[</span><span class="s1">'self_link'</span><span class="p">],</span> <span class="n">content</span><span class="p">)</span></div>
<div class="viewcode-block" id="Client.get_list"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.get_list">[docs]</a> <span class="k">def</span> <span class="nf">get_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</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="s1">'lists/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">fqdn_listname</span><span class="p">))</span>
<span class="k">return</span> <span class="n">MailingList</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">'self_link'</span><span class="p">],</span> <span class="n">content</span><span class="p">)</span></div>
<div class="viewcode-block" id="Client.delete_list"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.delete_list">[docs]</a> <span class="k">def</span> <span class="nf">delete_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</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="s1">'lists/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">fqdn_listname</span><span class="p">),</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">'DELETE'</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="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="s1">'bans'</span><span class="p">,</span> <span class="n">mlist</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<div class="viewcode-block" id="Client.get_bans_page"><a class="viewcode-back" href="../../src/mailmanclient/docs/apiref.html#mailmanclient.Client.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="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="s1">'bans'</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></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> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2012-2018, The Free Software Foundation.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|