/usr/share/doc/python-mailmanclient/html/src/mailmanclient/docs/using.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 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 | <!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>Example Usage — 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" />
<link rel="next" title="API Reference" href="apiref.html" />
<link rel="prev" title="NEWS for mailmanclient" href="NEWS.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="right" >
<a href="apiref.html" title="API Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="NEWS.html" title="NEWS for mailmanclient"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../README.html">Mailman Client 3.1.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="example-usage">
<h1>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">¶</a></h1>
<p>This is the official Python bindings for the GNU Mailman REST API. In order
to talk to Mailman, the engine’s REST server must be running. You begin by
instantiating a client object to access the root of the REST hierarchy,
providing it the base URL, user name and password (for Basic Auth).</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">mailmanclient</span> <span class="k">import</span> <span class="n">Client</span>
<span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s1">'http://localhost:9001/3.1'</span><span class="p">,</span> <span class="s1">'restadmin'</span><span class="p">,</span> <span class="s1">'restpass'</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Please note that port ‘9001’ is used above, since mailman’s test server
runs on port <em>9001</em>. In production Mailman’s REST API usually listens on
port <em>8001</em>.</p>
</div>
<p>We can retrieve basic information about the server.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">dump</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">system</span><span class="p">)</span>
<span class="go">api_version: 3.1</span>
<span class="go">http_etag: "..."</span>
<span class="go">mailman_version: GNU Mailman ... (...)</span>
<span class="go">python_version: ...</span>
<span class="go">self_link: http://localhost:9001/3.1/system/versions</span>
</pre></div>
</div>
<p>To start with, there are no known mailing lists.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">lists</span>
<span class="go">[]</span>
</pre></div>
</div>
<div class="section" id="domains">
<h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">¶</a></h2>
<p>Before new mailing lists can be added, the domain that the list will live in
must be added. By default, there are no known domains.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">domains</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>It’s easy to create a new domain; when you do, a proxy object for that domain
is returned.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">example_dot_com</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_domain</span><span class="p">(</span><span class="s1">'example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">example_dot_com</span>
<span class="go"><Domain "example.com"></span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">example_dot_com</span><span class="o">.</span><span class="n">description</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">example_dot_com</span><span class="o">.</span><span class="n">mail_host</span><span class="p">)</span>
<span class="go">example.com</span>
</pre></div>
</div>
<p>You can also get an existing domain independently using its mail host.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">example</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_domain</span><span class="p">(</span><span class="s1">'example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">example</span>
<span class="go"><Domain "example.com"></span>
</pre></div>
</div>
<p>After creating a few more domains, we can print the list of all domains.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">create_domain</span><span class="p">(</span><span class="s1">'example.net'</span><span class="p">)</span>
<span class="go"><Domain "example.net"></span>
<span class="gp">>>> </span><span class="n">example_org</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_domain</span><span class="p">(</span><span class="s1">'example.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">example_org</span><span class="p">)</span>
<span class="go"><Domain "example.org"></span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">mail_host</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">domains</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mail_host</span><span class="p">)</span>
<span class="go"><Domain "example.com"></span>
<span class="go"><Domain "example.net"></span>
<span class="go"><Domain "example.org"></span>
</pre></div>
</div>
<p>Also, domain can be deleted.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">example_org</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">mail_host</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">domains</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mail_host</span><span class="p">)</span>
<span class="go"><Domain "example.com"></span>
<span class="go"><Domain "example.net"></span>
</pre></div>
</div>
</div>
<div class="section" id="mailing-lists">
<h2>Mailing lists<a class="headerlink" href="#mailing-lists" title="Permalink to this headline">¶</a></h2>
<p>Once you have a domain, you can create mailing lists in that domain.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span> <span class="o">=</span> <span class="n">example</span><span class="o">.</span><span class="n">create_list</span><span class="p">(</span><span class="s1">'test-1'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">test_one</span>
<span class="go"><List "test-1@example.com"></span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">fqdn_listname</span><span class="p">)</span>
<span class="go">test-1@example.com</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">mail_host</span><span class="p">)</span>
<span class="go">example.com</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">list_name</span><span class="p">)</span>
<span class="go">test-1</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span>
<span class="go">Test-1</span>
</pre></div>
</div>
<p>You can also retrieve the mailing list after the fact.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">my_list</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="s1">'test-1@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">my_list</span>
<span class="go"><List "test-1@example.com"></span>
</pre></div>
</div>
<p>And you can print all the known mailing lists.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">example</span><span class="o">.</span><span class="n">create_list</span><span class="p">(</span><span class="s1">'test-2'</span><span class="p">)</span>
<span class="go"><List "test-2@example.com"></span>
<span class="gp">>>> </span><span class="n">domain</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_domain</span><span class="p">(</span><span class="s1">'example.net'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">domain</span><span class="o">.</span><span class="n">create_list</span><span class="p">(</span><span class="s1">'test-3'</span><span class="p">)</span>
<span class="go"><List "test-3@example.net"></span>
<span class="gp">>>> </span><span class="n">example</span><span class="o">.</span><span class="n">create_list</span><span class="p">(</span><span class="s1">'test-3'</span><span class="p">)</span>
<span class="go"><List "test-3@example.com"></span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">mlist</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">lists</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mlist</span><span class="p">)</span>
<span class="go"><List "test-1@example.com"></span>
<span class="go"><List "test-2@example.com"></span>
<span class="go"><List "test-3@example.com"></span>
<span class="go"><List "test-3@example.net"></span>
</pre></div>
</div>
<p>You can also select advertised lists only.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">my_list</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s1">'advertised'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="gp">>>> </span><span class="n">my_list</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">mlist</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">get_lists</span><span class="p">(</span><span class="n">advertised</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mlist</span><span class="p">)</span>
<span class="go"><List "test-2@example.com"></span>
<span class="go"><List "test-3@example.com"></span>
<span class="go"><List "test-3@example.net"></span>
</pre></div>
</div>
<p>List results can be retrieved as pages:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_list_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">2</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="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">page</span><span class="p">)</span>
<span class="go">2</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">total_size</span>
<span class="go">4</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">m_list</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">m_list</span><span class="p">)</span>
<span class="go"><List "test-1@example.com"></span>
<span class="go"><List "test-2@example.com"></span>
<span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">next</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">2</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">m_list</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">m_list</span><span class="p">)</span>
<span class="go"><List "test-3@example.com"></span>
<span class="go"><List "test-3@example.net"></span>
</pre></div>
</div>
<p>Pages can also use the advertised filter:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_list_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">2</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">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">m_list</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">m_list</span><span class="p">)</span>
<span class="go"><List "test-2@example.com"></span>
<span class="go"><List "test-3@example.com"></span>
</pre></div>
</div>
<p>If you only want to know all lists for a specific domain, use the domain
object.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">mlist</span> <span class="ow">in</span> <span class="n">example</span><span class="o">.</span><span class="n">lists</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mlist</span><span class="p">)</span>
<span class="go"><List "test-1@example.com"></span>
<span class="go"><List "test-2@example.com"></span>
<span class="go"><List "test-3@example.com"></span>
</pre></div>
</div>
<p>It is also possible to display only advertised lists when using the domain.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">mlist</span> <span class="ow">in</span> <span class="n">example</span><span class="o">.</span><span class="n">get_lists</span><span class="p">(</span><span class="n">advertised</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mlist</span><span class="p">)</span>
<span class="go"><List "test-2@example.com"></span>
<span class="go"><List "test-3@example.com"></span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">mlist</span> <span class="ow">in</span> <span class="n">example</span><span class="o">.</span><span class="n">get_list_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">2</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">True</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mlist</span><span class="p">)</span>
<span class="go"><List "test-2@example.com"></span>
<span class="go"><List "test-3@example.com"></span>
</pre></div>
</div>
<p>You can use a list instance to delete the list.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_three</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="s1">'test-3@example.net'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">test_three</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
</pre></div>
</div>
<p>You can also delete a list using the client instance’s delete_list method.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">delete_list</span><span class="p">(</span><span class="s1">'test-3@example.com'</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">mlist</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">lists</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">mlist</span><span class="p">)</span>
<span class="go"><List "test-1@example.com"></span>
<span class="go"><List "test-2@example.com"></span>
</pre></div>
</div>
</div>
<div class="section" id="membership">
<h2>Membership<a class="headerlink" href="#membership" title="Permalink to this headline">¶</a></h2>
<p>Email addresses can subscribe to existing mailing lists, becoming members of
that list. The address is a unique id for a specific user in the system, and
a member is a user that is subscribed to a mailing list. Email addresses need
not be pre-registered, though the auto-registered user will be unique for each
email address.</p>
<p>The system starts out with no members.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">members</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>New members can be easily added; users are automatically registered.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_two</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="s1">'test-2@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_two</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s1">'subscription_policy'</span><span class="p">])</span>
<span class="go">confirm</span>
</pre></div>
</div>
<p>Email addresses need to be verified first, so if we try to subscribe a
user, we get a response with a token:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'unverified@example.com'</span><span class="p">,</span> <span class="s1">'Unverified'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">data</span><span class="p">[</span><span class="s1">'token'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s1">'token_owner'</span><span class="p">])</span>
<span class="go">subscriber</span>
</pre></div>
</div>
<p>If we know the email address to be valid, we can set the
<code class="docutils literal"><span class="pre">pre_verified</span></code> flag. However, the list’s subscription policy is
“confirm”, so if we try to subscribe a user, we will also get a token
back:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'unconfirmed@example.com'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s1">'Unconfirmed'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">data</span><span class="p">[</span><span class="s1">'token'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s1">'token_owner'</span><span class="p">])</span>
<span class="go">subscriber</span>
</pre></div>
</div>
<p>If we know the user originated the subscription (for example if she or
he has been authenticated elsewhere), we can set the <code class="docutils literal"><span class="pre">pre_confirmed</span></code>
flag.</p>
<p>The <code class="docutils literal"><span class="pre">pre_approved</span></code> flag is used for lists that require moderator
approval and should only be used if the subscription is initiated by a
moderator or admin.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">,</span> <span class="s1">'Anna'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">,</span> <span class="s1">'Bill'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_two</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_two</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'cris@example.com'</span><span class="p">,</span> <span class="s1">'Cris'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go"><Member "cris@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<p>We can retrieve all known memberships. These are sorted first by mailing list
name, then by email address.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">members</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-1.example.com"></span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
<span class="go"><Member "anna@example.com" on "test-2.example.com"></span>
<span class="go"><Member "cris@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<p>We can also view the memberships for a single mailing list.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">test_one</span><span class="o">.</span><span class="n">members</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-1.example.com"></span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<p>Membership lists can be paginated, to recieve only a part of the result.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_member_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">2</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="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">total_size</span>
<span class="go">4</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-1.example.com"></span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">next</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">2</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-2.example.com"></span>
<span class="go"><Member "cris@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">get_member_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">1</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="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">total_size</span>
<span class="go">2</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "anna@example.com" on "test-1.example.com"></span>
<span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">next</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">2</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">total_size</span>
<span class="go">2</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<p>We can get a single membership too.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris_test_two</span> <span class="o">=</span> <span class="n">test_two</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="s1">'cris@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">cris_test_two</span>
<span class="go"><Member "cris@example.com" on "test-2.example.com"></span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">cris_test_two</span><span class="o">.</span><span class="n">role</span><span class="p">)</span>
<span class="go">member</span>
</pre></div>
</div>
<p>A membership can also be retrieved without instantiating the list object first:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="s1">'test-2@example.com'</span><span class="p">,</span> <span class="s1">'cris@example.com'</span><span class="p">)</span>
<span class="go"><Member "cris@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<p>A membership has preferences.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">prefs</span> <span class="o">=</span> <span class="n">cris_test_two</span><span class="o">.</span><span class="n">preferences</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'delivery_mode'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'acknowledge_posts'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'delivery_status'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'hide_address'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'preferred_language'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'receive_list_copy'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'receive_own_postings'</span><span class="p">])</span>
<span class="go">None</span>
</pre></div>
</div>
<p>The membership object’s <code class="docutils literal"><span class="pre">user</span></code> attribute will return a User object:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris_test_two</span><span class="o">.</span><span class="n">user</span>
<span class="go"><User "Cris" (...)></span>
</pre></div>
</div>
<p>If you use an address which is not a member of test_two <cite>ValueError</cite> is raised:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_two</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="s1">'nomember@example.com'</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="c">...</span>
<span class="gr">ValueError</span>: <span class="n">nomember@example.com is not a member address of test-2@example.com</span>
</pre></div>
</div>
<p>After a while, Anna decides to unsubscribe from the Test One mailing list,
though she keeps her Test Two membership active.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">time</span>
<span class="gp">>>> </span><span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">members</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
<span class="go"><Member "anna@example.com" on "test-2.example.com"></span>
<span class="go"><Member "cris@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<p>A little later, Cris decides to unsubscribe from the Test Two mailing list.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris_test_two</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">members</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">member</span><span class="p">)</span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
<span class="go"><Member "anna@example.com" on "test-2.example.com"></span>
</pre></div>
</div>
<p>If you try to unsubscribe an address which is not a member address
<cite>ValueError</cite> is raised:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="s1">'nomember@example.com'</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="c">...</span>
<span class="gr">ValueError</span>: <span class="n">nomember@example.com is not a member address of test-1@example.com</span>
</pre></div>
</div>
</div>
<div class="section" id="non-members">
<h2>Non-Members<a class="headerlink" href="#non-members" title="Permalink to this headline">¶</a></h2>
<p>When someone attempts to post to a list but is not a member, then they are
listed as a “non-member” of that list so that a moderator can choose how to
handle their messages going forward. In some cases, one might wish to
accept or reject their future messages automatically. Just like with regular
members, they are given a unique id.</p>
<p>The list starts out with no nonmembers.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">nonmembers</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>When someone tries to send a message to the list and they are not a
subscriber, they get added to the nonmember list.</p>
</div>
<div class="section" id="users">
<h2>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h2>
<p>Users are people with one or more list memberships. To get a list of all users,
access the clients user property.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">users</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
<span class="go"><User "..." (...)></span>
<span class="go"><User "..." (...)></span>
<span class="go"><User "..." (...)></span>
</pre></div>
</div>
<p>The list of users can also be paginated:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_user_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">4</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="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">total_size</span>
<span class="go">5</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
<span class="go"><User "Unverified" (...)></span>
<span class="go"><User "Unconfirmed" (...)></span>
<span class="go"><User "Anna" (...)></span>
<span class="go"><User "Bill" (...)></span>
</pre></div>
</div>
<p>You can get the next or previous pages without calling <code class="docutils literal"><span class="pre">get_userpage</span></code> again.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">next</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">2</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
<span class="go"><User "Cris" (...)></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">previous</span>
<span class="gp">>>> </span><span class="n">page</span><span class="o">.</span><span class="n">nr</span>
<span class="go">1</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
<span class="go"><User "Unverified" (...)></span>
<span class="go"><User "Unconfirmed" (...)></span>
<span class="go"><User "Anna" (...)></span>
<span class="go"><User "Bill" (...)></span>
</pre></div>
</div>
<p>A single user can be retrieved using their email address.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_user</span><span class="p">(</span><span class="s1">'cris@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">cris</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span>
<span class="go">Cris</span>
</pre></div>
</div>
<p>Every user has a list of one or more addresses.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">address</span> <span class="ow">in</span> <span class="n">cris</span><span class="o">.</span><span class="n">addresses</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="o">.</span><span class="n">registered_on</span><span class="p">)</span>
<span class="go">cris@example.com</span>
<span class="go">Cris</span>
<span class="gp">...</span>
</pre></div>
</div>
<p>Multiple addresses can be assigned to a user record:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris</span><span class="o">.</span><span class="n">add_address</span><span class="p">(</span><span class="s1">'cris.person@example.org'</span><span class="p">)</span>
<span class="go">cris.person@example.org</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">get_address</span><span class="p">(</span><span class="s1">'cris.person@example.org'</span><span class="p">))</span>
<span class="go">cris.person@example.org</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">address</span> <span class="ow">in</span> <span class="n">cris</span><span class="o">.</span><span class="n">addresses</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
<span class="go">cris.person@example.org</span>
<span class="go">cris@example.com</span>
</pre></div>
</div>
<p>Trying to add an existing address will raise an error:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">create_user</span><span class="p">(</span><span class="n">email</span><span class="o">=</span><span class="s1">'dana@example.org'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">password</span><span class="o">=</span><span class="s1">'somepass'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">display_name</span><span class="o">=</span><span class="s1">'Dana'</span><span class="p">)</span>
<span class="go"><User "Dana" (...)></span>
<span class="gp">>>> </span><span class="n">cris</span><span class="o">.</span><span class="n">add_address</span><span class="p">(</span><span class="s1">'dana@example.org'</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="c">...</span>
<span class="gr">HTTPError</span>: <span class="n">HTTP Error 400: Address already exists</span>
</pre></div>
</div>
<p>This can be overridden by using the <code class="docutils literal"><span class="pre">absorb_existing</span></code> flag:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris</span><span class="o">.</span><span class="n">add_address</span><span class="p">(</span><span class="s1">'dana@example.org'</span><span class="p">,</span> <span class="n">absorb_existing</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go">dana@example.org</span>
</pre></div>
</div>
<p>The user Chris will then be merged with Dana, acquiring all its subscriptions
and preferences. In case of conflict, Chris’ original preferences will prevail.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">address</span> <span class="ow">in</span> <span class="n">cris</span><span class="o">.</span><span class="n">addresses</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
<span class="go">cris.person@example.org</span>
<span class="go">cris@example.com</span>
<span class="go">dana@example.org</span>
</pre></div>
</div>
</div>
<div class="section" id="addresses">
<h2>Addresses<a class="headerlink" href="#addresses" title="Permalink to this headline">¶</a></h2>
<p>Addresses can be accessed directly:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">address</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_address</span><span class="p">(</span><span class="s1">'dana@example.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
<span class="go">dana@example.org</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span>
<span class="go">Dana</span>
</pre></div>
</div>
<p>The address has not been verified:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="o">.</span><span class="n">verified</span><span class="p">)</span>
<span class="go">False</span>
</pre></div>
</div>
<p>But that can be done via the address object:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">address</span><span class="o">.</span><span class="n">verify</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="o">.</span><span class="n">verified</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
<p>It can also be unverified:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">address</span><span class="o">.</span><span class="n">unverify</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="o">.</span><span class="n">verified</span><span class="p">)</span>
<span class="go">False</span>
</pre></div>
</div>
<p>Addresses can be deleted by calling their <code class="docutils literal"><span class="pre">delete()</span></code> method or by removing
them from their user’s <code class="docutils literal"><span class="pre">addresses</span></code> list:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cris</span><span class="o">.</span><span class="n">addresses</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s1">'dana@example.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">address</span> <span class="ow">in</span> <span class="n">cris</span><span class="o">.</span><span class="n">addresses</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
<span class="go">cris.person@example.org</span>
<span class="go">cris@example.com</span>
</pre></div>
</div>
<dl class="docutils">
<dt>Users can be added using <code class="docutils literal"><span class="pre">create_user</span></code>. The display_name is optional:</dt>
<dd><div class="first last highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">create_user</span><span class="p">(</span><span class="n">email</span><span class="o">=</span><span class="s1">'ler@primus.org'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">password</span><span class="o">=</span><span class="s1">'somepass'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">display_name</span><span class="o">=</span><span class="s1">'Ler'</span><span class="p">)</span>
<span class="go"><User "Ler" (...)></span>
<span class="gp">>>> </span><span class="n">ler</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_user</span><span class="p">(</span><span class="s1">'ler@primus.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">ler</span><span class="o">.</span><span class="n">password</span><span class="p">)</span>
<span class="go">$...</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">ler</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span>
<span class="go">Ler</span>
</pre></div>
</div>
</dd>
</dl>
<p>User attributes can be changed through assignment, but you need to call the
object’s <code class="docutils literal"><span class="pre">save</span></code> method to store the changes in the mailman core database.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">ler</span><span class="o">.</span><span class="n">display_name</span> <span class="o">=</span> <span class="s1">'Sir Ler'</span>
<span class="gp">>>> </span><span class="n">ler</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">ler</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_user</span><span class="p">(</span><span class="s1">'ler@primus.org'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">ler</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span>
<span class="go">Sir Ler</span>
</pre></div>
</div>
<p>Passwords can be changed as well:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">old_pwd</span> <span class="o">=</span> <span class="n">ler</span><span class="o">.</span><span class="n">password</span>
<span class="gp">>>> </span><span class="n">ler</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="s1">'easy'</span>
<span class="gp">>>> </span><span class="n">old_pwd</span> <span class="o">==</span> <span class="n">ler</span><span class="o">.</span><span class="n">password</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">ler</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">old_pwd</span> <span class="o">==</span> <span class="n">ler</span><span class="o">.</span><span class="n">password</span>
<span class="go">False</span>
</pre></div>
</div>
<div class="section" id="user-subscriptions">
<h3>User Subscriptions<a class="headerlink" href="#user-subscriptions" title="Permalink to this headline">¶</a></h3>
<p>A User’s subscriptions can be access through their <code class="docutils literal"><span class="pre">subscriptions</span></code> property.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">bill</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_user</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">subscription</span> <span class="ow">in</span> <span class="n">bill</span><span class="o">.</span><span class="n">subscriptions</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">subscription</span><span class="p">)</span>
<span class="go"><Member "bill@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<p>If all you need are the list ids of all mailing lists a user is subscribed to,
you can use the <code class="docutils literal"><span class="pre">subscription_list_ids</span></code> property.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">list_id</span> <span class="ow">in</span> <span class="n">bill</span><span class="o">.</span><span class="n">subscription_list_ids</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">list_id</span><span class="p">)</span>
<span class="go">test-1.example.com</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="list-settings">
<h2>List Settings<a class="headerlink" href="#list-settings" title="Permalink to this headline">¶</a></h2>
<p>We can get all list settings via a lists settings attribute. A proxy object
for the settings is returned which behaves much like a dictionary.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">settings</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">settings</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">settings</span><span class="p">)</span>
<span class="go">56</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">settings</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">attr</span> <span class="o">+</span> <span class="s1">': '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">settings</span><span class="p">[</span><span class="n">attr</span><span class="p">]))</span>
<span class="go">acceptable_aliases: []</span>
<span class="gp">...</span>
<span class="go">volume: 1</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">settings</span><span class="p">[</span><span class="s1">'display_name'</span><span class="p">])</span>
<span class="go">Test-1</span>
</pre></div>
</div>
<p>We can access all valid list settings as attributes.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">settings</span><span class="p">[</span><span class="s1">'fqdn_listname'</span><span class="p">])</span>
<span class="go">test-1@example.com</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">settings</span><span class="p">[</span><span class="s1">'description'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">settings</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'A very meaningful description.'</span>
<span class="gp">>>> </span><span class="n">settings</span><span class="p">[</span><span class="s1">'display_name'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'Test Numero Uno'</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">settings</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">settings_new</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">settings</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">settings_new</span><span class="p">[</span><span class="s1">'description'</span><span class="p">])</span>
<span class="go">A very meaningful description.</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">settings_new</span><span class="p">[</span><span class="s1">'display_name'</span><span class="p">])</span>
<span class="go">Test Numero Uno</span>
</pre></div>
</div>
<p>The settings object also supports the <cite>get</cite> method of usual Python
dictionaries:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">settings_new</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'OhNoIForgotTheKey'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s1">'HowGoodIPlacedOneUnderTheDoormat'</span><span class="p">))</span>
<span class="go">HowGoodIPlacedOneUnderTheDoormat</span>
</pre></div>
</div>
</div>
<div class="section" id="preferences">
<h2>Preferences<a class="headerlink" href="#preferences" title="Permalink to this headline">¶</a></h2>
<p>Preferences can be accessed and set for users, members and addresses.</p>
<p>By default, preferences are not set and fall back to the global system
preferences. They’re read-only and can be accessed through the client object.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">global_prefs</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">preferences</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'acknowledge_posts'</span><span class="p">])</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'delivery_mode'</span><span class="p">])</span>
<span class="go">regular</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'delivery_status'</span><span class="p">])</span>
<span class="go">enabled</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'hide_address'</span><span class="p">])</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'preferred_language'</span><span class="p">])</span>
<span class="go">en</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'receive_list_copy'</span><span class="p">])</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">global_prefs</span><span class="p">[</span><span class="s1">'receive_own_postings'</span><span class="p">])</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Preferences can be set, but you have to call <code class="docutils literal"><span class="pre">save</span></code> to make your changes
permanent.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">prefs</span> <span class="o">=</span> <span class="n">test_two</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">)</span><span class="o">.</span><span class="n">preferences</span>
<span class="gp">>>> </span><span class="n">prefs</span><span class="p">[</span><span class="s1">'delivery_status'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'by_user'</span>
<span class="gp">>>> </span><span class="n">prefs</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">prefs</span> <span class="o">=</span> <span class="n">test_two</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">)</span><span class="o">.</span><span class="n">preferences</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">prefs</span><span class="p">[</span><span class="s1">'delivery_status'</span><span class="p">])</span>
<span class="go">by_user</span>
</pre></div>
</div>
</div>
<div class="section" id="pipelines-and-chains">
<h2>Pipelines and Chains<a class="headerlink" href="#pipelines-and-chains" title="Permalink to this headline">¶</a></h2>
<p>The available pipelines and chains can also be retrieved:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pipelines</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipelines</span><span class="p">[</span><span class="s1">'pipelines'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">pipeline</span> <span class="ow">in</span> <span class="n">pipelines</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">pipeline</span><span class="p">)</span>
<span class="go">default-owner-pipeline</span>
<span class="go">default-posting-pipeline</span>
<span class="go">virgin</span>
<span class="gp">>>> </span><span class="n">chains</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">chains</span><span class="p">[</span><span class="s1">'chains'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">chain</span> <span class="ow">in</span> <span class="n">chains</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">chain</span><span class="p">)</span>
<span class="go">accept</span>
<span class="go">default-owner-chain</span>
<span class="go">default-posting-chain</span>
<span class="go">discard</span>
<span class="go">header-match</span>
<span class="go">hold</span>
<span class="go">moderation</span>
<span class="go">reject</span>
</pre></div>
</div>
</div>
<div class="section" id="owners-and-moderators">
<h2>Owners and Moderators<a class="headerlink" href="#owners-and-moderators" title="Permalink to this headline">¶</a></h2>
<p>Owners and moderators are properties of the list object.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">owners</span>
<span class="go">[]</span>
<span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">moderators</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>Owners can be added via the <code class="docutils literal"><span class="pre">add_owner</span></code> method:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">add_owner</span><span class="p">(</span><span class="s1">'foo@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">owner</span> <span class="ow">in</span> <span class="n">test_one</span><span class="o">.</span><span class="n">owners</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">owner</span><span class="p">)</span>
<span class="go">foo@example.com</span>
</pre></div>
</div>
<p>The owner of the list not automatically added as a member:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">members</span>
<span class="go">[<Member "bill@example.com" on "test-1.example.com">]</span>
</pre></div>
</div>
<p>Moderators can be added similarly:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">add_moderator</span><span class="p">(</span><span class="s1">'bar@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">moderator</span> <span class="ow">in</span> <span class="n">test_one</span><span class="o">.</span><span class="n">moderators</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">moderator</span><span class="p">)</span>
<span class="go">bar@example.com</span>
</pre></div>
</div>
<p>Moderators are also not automatically added as members:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">members</span>
<span class="go">[<Member "bill@example.com" on "test-1.example.com">]</span>
</pre></div>
</div>
<p>Members and owners/moderators are separate entries in in the general members
list:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'bar@example.com'</span><span class="p">,</span> <span class="s1">'Bar'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go"><Member "bar@example.com" on "test-1.example.com"></span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">members</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1">: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span><span class="p">(</span><span class="n">member</span><span class="p">,</span> <span class="n">member</span><span class="o">.</span><span class="n">role</span><span class="p">))</span>
<span class="go"><Member "foo@example.com" on "test-1.example.com">: owner</span>
<span class="go"><Member "bar@example.com" on "test-1.example.com">: moderator</span>
<span class="go"><Member "bar@example.com" on "test-1.example.com">: member</span>
<span class="go"><Member "bill@example.com" on "test-1.example.com">: member</span>
<span class="go"><Member "anna@example.com" on "test-2.example.com">: member</span>
</pre></div>
</div>
<p>Both owners and moderators can be removed:</p>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">remove_owner</span><span class="p">(</span><span class="s1">'foo@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">owners</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>test_one.remove_moderator(<a class="reference external" href="mailto:'bar%40example.com">‘bar<span>@</span>example<span>.</span>com</a>’)
test_one.moderators
[]</p>
</div></blockquote>
</div>
<div class="section" id="moderation">
<h2>Moderation<a class="headerlink" href="#moderation" title="Permalink to this headline">¶</a></h2>
<div class="section" id="subscription-moderation">
<h3>Subscription Moderation<a class="headerlink" href="#subscription-moderation" title="Permalink to this headline">¶</a></h3>
<p>Subscription requests can be accessed through the list object’s
<cite>request</cite> property. So let’s create a non-open list first.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">confirm_first</span> <span class="o">=</span> <span class="n">example_dot_com</span><span class="o">.</span><span class="n">create_list</span><span class="p">(</span><span class="s1">'confirm-first'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">settings</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">settings</span>
<span class="gp">>>> </span><span class="n">settings</span><span class="p">[</span><span class="s1">'subscription_policy'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'moderate'</span>
<span class="gp">>>> </span><span class="n">settings</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">confirm_first</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="s1">'confirm-first.example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">confirm_first</span><span class="o">.</span><span class="n">settings</span><span class="p">[</span><span class="s1">'subscription_policy'</span><span class="p">])</span>
<span class="go">moderate</span>
</pre></div>
</div>
<p>Initially there are no requests, so let’s to subscribe someone to the
list. We’ll get a token back.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span>
<span class="go">[]</span>
<span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'groucho@example.com'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s1">'token_owner'</span><span class="p">])</span>
<span class="go">moderator</span>
</pre></div>
</div>
<p>Now the request shows up in the list of requests:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">time</span><span class="p">;</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">)</span>
<span class="go">1</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">request_1</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">request_1</span><span class="p">[</span><span class="s1">'email'</span><span class="p">])</span>
<span class="go">groucho@example.com</span>
<span class="gp">>>> </span><span class="nb">print</span> <span class="p">(</span><span class="n">request_1</span><span class="p">[</span><span class="s1">'token'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">request_1</span><span class="p">[</span><span class="s1">'token_owner'</span><span class="p">])</span>
<span class="go">moderator</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">request_1</span><span class="p">[</span><span class="s1">'request_date'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">request_1</span><span class="p">[</span><span class="s1">'list_id'</span><span class="p">])</span>
<span class="go">confirm-first.example.com</span>
</pre></div>
</div>
<p>Subscription requests can be accepted, deferred, rejected or
discarded using the request token.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'harpo@example.com'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s1">'zeppo@example.com'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_verified</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">pre_confirmed</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">)</span>
<span class="go">3</span>
</pre></div>
</div>
<p>Let’s accept Groucho:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">response</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_1</span><span class="p">[</span><span class="s1">'token'</span><span class="p">],</span> <span class="s1">'accept'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">)</span>
<span class="go">2</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">request_2</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">request_2</span><span class="p">[</span><span class="s1">'email'</span><span class="p">])</span>
<span class="go">harpo@example.com</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">request_3</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">request_3</span><span class="p">[</span><span class="s1">'email'</span><span class="p">])</span>
<span class="go">zeppo@example.com</span>
</pre></div>
</div>
<p>Let’s reject Harpo:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">response</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_2</span><span class="p">[</span><span class="s1">'token'</span><span class="p">],</span> <span class="s1">'reject'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">)</span>
<span class="go">1</span>
</pre></div>
</div>
<p>Let’s discard Zeppo’s request:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">response</span> <span class="o">=</span> <span class="n">confirm_first</span><span class="o">.</span><span class="n">moderate_request</span><span class="p">(</span><span class="n">request_3</span><span class="p">[</span><span class="s1">'token'</span><span class="p">],</span> <span class="s1">'discard'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">confirm_first</span><span class="o">.</span><span class="n">requests</span><span class="p">)</span>
<span class="go">0</span>
</pre></div>
</div>
</div>
<div class="section" id="message-moderation">
<h3>Message Moderation<a class="headerlink" href="#message-moderation" title="Permalink to this headline">¶</a></h3>
<p>By injecting a message by a non-member into the incoming queue, we can
simulate a message being held for moderator approval.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">msg</span> <span class="o">=</span> <span class="s2">"""From: nomember@example.com</span>
<span class="gp">... </span><span class="s2">To: test-1@example.com</span>
<span class="gp">... </span><span class="s2">Subject: Something</span>
<span class="gp">... </span><span class="s2">Message-ID: <moderated_01></span>
<span class="gp">...</span><span class="s2"></span>
<span class="gp">... </span><span class="s2">Some text.</span>
<span class="gp">...</span><span class="s2"></span>
<span class="gp">... </span><span class="s2">"""</span>
<span class="gp">>>> </span><span class="n">inq</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">queues</span><span class="p">[</span><span class="s1">'in'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">inq</span><span class="o">.</span><span class="n">inject</span><span class="p">(</span><span class="s1">'test-1.example.com'</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
</pre></div>
</div>
<p>Now wait until the message has been processed.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">inq</span><span class="o">.</span><span class="n">files</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">break</span>
<span class="gp">... </span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.1</span><span class="p">)</span>
</pre></div>
</div>
<p>It might take a few moments for the message to show up in the moderation
queue.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">all_held</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">held</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_held</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">break</span>
<span class="gp">... </span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.1</span><span class="p">)</span>
</pre></div>
</div>
<p>Messages held for moderation can be listed on a per list basis.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">all_held</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">request_id</span><span class="p">)</span>
<span class="go">1</span>
</pre></div>
</div>
<p>A held message can be retrieved by ID, and have attributes:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">heldmsg</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">get_held_message</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">heldmsg</span><span class="o">.</span><span class="n">subject</span><span class="p">)</span>
<span class="go">Something</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">heldmsg</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>
<span class="go">The message is not from a list member</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">heldmsg</span><span class="o">.</span><span class="n">sender</span><span class="p">)</span>
<span class="go">nomember@example.com</span>
<span class="gp">>>> </span><span class="s1">'Message-ID: <moderated_01>'</span> <span class="ow">in</span> <span class="n">heldmsg</span><span class="o">.</span><span class="n">msg</span>
<span class="go">True</span>
</pre></div>
</div>
<p>A moderation action can be taken on them using the list methods or the held
message’s methods.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">defer_message</span><span class="p">(</span><span class="n">heldmsg</span><span class="o">.</span><span class="n">request_id</span><span class="p">)[</span><span class="s1">'status'</span><span class="p">])</span>
<span class="go">204</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">held</span><span class="p">)</span>
<span class="go">1</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">heldmsg</span><span class="o">.</span><span class="n">discard</span><span class="p">()[</span><span class="s1">'status'</span><span class="p">])</span>
<span class="go">204</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">held</span><span class="p">)</span>
<span class="go">0</span>
</pre></div>
</div>
</div>
<div class="section" id="member-moderation">
<h3>Member moderation<a class="headerlink" href="#member-moderation" title="Permalink to this headline">¶</a></h3>
<p>Each member or non-member can have a specific moderation action. It is set
using the ‘moderation_action’ property:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">bill_member</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">bill_member</span><span class="o">.</span><span class="n">moderation_action</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="n">bill_member</span><span class="o">.</span><span class="n">moderation_action</span> <span class="o">=</span> <span class="s1">'hold'</span>
<span class="gp">>>> </span><span class="n">bill_member</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">get_member</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span><span class="o">.</span><span class="n">moderation_action</span><span class="p">)</span>
<span class="go">hold</span>
</pre></div>
</div>
</div>
<div class="section" id="banning-addresses">
<h3>Banning addresses<a class="headerlink" href="#banning-addresses" title="Permalink to this headline">¶</a></h3>
<p>A ban list is a list of email addresses that are not allowed to subscribe to a
mailing-list. There are two types of ban lists: each mailing-list has its ban
list, and there is a site-wide list. Addresses on the site-wide list are
prevented from subscribing to every mailing-list on the server.</p>
<p>To view the site-wide ban list, use the <cite>bans</cite> property:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="p">)</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>You can use the <cite>add</cite> method on the ban list to ban an email address:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">banned_anna</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">banned_anna</span><span class="p">)</span>
<span class="go">anna@example.com</span>
<span class="gp">>>> </span><span class="s1">'anna@example.com'</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">bans</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span>
<span class="go">bill@example.com</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="p">))</span>
<span class="go">[anna@example.com, bill@example.com]</span>
</pre></div>
</div>
<p>The list of banned addresses can be paginated using the <code class="docutils literal"><span class="pre">get_bans_page()</span></code>
method:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">get_bans_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">1</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="go">[anna@example.com]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">get_bans_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="mi">2</span><span class="p">)))</span>
<span class="go">[bill@example.com]</span>
</pre></div>
</div>
<p>You can use the <code class="docutils literal"><span class="pre">delete()</span></code> method on a banned address to unban it, or the
<code class="docutils literal"><span class="pre">remove()</span></code> method on the ban list:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">banned_anna</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
<span class="gp">>>> </span><span class="s1">'anna@example.com'</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">bans</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="p">))</span>
<span class="go">[bill@example.com]</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="s1">'bill@example.com'</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">bans</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">bans</span><span class="p">))</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>The mailing-list-specific ban lists work in the same way:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">bans</span><span class="p">))</span>
<span class="go">[]</span>
<span class="gp">>>> </span><span class="n">banned_anna</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">bans</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'anna@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="s1">'anna@example.com'</span> <span class="ow">in</span> <span class="n">test_one</span><span class="o">.</span><span class="n">bans</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">bans</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span>
<span class="go">bill@example.com</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">bans</span><span class="p">))</span>
<span class="go">[anna@example.com, bill@example.com]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">get_bans_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">1</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="go">[anna@example.com]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">get_bans_page</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="mi">2</span><span class="p">)))</span>
<span class="go">[bill@example.com]</span>
<span class="gp">>>> </span><span class="n">banned_anna</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
<span class="gp">>>> </span><span class="s1">'anna@example.com'</span> <span class="ow">in</span> <span class="n">test_one</span><span class="o">.</span><span class="n">bans</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">test_one</span><span class="o">.</span><span class="n">bans</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s1">'bill@example.com'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">bans</span><span class="p">))</span>
<span class="go">[]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="archivers">
<h2>Archivers<a class="headerlink" href="#archivers" title="Permalink to this headline">¶</a></h2>
<p>Each list object has an <code class="docutils literal"><span class="pre">archivers</span></code> attribute.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">archivers</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">archivers</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">archivers</span><span class="p">)</span>
<span class="go"><Archivers on "test-1.example.com"></span>
</pre></div>
</div>
<p>The activation status of each available archiver can be accessed like a
key in a dictionary.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">archivers</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">archivers</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">archiver</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">archivers</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{0}</span><span class="s1">: </span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">archiver</span><span class="p">,</span> <span class="n">archivers</span><span class="p">[</span><span class="n">archiver</span><span class="p">]))</span>
<span class="go">mail-archive: True</span>
<span class="go">mhonarc: True</span>
<span class="go">prototype: True</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">archivers</span><span class="p">[</span><span class="s1">'mail-archive'</span><span class="p">]</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">archivers</span><span class="p">[</span><span class="s1">'mhonarc'</span><span class="p">]</span>
<span class="go">True</span>
</pre></div>
</div>
<p>They can also be set like items in dictionary.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">archivers</span><span class="p">[</span><span class="s1">'mail-archive'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="gp">>>> </span><span class="n">archivers</span><span class="p">[</span><span class="s1">'mhonarc'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
</pre></div>
</div>
<p>So if we get a new <code class="docutils literal"><span class="pre">archivers</span></code> object from the API (by accessing the
list’s archiver attribute again), we can see that the archiver stati
have now been set.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">archivers</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">archivers</span>
<span class="gp">>>> </span><span class="n">archivers</span><span class="p">[</span><span class="s1">'mail-archive'</span><span class="p">]</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">archivers</span><span class="p">[</span><span class="s1">'mhonarc'</span><span class="p">]</span>
<span class="go">False</span>
</pre></div>
</div>
</div>
<div class="section" id="header-matches">
<h2>Header matches<a class="headerlink" href="#header-matches" title="Permalink to this headline">¶</a></h2>
<p>Header matches are filtering rules that apply to messages sent to a mailing
list. They match a header to a pattern using a regular expression, and matching
patterns can trigger specific moderation actions. They are accessible via the
mailing list’s <code class="docutils literal"><span class="pre">header_matches</span></code> attribute, which behaves like a list.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">header_matches</span> <span class="o">=</span> <span class="n">test_one</span><span class="o">.</span><span class="n">header_matches</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">header_matches</span><span class="p">)</span>
<span class="go"><HeaderMatches for "test-1.example.com"></span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">header_matches</span><span class="p">)</span>
<span class="go">0</span>
</pre></div>
</div>
<p>Header matches can be added using the <code class="docutils literal"><span class="pre">add()</span></code> method. The arguments are:</p>
<ul>
<li><p class="first">the header to consider (<code class="docutils literal"><span class="pre">str</span></code>). Il will be lower-cased.</p>
</li>
<li><p class="first">the regular expression to use for filtering (<code class="docutils literal"><span class="pre">str</span></code>)</p>
</li>
<li><p class="first">the action to take when the header matches the pattern. This can be
<code class="docutils literal"><span class="pre">'accept'</span></code>, <code class="docutils literal"><span class="pre">'discard'</span></code>, <code class="docutils literal"><span class="pre">'reject'</span></code>, or <code class="docutils literal"><span class="pre">'hold'</span></code>.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">header_matches</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'Subject'</span><span class="p">,</span> <span class="s1">'^test: '</span><span class="p">,</span> <span class="s1">'discard'</span><span class="p">)</span>
<span class="go"><HeaderMatch on "subject"></span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">header_matches</span><span class="p">)</span>
<span class="go"><HeaderMatches for "test-1.example.com"></span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">header_matches</span><span class="p">)</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">header_matches</span><span class="p">))</span>
<span class="go">[<HeaderMatch on "subject">]</span>
</pre></div>
</div>
</li>
</ul>
<p>You can delete a header match by deleting it from the <code class="docutils literal"><span class="pre">header_matches</span></code>
collection.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">del</span> <span class="n">header_matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">header_matches</span><span class="p">)</span>
<span class="go">0</span>
</pre></div>
</div>
<p>You can also delete a header match using its <code class="docutils literal"><span class="pre">delete()</span></code> method, but be aware
that the collection will not automatically be updated. Get a new collection
from the list’s <code class="docutils literal"><span class="pre">header_matches</span></code> attribute to see the change.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">header_matches</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'Subject'</span><span class="p">,</span> <span class="s1">'^test: '</span><span class="p">,</span> <span class="s1">'discard'</span><span class="p">)</span>
<span class="go"><HeaderMatch on "subject"></span>
<span class="gp">>>> </span><span class="n">header_matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">header_matches</span><span class="p">)</span> <span class="c1"># not automatically updated</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">test_one</span><span class="o">.</span><span class="n">header_matches</span><span class="p">)</span>
<span class="go">0</span>
</pre></div>
</div>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>Mailman Core exposes all its configuration through REST API. All these
configuration options are read-only.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cfg</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">configuration</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">cfg</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="p">[</span><span class="n">key</span><span class="p">])</span>
<span class="go"><Configuration: "antispam"></span>
<span class="go"><Configuration: "archiver.mail_archive"></span>
<span class="go"><Configuration: "archiver.master"></span>
<span class="go"><Configuration: "archiver.mhonarc"></span>
<span class="go"><Configuration: "archiver.prototype"></span>
<span class="go"><Configuration: "bounces"></span>
<span class="go"><Configuration: "database"></span>
<span class="go"><Configuration: "devmode"></span>
<span class="go"><Configuration: "digests"></span>
<span class="go"><Configuration: "dmarc"></span>
<span class="go"><Configuration: "language.ar"></span>
<span class="go"><Configuration: "language.ast"></span>
<span class="go"><Configuration: "language.ca"></span>
<span class="go"><Configuration: "language.cs"></span>
<span class="go"><Configuration: "language.da"></span>
<span class="go"><Configuration: "language.de"></span>
<span class="go"><Configuration: "language.el"></span>
<span class="go"><Configuration: "language.en"></span>
<span class="go"><Configuration: "language.es"></span>
<span class="go"><Configuration: "language.et"></span>
<span class="go"><Configuration: "language.eu"></span>
<span class="go"><Configuration: "language.fi"></span>
<span class="go"><Configuration: "language.fr"></span>
<span class="go"><Configuration: "language.gl"></span>
<span class="go"><Configuration: "language.he"></span>
<span class="go"><Configuration: "language.hr"></span>
<span class="go"><Configuration: "language.hu"></span>
<span class="go"><Configuration: "language.ia"></span>
<span class="go"><Configuration: "language.it"></span>
<span class="go"><Configuration: "language.ja"></span>
<span class="go"><Configuration: "language.ko"></span>
<span class="go"><Configuration: "language.lt"></span>
<span class="go"><Configuration: "language.nl"></span>
<span class="go"><Configuration: "language.no"></span>
<span class="go"><Configuration: "language.pl"></span>
<span class="go"><Configuration: "language.pt"></span>
<span class="go"><Configuration: "language.pt_BR"></span>
<span class="go"><Configuration: "language.ro"></span>
<span class="go"><Configuration: "language.ru"></span>
<span class="go"><Configuration: "language.sk"></span>
<span class="go"><Configuration: "language.sl"></span>
<span class="go"><Configuration: "language.sr"></span>
<span class="go"><Configuration: "language.sv"></span>
<span class="go"><Configuration: "language.tr"></span>
<span class="go"><Configuration: "language.uk"></span>
<span class="go"><Configuration: "language.vi"></span>
<span class="go"><Configuration: "language.zh_CN"></span>
<span class="go"><Configuration: "language.zh_TW"></span>
<span class="go"><Configuration: "logging.archiver"></span>
<span class="go"><Configuration: "logging.bounce"></span>
<span class="go"><Configuration: "logging.config"></span>
<span class="go"><Configuration: "logging.database"></span>
<span class="go"><Configuration: "logging.debug"></span>
<span class="go"><Configuration: "logging.error"></span>
<span class="go"><Configuration: "logging.fromusenet"></span>
<span class="go"><Configuration: "logging.http"></span>
<span class="go"><Configuration: "logging.locks"></span>
<span class="go"><Configuration: "logging.mischief"></span>
<span class="go"><Configuration: "logging.root"></span>
<span class="go"><Configuration: "logging.runner"></span>
<span class="go"><Configuration: "logging.smtp"></span>
<span class="go"><Configuration: "logging.subscribe"></span>
<span class="go"><Configuration: "logging.vette"></span>
<span class="go"><Configuration: "mailman"></span>
<span class="go"><Configuration: "mta"></span>
<span class="go"><Configuration: "nntp"></span>
<span class="go"><Configuration: "passwords"></span>
<span class="go"><Configuration: "paths.dev"></span>
<span class="go"><Configuration: "paths.fhs"></span>
<span class="go"><Configuration: "paths.here"></span>
<span class="go"><Configuration: "paths.local"></span>
<span class="go"><Configuration: "runner.archive"></span>
<span class="go"><Configuration: "runner.bad"></span>
<span class="go"><Configuration: "runner.bounces"></span>
<span class="go"><Configuration: "runner.command"></span>
<span class="go"><Configuration: "runner.digest"></span>
<span class="go"><Configuration: "runner.in"></span>
<span class="go"><Configuration: "runner.lmtp"></span>
<span class="go"><Configuration: "runner.nntp"></span>
<span class="go"><Configuration: "runner.out"></span>
<span class="go"><Configuration: "runner.pipeline"></span>
<span class="go"><Configuration: "runner.rest"></span>
<span class="go"><Configuration: "runner.retry"></span>
<span class="go"><Configuration: "runner.shunt"></span>
<span class="go"><Configuration: "runner.virgin"></span>
<span class="go"><Configuration: "shell"></span>
<span class="go"><Configuration: "styles"></span>
<span class="go"><Configuration: "webservice"></span>
</pre></div>
</div>
<p>Each configuration object is a dictionary and you can iterate over them:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">cfg</span><span class="p">[</span><span class="s1">'mailman'</span><span class="p">]):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{}</span><span class="s1"> : </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">cfg</span><span class="p">[</span><span class="s1">'mailman'</span><span class="p">][</span><span class="n">key</span><span class="p">]))</span>
<span class="go">cache_life : 7d</span>
<span class="go">default_language : en</span>
<span class="go">email_commands_max_lines : 10</span>
<span class="go">filtered_messages_are_preservable : no</span>
<span class="go">html_to_plain_text_command : /usr/bin/lynx -dump $filename</span>
<span class="go">layout : here</span>
<span class="go">listname_chars : [-_.0-9a-z]</span>
<span class="go">noreply_address : noreply</span>
<span class="go">pending_request_life : 3d</span>
<span class="go">post_hook :</span>
<span class="go">pre_hook :</span>
<span class="go">self_link : http://localhost:9001/3.1/system/configuration/mailman</span>
<span class="go">sender_headers : from from_ reply-to sender</span>
<span class="go">site_owner : changeme@example.com</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../README.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Example Usage</a><ul>
<li><a class="reference internal" href="#domains">Domains</a></li>
<li><a class="reference internal" href="#mailing-lists">Mailing lists</a></li>
<li><a class="reference internal" href="#membership">Membership</a></li>
<li><a class="reference internal" href="#non-members">Non-Members</a></li>
<li><a class="reference internal" href="#users">Users</a></li>
<li><a class="reference internal" href="#addresses">Addresses</a><ul>
<li><a class="reference internal" href="#user-subscriptions">User Subscriptions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#list-settings">List Settings</a></li>
<li><a class="reference internal" href="#preferences">Preferences</a></li>
<li><a class="reference internal" href="#pipelines-and-chains">Pipelines and Chains</a></li>
<li><a class="reference internal" href="#owners-and-moderators">Owners and Moderators</a></li>
<li><a class="reference internal" href="#moderation">Moderation</a><ul>
<li><a class="reference internal" href="#subscription-moderation">Subscription Moderation</a></li>
<li><a class="reference internal" href="#message-moderation">Message Moderation</a></li>
<li><a class="reference internal" href="#member-moderation">Member moderation</a></li>
<li><a class="reference internal" href="#banning-addresses">Banning addresses</a></li>
</ul>
</li>
<li><a class="reference internal" href="#archivers">Archivers</a></li>
<li><a class="reference internal" href="#header-matches">Header matches</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="NEWS.html"
title="previous chapter">NEWS for mailmanclient</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="apiref.html"
title="next chapter">API Reference</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/src/mailmanclient/docs/using.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<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="right" >
<a href="apiref.html" title="API Reference"
>next</a> |</li>
<li class="right" >
<a href="NEWS.html" title="NEWS for mailmanclient"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../README.html">Mailman Client 3.1.1 documentation</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>
|