This file is indexed.

/usr/share/doc/xmail/Readme.html is in xmail-doc 1.27-1.1build1.

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
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>XMail mail server v 1.27</title>
<link rel="stylesheet" href="./xmail.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body>


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#license">LICENSE</a></li>
	<li><a href="#overview">OVERVIEW</a></li>
	<li><a href="#version">VERSION</a></li>
	<ul>

		<li><a href="#current">current</a></li>
		<li><a href="#release_type">release type</a></li>
		<li><a href="#release_date">release date</a></li>
		<li><a href="#project_by">project by</a></li>
		<li><a href="#credits">credits</a></li>
		<li><a href="#warning">warning</a></li>
	</ul>

	<li><a href="#documentation_conventions">DOCUMENTATION CONVENTIONS</a></li>
	<li><a href="#features">FEATURES</a></li>
	<li><a href="#porting_status">PORTING STATUS</a></li>
	<li><a href="#requirements">REQUIREMENTS</a></li>
	<li><a href="#obtaining_the_source">OBTAINING THE SOURCE</a></li>
	<li><a href="#build">BUILD</a></li>
	<li><a href="#configuration">CONFIGURATION</a></li>
	<ul>

		<li><a href="#linux_solaris_freebsd_openbsd">Linux/Solaris/FreeBSD/OpenBSD</a></li>
		<li><a href="#nt_win2k_xp">NT/Win2K/XP</a></li>
		<li><a href="#environment_variables">Environment variables</a></li>
		<li><a href="#mailroot_structure">MailRoot structure</a></li>
		<li><a href="#configuration_tables">Configuration tables</a></li>
		<ul>

			<li><a href="#aliases_tab">ALIASES.TAB</a></li>
			<li><a href="#aliasdomain_tab">ALIASDOMAIN.TAB</a></li>
			<li><a href="#domains_tab">DOMAINS.TAB</a></li>
			<li><a href="#dnsroots">DNSROOTS</a></li>
			<li><a href="#extaliases_tab">EXTALIASES.TAB</a></li>
			<li><a href="#mailusers_tab">MAILUSERS.TAB</a></li>
			<li><a href="#message_id">MESSAGE.ID</a></li>
			<li><a href="#pop3links_tab">POP3LINKS.TAB</a></li>
			<li><a href="#server_tab">SERVER.TAB</a></li>
			<li><a href="#smtpgw_tab">SMTPGW.TAB</a></li>
			<li><a href="#smtpfwd_tab">SMTPFWD.TAB</a></li>
			<li><a href="#smtprelay_tab">SMTPRELAY.TAB</a></li>
			<li><a href="#smtpauth_tab">SMTPAUTH.TAB</a></li>
			<li><a href="#smtpextauth_tab">SMTPEXTAUTH.TAB</a></li>
			<li><a href="#userdef_tab">USERDEF.TAB</a></li>
			<li><a href="#ctrlaccounts_tab">CTRLACCOUNTS.TAB</a></li>
			<li><a href="#spammers_tab">SPAMMERS.TAB</a></li>
			<li><a href="#spam_address_tab">SPAM-ADDRESS.TAB</a></li>
			<li><a href="#pop3_ipmap_tab">POP3.IPMAP.TAB</a></li>
			<li><a href="#smtp_ipmap_tab">SMTP.IPMAP.TAB</a></li>
			<li><a href="#ctrl_ipmap_tab">CTRL.IPMAP.TAB</a></li>
			<li><a href="#finger_ipmap_tab">FINGER.IPMAP.TAB</a></li>
			<li><a href="#user_tab">USER.TAB</a></li>
			<li><a href="#mlusers_tab">MLUSERS.TAB</a></li>
			<li><a href="#mailproc_tab">MAILPROC.TAB</a></li>
			<li><a href="#smtp_ipprop_tab">SMTP.IPPROP.TAB</a></li>
			<li><a href="#smtp_hnprop_tab">SMTP.HNPROP.TAB</a></li>
			<li><a href="#filters_in_tab">FILTERS.IN.TAB</a></li>
			<li><a href="#filters_out_tab">FILTERS.OUT.TAB</a></li>
			<li><a href="#filters_post_rcpt_tab">FILTERS.POST-RCPT.TAB</a></li>
			<li><a href="#filters_pre_data_tab">FILTERS.PRE-DATA.TAB</a></li>
			<li><a href="#filters_post_data_tab">FILTERS.POST-DATA.TAB</a></li>
		</ul>

	</ul>

	<li><a href="#macro_substitution">MACRO SUBSTITUTION</a></li>
	<li><a href="#external_authentication">EXTERNAL AUTHENTICATION</a></li>
	<li><a href="#smtp_client_authentication">SMTP CLIENT AUTHENTICATION</a></li>
	<li><a href="#custom_domain_mail_processing">CUSTOM DOMAIN MAIL PROCESSING</a></li>
	<li><a href="#cmd_aliases">CMD ALIASES</a></li>
	<li><a href="#server_tab_variables">SERVER.TAB VARIABLES</a></li>
	<li><a href="#message_filters">MESSAGE FILTERS</a></li>
	<li><a href="#smtp_message_filters">SMTP MESSAGE FILTERS</a></li>
	<li><a href="#user_tab_variables">USER.TAB VARIABLES</a></li>
	<li><a href="#mail_routing_through_addresses">MAIL ROUTING THROUGH ADDRESSES</a></li>
	<li><a href="#xmail_spool_design">XMAIL SPOOL DESIGN</a></li>
	<li><a href="#smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a></li>
	<li><a href="#ssl_configuration">SSL CONFIGURATION</a></li>
	<li><a href="#smtp_commands">SMTP COMMANDS</a></li>
	<li><a href="#pop3_commands">POP3 COMMANDS</a></li>
	<li><a href="#command_line">COMMAND LINE</a></li>
	<li><a href="#xmail_admin_protocol">XMAIL ADMIN PROTOCOL</a></li>
	<ul>

		<li><a href="#description">Description</a></li>
		<li><a href="#adding_a_user">Adding a user</a></li>
		<li><a href="#deleting_a_user">Deleting a user</a></li>
		<li><a href="#changing_a_user_s_password">Changing a user's password</a></li>
		<li><a href="#authenticate_user">Authenticate user</a></li>
		<li><a href="#retrieve_user_statistics">Retrieve user statistics</a></li>
		<li><a href="#adding_an_alias">Adding an alias</a></li>
		<li><a href="#deleting_an_alias">Deleting an alias</a></li>
		<li><a href="#listing_aliases">Listing aliases</a></li>
		<li><a href="#adding_an_external_alias">Adding an external alias</a></li>
		<li><a href="#deleting_an_external_alias">Deleting an external alias</a></li>
		<li><a href="#listing_external_aliases">Listing external aliases</a></li>
		<li><a href="#listing_user_vars">Listing user vars</a></li>
		<li><a href="#setting_user_vars">Setting user vars</a></li>
		<li><a href="#listing_users">Listing users</a></li>
		<li><a href="#getting_mailproc_tab_file">Getting mailproc.tab file</a></li>
		<li><a href="#setting_mailproc_tab_file">Setting mailproc.tab file</a></li>
		<li><a href="#adding_a_mailing_list_user">Adding a mailing list user</a></li>
		<li><a href="#deleting_a_mailing_list_user">Deleting a mailing list user</a></li>
		<li><a href="#listing_mailing_list_users">Listing mailing list users</a></li>
		<li><a href="#adding_a_domain">Adding a domain</a></li>
		<li><a href="#deleting_a_domain">Deleting a domain</a></li>
		<li><a href="#listing_handled_domains">Listing handled domains</a></li>
		<li><a href="#adding_a_domain_alias">Adding a domain alias</a></li>
		<li><a href="#deleting_a_domain_alias">Deleting a domain alias</a></li>
		<li><a href="#listing_alias_domains">Listing alias domains</a></li>
		<li><a href="#getting_custom_domain_file">Getting custom domain file</a></li>
		<li><a href="#setting_custom_domain_file">Setting custom domain file</a></li>
		<li><a href="#listing_custom_domains">Listing custom domains</a></li>
		<li><a href="#adding_a_pop3_external_link">Adding a POP3 external link</a></li>
		<li><a href="#deleting_a_pop3_external_link">Deleting a POP3 external link</a></li>
		<li><a href="#listing_pop3_external_links">Listing POP3 external links</a></li>
		<li><a href="#enabling_a_pop3_external_link">Enabling a POP3 external link</a></li>
		<li><a href="#listing_files">Listing files</a></li>
		<li><a href="#getting_configuration_file">Getting configuration file</a></li>
		<li><a href="#setting_configuration_file">Setting configuration file</a></li>
		<li><a href="#listing_frozen_messages">Listing frozen messages</a></li>
		<li><a href="#rescheduling_frozen_message">Rescheduling frozen message</a></li>
		<li><a href="#deleting_frozen_message">Deleting frozen message</a></li>
		<li><a href="#getting_frozen_message_log_file">Getting frozen message log file</a></li>
		<li><a href="#getting_frozen_message">Getting frozen message</a></li>
		<li><a href="#starting_a_queue_flush">Starting a queue flush</a></li>
		<li><a href="#do_nothing_command">Do nothing command</a></li>
		<li><a href="#quit_the_connection">Quit the connection</a></li>
		<li><a href="#do_you_want___">Do you want...?</a></li>
	</ul>

	<li><a href="#xmail_local_mailer">XMAIL LOCAL MAILER</a></li>
	<li><a href="#ctrlclnt__xmail_administration_">CtrlClnt (XMAIL ADMINISTRATION)</a></li>
	<li><a href="#server_shutdown">SERVER SHUTDOWN</a></li>
	<li><a href="#mkusers">MkUsers</a></li>
	<li><a href="#sendmail">sendmail</a></li>
	<li><a href="#miscellaneous">MISCELLANEOUS</a></li>
	<li><a href="#thanks">THANKS</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>XMail - Internet/Intranet mail server.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="license">LICENSE</a></h1>
<p>This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation (<a href="http://www.gnu.org">http://www.gnu.org</a>);
either version 2 of the License, or
(at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="overview">OVERVIEW</a></h1>
<p>XMail is an Internet and Intranet mail server featuring an SMTP server,
POP3 server, finger server, multiple domains,
no need for users to have a real system account,
SMTP relay checking, RBL/RSS/ORBS/DUL and custom (IP based and address based) spam protection,
SMTP authentication (PLAIN LOGIN CRAM-MD5 POP3-before-SMTP and custom),
a POP3 account synchronizer with external POP3 accounts, account aliases,
domain aliases, custom mail processing, direct mail files delivery,
custom mail filters, mailing lists, remote administration, custom mail exchangers,
logging, and multi-platform code.</p>
<p>XMail sources compile under GNU/Linux, FreeBSD, OpenBSD, NetBSD, OSX, Solaris and NT/2K.</p>
<p>This server was born due to the need of having a free and stable Mail Server
to be used inside my old company, which used a Windows Network.
I don't like to reinvent the wheel but the need of some special features
drive me to start a new project. Probably if I could use a Linux server
on my net, I would be able to satisfy my needs without writing code, but
this is not the case. It should be also portable to other OSs, like Linux
and other Unixes.</p>
<p>Another reason that drove me to write XMail is the presence of the same steps
in setting up a typical mail server, i.e.:</p>
<pre>
 sendmail + qpopper + fetchmail</pre>
<p>if one needs SMTP, POP3 and external synchronization, or:</p>
<pre>
 sendmail + qpopper</pre>
<p>for only SMTP and POP3 (I've quoted sendmail, qpopper and fetchmail, but there
are many other packages you can use to reach these needs).
With XMail you get an all-in-one package with a central administration that can
simplify the above common steps.</p>
<p>The first code of XMail Server is started on Windows NT and Linux, and
now, the FreeBSD and Solaris version ready. The compilers supported are gcc for
Linux, FreeBSD, OpenBSD and Solaris and M$ Visual C++ for NT/2K.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="version">VERSION</a></h1>
<p>
</p>
<h2><a name="current">current</a></h2>
<p>1.27</p>
<p>
</p>
<h2><a name="release_type">release type</a></h2>
<p>Gnu Public License <a href="http://www.gnu.org">http://www.gnu.org</a></p>
<p>
</p>
<h2><a name="release_date">release date</a></h2>
<p>Feb 25, 2010</p>
<p>
</p>
<h2><a name="project_by">project by</a></h2>
<p>Davide Libenzi &lt;<a href="mailto:davidel@xmailserver.org">davidel@xmailserver.org</a>&gt; <a href="http://www.xmailserver.org/">http://www.xmailserver.org/</a></p>
<p>
</p>
<h2><a name="credits">credits</a></h2>
<p>Michael Hartle &lt;<a href="mailto:mhartle@hartle-klug.com">mhartle@hartle-klug.com</a>&gt;</p>
<p>Shawn Anderson &lt;<a href="mailto:sanderson@eye-catcher.com">sanderson@eye-catcher.com</a>&gt;</p>
<p>Dick van der Kaaden &lt;<a href="mailto:dick@netrex.nl">dick@netrex.nl</a>&gt;</p>
<p>Beau E, Cox &lt;<a href="mailto:beau@beaucox.com">beau@beaucox.com</a>&gt;</p>
<p>
</p>
<h2><a name="warning">warning</a></h2>
<pre>
 ************************************************************
 *                     &lt;&lt;WARNING&gt;&gt;                          *
 *  If you're upgrading an existing version of XMail it's   *
 *  strongly suggested that you read all the ChangeLog      *
 *  notes that range from existing version to the new one.  *
 ************************************************************</pre>
<p>See the <a href="./ChangeLog.html"><b>Change Log</b></a>.</p><p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="documentation_conventions">DOCUMENTATION CONVENTIONS</a></h1>
<p>This document contains various examples of entries you must make to the XMail
configuration tables. These examples are written in a</p>
<pre>
 mono-spaced font like this.</pre>
<p>The prototype statement is shown with explicit '<strong>[TAB]</strong>' and '<strong>[NEWLINE]</strong>'
characters:</p>
<pre>
 &quot;aliasdomain&quot;[TAB]&quot;realdomain&quot;[NEWLINE]</pre>
<p>while examples omit these characters:</p>
<pre>
 &quot;simpson.org&quot;   &quot;simpson.com&quot;
 &quot;*.homer.net&quot;   &quot;homer.net&quot;</pre>
<p>'<strong>YOU MUST ALWAYS ENTER THE DATA EXACTLY AS SHOWN IN THE PROTOTYPE.</strong>'</p>
<p>When a prototype or example statement is too long to be easily shown on the screen or
printed, the line is split into multiple lines by showing '<strong>=</strong>&gt;' at the end of
continued lines and indenting the continuation line(s):</p>
<pre>
 &quot;domain&quot;[TAB]&quot;account&quot;[TAB]&quot;enc-passwd&quot;[TAB]&quot;account-id&quot;[TAB]&quot;account-dir&quot;[TAB]=&gt;
   &quot;account-type&quot;[NEWLINE]</pre>
<p>'<strong>DO NOT ENTER THE =&gt; CHARACTERS. ENTER THE ENTIRE ENTRY AS ONE LINE.</strong>'</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="features">FEATURES</a></h1>
<ul>
<li>
<p>ESMTP/ESMTPS server</p>
</li>
<li>
<p>POP3/POP3S server</p>
</li>
<li>
<p>Finger server</p>
</li>
<li>
<p>Multiple domains</p>
</li>
<li>
<p>Users don't need a real system account</p>
</li>
<li>
<p>SMTP relay checking</p>
</li>
<li>
<p>Custom SMTP maps check</p>
</li>
<li>
<p>SMTP protection over spammers (IP based and address based)</p>
</li>
<li>
<p>SMTP authentication (PLAIN LOGIN CRAM-MD5 POP3/SMTP and custom)</p>
</li>
<li>
<p>SMTP ETRN command support</p>
</li>
<li>
<p>POP3 account synchronizer with external POP3 accounts</p>
</li>
<li>
<p>Account aliasing</p>
</li>
<li>
<p>Domain aliasing</p>
</li>
<li>
<p>Mailing lists</p>
</li>
<li>
<p>Custom mail processing</p>
</li>
<li>
<p>Locally generated mail files delivery</p>
</li>
<li>
<p>Remote administration</p>
</li>
<li>
<p>Custom mail exchangers</p>
</li>
<li>
<p>Logging</p>
</li>
<li>
<p>Multi platform (any Windows and almost any Unix OSs)</p>
</li>
<li>
<p>Fine grained message filters</p>
</li>
<li>
<p>Custom (external) POP3/SMTP authentication</p>
</li>
<li>
<p>TLS support for SMTP and POP3, both server and client side</p>
</li>
</ul>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="porting_status">PORTING STATUS</a></h1>
<p>Right now the Linux and NT ports are stable, while the Solaris, FreeBSD, OpenBSD and OSX
ones have not been tested as well as the previous OSs.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="requirements">REQUIREMENTS</a></h1>
<ul>
<li>
<p>Any version of Linux that has glibc.</p>
</li>
<li>
<p>Windows NT with ws2_32.dll correctly installed.</p>
</li>
<li>
<p>A working DNS and gateway to the Internet (if you plan to use it).</p>
</li>
<li>
<p>To build from source for Linux you need any version of gcc and glibc installed.</p>
</li>
<li>
<p>To build from source for Windows you need MS Visual C++ (makefile included).</p>
</li>
<li>
<p>-or- any other working compiler that provides support for the Win32 SDK.</p>
</li>
</ul>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="obtaining_the_source">OBTAINING THE SOURCE</a></h1>
<p>Always get the latest sources at the XMail home page <a href="http://www.xmailserver.org/">http://www.xmailserver.org/</a>
because otherwise you may be using an old version.</p>
<p>Use the correct distribution for your system and don't mix Unix files with
Windows ones because this is one of the most common cause of XMail bad behavior.</p>
<p>When you unzip (or untar) the package you've to check that the MailRoot
directory contained inside the package itself is complete (look at the directory tree 
listed below) because some unzippers don't restore empty directories.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="build">BUILD</a></h1>
<p>XMail depends on OpenSSL to provide SSL support, so the development package of OpenSSL
(in Debian called libssl-dev) must be installed on your system. For Windows, the XMail
source already contains a pre-built version of the OpenSSL libraries, include files, and
executable. The OpenSSL web site can be found here <a href="http://www.openssl.org">http://www.openssl.org</a>.</p>
<p>[Windows]</p>
<pre>
  You have to have the command line environment setup before (usually the vcvars32.bat
  script inside the Visual C++ directory). You also need to copy the openSSL DLLs
  (located in &quot;win32ssl\dll&quot;) inside the same folder where the XMail.exe binary resides.</pre>
<pre>
  C:&gt; nmake /f Makefile.win
  
  If once you run the XMail binaries, Windows complains about missing DLLs, your system
  is probably missing the Microsoft CRT redistributable package, that you can download
  here L&lt;<a href="http://www.xmailserver.org/vcredist_x86.exe&gt">http://www.xmailserver.org/vcredist_x86.exe&gt</a>;.</pre>
<p>[Linux]</p>
<pre>
  # make -f Makefile.lnx</pre>
<p>[FreeBSD]</p>
<pre>
  # setenv OSTYPE FreeBSD
  # gmake -f Makefile.bsd</pre>
<p>or (depending on the shell):</p>
<pre>
  # OSTYPE=FreeBSD gmake -f Makefile.bsd</pre>
<p>[OpenBSD]</p>
<pre>
  # setenv OSTYPE OpenBSD
  # gmake -f Makefile.bsd</pre>
<p>or (depending on the shell):</p>
<pre>
  # OSTYPE=OpenBSD gmake -f Makefile.bsd</pre>
<p>[NetBSD]</p>
<pre>
  # setenv OSTYPE NetBSD
  # gmake -f Makefile.bsd</pre>
<p>or (depending on the shell):</p>
<pre>
  # OSTYPE=NetBSD gmake -f Makefile.bsd</pre>
<p>[OSX]</p>
<pre>
  # OSTYPE=Darwin make -f Makefile.bsd</pre>
<p>or (depending on the shell):</p>
<pre>
  # setenv OSTYPE Darwin
  # make -f Makefile.bsd</pre>
<p>[Solaris]</p>
<pre>
  # make -f Makefile.sso</pre>
<p>Under Linux an init.d startup script is supplied (xmail) to allow you to run
XMail as a standard rc? daemon. You must put it into /etc/init.d (it depends on which
distro you're using) directory and then create K??xmail - S??xmail links into the
proper directories.</p>
<p>Under Windows NT/2000/XP the XMail's executable is a Win32 service by default and if
you want to have it built like a standard executable you've to comment the statement:</p>
<pre>
 &quot;#define SERVICE&quot; in MainWin.cpp</pre>
<p>When it's built as a service (default) you can run:</p>
<pre>
 XMail --install</pre>
<p>to install XMail as a manual startup service or:</p>
<pre>
 XMail --install-auto</pre>
<p>to install XMail as an automatic startup service.</p>
<p>If you run '<strong>--install</strong>' and you want XMail to run at NT boot, you must go in
ControlPanel-&gt;Services and edit the startup options of XMail.
Once you have the service version of XMail you can run it in a 'normal' way by
executing:</p>
<pre>
 XMail --debug [options]</pre>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="configuration">CONFIGURATION</a></h1>
<p>
</p>
<h2><a name="linux_solaris_freebsd_openbsd">Linux/Solaris/FreeBSD/OpenBSD</a></h2>
<ol>
<li>
<p>Build XMail.</p>
</li>
<li>
<p>Log as root.</p>
</li>
<li>
<p>Copy the supplied MailRoot directory where you want it to reside (normally /var).</p>
</li>
<li>
<p>Do a
 # chmod 700 /var/MailRoot
to setup MailRoot directory access rights.</p>
</li>
<li>
<p>Strip XMail executables if you want to reduce their sizes (strip filename).</p>
</li>
<li>
<p>Copy XMail executables to  /var/MailRoot/bin.</p>
</li>
<li>
<p>Optionally, you can setup a dedicated temporary files directory for XMail, by
setting the environment variable XMAIL_TEMP, which defaults to /tmp/.
XMail uses such directory when it has to create files that must be accessible to
external programs like filters.</p>
</li>
<li>
<p>If you have '<strong>inetd</strong>' installed, comment out the lines of '<strong>/etc/inetd.conf</strong>'
that involve SMTP, POP3, and Finger. Restart '<strong>inetd</strong>' (kill -HUP ...).</p>
</li>
<li>
<p>Since XMail uses syslog to log messages, enable syslogd if it's not running.</p>
</li>
<li>
<p>Setup the '<strong>SERVER.TAB</strong>' configuration file (after reading the rest of this
document well).</p>
</li>
<li>
<p>Add your users and domains (after reading the rest of this
document well).</p>
</li>
<li>
<p>Change or comment out (#) the example account in '<strong>ctrlaccounts.tab</strong>' by using
a non-trivial username and password.</p>
</li>
<li>
<p>Copy  the xmail startup script to your init.d directory
(it's position depends on your distro).
If you've setup XMail to work in a subdirectory other than '<strong>/var/MailRoot</strong>' you
must edit the xmail startup script to customize its boot parameters.</p>
</li>
<li>
<p>Use the '<strong>sysv_inst.sh</strong>' shell script (from root user) to create SysV boot script -
unless your distro has other tools to do this.</p>
</li>
<li>
<p>To start XMail without reboot you can run (from root):
 /etc/rc.d/init.d/xmail start
otherwise reboot your machine.</p>
</li>
<li>
<p>Setup the file '<strong>smtprelay.tab</strong>' if you want to extend mail relaying to IPs outside
of the internet's private IP blocks (or you want to deny even those - that comes enabled by
default with XMail).</p>
</li>
<li>
<p>Look at [<a href="#ssl_configuration">SSL CONFIGURATION</a>] for information about how to
create the required '<strong>server.key</strong>' and '<strong>server.cert</strong>' files.</p>
</li>
</ol>
<p>For further configuration options, please see the [<a href="#command_line">COMMAND LINE</a>] section.</p>
<p>[<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="nt_win2k_xp">NT/Win2K/XP</a></h2>
<ol>
<li>
<p>Build XMail.</p>
</li>
<li>
<p>Copy the supplied MailRoot directory where you want it to reside (normally '<strong>C:\MailRoot</strong>').</p>
</li>
<li>
<p>Setup the MailRoot directory (and subdirectories and file) permissions to allow access
only to System and Administrators. Doing this you can run XMail as a console startup only
if you're Administrator (service startup as System).</p>
</li>
<li>
<p>Copy XMail executables to '<strong>C:\MailRoot\bin</strong>'. Also copy the OpenSSL DLLs located in
&quot;win32ssl\dll&quot; to '<strong>C:\MailRoot\bin</strong>'.</p>
</li>
<li>
<p>With '<strong>regedit</strong>', create '<strong>GNU</strong>' key inside '<strong>HKEY_LOCAL_MACHINE\SOFTWARE\</strong>' and then '<strong>XMail</strong>'
key inside '<strong>HKEY_LOCAL_MACHINE\SOFTWARE\GNU</strong>'.
Note: If you are using a 32bit binary with a 64bit Windows, replace '<strong>HKEY_LOCAL_MACHINE\SOFTWARE\</strong>' with
'<strong>HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\</strong>' here, and in the points below.</p>
</li>
<li>
<p>Create a new string value named '<strong>MAIL_ROOT</strong>' inside '<strong>HKEY_LOCAL_MACHINE\SOFTWARE\GNU\XMail\</strong>'
with value '<strong>C:\MailRoot</strong>'.</p>
</li>
<li>
<p>Optionally create a new string value named '<strong>MAIL_CMD_LINE</strong>' inside
'<strong>HKEY_LOCAL_MACHINE\SOFTWARE\GNU\XMail\</strong>' to store your command line options
(read well the rest of this document).</p>
</li>
<li>
<p>Open an NT console (command prompt).</p>
</li>
<li>
<p>Go inside '<strong>C:\MailRoot\bin</strong>' and run:
 XMail --install
for a manual startup, or:
 XMail --install-auto
for an automatic startup.</p>
</li>
<li>
<p>If you have other services that provide the same functionality as XMail, that is
SMTP, POP3, or Finger servers, you must stop these services.</p>
</li>
<li>
<p>Setup the '<strong>SERVER.TAB</strong>' configuration option after reading the rest of this document
well.</p>
</li>
<li>
<p>Add your users and domains (after reading to the rest of this document well).</p>
</li>
<li>
<p>Setup file permissions of the '<strong>C:\MailRoot</strong>' directory to grant access only to
'<strong>SYSTEM</strong>' and '<strong>Domain Admins</strong>'.</p>
</li>
<li>
<p>Change or comment out (#) the example account in  ctrlaccounts.tab  by using a
non-trivial username and password.</p>
</li>
<li>
<p>To start XMail without reboot you can go to:
 ControlPanel -&gt; Services -&gt; XMail server
and start the service, otherwise reboot your machine.</p>
</li>
<li>
<p>Setup the file '<strong>smtprelay.tab</strong>' if you want to extend mail relaying to IPs outside 
of the internet's private IP blocks (or you want to deny even those - that comes enabled by
default with XMail).</p>
</li>
<li>
<p>Look at [<a href="#ssl_configuration">SSL CONFIGURATION</a>] for information about how to
create the required '<strong>server.key</strong>' and '<strong>server.cert</strong>' files.</p>
</li>
</ol>
<p>For further configuration options, please see the [<a href="#command_line">COMMAND LINE</a>] section.</p>
<p>[<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="environment_variables">Environment variables</a></h2>
<dl>
<dt><strong><a name="mail_root" class="item">[MAIL_ROOT]</a></strong></dt>

<dd>
<p>If you want to start XMail as a simple test you must setup an environment variable 
MAIL_ROOT that points to the XMail Server root directory.</p>
<p>Linux/etc.:</p>
<pre>
 export MAIL_ROOT=/var/XMailRoot</pre>
<p>Windows:</p>
<pre>
 set MAIL_ROOT=C:\MailRoot</pre>
</dd>
<dt><strong><a name="mail_cmd_line" class="item">[MAIL_CMD_LINE]</a></strong></dt>

<dd>
<p>Allows the user to specify extra command line parameters (they will be appended to the
ones specified in the command line).</p>
</dd>
<dt><strong><a name="xmail_pid_dir" class="item">[XMAIL_PID_DIR]</a></strong></dt>

<dd>
<p>Allows the user to specify the PID directory (Unix only ports). The specified directory must
NOT have the final slash (/) appended to the path.</p>
</dd>
</dl>
<p>[<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="mailroot_structure">MailRoot structure</a></h2>
<p>Mail root directory contain these files:</p>
<pre>
  aliases.tab &lt;file&gt;
  aliasdomain.tab &lt;file&gt;
  domains.tab &lt;file&gt;
  dnsroots    &lt;file&gt;
  extaliases.tab  &lt;file&gt;
  mailusers.tab   &lt;file&gt;
  message.id  &lt;file&gt;
  pop3links.tab   &lt;file&gt;
  server.tab  &lt;file&gt;
  server.cert &lt;file&gt;
  server.key &lt;file&gt;
  smtpgw.tab  &lt;file&gt;
  smtpfwd.tab &lt;file&gt;
  smtprelay.tab   &lt;file&gt;
  smtpauth.tab    &lt;file&gt;
  smtpextauth.tab &lt;file&gt;
  userdef.tab &lt;file&gt;
  ctrlaccounts.tab    &lt;file&gt;
  spammers.tab    &lt;file&gt;
  spam-address.tab    &lt;file&gt;
  pop3.ipmap.tab  &lt;file&gt;
  smtp.ipmap.tab  &lt;file&gt;
  ctrl.ipmap.tab  &lt;file&gt;
  finger.ipmap.tab    &lt;file&gt;
  filters.in.tab  &lt;file&gt;
  filters.out.tab &lt;file&gt;
  filters.post-rcpt.tab &lt;file&gt;
  filters.pre-data.tab &lt;file&gt;
  filters.post-data.tab &lt;file&gt;
  smtp.ipprop.tab &lt;file&gt;
  smtp.hnprop.tab &lt;file&gt;</pre>
<p>and these directories:</p>
<pre>
  bin     &lt;dir&gt;
  cmdaliases  &lt;dir&gt;
  tabindex    &lt;dir&gt;
  dnscache    &lt;dir&gt;
    mx  &lt;dir&gt;
    ns  &lt;dir&gt;
  custdomains &lt;dir&gt;
  filters     &lt;dir&gt;
  logs        &lt;dir&gt;
  pop3locks   &lt;dir&gt;
  pop3linklocks   &lt;dir&gt;
  pop3links   &lt;dir&gt;
  spool       &lt;dir&gt;
    local       &lt;dir&gt;
    temp        &lt;dir&gt;
    0           &lt;dir&gt;
      0           &lt;dir&gt;
        mess        &lt;dir&gt;
        rsnd        &lt;dir&gt;
        info        &lt;dir&gt;
        temp        &lt;dir&gt;
        slog        &lt;dir&gt;
        lock        &lt;dir&gt;
        mprc        &lt;dir&gt;
        froz        &lt;dir&gt;
      ...
    ...
  userauth    &lt;dir&gt;
    pop3    &lt;dir&gt;
    smtp    &lt;dir&gt;
  domains     &lt;dir&gt;
  msgsync     &lt;dir&gt;</pre>
<p>and for each domain DOMAIN handled a directory (inside  <strong>domains</strong>):</p>
<pre>
    DOMAIN      &lt;dir&gt;
    userdef.tab &lt;file&gt;
    mailproc.tab    &lt;file&gt;  [ optional ]</pre>
<p>inside of which reside, for each account ACCOUNT:</p>
<pre>
      ACCOUNT         &lt;dir&gt;
        user.tab    &lt;file&gt;
        mlusers.tab &lt;file&gt;  [ mailing list case ]
        mailproc.tab    &lt;file&gt;  [ optional ]
        pop3.ipmap.tab  &lt;file&gt;  [ optional ]</pre>
<p>and</p>
<pre>
        mailbox     &lt;dir&gt;</pre>
<p>for mailbox structure, while:</p>
<pre>
        Maildir     &lt;dir&gt;
          tmp &lt;dir&gt;
          new &lt;dir&gt;
          cur &lt;dir&gt;</pre>
<p>for Maildir structure. The <strong>msgsync</strong> directory is used to store UIDL lists
for PSYNC accounts that require leaving messages on the server. Inside the <strong>msgsync</strong>
other directories will be created with the name of the remote server, directories that
will store UIDL DB files.</p>
<p>[<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="configuration_tables">Configuration tables</a></h2>
<p>TAB ('<strong>something.tab</strong>') files are text files (in the sense meant by the OS in use:
&lt;CR&gt;&lt;LF&gt; for NT and &lt;CR&gt; for Linux) with this format:</p>
<pre>
 &quot;value1&quot;[TAB]&quot;value2&quot;[TAB]...[NEWLINE]</pre>
<p>The following sections explain each file's structure and use.</p>
<dl>
<dt><strong><a name="aliases_tab_file_aliases_tab" class="item"><a href="#aliases_tab">&quot;ALIASES.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="aliasdomain_tab_file_aliasdomain_tab" class="item"><a href="#aliasdomain_tab">&quot;ALIASDOMAIN.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="domains_tab_file_domains_tab" class="item"><a href="#domains_tab">&quot;DOMAINS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="dnsroots_file_dnsroots" class="item"><a href="#dnsroots">&quot;DNSROOTS file&quot;</a></a></strong></dt>

<dt><strong><a name="extaliases_tab_file_extaliases_tab" class="item"><a href="#extaliases_tab">&quot;EXTALIASES.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="mailusers_tab_file_mailusers_tab" class="item"><a href="#mailusers_tab">&quot;MAILUSERS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="message_id_file_message_id" class="item"><a href="#message_id">&quot;MESSAGE.ID file&quot;</a></a></strong></dt>

<dt><strong><a name="pop3links_tab_file_pop3links_tab" class="item"><a href="#pop3links_tab">&quot;POP3LINKS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="server_tab_file_server_tab" class="item"><a href="#server_tab">&quot;SERVER.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtpgw_tab_file_smtpgw_tab" class="item"><a href="#smtpgw_tab">&quot;SMTPGW.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtpfwd_tab_file_smtpfwd_tab" class="item"><a href="#smtpfwd_tab">&quot;SMTPFWD.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtprelay_tab_file_smtprelay_tab" class="item"><a href="#smtprelay_tab">&quot;SMTPRELAY.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtpauth_tab_file_smtpauth_tab" class="item"><a href="#smtpauth_tab">&quot;SMTPAUTH.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtpextauth_tab_file_smtpextauth_tab" class="item"><a href="#smtpextauth_tab">&quot;SMTPEXTAUTH.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="userdef_tab_file_userdef_tab" class="item"><a href="#userdef_tab">&quot;USERDEF.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="ctrlaccounts_tab_file_ctrlaccounts_tab" class="item"><a href="#ctrlaccounts_tab">&quot;CTRLACCOUNTS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="spammers_tab_file_spammers_tab" class="item"><a href="#spammers_tab">&quot;SPAMMERS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="spam_address_tab_file_spam_address_tab" class="item"><a href="#spam_address_tab">&quot;SPAM-ADDRESS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="pop3_ipmap_tab_file_pop3_ipmap_tab" class="item"><a href="#pop3_ipmap_tab">&quot;POP3.IPMAP.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtp_ipmap_tab_file_smtp_ipmap_tab" class="item"><a href="#smtp_ipmap_tab">&quot;SMTP.IPMAP.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="ctrl_ipmap_tab_file_ctrl_ipmap_tab" class="item"><a href="#ctrl_ipmap_tab">&quot;CTRL.IPMAP.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="finger_ipmap_tab_file_finger_ipmap_tab" class="item"><a href="#finger_ipmap_tab">&quot;FINGER.IPMAP.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="user_tab_file_user_tab" class="item"><a href="#user_tab">&quot;USER.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="mlusers_tab_file_mlusers_tab" class="item"><a href="#mlusers_tab">&quot;MLUSERS.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="mailproc_tab_file_mailproc_tab" class="item"><a href="#mailproc_tab">&quot;MAILPROC.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtp_ipprop_tab_file_smtp_ipprop_tab" class="item"><a href="#smtp_ipprop_tab">&quot;SMTP.IPPROP.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="smtp_hnprop_tab_file_smtp_hnprop_tab" class="item"><a href="#smtp_hnprop_tab">&quot;SMTP.HNPROP.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="filters_in_tab_file_filters_in_tab" class="item"><a href="#filters_in_tab">&quot;FILTERS.IN.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="filters_out_tab_file_filters_out_tab" class="item"><a href="#filters_out_tab">&quot;FILTERS.OUT.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="filters_post_rcpt_tab_file_filters_post_rcpt_tab" class="item"><a href="#filters_post_rcpt_tab">&quot;FILTERS.POST-RCPT.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="filters_pre_data_tab_file_filters_pre_data_tab" class="item"><a href="#filters_pre_data_tab">&quot;FILTERS.PRE-DATA.TAB file&quot;</a></a></strong></dt>

<dt><strong><a name="filters_post_data_tab_file_filters_post_data_tab" class="item"><a href="#filters_post_data_tab">&quot;FILTERS.POST-DATA.TAB file&quot;</a></a></strong></dt>

</dl>
<p>[<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="aliases_tab">ALIASES.TAB</a></h3>
<pre>
 &quot;domain&quot;[TAB]&quot;alias&quot;[TAB]&quot;realaccount&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;home.bogus&quot;    &quot;davidel&quot;   &quot;dlibenzi&quot;</pre>
<p>define 'davidel' as alias for 'dlibenzi' in 'home.bogus' domain.</p>
<pre>
 &quot;home.bogus&quot;    &quot;foo*bog&quot;   &quot;homer@internal-domain.org&quot;</pre>
<p>define an alias for all users whose name starts with '<strong>foo</strong>' and ends with '<strong>bog</strong>'
that points to the locally handled account '<strong>homer&#64;internal-domain.org</strong>'.</p>
<pre>
 &quot;home.bogus&quot;    &quot;??trips&quot;   &quot;travels&quot;</pre>
<p>define an alias for all users whose names start with any two chars and end with '<strong>trips</strong>'.
You can even have wildcards in the domain field, as:</p>
<pre>

 &quot;*&quot; &quot;postmaster&quot;    &quot;postmaster@domain.net&quot;</pre>
<p>You '<strong>CANNOT</strong>' edit this file while XMail is running because it is an indexed file.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="aliasdomain_tab">ALIASDOMAIN.TAB</a></h3>
<pre>
 &quot;aliasdomain&quot;[TAB]&quot;realdomain&quot;[NEWLINE]</pre>
<p>where '<strong>aliasdomain</strong>' can use wildcards:</p>
<pre>
 &quot;simpson.org&quot;   &quot;simpson.com&quot;
 &quot;*.homer.net&quot;   &quot;homer.net&quot;</pre>
<p>The first line defines '<strong>simpson.org</strong>' as an alias of '<strong>simpson.com</strong>' while the second remaps
all subdomains of '<strong>homer.net</strong>' to '<strong>homer.net</strong>'.</p>
<p>You '<strong>CANNOT</strong>' edit this file while XMail is running because it is an indexed file.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="domains_tab">DOMAINS.TAB</a></h3>
<pre>
 &quot;domain&quot;[NEWLINE]</pre>
<p>defines domains handled by the server.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="dnsroots">DNSROOTS</a></h3>
<pre>
 host</pre>
<p>This is a file that lists a root name server in each line (this is not a TAB file).
This can be created from a query via nslookup for type=ns and host = '.'.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="extaliases_tab">EXTALIASES.TAB</a></h3>
<pre>
 &quot;external-domain&quot;[TAB]&quot;external-account&quot;[TAB]&quot;local-domain&quot;[TAB]&quot;local-user&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;xmailserver.org&quot;   &quot;dlibenzi&quot;  &quot;home.bogus&quot;    &quot;dlibenzi&quot;</pre>
<p>This file is used in configurations in which the server does not run directly on Internet
(like my case) but acts as internal mail exchanger and external mail gateway.
This file defines 'Return-Path: &lt;...&gt;' mapping for internal mail delivery.
If you are using an Mail client like Outlook, Eudora, KMail ... you have to configure
your email address with the external account say 'dlibenzi&#64;xmailserver.org'.
When you post an internal message to 'foo&#64;home.bogus' the mail client puts your external
email address ('dlibenzi&#64;xmailserver.org') in the 'MAIL FROM: &lt;...&gt;' SMTP request.
Now if the user 'foo' replies to this message, it replies to 'dlibenzi&#64;xmailserver.org',
and then is sent to the external mail server.
With the entry above in '<strong>EXTALIASES.TAB</strong>' file the 'Return-Path: &lt;...&gt;' field is filled
with 'dlibenzi&#64;home.bogus' that leads to an internal mail reply.</p>
<p>You '<strong>CANNOT</strong>' edit this file while XMail is running because it is an indexed file.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="mailusers_tab">MAILUSERS.TAB</a></h3>
<pre>
 &quot;domain&quot;[TAB]&quot;account&quot;[TAB]&quot;enc-passwd&quot;[TAB]&quot;account-id&quot;[TAB]&quot;account-dir&quot;[TAB]=&gt;
   &quot;account-type&quot;[NEWLINE]</pre>
<p>(remember, enter as one line.) Example:</p>
<pre>
 &quot;home.bogus&quot;    &quot;dlibenzi&quot;  &quot;XYZ...&quot;    1   &quot;dlibenzi&quot;  &quot;U&quot;</pre>
<p>defines an account 'dlibenzi' in domain 'home.bogus' with the encrypted password 'XYZ...',
user id '1' and mail directory 'dlibenzi' inside '<strong>$MAIL_ROOT/domains/home.bogus</strong>'.
To allow multiple domain handling the POP3 client must use the entire email address
for the POP3 user account; for example, if a user has email user&#64;domain it must supply:</p>
<pre>
 user@domain</pre>
<p>as POP3 account login.</p>
<p>The directory 'account-dir' '<strong>must</strong>' case match with the field 'account-dir' of this file.
Note that user id '<strong>must</strong>' be unique for all users (duplicate user ids are not allowed).
The user id 0 is reserved by XMail and cannot be used.</p>
<p>The last field 'U' is the account type:</p>
<pre>
 &quot;U&quot; = User account
 &quot;M&quot; = Mailing list account</pre>
<p>The encrypted password is generated by '<strong>XMCrypt</strong>' whose source is '<strong>XMCrypt.cpp</strong>'.
Even if external authentication is used (see <a href="#external_authentication">External Authentication</a>) this
file '<strong>must</strong>' contain an entry for each user handled by XMail.</p>
<p>You '<strong>CANNOT</strong>' edit this file while XMail is running because it is an indexed file.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="message_id">MESSAGE.ID</a></h3>
<p>A file storing a sequential message number.
Set it at 1 when you install the server and leave it be handled by the software.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="pop3links_tab">POP3LINKS.TAB</a></h3>
<pre>
 &quot;local-domain&quot;[TAB]&quot;local-account&quot;[TAB]&quot;external-domain&quot;[TAB]=&gt;
   &quot;external-account&quot;[TAB]&quot;external-crypted-password&quot;[TAB]&quot;authtype&quot;[NEWLINE]</pre>
<p>(remember, enter as one line) where:</p>
<p>'<strong>authtype</strong>' = Comma-separated list of options:</p>
<dl>
<dt><strong><a name="clr" class="item">CLR</a></strong></dt>

<dd>
<p>Use clear-text USER/PASS authentication</p>
</dd>
<dt><strong><a name="apop" class="item">APOP</a></strong></dt>

<dd>
<p>Use POP3 APOP authentication (that does not send clear-text passwords over the wire).
Fall back to '<strong>CLR</strong>' if '<strong>APOP</strong>' is not supported</p>
</dd>
<dt><strong><a name="fapop" class="item">FAPOP</a></strong></dt>

<dd>
<p>Use POP3 APOP authentication (that does not send clear-text passwords over the wire).</p>
</dd>
<dt><strong><a name="stls" class="item">STLS</a></strong></dt>

<dd>
<p>Establish an SSL link with the server by issuing a POP3 STLS command.
Continue with the non-encrypted link if STLS is not supported</p>
</dd>
<dt><strong><a name="fstls" class="item">FSTLS</a></strong></dt>

<dd>
<p>Establish an SSL link with the server by issuing a POP3 STLS command.</p>
</dd>
<dt><strong><a name="pop3s" class="item">POP3S</a></strong></dt>

<dd>
<p>Establish a full POP3S connection with the remote server. Note that the POP3S port
(default 995) must be set inside the external domain declaration.</p>
</dd>
<dt><strong><a name="leave" class="item">Leave</a></strong></dt>

<dd>
<p>Leave messages on the server, and download only the new ones. In order for this
functionality to work, the remote POP3 server must support the UIDL command.</p>
</dd>
<dt><strong><a name="outbind" class="item">OutBind</a></strong></dt>

<dd>
<p>Sets the IP address of the network interface that should be used when connecting
to the remote host. This configuration should be used carefully, because XMail
will fail if the selected IP of the interface does not have a route to the remote
host using such IP.</p>
</dd>
</dl>
<p>Examples:</p>
<pre>
 &quot;home.bogus&quot;    &quot;dlibenzi&quot;  &quot;xmailserver.org&quot;   &quot;dlibenzi&quot; &quot;XYZ...&quot;=&gt;
   &quot;APOP&quot;</pre>
<p>This entry is used to synchronize the external account 'dlibenzi&#64;xmailserver.org' with encrypted
password 'XYZ...' with the local account 'dlibenzi&#64;home.bogus' using '<strong>APOP</strong>' authentication.
It connects with the 'xmailserver.org' POP3 server and downloads all messages for 'dlibenzi&#64;xmailserver.org' into
the local account 'dlibenzi&#64;home.bogus'.
The remote server must support '<strong>APOP</strong>' authentication to specify '<strong>APOP</strong>' as authtype.
Even if using APOP authentication is more secure because clear usernames and password do not
travel on the network, when you're not sure about it, specify '<strong>CLR</strong>' as authtype.
For non local POP3 sync you've to specify a line like this one (&#64; as the first domain char):</p>
<pre>
 &quot;@home.bogus.com&quot;   &quot;dlibenzi&quot;  &quot;xmailserver.org:110&quot;   &quot;dlibenzi&quot; &quot;XYZ...&quot;=&gt;
   &quot;CLR&quot;</pre>
<p>This entry is used to synchronize the external account 'dlibenzi&#64;xmailserver.org' with encrypted
password 'XYZ...' with the account 'dlibenzi&#64;home.bogus.com' using '<strong>CLR</strong>' authentication.
The message is pushed into the spool having as destination  dlibenzi&#64;home.bogus.com  ,
so you've to have some kind of processing for that user or domain in your XMail configuration
(for example custom domain processing).
you can also have the option to setup a line like this one:</p>
<pre>
 &quot;?home.bogus.com,felins.net,pets.org&quot;   &quot;dlibenzi&quot;  &quot;xmailserver.org&quot;=&gt;
   &quot;dlibenzi&quot;  &quot;XYZ...&quot;    &quot;CLR&quot;</pre>
<p>and messages are dropped inside the spool by following these rules:</p>
<ol>
<li>
<p>XMail parses the message headers by searching for To:, Cc: and Bcc: addresses.</p>
</li>
<li>
<p>Each address's domain is compared with the list of valid domains (felins.net, pets.org).</p>
</li>
<li>
<p>For each valid address the username part is taken and joined with the '&#64;' and
the masquerade domain name (the name following '?').</p>
</li>
<li>
<p>The message is spooled with the above built destination address.</p>
</li>
</ol>
<p>Obviously the masquerade domain ('home.bogus.com') MUST be handled by the server or MUST be
a valid external mail domain.
So if a message having as To: address  graycat&#64;felins.net  is fetched by the previous line a
message is pushed into the spool with address  graycat&#64;home.bogus.com.
Particular attention must be paid to prevent creating mail loops.
Another option is:</p>
<pre>
 &quot;&amp;.local,felins.net,pets.org&quot;   &quot;dlibenzi&quot;  &quot;xmailserver.org&quot; &quot;dlibenzi&quot;=&gt;
   &quot;XYZ...&quot;    &quot;CLR&quot;</pre>
<p>where a fetched message whose To: address is graycat&#64;felins.net is replaced with
graycat&#64;felins.net.local.
You can avoid the matching domain list after the masquerading domain but, in that case,
you may have bad destination addresses inside the spool.
The list MUST be comma separated WITHOUT spaces.
XMail starts PSYNC session with a delay that you can specify with the -Yi nsec
command line parameter (default 120).
XMail also checks for the presence (inside MAIL_ROOT) of a file named '.psync-trigger' and,
when this file is found, a PSYNC session starts and that file is removed.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="server_tab">SERVER.TAB</a></h3>
<pre>
 &quot;varname&quot;[TAB]&quot;varvalue&quot;[NEWLINE]</pre>
<p>This file contains server configuration variables.
See <a href="#server_tab_variables">SERVER.TAB variables</a> below for details.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtpgw_tab">SMTPGW.TAB</a></h3>
<pre>
 &quot;domain&quot;[TAB]&quot;smtp-gateway&quot;[NEWLINE]</pre>
<p>Examples:</p>
<pre>
 &quot;foo.example.com&quot;   &quot;@xmailserver.org&quot;</pre>
<p>sends all mail for 'foo.example.com' through the 'xmailserver.org' SMTP server,
while:</p>
<pre>
 &quot;*.dummy.net&quot;   &quot;@relay.xmailserver.org&quot;</pre>
<p>sends all mail for  '*.dummy.net'  through  'relay.xmailserver.org'.</p>
<p>The '<strong>smtp-gateway</strong>' can be a complex routing also, for example:</p>
<pre>
 &quot;*.dummy.net&quot;   &quot;@relay.xmailserver.org,@mail.nowhere.org&quot;</pre>
<p>sends all mail for  '*.dummy.net'  through  '&#64;relay.xmailserver.org,&#64;mail.nowhere.org',
in this way:  relay.xmailserver.org --&gt; mail.nowhere.org --&gt; &#64;DESTINATION.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtpfwd_tab">SMTPFWD.TAB</a></h3>
<pre>
 &quot;domain&quot;[TAB]&quot;smtp-mx-list&quot;[NEWLINE]</pre>
<p>The &quot;smtp-mx-list&quot; is a semicolon separated list of SMTP relays, and can also contain options as
a comma-separated list (see [<a href="#smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a>] for more
information).</p>
<p>Examples:</p>
<pre>
 &quot;foo.example.com&quot;   &quot;mail.xmailserver.org:7001;192.168.1.1:6123,NeedTLS=1;mx.xmailserver.org&quot;</pre>
<p>sends all mail for 'foo.example.com' using the provided list of mail exchangers,
while:</p>
<pre>
 &quot;*.dummy.net&quot;   &quot;mail.xmailserver.org,NeedTLS=1;192.168.1.1;mx.xmailserver.org:6423&quot;</pre>
<p>sends all mail for  '*.dummy.net'  through the provided list of mail exchangers.
If the port (:nn) is not specified the default SMTP port (25) is assumed.
you can also enable XMail to random-select the order of the gateway list by specifying:</p>
<pre>
 &quot;*.dummy.net&quot;   &quot;#mail.xmailserver.org;192.168.1.1;mx.xmailserver.org:6423&quot;</pre>
<p>using the character '<strong>#</strong>'  as the first char of the gateway list.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtprelay_tab">SMTPRELAY.TAB</a></h3>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;212.131.173.0&quot;   &quot;255.255.255.0&quot;</pre>
<p>allows all hosts of the class 'C' network '212.131.173.XXX' to use the server as relay.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtpauth_tab">SMTPAUTH.TAB</a></h3>
<pre>
 &quot;username&quot;[TAB]&quot;password&quot;[TAB]&quot;permissions&quot;[NEWLINE]</pre>
<p>is used to permit SMTP client authentication with protocols PLAIN, LOGIN, CRAM-MD5
and custom.
With custom authentication a file containing all secrets (username + ':' + password)
is passed as parameter to the custom authentication program which tests all secrets
to find the one matching (if exist).
For this reason it's better to keep the number of entries in this file as low as possible.
Permissions are a string that can contain:</p>
<dl>
<dt><strong><a name="m" class="item">M</a></strong></dt>

<dd>
<p>open mailing features</p>
</dd>
<dt><strong><a name="r" class="item">R</a></strong></dt>

<dd>
<p>open relay features (bypass all other relay blocking traps)</p>
</dd>
<dt><strong><a name="v" class="item">V</a></strong></dt>

<dd>
<p>VRFY command enabled (bypass SERVER.TAB variable)</p>
</dd>
<dt><strong><a name="t" class="item">T</a></strong></dt>

<dd>
<p>ETRN command enabled (bypass SERVER.TAB variable)</p>
</dd>
<dt><strong><a name="z" class="item">Z</a></strong></dt>

<dd>
<p>disable mail size checking (bypass SERVER.TAB variable)</p>
</dd>
<dt><strong><a name="s" class="item">S</a></strong></dt>

<dd>
<p>ease SSL requirement for this user (bypass the &quot;WantTLS&quot; mail config variable)</p>
</dd>
</dl>
<p>When PLAIN, LOGIN or CRAM-MD5 authentication mode are used, first a lookup in '<strong>MAILUSERS.TAB</strong>'
accounts is performed to avoid duplicating information with '<strong>SMTPAUTH.TAB</strong>'.
Therefore when using these authentication modes a user must use as username the full email address
(the : separator is permitted instead of @) and as password his POP3 password.
If the lookup succeeds, the '<strong>SERVER.TAB</strong>' variable '<strong>DefaultSmtpPerms</strong>' is used to assign
user SMTP permissions (default MR).
If the lookup fails then '<strong>SMTPAUTH.TAB</strong>' lookup is done.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtpextauth_tab">SMTPEXTAUTH.TAB</a></h3>
<p>The '<strong>SMTPEXTAUTH.TAB</strong>' file enables the XMail administrator to use external authentication
methods to verify SMTP clients. If the '<strong>SMTPEXTAUTH.TAB</strong>' does not exist, or it is empty,
XMail standard authentication methods are used, and those will use either the '<strong>MAILUSERS.TAB</strong>'
or the '<strong>SMTPAUTH.TAB</strong>' to verify account credentials.
If the file '<strong>SMTPEXTAUTH.TAB</strong>' is not empty, then the XMail standard authentication methods are
not advertised in the <strong>AUTH</strong> response of the <strong>EHLO</strong> SMTP command. Instead, only the ones
listed inside the '<strong>SMTPEXTAUTH.TAB</strong>' are reported to the SMTP client.
The '<strong>SMTPEXTAUTH.TAB</strong>' file can contain multiple lines with the following format:</p>
<pre>
 &quot;auth-name&quot;[TAB]&quot;program-path&quot;[TAB]&quot;arg-or-macro&quot;...[NEWLINE]</pre>
<p>This file can contain multiple lines whose '<strong>auth-name</strong>' are listed during the
EHLO command response.
Where 'arg-or-macro' can be (see [<a href="#macro_substitution">MACRO SUBSTITUTION</a>]):</p>
<dl>
<dt><strong><a name="auth" class="item">AUTH</a></strong></dt>

<dd>
<p>authentication method (PLAIN, LOGIN, CRAM-MD5, ...)</p>
</dd>
<dt><strong><a name="user" class="item">USER</a></strong></dt>

<dd>
<p>SMTP client supplied username (available in PLAIN, LOGIN and CRAM-MD5)</p>
</dd>
<dt><strong><a name="pass" class="item">PASS</a></strong></dt>

<dd>
<p>SMTP client supplied password (available in PLAIN and LOGIN)</p>
</dd>
<dt><strong><a name="chall" class="item">CHALL</a></strong></dt>

<dd>
<p>challenge used by the server (available in CRAM-MD5)</p>
</dd>
<dt><strong><a name="dgest" class="item">DGEST</a></strong></dt>

<dd>
<p>client response to server challenge (&#64;CHALL - available in CRAM-MD5)</p>
</dd>
<dt><strong><a name="rfile" class="item">RFILE</a></strong></dt>

<dd>
<p>a file path where the external authentication binary might supply extra
information/credentials about the account (available in all authentications)</p>
</dd>
</dl>
<p>The <strong>RFILE</strong> file is composed by multiple lines with the following format:</p>
<pre>
  VAR=VALUE</pre>
<p>Currently supported variables inside the <strong>RFILE</strong> file are:</p>
<dl>
<dt><strong><a name="perms" class="item">Perms</a></strong></dt>

<dd>
<p>Supply SMTP permissions for the account (see [<a href="#smtpauth_tab">SMTPAUTH.TAB</a>] for detailed information)</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;PLAIN&quot; &quot;/usr/bin/my-auth&quot; &quot;-a&quot; &quot;@@AUTH&quot; &quot;-u&quot; &quot;@@USER&quot; &quot;-p&quot; &quot;@@PASS&quot; &quot;-r&quot; &quot;@@RFILE&quot;</pre>
<p>The external authentication binary may or may not fill a response file. If the authentication
has been successful, the binary should exit with a code equal to zero. Any other exit code
different from zero, will be interpreted as failure.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="userdef_tab">USERDEF.TAB</a></h3>
<pre>
 &quot;varname&quot;[TAB]&quot;varvalue&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;RealName&quot;  &quot;??&quot;
 &quot;HomePage&quot;  &quot;??&quot;
 &quot;Address&quot;   &quot;??&quot;
 &quot;Telephone&quot; &quot;??&quot;
 &quot;MaxMBSize&quot; &quot;10000&quot;</pre>
<p>contains user default values for new users that are not set during the new account creation.
This file is looked up in two different places, first in '<strong>$MAIL_ROOT/domains/DOMAIN</strong>'
then in '<strong>$MAIL_ROOT</strong>',
where '<strong>DOMAIN</strong>' is the name of the domain where we're going to create the new user.</p>
<p>For each 'domain' handled by the server we'll create a directory 'domain' inside $MAIL_ROOT.
Inside $MAIL_ROOT/'domain' reside 'domain'-&gt;'account' directories
($MAIL_ROOT/'domain'/'account').
This folder contains a sub folder named '<strong>mailbox</strong>' (or '<strong>Maildir/(tmp,new,cur)</strong>')
that stores all 'account' messages.
It also contains a file named '<strong>USER.TAB</strong>' that stores &quot;account&quot; variables, for example:</p>
<pre>
 &quot;RealName&quot;  &quot;Davide Libenzi&quot;
 &quot;HomePage&quot;  &quot;<a href="http://www.xmailserver.org/davide.html&quot">http://www.xmailserver.org/davide.html&quot</a>;
 &quot;MaxMBSize&quot; &quot;30000&quot;</pre>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="ctrlaccounts_tab">CTRLACCOUNTS.TAB</a></h3>
<pre>
 &quot;username&quot;[TAB]&quot;password&quot;[NEWLINE]</pre>
<p>This file contains the accounts that are enabled to remote administer XMail.
The password is encrypted with  the '<strong>XMCrypt</strong>'  program supplied with the source distro.</p>
<p>'<strong>REMEMBER THAT THIS FILE HOLDS ADMIN ACCOUNTS, SO PLEASE CHOOSE COMPLEX USERNAMES AND PASSWORDS AND
USE CTRL.IPMAP.TAB TO RESTRICT IP ACCESS!
REMEMBER TO REMOVE THE EXAMPLE ACCOUNT FROM THIS FILE!</strong>'</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="spammers_tab">SPAMMERS.TAB</a></h3>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[NEWLINE]</pre>
<p>or:</p>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[TAB]&quot;params&quot;[NEWLINE]</pre>
<p>or:</p>
<pre>
 &quot;ipaddr/bits&quot;[NEWLINE]</pre>
<p>or:</p>
<pre>
 &quot;ipaddr/bits&quot;[TAB]&quot;params&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;212.131.173.0&quot;  &quot;255.255.255.0&quot;
 &quot;212.131.173.0/24&quot;</pre>
<p>registers all hosts of the class 'C' network '212.131.173.XXX' as spammers,
and blocks them the use of XMail SMTP server. If a match is found on one of those records,
XMail will reject the incoming SMTP connection at an early stage. It is possible to specify
optional parameters to tell XMail which behaviour it should assume in case of a match. An
example of such a setup is:</p>
<pre>
 &quot;212.131.173.0/24&quot;  &quot;code=0&quot;</pre>
<p>In this case a code=0 tells XMail to flag the connection as possible spammer, but to await later
SMTP session stages to reject the connection itself. In this case an authenticated SMTP session
can override the SPAMMERS.TAB match. The optional &quot;params&quot; field lists parameters associated
with the record, separated by a comma:</p>
<pre>
 &quot;param1=value1,param2=value2,...,paramN=valueN&quot;</pre>
<p>Currently supported parameters are:</p>
<dl>
<dt><strong><a name="code" class="item">code</a></strong></dt>

<dd>
<p>Specify the rejection code for the record. If the value is greater than zero, the connection
is rejected soon, and the remote SMTP client is disconnected. If the value is zero, the
connection is flagged as spammer but awaits later stages for rejection, by allowing
authenticated SMTP connections to bypass the SPAMMERS.TAB match. If the value is less than zero,
XMail will insert an &quot;absolute value&quot; seconds delay between SMTP commands. Default value for
code is greater than zero (immediate rejection).</p>
</dd>
</dl>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="spam_address_tab">SPAM-ADDRESS.TAB</a></h3>
<pre>
 &quot;spam-address&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;*@rude.net&quot;
 &quot;*-admin@even.more.rude.net&quot;</pre>
<p>blocks mails coming from the entire domain '<strong>rude.net</strong>' and coming from all
addresses that end with '<strong>-admin&#64;'even.more.rude.net</strong>.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="pop3_ipmap_tab">POP3.IPMAP.TAB</a></h3>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[TAB]&quot;permission&quot;[TAB]&quot;precedence&quot;[NEWLINE]</pre>
<p>This file controls the global IP access permission to the POP3 server if located
in the MAIL_ROOT path, and user IP access to its POP3 mailbox if located inside
the user directory.</p>
<p>Example:</p>
<pre>
 &quot;0.0.0.0&quot;  &quot;0.0.0.0&quot;  &quot;DENY&quot;  &quot;1&quot;
 &quot;212.131.173.0&quot;  &quot;255.255.255.0&quot;  &quot;ALLOW&quot;  &quot;2&quot;</pre>
<p>This configuration denies access to all IPs except the ones of the
class 'C' network '212.131.173.XXX'.</p>
<p>Higher precedences win over lower ones.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtp_ipmap_tab">SMTP.IPMAP.TAB</a></h3>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[TAB]&quot;permission&quot;[TAB]&quot;precedence&quot;[NEWLINE]</pre>
<p>This file controls IP access permission to SMTP server.</p>
<p>Example:</p>
<pre>
 &quot;0.0.0.0&quot;  &quot;0.0.0.0&quot;  &quot;DENY&quot;  &quot;1&quot;
 &quot;212.131.173.0&quot;  &quot;255.255.255.0&quot;  &quot;ALLOW&quot;  &quot;2&quot;</pre>
<p>This configuration denies access to all IPs except the ones of the
class 'C' network '212.131.173.XXX'.</p>
<p>Higher precedences win over lower ones.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="ctrl_ipmap_tab">CTRL.IPMAP.TAB</a></h3>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[TAB]&quot;permission&quot;[TAB]&quot;precedence&quot;[NEWLINE]</pre>
<p>This file control IP access permission to CTRL server.
Example:</p>
<pre>
 &quot;0.0.0.0&quot;  &quot;0.0.0.0&quot;  &quot;DENY&quot;  &quot;1&quot;
 &quot;212.131.173.0&quot;  &quot;255.255.255.0&quot;  &quot;ALLOW&quot;  &quot;2&quot;</pre>
<p>This configuration deny access to all IPs except the ones of the
class 'C' network '212.131.173.XXX'.
Higher precedences win over lower ones.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="finger_ipmap_tab">FINGER.IPMAP.TAB</a></h3>
<pre>
 &quot;ipaddr&quot;[TAB]&quot;netmask&quot;[TAB]&quot;permission&quot;[TAB]&quot;precedence&quot;[NEWLINE]</pre>
<p>This file controls IP access permission to FINGER server.
Example:</p>
<pre>
 &quot;0.0.0.0&quot;  &quot;0.0.0.0&quot;  &quot;DENY&quot;  &quot;1&quot;
 &quot;212.131.173.0&quot;  &quot;255.255.255.0&quot;  &quot;ALLOW&quot;  &quot;2&quot;</pre>
<p>This configuration denies access to all IPs except the ones of the
class 'C' network '212.131.173.XXX'.
Higher precedences win over lower ones.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="user_tab">USER.TAB</a></h3>
<pre>
 &quot;variable&quot;[TAB]&quot;value&quot;[NEWLINE]</pre>
<p>store user information such as:</p>
<pre>
 &quot;RealName&quot;  &quot;Davide Libenzi&quot;
 &quot;HomePage&quot;  &quot;<a href="http://www.xmailserver.org/davide.html&quot">http://www.xmailserver.org/davide.html&quot</a>;
 &quot;MaxMBSize&quot; &quot;30000&quot;
 &quot;ClosedML&quot;  &quot;0&quot;</pre>
<p>Please refer to <a href="#user_tab_variables">USER.TAB variables</a> below.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="mlusers_tab">MLUSERS.TAB</a></h3>
<p>If the user is a mailing list this file must exist inside the user account subdirectory
and contain a list of users subscribed to this list. The file format is:</p>
<pre>
 &quot;user&quot;[TAB]&quot;perms&quot;[NEWLINE]</pre>
<p>where:</p>
<dl>
<dt><strong><a name="user" class="item">user</a></strong></dt>

<dd>
<p>subscriber email address.</p>
</dd>
<dt><strong><a name="perms" class="item">perms</a></strong></dt>

<dd>
<p>subscriber permissions:</p>
<dl>
<dt><strong><a name="r2" class="item">R</a></strong></dt>

<dd>
<p>read.</p>
</dd>
<dt><strong><a name="w" class="item">W</a></strong></dt>

<dd>
<p>write (check done using the 'MAIL FROM:&lt;...&gt;' SMTP return path).</p>
</dd>
<dt><strong><a name="a" class="item">A</a></strong></dt>

<dd>
<p>write (check done using the email address used for SMTP authentication).</p>
</dd>
</dl>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;davidel@xmailserver.org&quot;   &quot;RW&quot;
 &quot;ghostuser@nightmare.net&quot;   &quot;R&quot;
 &quot;meawmeaw@kitty.cat&quot;        &quot;RA&quot;</pre>
<p>If the '<strong>USER.TAB</strong>' file defines the '<strong>ClosedML</strong>' variable as '<strong>1</strong>' then a client can post
to this mailing list only if it's listed in '<strong>MLUSERS.TAB</strong>' with RW permissions.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="mailproc_tab">MAILPROC.TAB</a></h3>
<pre>
 &quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>stores commands (internals or externals) that have to be executed on a message file.
The presence of this file is optional and if it does not exist the default processing
is to store the message in user mailbox. The '<strong>MAILPROC.TAB</strong>' file can be either per
user or per domain, depending where the file is stored. If stored inside the user
directory it applies only to the user whose directory hosts the '<strong>MAILPROC.TAB</strong>', while
if stored inside the domain directory it applies to all users of such domain.
Each argument can be a macro also (see [<a href="#macro_substitution">MACRO SUBSTITUTION</a>]):</p>
<dl>
<dt><strong><a name="from" class="item">FROM</a></strong></dt>

<dd>
<p>is substituted for the sender of the message</p>
</dd>
<dt><strong><a name="rcpt" class="item">RCPT</a></strong></dt>

<dd>
<p>is substituted for the recipient of the message</p>
</dd>
<dt><strong><a name="rrcpt" class="item">RRCPT</a></strong></dt>

<dd>
<p>is substituted for the real recipient ($(RCPT) could be an alias) of the message</p>
</dd>
<dt><strong><a name="file" class="item">FILE</a></strong></dt>

<dd>
<p>is substituted for the message file path (the external command _must_ only read the file)</p>
</dd>
<dt><strong><a name="msgid" class="item">MSGID</a></strong></dt>

<dd>
<p>is substituted for the (XMail unique) message id</p>
</dd>
<dt><strong><a name="msgref" class="item">MSGREF</a></strong></dt>

<dd>
<p>is substituted for the reference SMTP message id</p>
</dd>
<dt><strong><a name="tmpfile" class="item">TMPFILE</a></strong></dt>

<dd>
<p>creates a copy of the message file to a temporary one. It can be
used with 'external' command but in this case it's external program
responsibility to delete the temporary file. Do not use it with 'filter' commands
since the filter will have no way to modify the real spool file</p>
</dd>
<dt><strong><a name="userauth" class="item">USERAUTH</a></strong></dt>

<dd>
<p>name of the SMTP authenticated user, or &quot;-&quot; if no authentication has been supplied</p>
</dd>
</dl>
<p>Supported commands:</p>
<p>[EXTERNAL]</p>
<pre>
 &quot;external&quot;[TAB]&quot;priority&quot;[TAB]&quot;wait-timeout&quot;[TAB]&quot;command-path&quot;[TAB]=&gt;
   &quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>where:</p>
<dl>
<dt><strong><a name="external" class="item">external</a></strong></dt>

<dd>
<p>command keyword</p>
</dd>
<dt><strong><a name="priority" class="item">priority</a></strong></dt>

<dd>
<p>process priority: 0 = normal  -1 = below normal  +1 = above normal</p>
</dd>
<dt><strong><a name="wait_timeout" class="item">wait-timeout</a></strong></dt>

<dd>
<p>wait timeout for process execution in seconds: 0 = nowait</p>
<p>Be careful if using $(FILE) to give the external command enough timeout to complete,
otherwise the file will be removed by XMail while the command is processing.
This is because such file is a temporary one that is deleted when XMail exits
from '<strong>MAILPROC.TAB</strong>' file processing. In case the external command exit code will
be '<strong>16</strong>', the command processing will stop and all the following commands listed inside
the file will be skipped.</p>
</dd>
</dl>
<p>[FILTER]</p>
<pre>
 &quot;filter&quot;[TAB]&quot;priority&quot;[TAB]&quot;wait-timeout&quot;[TAB]&quot;command-path&quot;[TAB]=&gt;
   &quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>where:</p>
<dl>
<dt><strong><a name="filter" class="item">filter</a></strong></dt>

<dd>
<p>command keyword</p>
</dd>
<dt><strong>priority</strong></dt>

<dd>
<p>process priority: 0 = normal  -1 = below normal  +1 = above normal</p>
</dd>
<dt><strong><a name="wait_timeout2" class="item">wait-timeout</a></strong></dt>

<dd>
<p>wait timeout for process execution in seconds: 0 = nowait</p>
<p>With filters, it is not suggested to use $(TMPFILE), since the filter will never have
the ability to change the message content in that way. Also, to avoid problems very difficult to
troubleshoot, it is suggested to give the filter '<strong>ENOUGH</strong>' timeout to complete (90 seconds
or more). See [<a href="#message_filters">MESSAGE FILTERS</a>] for detailed information about return codes.
In the filter command, the &quot;Stop Filter Processing&quot; return flag will make XMail to stop
the execution of the current custom processing file.</p>
</dd>
</dl>
<p>The 'filter' command will pass the message file to a custom external filter, that
after inspecting it, has the option to accept, reject or modify it. Care should
be taken to properly re-format the message after changing it, to avoid message corruption.
The 'filter' command '<strong>CANNOT</strong>' successfully change the private XMail's header part of the
spool message.</p>
<p>[MAILBOX]</p>
<pre>
 &quot;mailbox&quot;[NEWLINE]</pre>
<p>With this command the message is pushed into local user mailbox.</p>
<p>[REDIRECT]</p>
<pre>
 &quot;redirect&quot;[TAB]&quot;domain-or-emailaddress&quot;[TAB]...[NEWLINE]</pre>
<p>Redirect message to internal or external domain or email address.
If the message was for foo-user&#64;custdomain.net and the file custdomain.net.tab
contains a line:</p>
<pre>
 &quot;redirect&quot;  &quot;target-domain.org&quot;</pre>
<p>the message is delivered to '<strong>foo-user&#64;target-domain.org</strong>'.</p>
<p>While the line:</p>
<pre>
 &quot;redirect&quot;  &quot;user@target-domain.org&quot;</pre>
<p>redirects the message to user&#64;target-domain.org.</p>
<p>[LREDIRECT]</p>
<pre>
 &quot;lredirect&quot;[TAB]&quot;domain-or-emailaddress&quot;[TAB]...[NEWLINE]</pre>
<p>Redirect the message to internal or external domain (or email address)
impersonating local domain during messages delivery.
If the message was for foo-user&#64;custdomain.net and the file custdomain.net.tab
contains a line:</p>
<pre>
 &quot;redirect&quot;  &quot;target-domain.org&quot;</pre>
<p>the message is delivered to '<strong>foo-user&#64;target-domain.org</strong>'.</p>
<p>While the line:</p>
<pre>
 &quot;redirect&quot;  &quot;user@target-domain.org&quot;</pre>
<p>redirects the message to '<strong>user&#64;target-domain.org</strong>'. The difference between
&quot;redirect&quot; and &quot;lredirect&quot; is the following. Suppose A@B sends a message to C@D,
that has a redirect to E@F. With &quot;redirect&quot; E@F will see A@B has sender while with
&quot;lredirect&quot; he will see C@D.</p>
<p>[SMTPRELAY]</p>
<pre>
 &quot;smtprelay&quot;[TAB]&quot;server[:port][,options];server[:port][,options];...&quot;[NEWLINE]</pre>
<p>Send mail to the specified SMTP server list by trying the first, if fails the second and so on.
Otherwise You can use this syntax:</p>
<pre>
 &quot;smtprelay&quot;[TAB]&quot;#server[:port][,options];server[:port][,options];...&quot;[NEWLINE]</pre>
<p>to have XMail random-select the order the specified relays.
Each gateway definition can also contain options as a comma-separated list (see
[<a href="#smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a>] for more information).</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtp_ipprop_tab">SMTP.IPPROP.TAB</a></h3>
<p>This file lists SMTP properties to be associated with the remote SMTP peer IP.
The format of the file is:</p>
<pre>
 &quot;ip-addr&quot;[TAB]&quot;var0=value0&quot;...[TAB]&quot;varN=valueN&quot;[NEWLINE]</pre>
<p>Example:</p>
<pre>
 &quot;192.168.0.7/32&quot;   &quot;WhiteList=1&quot;</pre>
<p>Address selection mask are formed by an IP address (network) plus the number of
valid bits inside the network mask. No space are allowed between the variable name
and the '=' sign and between the '=' sign and the value. These are the currently
defined variables:</p>
<dl>
<dt><strong><a name="whitelist" class="item">WhiteList</a></strong></dt>

<dd>
<p>If set to 1, all peer IP based checks will be skipped.</p>
</dd>
<dt><strong><a name="easetls" class="item">EaseTLS</a></strong></dt>

<dd>
<p>If set to 1, drops the TLS requirement for SMTP sessions coming from the matched network.</p>
</dd>
<dt><strong><a name="senderdomaincheck" class="item">SenderDomainCheck</a></strong></dt>

<dd>
<p>If set to 0, bypasses the &quot;CheckMailerDomain&quot; '<strong>SERVER.TAB</strong>' variable.</p>
</dd>
<dt><strong><a name="noauth" class="item">NoAuth</a></strong></dt>

<dd>
<p>If set to 1, release the authentication policy for this IP.</p>
</dd>
<dt><strong><a name="enablevrfy" class="item">EnableVRFY</a></strong></dt>

<dd>
<p>If set to 1, enable VRFY commands from this IP.</p>
</dd>
<dt><strong><a name="enableetrn" class="item">EnableETRN</a></strong></dt>

<dd>
<p>If set to 1, enable ETRN commands from this IP.</p>
</dd>
</dl>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="smtp_hnprop_tab">SMTP.HNPROP.TAB</a></h3>
<p>This file lists SMTP properties to be associated with the remote SMTP peer host name.
The format of the file is:</p>
<pre>
 &quot;host-spec&quot;[TAB]&quot;var0=value0&quot;...[TAB]&quot;varN=valueN&quot;[NEWLINE]</pre>
<p>If the &quot;host-spec&quot; starts with a dot ('.'), the properties listed for that record will
be applied to all sub-domains of the &quot;host-spec&quot; domain.
Since applying the '<strong>SMTP.HNPROP.TAB</strong>' rules requires a DNS PTR lookup of the peer IP,
you should be aware that this might introduce latencies into the XMail processing.
If you do not have any hostname-based rules, do not create the '<strong>SMTP.HNPROP.TAB</strong>' file
at all, since the simple existence of the file would trigger the DNS PTR lookup.
Example:</p>
<pre>
 &quot;xmailserver.org&quot;   &quot;WhiteList=1&quot;   &quot;EaseTLS=1&quot;</pre>
<p>or:</p>
<pre>
 &quot;.xmailserver.org&quot;   &quot;WhiteList=1&quot;   &quot;EaseTLS=1&quot;</pre>
<p>See [<a href="#smtp_ipprop_tab">SMTP.IPPROP.TAB</a>] for information about the properties allowed
to be listed in this file.</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="filters_in_tab">FILTERS.IN.TAB</a></h3>
<p>See [<a href="#message_filters">MESSAGE FILTERS</a>]</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="filters_out_tab">FILTERS.OUT.TAB</a></h3>
<p>See [<a href="#message_filters">MESSAGE FILTERS</a>]</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="filters_post_rcpt_tab">FILTERS.POST-RCPT.TAB</a></h3>
<p>See [<a href="#smtp_message_filters">SMTP MESSAGE FILTERS</a>]</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="filters_pre_data_tab">FILTERS.PRE-DATA.TAB</a></h3>
<p>See [<a href="#smtp_message_filters">SMTP MESSAGE FILTERS</a>]</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h3><a name="filters_post_data_tab">FILTERS.POST-DATA.TAB</a></h3>
<p>See [<a href="#smtp_message_filters">SMTP MESSAGE FILTERS</a>]</p>
<p>[<a href="#configuration_tables">table index</a>] [<a href="#configuration">configuration</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="macro_substitution">MACRO SUBSTITUTION</a></h1>
<p>XMail support two kinds of macro declaration inside its TAB file. The old macro
declaration done by prefixing the macro name with the '<strong>@@</strong>' sequence is still supported
for backward compatibility, and has to be used when the macro is the only content of the
parameter. Macro can also be declared as '<strong>$(MACRO)</strong>' and this form can be used anywhere
inside the parameter declaration, like:</p>
<pre>
 &quot;/var/spool/mail/$(USER).dat&quot;</pre>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="external_authentication">EXTERNAL AUTHENTICATION</a></h1>
<p>You can use external modules (executables) to perform user authentication instead
of using XMail  '<strong>mailusers.tab</strong>' lookups.
Inside  the userauth  directory you'll find one directory for each service whose
authentication can be handled externally (see <a href="#smtpextauth_tab">SMTPEXTAUTH.TAB</a> for SMTP).
Suppose We must authenticate '<strong>USERNAME</strong>' inside '<strong>DOMAIN</strong>', XMail first tries
to lookup (inside  userauth/pop3) a file named:</p>
<p>'<strong>DOMAIN.tab</strong>'</p>
<p>else:</p>
<p>'<strong>.tab</strong>'</p>
<p>If one of these files is found, XMail authenticates '<strong>USERNAME</strong>' - '<strong>DOMAIN</strong>' using that file.
The authentication file is a TAB file (see at the proper section in this document) which has
the given structure:</p>
<pre>
 &quot;auth-action&quot;[TAB]&quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>Each argument can be a macro also (see [<a href="#macro_substitution">MACRO SUBSTITUTION</a>]):</p>
<dl>
<dt><strong><a name="user2" class="item">USER</a></strong></dt>

<dd>
<p>the USERNAME to authenticate</p>
</dd>
<dt><strong><a name="domain" class="item">DOMAIN</a></strong></dt>

<dd>
<p>the DOMAIN to authenticate</p>
</dd>
<dt><strong><a name="passwd" class="item">PASSWD</a></strong></dt>

<dd>
<p>the user password</p>
</dd>
<dt><strong><a name="path" class="item">PATH</a></strong></dt>

<dd>
<p>user path</p>
</dd>
</dl>
<p>The values for '<strong>auth-action</strong>'  can be one of:</p>
<p>item userauth</p>
<p>executed when user authentication is required</p>
<dl>
<dt><strong><a name="useradd" class="item">useradd</a></strong></dt>

<dd>
<p>executed when a user need to be added</p>
</dd>
<dt><strong><a name="useredit" class="item">useredit</a></strong></dt>

<dd>
<p>executed when a user change is required</p>
</dd>
<dt><strong><a name="userdel" class="item">userdel</a></strong></dt>

<dd>
<p>executed when a user deletion is required</p>
</dd>
<dt><strong><a name="domaindrop" class="item">domaindrop</a></strong></dt>

<dd>
<p>executed when all domain users need to be deleted</p>
</dd>
</dl>
<p>The first line that stores the handling command for the requested action is executed as:</p>
<pre>
 command arg0 ... argN</pre>
<p>that must return zero if successful. Any other exit code is interpreted as
authentication operation failure, that. in '<strong>userauth</strong>' case, means such user is
not authenticated.</p>
<p>If the execution of the  command  fails for system reasons (command not found,
access denied, etc ...) then the user is not authenticated.</p>
<p>If none of this file's id are found, then usual authentication is performed ('<strong>mailusers.tab</strong>').
The use of external authentication does not avoid the presence of the user entry in
'<strong>mailusers.tab</strong>'.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="smtp_client_authentication">SMTP CLIENT AUTHENTICATION</a></h1>
<p>When a message is to be sent through an SMTP server that requires authentication,
XMail provides a way to handle this task by if the '<strong>userauth/smtp</strong>'
subdirectory is set up properly.</p>
<p>Suppose a mail is to be sent through the SMTP server '<strong>mail.foo.net</strong>', this makes XMail
to search for a file named (inside  userauth/smtp):</p>
<p>'<strong>mail.foo.net.tab</strong>'</p>
<p>then:</p>
<p>'<strong>foo.net.tab</strong>'</p>
<p>then:</p>
<p>'<strong>net.tab</strong>'</p>
<p>If one of these files is found its content is used to authenticate the SMTP client session.
The structure of this file, as the extension says, is the TAB one used for most of the
configuration files inside XMail.
Only the first valid line (uncommented #) is used to choose the authentication method
and lines has this format:</p>
<pre>
 &quot;auth-type&quot;[TAB]&quot;param1&quot;...[TAB]&quot;paramN&quot;[NEWLINE]</pre>
<p>Valid lines are:</p>
<pre>
 &quot;PLAIN&quot; &quot;username&quot;  &quot;password&quot;</pre>
<p>or</p>
<pre>
 &quot;LOGIN&quot; &quot;username&quot;  &quot;password&quot;</pre>
<p>or</p>
<pre>
 &quot;CRAM-MD5&quot;  &quot;username&quot;  &quot;password&quot;</pre>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="custom_domain_mail_processing">CUSTOM DOMAIN MAIL PROCESSING</a></h1>
<p>If a message that has as target domain of '<strong>sub1.sub2.domain.net</strong>' arrives at the XMail server,
'<strong>AND</strong>' XMail does not have a real domain '<strong>sub1.sub2.domain.net</strong>' inside its domain list,
XMail decides if this domain gets a custom domain processing by trying to lookup:</p>
<pre>
 sub1.sub2.domain.net.tab
 .sub2.domain.net.tab
 .domain.net.tab
 .net.tab
 .tab</pre>
<p>inside the '<strong>custdomains</strong>' directory.</p>
<p>If one of these files is found the incoming mail gets custom domain processing by executing
commands that are stored in such a file.</p>
<p>The format is:</p>
<pre>
 &quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>These tables store commands (internals or externals) that have to be executed on the message file.
The presence of one of these files is optional and if none exist the default processing
is applied to the message via SMTP.</p>
<p>Each argument can be a macro also (see [<a href="#macro_substitution">MACRO SUBSTITUTION</a>]):</p>
<dl>
<dt><strong><a name="from2" class="item">FROM</a></strong></dt>

<dd>
<p>the sender of the message</p>
</dd>
<dt><strong><a name="rcpt2" class="item">RCPT</a></strong></dt>

<dd>
<p>the target of the message</p>
</dd>
<dt><strong><a name="file2" class="item">FILE</a></strong></dt>

<dd>
<p>the message file path (the external command '<strong>must only read</strong>' the file)</p>
</dd>
<dt><strong><a name="msgid2" class="item">MSGID</a></strong></dt>

<dd>
<p>the (XMail unique) message id</p>
</dd>
<dt><strong><a name="msgref2" class="item">MSGREF</a></strong></dt>

<dd>
<p>the reference SMTP message id</p>
</dd>
<dt><strong><a name="tmpfile2" class="item">TMPFILE</a></strong></dt>

<dd>
<p>creates a copy of the message file to a temporary one. It can be
used with 'external' command but in this case it's external program's
responsibility to delete the temporary file</p>
</dd>
<dt><strong><a name="userauth2" class="item">USERAUTH</a></strong></dt>

<dd>
<p>name of the SMTP authenticated user, or &quot;-&quot; if no authentication has been supplied</p>
</dd>
</dl>
<p>Supported commands:</p>
<dl>
<dt><strong><a name="external" class="item">[EXTERNAL]</a></strong></dt>

<dd>
<pre>
 &quot;external&quot;[TAB]&quot;priority&quot;[TAB]&quot;wait-timeout&quot;[TAB]&quot;command-path&quot;[TAB]=&gt;
   &quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>where:</p>
<dl>
<dt><strong>external</strong></dt>

<dd>
<p>command keyword</p>
</dd>
<dt><strong>priority</strong></dt>

<dd>
<p>process priority: 0 = normal  -1 = below normal  +1 = above normal</p>
</dd>
<dt><strong><a name="wait_timeout3" class="item">wait-timeout</a></strong></dt>

<dd>
<p>wait timeout for process execution in seconds: 0 = nowait</p>
<p>Be careful if using $(FILE) to give the external command enough timeout to complete,
otherwise the file will be removed by XMail while the command is processing.
This is because such file is a temporary one that is deleted when XMail exits
from file processing. In case the external command exit code will be '<strong>16</strong>',
the command processing will stop and all the following commands listed inside
the file will be skipped.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="filter" class="item">[FILTER]</a></strong></dt>

<dd>
<pre>
 &quot;filter&quot;[TAB]&quot;priority&quot;[TAB]&quot;wait-timeout&quot;[TAB]&quot;command-path&quot;[TAB]=&gt;
   &quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>where:</p>
<dl>
<dt><strong>filter</strong></dt>

<dd>
<p>command keyword</p>
</dd>
<dt><strong>priority</strong></dt>

<dd>
<p>process priority: 0 = normal  -1 = below normal  +1 = above normal</p>
</dd>
<dt><strong><a name="wait_timeout4" class="item">wait-timeout</a></strong></dt>

<dd>
<p>wait timeout for process execution in seconds: 0 = nowait</p>
<p>With filters, it is not suggested to use $(TMPFILE), since the filter will never have
the ability to change the message content in that way. Also, to avoid problems very difficult to
troubleshoot, it is suggested to give the filter '<strong>ENOUGH</strong>' timeout to complete (90 seconds
or more). See [<a href="#message_filters">MESSAGE FILTERS</a>] for detailed information about return codes.
In the filter command, the &quot;Stop Filter Processing&quot; return flag will make XMail to stop
the execution of the current custom processing file.</p>
</dd>
</dl>
<p>The 'filter' command will pass the message file to a custom external filter, that
after inspecting it, has the option to accept, reject or modify it. Care should
be taken to properly re-format the message after changing it, to avoid message corruption.
The 'filter' command '<strong>CANNOT</strong>' successfully change the private XMail's header part of the
spool message.</p>
</dd>
<dt><strong><a name="redirect" class="item">[REDIRECT]</a></strong></dt>

<dd>
<pre>
 &quot;redirect&quot;[TAB]&quot;domain-or-emailaddress&quot;[TAB]...[NEWLINE]</pre>
<p>Redirect message to internal or external domain or email address.
If the message was for foo-user&#64;custdomain.net and the file custdomain.net.tab
contains a line:</p>
<pre>
 &quot;redirect&quot;  &quot;target-domain.org&quot;</pre>
<p>the message is delivered to '<strong>foo-user&#64;target-domain.org</strong>'.</p>
<p>While the line:</p>
<pre>
 &quot;redirect&quot;  &quot;user@target-domain.org&quot;</pre>
<p>redirects the message to user&#64;target-domain.org.</p>
</dd>
<dt><strong><a name="lredirect" class="item">[LREDIRECT]</a></strong></dt>

<dd>
<pre>
 &quot;lredirect&quot;[TAB]&quot;domain-or-emailaddress&quot;[TAB]...[NEWLINE]</pre>
<p>Redirect the message to internal or external domain (or email address)
impersonating local domain during messages delivery.
If the message was for foo-user&#64;custdomain.net and the file custdomain.net.tab
contains a line:</p>
<pre>
 &quot;redirect&quot;  &quot;target-domain.org&quot;</pre>
<p>the message is delivered to '<strong>foo-user&#64;target-domain.org</strong>'.</p>
<p>While the line:</p>
<pre>
 &quot;redirect&quot;  &quot;user@target-domain.org&quot;</pre>
<p>redirects the message to '<strong>user&#64;target-domain.org</strong>'. The difference between
&quot;redirect&quot; and &quot;lredirect&quot; is the following. Suppose A@B sends a message to C@D,
that has a redirect to E@F. With &quot;redirect&quot; E@F will see A@B has sender while with
&quot;lredirect&quot; he will see C@D.</p>
</dd>
<dt><strong><a name="smtprelay" class="item">[SMTPRELAY]</a></strong></dt>

<dd>
<pre>
 &quot;smtprelay&quot;[TAB]&quot;server[:port][,options];server[:port][,options];...&quot;[NEWLINE]</pre>
<p>Send mail to the specified SMTP server list by trying the first, if fails the second and so on.
Otherwise You can use this syntax:</p>
<pre>
 &quot;smtprelay&quot;[TAB]&quot;#server[:port][,options];server[:port][,options];...&quot;[NEWLINE]</pre>
<p>to have XMail random-select the order the specified relays.
Each gateway definition can also contain options as a comma-separated list (see
[<a href="#smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a>] for more information).</p>
</dd>
<dt><strong><a name="smtp" class="item">[SMTP]</a></strong></dt>

<dd>
<pre>
 &quot;smtp&quot;[NEWLINE]</pre>
<p>Do SMTP delivery.</p>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="cmd_aliases">CMD ALIASES</a></h1>
<p>CmdAliases implement aliases that are handled only through commands and can be thought of as
a user level implementation of custom domain processing commands.
The command set is the same of the one that is described above
(<a href="#custom_domain_mail_processing">Custom domain mail processing</a>)
and won't be explained again here.</p>
<p>For every handled domain (listed inside '<strong>domains.tab</strong>') a directory with the same domain name
is created inside the '<strong>cmdaliases</strong>' subdirectory.
This directory is automatically created and removed when you add/remove domains through the
CTRL protocol (or '<strong>CtrlClnt</strong>').</p>
<p>When a mail for '<strong>USER&#64;DOMAIN</strong>' is received by the server, the domain '<strong>DOMAIN</strong>'
is to be
handled locally, and the standard users/aliases lookup fails, a file named '<strong>USER.tab</strong>' is searched
inside '<strong>$MAIL_ROOT/cmdaliases/DOMAIN</strong>'.
If such file is found, commands listed inside the file (whose format must follow the one
described in the previous section) are executed by the server as a matter of mail message processing.
An important thing to remember is that all domain and user names, when applied to the file
system, must be lower case.</p>
<p>The use of the command '<strong>[SMTP]</strong>' must be implemented with great care because it could create
mail loops within the server.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="server_tab_variables">SERVER.TAB VARIABLES</a></h1>
<p>The following variables are for use int the <a href="#server_tab">SERVER.TAB</a> configuration file.</p>
<dl>
<dt><strong><a name="rootdomain" class="item">[RootDomain]</a></strong></dt>

<dd>
<p>Indicate the primary domain for the server.</p>
</dd>
<dt><strong><a name="smtpserverdomain" class="item">[SmtpServerDomain]</a></strong></dt>

<dd>
<p>If set, forces the domain name XMail uses inside the ESMTP greeting used to support
CRAM-MD5 ESMTP authentication.</p>
</dd>
<dt><strong><a name="pop3domain" class="item">[POP3Domain]</a></strong></dt>

<dd>
<p>Set the default domain for POP3 client connections.</p>
</dd>
<dt><strong><a name="postmaster" class="item">[PostMaster]</a></strong></dt>

<dd>
<p>Set the postmaster address.</p>
</dd>
<dt><strong><a name="errorsadmin" class="item">[ErrorsAdmin]</a></strong></dt>

<dd>
<p>The email address that receives notification messages for every message that has had delivery errors.
If it is empty (allowed), the notification message is sent to the sender only.</p>
</dd>
<dt><strong><a name="temperrorsadmin" class="item">[TempErrorsAdmin]</a></strong></dt>

<dd>
<p>The email address that receives notification for temporary delivery failures.
In case it's empty the notification message is sent to the sender only.</p>
</dd>
<dt><strong><a name="defaultsmtpgateways" class="item">[DefaultSMTPGateways]</a></strong></dt>

<dd>
<p>A semicolon separated list of SMTP servers XMail '<strong>must</strong>' use to send its mails.
The definition can also contain options as a comma-separated list (see
[<a href="#smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a>] for more information).
Example:</p>
<pre>
  &quot;192.168.0.1,NeedTLS=2;192.168.0.2&quot;</pre>
<p>This has the precedence over MX records.</p>
</dd>
<dt><strong><a name="helodomain" class="item">[HeloDomain]</a></strong></dt>

<dd>
<p>If this variable is specified and is not empty, its content is sent as HELO domain.
Otherwise the reverse lookup of the local IP is sent as HELO domain.
This helps to deal with remote SMTP servers that are set to check the reverse lookup
of the incoming IP.</p>
</dd>
<dt><strong><a name="checkmailerdomain" class="item">[CheckMailerDomain]</a></strong></dt>

<dd>
<p>Enable validation of the sender domain ('MAIL FROM:&lt;...&#64;xxx&gt;') by looking up DNS/MX entries.</p>
</dd>
<dt><strong><a name="removespoolerrors" class="item">[RemoveSpoolErrors]</a></strong></dt>

<dd>
<p>Indicate if mail has to be removed or stored in '<strong>froz</strong>'  directory after a failure in
delivery or filtering.</p>
</dd>
<dt><strong><a name="notifymsglinesextra" class="item">[NotifyMsgLinesExtra]</a></strong></dt>

<dd>
<p>Number of lines of the bounced message that have to be listed inside the notify message
(lines after
the headers section). Default is zero.</p>
</dd>
<dt><strong><a name="notifysendlogtosender" class="item">[NotifySendLogToSender]</a></strong></dt>

<dd>
<p>Enable/Disable sending the message log file inside the notify message to the sender.
Default is off (zero).</p>
</dd>
<dt><strong><a name="notifytrypattern" class="item">[NotifyTryPattern]</a></strong></dt>

<dd>
<p>List of delivery attempts that require the system to send a notification to the sender
(and eventually to '<strong>TempErrorsAdmin</strong>').
The list is a comma separated list of numbers (with no extra spaces) as in:</p>
<pre>
 &quot;1,4,9&quot;</pre>
<p>Default is empty which means no notification is sent upon a delivery attempt failure.</p>
</dd>
<dt><strong><a name="allownullsender" class="item">[AllowNullSender]</a></strong></dt>

<dd>
<p>Enable null sender ('MAIL FROM:&lt;&gt;') messages to be accepted by XMail.</p>
</dd>
<dt><strong><a name="nosenderbounce" class="item">[NoSenderBounce]</a></strong></dt>

<dd>
<p>When building bounce messages, use the null SMTP sender ('MAIL FROM:&lt;&gt;') instead
of the '<strong>PostMaster</strong>' address. This will affect only the SMTP sender, while the
message <a href="http://www.ietf.org/rfc/rfc822.txt" class="rfc">RFC822</a> headers will still contain the correct From: header.</p>
</dd>
<dt><strong><a name="maxmtaops" class="item">[MaxMTAOps]</a></strong></dt>

<dd>
<p>Set the maximum number of MTA relay steps before to declare the message as looped (default 16).</p>
</dd>
<dt><strong><a name="receivedhdrtype" class="item">[ReceivedHdrType]</a></strong></dt>

<dd>
<p>Set the verbosity of the Received: message headers tag.</p>
<dl>
<dt><strong><a name="_0_" class="item">'0'</a></strong></dt>

<dd>
<p>Standard (client IP shown , server IP not). Default.</p>
</dd>
<dt><strong><a name="1" class="item">'1'</a></strong></dt>

<dd>
<p>Verbose (client IP shown , server IP shown)</p>
</dd>
<dt><strong><a name="2" class="item">'2'</a></strong></dt>

<dd>
<p>Strict (no IP shown)</p>
</dd>
<dt><strong><a name="3" class="item">'3'</a></strong></dt>

<dd>
<p>Same as 0 but the client IP is not shown if the client authenticate itself.</p>
</dd>
<dt><strong><a name="4" class="item">'4'</a></strong></dt>

<dd>
<p>Same as 1 but the client IP is not shown if the client authenticate itself.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="fetchhdrtags" class="item">[FetchHdrTags]</a></strong></dt>

<dd>
<p>Set the list of headers tags to be used to extract addresses from POP3 fetched messages
(<a href="#pop3links_tab">POP3LINKS.TAB</a>).
This is a comma delimited list (no extra space or TABs must be included inside the list) as in:</p>
<pre>
 &quot;+X-Deliver-To,To,Cc&quot;</pre>
<p>Tags preceded by a '+' character make XMail stop scanning when an address is found inside the header tag.</p>
<p>Tags preceded by a '+' character must be listed before other tags.</p>
<p>The string &quot;+X-Deliver-To,To,Cc&quot; is the default if nothing is specified.</p>
</dd>
<dt><strong><a name="smtp_maxerrors" class="item">[SMTP-MaxErrors]</a></strong></dt>

<dd>
<p>Set the maximum number of errors allowed in a single SMTP session. When the maximum
number of allowed errors is exceeded, the connection will be automatically dropped.
If such variable is not set, or it is set to zero, the maximum number of errors will
be unlimited.</p>
</dd>
<dt><strong><a name="smtpmsgipbanspammers" class="item">[SmtpMsgIPBanSpammers]</a></strong></dt>

<dd>
<p>Used to set the message that is sent to the SMTP client when the client IP is listed inside
the file SPAMMER.TAB.</p>
</dd>
<dt><strong><a name="smtpmsgipbanspamaddress" class="item">[SmtpMsgIPBanSpamAddress]</a></strong></dt>

<dd>
<p>Used to set the message that is sent to the SMTP client when the client IP is listed inside
the file SPAM-ADDRESS.TAB.</p>
</dd>
<dt><strong><a name="smtpmsgipbanmaps" class="item">[SmtpMsgIPBanMaps]</a></strong></dt>

<dd>
<p>Used to set the message that is sent to the SMTP client when the client IP is listed inside
one of the &quot;CustMapsList&quot;.</p>
</dd>
<dt><strong><a name="smtpmsgipban" class="item">[SmtpMsgIPBan]</a></strong></dt>

<dd>
<p>Used to set the message that is sent to the SMTP client when the client IP is listed inside
the file SMTP.IPMAP.TAB.</p>
</dd>
<dt><strong><a name="customsmtpmessage" class="item">[CustomSMTPMessage]</a></strong></dt>

<dd>
<p>Set this to the message that you want to follow the standard SMTP error
response sent by XMail, as in (one line, remember the =&gt;):</p>
<pre>
 &quot;Please open <a href="http://www.xmailserver.test/smtp_errors.html">http://www.xmailserver.test/smtp_errors.html</a> to get=&gt;
    more information about this error&quot;</pre>
<p>Please be aware the <a href="http://www.ietf.org/rfc/rfc821.txt" class="rfc">RFC821</a> fix the maximum reply line length to 512 bytes.</p>
</dd>
<dt><strong><a name="smtp_ipmapdropcode" class="item">[SMTP-IpMapDropCode]</a></strong></dt>

<dd>
<p>Set the drop code for IPs blocked by the SMTP.IPMAP.TAB file:</p>
<dl>
<dt><strong><a name="12" class="item">'1'</a></strong></dt>

<dd>
<p>the connection is dropped soon</p>
</dd>
<dt><strong><a name="0" class="item">&quot;0&quot;</a></strong></dt>

<dd>
<p>the connection is kept alive but only authenticated users can send mail</p>
</dd>
<dt><strong><a name="s2" class="item">'-S'</a></strong></dt>

<dd>
<p>the peer can send messages but a delay of S seconds is introduced between commands</p>
</dd>
</dl>
</dd>
<dt><strong><a name="allowsmtpvrfy" class="item">[AllowSmtpVRFY]</a></strong></dt>

<dd>
<p>Enable the use of VRFY SMTP command. This flag may be forced by SMTP authentication.</p>
</dd>
<dt><strong><a name="allowsmtpetrn" class="item">[AllowSmtpETRN]</a></strong></dt>

<dd>
<p>Enable the use of ETRN SMTP command. This flag may be forced by SMTP authentication.</p>
</dd>
<dt><strong><a name="smtpmindiskspace" class="item">[SmtpMinDiskSpace]</a></strong></dt>

<dd>
<p>Minimum disk space (in Kb) that is requested before accepting an SMTP connection.</p>
</dd>
<dt><strong><a name="smtpminvirtmemspace" class="item">[SmtpMinVirtMemSpace]</a></strong></dt>

<dd>
<p>Minimum virtual memory (in Kb) that is requested before accepting an SMTP connection.</p>
</dd>
<dt><strong><a name="pop3minvirtmemspace" class="item">[Pop3MinVirtMemSpace]</a></strong></dt>

<dd>
<p>Minimum virtual memory (in Kb) that is requested before accepting a POP3 connection.</p>
</dd>
<dt><strong><a name="pop3syncerroraccount" class="item">[Pop3SyncErrorAccount]</a></strong></dt>

<dd>
<p>This defines the email account (MUST be handled locally) that receives all
fetched email that XMail has not been able to deliver.</p>
</dd>
<dt><strong><a name="enableauthsmtp_pop3" class="item">[EnableAuthSMTP-POP3]</a></strong></dt>

<dd>
<p>Enable SMTP after POP3 authentication (default on).</p>
</dd>
<dt><strong><a name="maxmessagesize" class="item">[MaxMessageSize]</a></strong></dt>

<dd>
<p>Set the maximum message size in Kb that is possible to send through the server.</p>
</dd>
<dt><strong><a name="defaultsmtpperms" class="item">[DefaultSmtpPerms]</a></strong></dt>

<dd>
<p>This list SMTP permissions assigned to users looked up inside <a href="#mailusers_tab">MAILUSERS.TAB</a>
during SMTP authentication.
It also defines the permissions for users authenticated with SMTP after POP3.</p>
</dd>
<dt><strong><a name="custmapslist" class="item">[CustMapsList]</a></strong></dt>

<dd>
<p>This is a list a user can use to set custom maps checking. The list has the given (strict) format:</p>
<p>maps-root:code,maps-root:code...</p>
<p>Where  maps-root  is the root for the DNS query (i.e. dialups.mail-abuse.org.)
and the code can be:</p>
<dl>
<dt><strong><a name="13" class="item">'1'</a></strong></dt>

<dd>
<p>the connection is dropped soon</p>
</dd>
<dt><strong><a name="02" class="item">&quot;0&quot;</a></strong></dt>

<dd>
<p>the connection is kept alive but only authenticated users can send mail</p>
</dd>
<dt><strong><a name="s3" class="item">'-S'</a></strong></dt>

<dd>
<p>the peer can send messages but a delay of S seconds is introduced between commands</p>
</dd>
</dl>
</dd>
<dt><strong><a name="smtp_rdnscheck" class="item">[SMTP-RDNSCheck]</a></strong></dt>

<dd>
<p>Indicate if XMail must do an RDNS lookup before accepting a incoming SMTP connection.
If 0, the check is not performed; if 1 and the check fails,
the user receives a 'server use forbidden'
at MAIL_FROM time;
if -S (S &gt; 0) and the check fails, a delay of S seconds between SMTP commands is used to prevent
massive spamming.</p>
<p>SMTP authentication overrides the denial set by this option by giving authenticated users
the ability to access the server from 'mapped' IPs.</p>
</dd>
<dt><strong><a name="smartdnshost" class="item">[SmartDNSHost]</a></strong></dt>

<dd>
<p>Setup a list of smart DNS hosts to which are directed DNS queries with recursion
bit set to true. Such DNS hosts must support DNS recursion in queries.
The format is:</p>
<pre>
 dns.home.bogus.net:tcp,192.168.1.1:udp,...</pre>
</dd>
<dt><strong><a name="disableemitauthuser" class="item">[DisableEmitAuthUser]</a></strong></dt>

<dd>
<p>Enable/disable the emission the the 'X-AuthUser:' mail header for authenticated users.
Valid values are &quot;0&quot; or '1', default is &quot;0&quot; (emission enabled).</p>
</dd>
<dt><strong><a name="smtpgwconfig" class="item">[SmtpGwConfig]</a></strong></dt>

<dd>
<p>Sets global SMTP gateway options. Those can be overridden by specific gateway options.
See [<a href="#smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a>] for information.</p>
</dd>
<dt><strong><a name="pop3logpasswd" class="item">[Pop3LogPasswd]</a></strong></dt>

<dd>
<p>Control if POP3 passwords are logged into the POP3 log file. Set to &quot;0&quot; to disable
password logging, set to &quot;1&quot; to enable logging of failed logins, and the to &quot;2&quot; to
always enable password logging. Default is &quot;0&quot;.</p>
</dd>
<dt><strong><a name="smtpnotlsauths" class="item">[SmtpNoTLSAuths]</a></strong></dt>

<dd>
<p>Lists a comma-separated sequence of SMTP authentications that are allowed
while the connections is in non-TLS mode (clear text). Do not set this variable
if you do not want to impose any restriction, or set it to the empty string if
you do not want any authentication method to be allowed in clear-text mode.</p>
</dd>
<dt><strong><a name="enablectrl_tls" class="item">[EnableCTRL-TLS]</a></strong></dt>

<dd>
<p>Enable CTRL TLS negotiation (default &quot;1&quot;).</p>
</dd>
<dt><strong><a name="enablepop3_tls" class="item">[EnablePOP3-TLS]</a></strong></dt>

<dd>
<p>Enable POP3 TLS (STLS) negotiation (default &quot;1&quot;).</p>
</dd>
<dt><strong><a name="enablesmtp_tls" class="item">[EnableSMTP-TLS]</a></strong></dt>

<dd>
<p>Enable SMTP TLS (STARTTLS) negotiation (default &quot;1&quot;).</p>
</dd>
<dt><strong><a name="sslusecertsfile" class="item">[SSLUseCertsFile]</a></strong></dt>

<dt><strong><a name="sslusecertsdir" class="item">[SSLUseCertsDir]</a></strong></dt>

<dt><strong><a name="sslwantverify" class="item">[SSLWantVerify]</a></strong></dt>

<dt><strong><a name="sslallowselfsigned" class="item">[SSLAllowSelfSigned]</a></strong></dt>

<dt><strong><a name="sslwantcert" class="item">[SSLWantCert]</a></strong></dt>

<dt><strong><a name="sslmaxcertsdepth" class="item">[SSLMaxCertsDepth]</a></strong></dt>

<dd>
<p>See [<a href="#ssl_configuration">SSL CONFIGURATION</a>] for information.</p>
</dd>
<dt><strong><a name="smtpconfig" class="item">[SmtpConfig]</a></strong></dt>

<dd>
<p>Default SMTP server config loaded if specific server IP[,PORT] config is not found.</p>
</dd>
<dt><strong><a name="smtpconfig_ip_smtpconfig_ip_port" class="item">[SmtpConfig-IP | SmtpConfig-IP,PORT]</a></strong></dt>

<dd>
<p>Specific IP or IP,PORT SMTP server config. Examples:</p>
<pre>
 &quot;SmtpConfig-192.168.1.123&quot; &quot;...&quot;
 &quot;SmtpConfig-192.168.1.17,1025&quot; &quot;...&quot;</pre>
<p>The variable value is a comma separated sequence of configuration tokens whose
meaning is:</p>
<dl>
<dt><strong><a name="mailauth" class="item">MailAuth</a></strong></dt>

<dd>
<p>authentication required to send mail to the server.
Please note that by setting this value everything requires authentication,
even for sending to local domains, and this is probably not what you want.
The &quot;mail-auth&quot; is also synonym of &quot;MailAuth&quot;.</p>
</dd>
<dt><strong><a name="wanttls" class="item">WantTLS</a></strong></dt>

<dd>
<p>TLS connection needed to talk to this server. This is either done by issuing
a STARTTLS command over a standard SMTP session, or by using an SMTPS port</p>
</dd>
</dl>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="message_filters">MESSAGE FILTERS</a></h1>
<p>This feature offers a way to filter messages by providing the ability to
execute external programs, such as scripts or real executables.
These 'filters' may examine and/or modify messages and inform XMail of
their actions with a return value.</p>
<p>This feature offers the ability to inspect and modify messages, giving a way
to reject messages based on content, alter messages (address rewriting)
and so on.</p>
<p>If this filters returns '<strong>4, 5 or 6</strong>' the message is rejected and
is stopped in its travel.
If the filter modifies the message it must return '<strong>7</strong>'.</p>
<p>Additional flags are allowed to be returned to XMail as a result of filter processing
by adding the flags value to the exits code above listed. The currently defined
flags are :</p>
<dl>
<dt><strong><a name="16" class="item">'16'</a></strong></dt>

<dd>
<p>Stop selected filter list processing.</p>
</dd>
</dl>
<p>Filter flags are additive and if more than one flag need to be specified, their values
must be added together. If a filter &quot;raw&quot; exit code is <strong>RC</strong> and the filter needs
to return extra flags <strong>FILTER-SUM</strong>, the final return code <strong>FRC</strong> must be :</p>
<p><strong>FRC</strong> = <strong>RC</strong> + <strong>FILTER-SUM</strong></p>
<p>Example. Suppose a filter modified the message and hence needs to return <strong>7</strong> as return code.
Suppose also that a filter wants to block the filter selection list processing by
specifying a flags value of <strong>16</strong>, the value to be returned will be :</p>
<p><strong>FRC</strong> = <strong>7</strong> + <strong>16</strong> = <strong>23</strong></p>
<p>Filter selection is driven by two files '<strong>FILTERS.IN.TAB</strong>' and '<strong>FILTERS.OUT.TAB</strong>'
located inside the $MAIL_ROOT/ directory and that have the following format:</p>
<pre>
 &quot;sender&quot;[TAB]&quot;recipient&quot;[TAB]&quot;remote-addr&quot;[TAB]&quot;local-addr&quot;[TAB]&quot;filename&quot;[NEWLINE]</pre>
<p>For example:</p>
<pre>
 &quot;*@bad-domain.com&quot; &quot;*&quot; &quot;0.0.0.0/0&quot; &quot;0.0.0.0/0&quot; &quot;av-filter.tab&quot;
 &quot;*&quot; &quot;clean@purified.net&quot; &quot;0.0.0.0/0&quot; &quot;0.0.0.0/0&quot; &quot;spam-block.tab&quot;
 &quot;*&quot; &quot;*&quot; &quot;192.168.1.0/24&quot; &quot;0.0.0.0/0&quot; &quot;archive.tab&quot;</pre>
<p>where the file &quot;av-filter.tab&quot; must be present inside the $MAIL_ROOT/filters directory.
The &quot;sender&quot; and the &quot;recipient&quot; are resolved to the real account when possible.
Address selection mask are formed by an IP address (network) plus the number of
valid bits inside the network mask. The file '<strong>FILTERS.IN.TAB</strong>' lists filters that
have to be applied to inbound messages (going to local mailboxes) while the file
'<strong>FILTERS.OUT.TAB</strong>' lists filters that have to be applied to outbound messages
(delivered remotely).
All four (sender+recipient+remote-addr+local-addr) selection fields must have a match
in order &quot;filename&quot; to be evaluated.
The syntax of the filter file is:</p>
<pre>
 &quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>or:</p>
<pre>
 &quot;!flags&quot;[TAB]&quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>Each file may contain multiple commands, that will be executed in strictly sequential
order. The first command that will trigger a rejection code will make the filtering
process to end. The '<strong>flags</strong>' parameter is a comma-separated list of flags that drives
the filter execution. The syntax of each flag is either FLAG or FLAG=VAL. Currently
supported flags are:</p>
<dl>
<dt><strong><a name="aex" class="item">aex</a></strong></dt>

<dd>
<p>exclude filter execution in case of authenticated sender</p>
</dd>
<dt><strong><a name="wlex" class="item">wlex</a></strong></dt>

<dd>
<p>exclude filter execution in case the client IP is white-listed inside the SMTP.IPPROP.TAB file.
This flag works only for SMTP filters.</p>
</dd>
<dt><strong><a name="timeo" class="item">timeo</a></strong></dt>

<dd>
<p>sets the timeout value for this filter execution</p>
</dd>
</dl>
<p>Each argument can be a macro also (see [<a href="#macro_substitution">MACRO SUBSTITUTION</a>]):</p>
<dl>
<dt><strong><a name="from3" class="item">FROM</a></strong></dt>

<dd>
<p>the sender of the message</p>
</dd>
<dt><strong><a name="rfrom" class="item">RFROM</a></strong></dt>

<dd>
<p>the sender of the message resolved to the real account, when possible (alias resolution)</p>
</dd>
<dt><strong><a name="rcpt3" class="item">RCPT</a></strong></dt>

<dd>
<p>the target of the message</p>
</dd>
<dt><strong><a name="rrcpt2" class="item">RRCPT</a></strong></dt>

<dd>
<p>the target of the message resolved to the real account, when possible (alias resolution)</p>
</dd>
<dt><strong><a name="remoteaddr" class="item">REMOTEADDR</a></strong></dt>

<dd>
<p>remote IP address and port of the sender</p>
</dd>
<dt><strong><a name="localaddr" class="item">LOCALADDR</a></strong></dt>

<dd>
<p>local IP address and port where the message has been accepted</p>
</dd>
<dt><strong><a name="file3" class="item">FILE</a></strong></dt>

<dd>
<p>the message file path (the external command may modify the file if it returns '<strong>7</strong>'
as command exit value.)</p>
</dd>
<dt><strong><a name="msgid3" class="item">MSGID</a></strong></dt>

<dd>
<p>with the (XMail unique) message id</p>
</dd>
<dt><strong><a name="msgref3" class="item">MSGREF</a></strong></dt>

<dd>
<p>the reference SMTP message id</p>
</dd>
<dt><strong><a name="userauth3" class="item">USERAUTH</a></strong></dt>

<dd>
<p>name of the SMTP authenticated user, or &quot;-&quot; if no authentication has been supplied</p>
</dd>
</dl>
<p>Here '<strong>command</strong>' is the name of an external program that processes the message and
returns its processing result. If it returns '<strong>6</strong>' the message is rejected and a notification
message is sent to the sender. By returning '<strong>5</strong>' the message is rejected
without notification.
While returning '<strong>4</strong>' the message is rejected without notification and without being frozen
(a '<strong>5</strong>' response could lead to a frozen message if the <a href="#server_tab">SERVER.TAB</a> configuration enables this).
If all filters return values different from '<strong>6, 5 and 4</strong>' the message continues its trip.
The filter command may also modify the file
(AV scanning, content filter, message rewriting, etc) by returning '<strong>7</strong>'.
The filter '<strong>MUST</strong>' return '<strong>7</strong>' in case it modifies the message.
If the filter changes the message file it '<strong>MUST</strong>' keep the message structure and
it '<strong>MUST</strong>' terminate all line with &lt;CR&gt;&lt;LF&gt;. The filter has also the ability to return
a one-line custom return message by creating a file named $(FILE).rej holding the message
in the very first line. This file should be created '<strong>ONLY</strong>' when the filter returns a
rejection code ('<strong>6, 5 and 4</strong>')and '<strong>NEVER</strong>' in case of passthrough code ('<strong>7</strong>') or modify code.</p>
<p>The spool files has this structure:</p>
<pre>
 Info Data           [ 1th line ]
 SmtpDomain          [ 2nd line ]
 SmtpMessageID       [ 3rd line ]
 MAIL FROM:&lt;...&gt;     [ 4th line ]
 RCPT TO:&lt;...&gt;       [ 5th line ]
 &lt;&lt;MAIL-DATA&gt;&gt;       [ 6th line ]
 ...</pre>
<p>After the '<strong>&lt;&lt;MAIL-DATA&gt;&gt;</strong>' tag (5th line) the message follows. The message is composed
of a headers section and, after the first empty line, the message body. The format of the &quot;Info Data&quot;
line is:</p>
<pre>
 [ClientIP]:ClientPort;[ServerIP]:ServerPort;Time</pre>
<p>'<strong>EXTREME</strong>' care must be used when modifying the message because the filter will be working
on the real message, and a badly reformatted file will lead to message loss. The spool file
header (any data before &lt;&lt;MAIL-DATA&gt;&gt;) '<strong>MUST</strong>' be preserved as is by the filter in case of
message rewrite happens.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="smtp_message_filters">SMTP MESSAGE FILTERS</a></h1>
<p>Besides having the ability to perform off-line message filtering, XMail gives the user
the power to run filters during the SMTP session. Three files drive the SMTP on-line filtering,
and these are '<strong>FILTERS.POST-RCPT.TAB</strong>', '<strong>FILTERS.PRE-DATA.TAB</strong>' and '<strong>FILTERS.POST-DATA.TAB</strong>'.
The file '<strong>FILTERS.POST-RCPT.TAB</strong>', contains one or more commands to be executed after the remote
SMTP client sends the RCPT_TO command(s), and before XMail sends the response to the command.
The file '<strong>FILTERS.PRE-DATA.TAB</strong>' contains one or more commands to be executed after the remote
SMTP client sends the DATA command, and before XMail sends the response to the command.
Using such filters, the user can tell XMail if or if not accept the following transaction
and, in case of rejection, the user is also allowed to specify a custom message to be sent
to the remote SMTP client. The file '<strong>FILTERS.POST-DATA.TAB</strong>' contains one or more commands
to be executed after XMail received the whole client DATA, and before XMail sends the final
response to the DATA command (final messages ack). The files '<strong>FILTERS.POST-RCPT.TAB</strong>',
'<strong>FILTERS.PRE-DATA.TAB</strong>' and '<strong>FILTERS.POST-DATA.TAB</strong>' contains zero or more lines with the
following format:</p>
<pre>
 &quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>or:</p>
<pre>
 &quot;!flags&quot;[TAB]&quot;command&quot;[TAB]&quot;arg-or-macro&quot;[TAB]...[NEWLINE]</pre>
<p>Each file may contain multiple commands, that will be executed in strictly sequential
order. The first command that will trigger a rejection code will make the filtering
process to end. The '<strong>flags</strong>' parameter is a comma-separated list of flags that drives
the filter execution. The syntax of each flag is either FLAG or FLAG=VAL. Currently
supported flags are:</p>
<dl>
<dt><strong>aex</strong></dt>

<dd>
<p>exclude filter execution in case of authenticated sender</p>
</dd>
<dt><strong>wlex</strong></dt>

<dd>
<p>exclude filter execution in case the client IP is white-listed inside the SMTP.IPPROP.TAB file.</p>
</dd>
</dl>
<p>Each argument can be a macro also (see [<a href="#macro_substitution">MACRO SUBSTITUTION</a>]):</p>
<dl>
<dt><strong><a name="file4" class="item">FILE</a></strong></dt>

<dd>
<p>message file path</p>
</dd>
<dt><strong><a name="userauth4" class="item">USERAUTH</a></strong></dt>

<dd>
<p>name of the SMTP authenticated user, or &quot;-&quot; if no authentication has been supplied</p>
</dd>
<dt><strong><a name="remoteaddr2" class="item">REMOTEADDR</a></strong></dt>

<dd>
<p>remote IP address and port of the sender</p>
</dd>
<dt><strong><a name="localaddr2" class="item">LOCALADDR</a></strong></dt>

<dd>
<p>local IP address and port where the message has been accepted</p>
</dd>
<dt><strong><a name="from4" class="item">FROM</a></strong></dt>

<dd>
<p>message sender address</p>
</dd>
<dt><strong><a name="crcpt" class="item">CRCPT</a></strong></dt>

<dd>
<p>last recipient submitted by the client. For post-rcpt filters, this will be
used as to-validate recipient</p>
</dd>
<dt><strong><a name="rrcpt3" class="item">RRCPT</a></strong></dt>

<dd>
<p>last recipient submitted by the client, translated to the real account (in case
of aliases)</p>
</dd>
</dl>
<p>Filter commands have the ability to inspect and modify the content of the message
(or info) file. The exit code of commands executed by XMail are used to tell XMail
the action that has to be performed as a consequence of the filter. The exit code
is composed by a raw exit code and additional flags. Currently defined flags are:</p>
<dl>
<dt><strong><a name="162" class="item">'16'</a></strong></dt>

<dd>
<p>Stop selected filter list processing.</p>
</dd>
</dl>
<p>Currently defined raw exit codes are:</p>
<dl>
<dt><strong><a name="32" class="item">'3'</a></strong></dt>

<dd>
<p>Reject the message.</p>
</dd>
</dl>
<p>Any other exit codes will make XMail to accept the message, and can be used also when
changing the content of the $(FILE) file. '<strong>EXTREME</strong>' care must be used when changing the
$(FILE) file, since XMail expect the file format to be correct. Also, it is important to
preserve the &lt;CR&gt;&lt;LF&gt; line termination of the file itself.
When rejecting the message, the filter command has the ability to specify the SMTP
status code that XMail will send to the remote SMTP client, by creating a file named
$(FILE).rej containing the message in the very first line. Such file will be automatically
removed by XMail. The data passed to filter commands inside $(FILE) varies depending
if the command is listed inside '<strong>FILTERS.POST-RCPT.TAB</strong>', '<strong>FILTERS.PRE-DATA.TAB</strong>' or
inside '<strong>FILTERS.POST-DATA.TAB</strong>'. Commands listed inside '<strong>FILTERS.POST-RCPT.TAB</strong>' and
'<strong>FILTERS.PRE-DATA.TAB</strong>' will receive the following data stored inside $(FILE):</p>
<pre>
 Info Data           [ 1th line ]
 SmtpDomain          [ 2nd line ]
 SmtpMessageID       [ 3rd line ]
 MAIL FROM:&lt;...&gt;     [ 4th line ]
 RCPT TO:&lt;...&gt; {...} [ 5th line ]
 ...</pre>
<p>The file can have one or more &quot;RCPT TO&quot; lines. The format of the &quot;Info Data&quot;
line is:</p>
<pre>
 ClientDomain;[ClientIP]:ClientPort;ServerDomain;[ServerIP]:ServerPort;Time;Logo</pre>
<p>Note that in case of '<strong>FILTERS.POST-RCPT.TAB</strong>', the $(FILE) data does not yet contain the
current recipient to be validated. This needs to be fetched and passed to the external program
using the $(CRCPT) macro (or $(RRCPT)).
Commands listed inside '<strong>FILTERS.POST-DATA.TAB</strong>' will receive the following data stored
inside $(FILE):</p>
<pre>
 Info Data           [ 1th line ]
 SmtpDomain          [ 2nd line ]
 SmtpMessageID       [ 3rd line ]
 MAIL FROM:&lt;...&gt;     [ 4th line ]
 RCPT TO:&lt;...&gt; {...} [ 5th line ]
 ...
 &lt;&lt;MAIL-DATA&gt;&gt;
 ...</pre>
<p>After the '<strong>&lt;&lt;MAIL-DATA&gt;&gt;</strong>' tag the message follows. The message is composed
of a headers section and, after the first empty line, the message body. The format of the
RCPT line is:</p>
<pre>
 RCPT TO:&lt;address&gt; {ra=real-address}</pre>
<p>where &quot;real-address&quot; is the &quot;address&quot; after it has been translated (if aliases applies)
to the real local address. Otherwise it holds the same value of &quot;address&quot;.
In case one or more SMTP filter operations are not needed, avoid to create zero sized
files altogether, since this will result in faster processing.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="user_tab_variables">USER.TAB VARIABLES</a></h1>
<p>The following variables are for use in the <a href="#user_tab">USER.TAB</a> configuration file.</p>
<dl>
<dt><strong><a name="realname" class="item">[RealName]</a></strong></dt>

<dd>
<p>Full user name, i.e.:</p>
<pre>
 &quot;RealName&quot;  &quot;Davide Libenzi&quot;</pre>
</dd>
<dt><strong><a name="homepage" class="item">[HomePage]</a></strong></dt>

<dd>
<p>User home page, i.e.:</p>
<pre>
 &quot;HomePage&quot;  &quot;<a href="http://www.xmailserver.org/davide.html&quot">http://www.xmailserver.org/davide.html&quot</a>;</pre>
</dd>
<dt><strong><a name="maxmbsize" class="item">[MaxMBSize]</a></strong></dt>

<dd>
<p>Max user mailbox size in Kb, i.e.:</p>
<pre>
 &quot;MaxMBSize&quot; &quot;30000&quot;</pre>
</dd>
<dt><strong><a name="closedml" class="item">[ClosedML]</a></strong></dt>

<dd>
<p>Specify if the mailing list is closed only to subscribed users, i.e.:</p>
<pre>
 &quot;ClosedML&quot;  &quot;1&quot;</pre>
</dd>
<dt><strong><a name="listsender" class="item">[ListSender]</a></strong></dt>

<dd>
<p>Specify the mailing list sender or administrator:</p>
<pre>
 &quot;ListSender&quot;    &quot;ml-admin@xmailserver.org&quot;</pre>
<p>This variable should be set to avoid delivery error notifications to reach the
original message senders.</p>
</dd>
<dt><strong><a name="smtpperms" class="item">[SmtpPerms]</a></strong></dt>

<dd>
<p>User SMTP permissions (see SMTPAUTH.TAB for info).</p>
</dd>
<dt><strong><a name="receiveenable" class="item">[ReceiveEnable]</a></strong></dt>

<dd>
<p>Set to '1' if the account can receive email, '0' if you want to disable the account from receiving messages.</p>
</dd>
<dt><strong><a name="popenable" class="item">[PopEnable]</a></strong></dt>

<dd>
<p>Set to '1' if you want to enable the account to fetch POP3 messages, '0' otherwise.</p>
</dd>
<dt><strong><a name="usereplyto" class="item">[UseReplyTo]</a></strong></dt>

<dd>
<p>Enable/Disable the emission of the Reply-To: header for mailing list's messages (default 1).</p>
</dd>
<dt><strong><a name="maxmessagesize2" class="item">[MaxMessageSize]</a></strong></dt>

<dd>
<p>Set the maximum message size (in Kb) that the user is able to send through the server.
Overrides the SERVER.TAB variable.</p>
</dd>
<dt><strong><a name="disableemitauthuser2" class="item">[DisableEmitAuthUser]</a></strong></dt>

<dd>
<p>Enable/disable the emission the the 'X-AuthUser:' mail header for authenticated users.
Valid values are '0' or '1', default is '0' (emission enabled). This variable overrides
the SERVER.TAB one when present.</p>
</dd>
<dt><strong><a name="pop3scancur" class="item">[Pop3ScanCur]</a></strong></dt>

<dd>
<p>In case of Maildir mailbox structure, scan the &quot;cur&quot; directory during POP3 message list build.
Set to &quot;0&quot; to disable &quot;cur&quot; directory scanning, or to &quot;1&quot; to enable it.</p>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="mail_routing_through_addresses">MAIL ROUTING THROUGH ADDRESSES</a></h1>
<p>A full implementation of SMTP protocol allows the ability to perform mail routing
bypassing DNS MX records by means of setting, in a ruled way, the 'RCPT TO: &lt;&gt;' request.
A mail from '<strong>xuser&#64;hostz</strong>' directed to
'<strong>&#64;hosta,&#64;hostb:foouser&#64;hostc</strong>' is received
by '<strong>&#64;hosta</strong>' then sent to '<strong>&#64;hostb</strong>' using
'<strong>MAIL FROM: &lt;&#64;hosta:xuser&#64;hostz</strong>&gt;'
and '<strong>RCPT TO: &lt;&#64;hostb:foouser&#64;hostc</strong>&gt;'.
The message is then sent to '<strong>&#64;'hostc</strong> using
'<strong>MAIL FROM: &lt;&#64;hostb,&#64;hosta:xuser&#64;hostz</strong>&gt;'
and '<strong>RCPT TO: &lt;foouser&#64;hostc</strong>&gt;'.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="xmail_spool_design">XMAIL SPOOL DESIGN</a></h1>
<p>The new spool filesystem tree format has been designed to enable XMail to handle very
large queues.
Instead of having a single spool directory (like versions older than 0.61)
a two layer deep splitting has been introduced so that its structure is:</p>
<pre>
 0   &lt;dir&gt;
   0   &lt;dir&gt;
     mess    &lt;dir&gt;
     rsnd    &lt;dir&gt;
     info    &lt;dir&gt;
     temp    &lt;dir&gt;
     slog    &lt;dir&gt;
     cust    &lt;dir&gt;
     froz    &lt;dir&gt;
   ...
 ...</pre>
<p>When XMail needs to create a new spool file a spool path is chosen in a random way and
a new file with the format:</p>
<pre>
 mstime.tid.seq.hostname</pre>
<p>is created inside the '<strong>temp</strong>' subdirectory.
When the spool file is ready to be committed, it's moved into the '<strong>mess</strong>' subdirectory that holds
newer spool files.
If XMail fails sending a new message (the ones in  mess  subdirectory) it creates a log file
(with the same name of the message file) inside the '<strong>slog</strong>' subdirectory and move the file
from '<strong>mess</strong>'  to '<strong>rsnd</strong>'.
During the message sending the message itself is locked by creating a file inside the '<strong>lock</strong>'
subdirectory (with the same name of the message file).
If the message has permanent delivery errors or is expired and if the option '<strong>RemoveSpoolErrors</strong>'
of the '<strong>SERVER.TAB</strong>' file is off, the message file is moved into the '<strong>froz</strong>' subdirectory.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="smtp_gateway_configuration">SMTP GATEWAY CONFIGURATION</a></h1>
<p>An SMTP gateway definition inside XMail can be followed by a set of configuration options,
that are in the form of a comma-separated VAR=VAL or FLAG definitions.
Currently defined options are:</p>
<dl>
<dt><strong><a name="needtls" class="item">NeedTLS</a></strong></dt>

<dd>
<p>If set to 1, instruct XMail to try to establish a TLS session with the remote host
(by the means of a STARTTLS SMTP command). If set to 2, XMail will try to establish a TLS session,
but it will fail if not able to do so (the remote server does not support STARTTLS, or
reject our attempt to negotiate the TLS link).</p>
</dd>
<dt><strong><a name="outbind2" class="item">OutBind</a></strong></dt>

<dd>
<p>Sets the IP address of the network interface that should be used when connecting
to the remote host. This configuration should be used carefully, because XMail
will fail if the selected IP of the interface does not have a route to the remote
host using such IP.</p>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="ssl_configuration">SSL CONFIGURATION</a></h1>
<p>XMail uses to identify itself during SSL negotiations, by the mean of the two files
'<strong>server.cert</strong>' and '<strong>server.key</strong>'. These files '<strong>MUST</strong>' be available inside the
'<strong>MAIL_ROOT</strong>' directory. Both are in PEM format, and one represent the server certificate
file/chain ('<strong>server.cert</strong>') while the other represent the server private key file ('<strong>server.key</strong>').
XMail uses the OpenSSL libraries for its SSL operations. <a href="http://www.openssl.org/docs/HOWTO/certificates.txt">http://www.openssl.org/docs/HOWTO/certificates.txt</a>
contains examples about how to create certificates to be use by XMail, while
<a href="http://www.openssl.org/docs/HOWTO/keys.txt">http://www.openssl.org/docs/HOWTO/keys.txt</a> describes own to generate keys.
In order to properly manage your XMail server when using SSL support, you need to have access
to the OpenSSL binary. For Unix ports, this is available as a package, whose name varies
depending on the distribution. For Windows, pre-built versions of theOpenSSL libraries and binary
are supplied inside the &quot;win32ssl&quot; directory of the XMail source package.
For example, to create a self-signed certificate, you first have to create a private key with:</p>
<pre>
  $ openssl genrsa 2048 &gt; server.key</pre>
<p>After you have created the private key, you can create you own copy of the self-signed
certificate with:</p>
<pre>
  $ openssl req -new -x509 -key server.key -out server.cert</pre>
<pre>
  C:&gt; openssl req -new -x509 -key server.key -out server.cert -config openssl.cnf</pre>
<p>Remeber that the Common Name (CN) that you supply to the OpenSSL binary, is the fully
qualified host name that answers to the IP where your XMail server is listening.
If you want to have a certificate signed by an authority, you need to generate a certificate
request file:</p>
<pre>
  $ openssl req -new -key server.key -out cert.csr
  
  C:&gt; openssl req -new -key server.key -out cert.csr -config openssl.cnf</pre>
<p>The '<strong>openssl.cnf</strong>' file is supplied inside the Xmail's Windows binary package, and
inside the '<strong>win32ssl\conf</strong>' directory of the source package.
The '<strong>cert.csr</strong>' file needs then to be submitted to the certificate authority in order to
obtain a root-signed certificate file (that will be your '<strong>server.cert</strong>').
The behaviour of the XMail SSL module is controlled by a few '<strong>SERVER.TAB</strong>' variables:</p>
<dl>
<dt><strong><a name="sslwantverify2" class="item">[SSLWantVerify]</a></strong></dt>

<dd>
<p>Tells the SSL link negotiation code to verify the remote peer certificate. If this
is enabled, you need to use either <strong>SSLUseCertsFile</strong> or <strong>SSLUseCertsDir</strong> to provide
a set of valid root certificates. You can also add your own certificates in the set,
in order to provide access to your servers by clients using certificates signed by you.</p>
</dd>
<dt><strong><a name="sslwantcert2" class="item">[SSLWantCert]</a></strong></dt>

<dd>
<p>Tells the SSL link negotiation code to fail if the remote peer does not supply
a certificate.</p>
</dd>
<dt><strong><a name="sslallowselfsigned2" class="item">[SSLAllowSelfSigned]</a></strong></dt>

<dd>
<p>Allows self-signed certificates supplied by remote peers.</p>
</dd>
<dt><strong><a name="sslmaxcertsdepth2" class="item">[SSLMaxCertsDepth]</a></strong></dt>

<dd>
<p>Set the maximum certificate chain depth for the verification process.</p>
</dd>
<dt><strong><a name="sslusecertsfile2" class="item">[SSLUseCertsFile]</a></strong></dt>

<dd>
<p>When using <strong>SSLWantVerify</strong>, the SSL code will verify the peer certificate using
standard SSL certificate chain verification rules. It is possible to supply to
XMail an extra list of valid certificates, by filling up a '<strong>CERTS.PEM</strong>' file
and setting <strong>SSLUseCertsFile</strong> to 1. The '<strong>CERTS.PEM</strong>' is a concatenation of
certificates in PEM format.</p>
</dd>
<dt><strong><a name="sslusecertsdir2" class="item">[SSLUseCertsDir]</a></strong></dt>

<dd>
<p>In the same way as <strong>SSLUseCertsFile</strong> does, setting <strong>SSLUseCertsDir</strong> to 1 enables
the usage of extra valid certificates stored inside the '<strong>CERTS</strong>' XMail sub-directory.
The '<strong>CERTS</strong>' contains hashed file names that are created by feeding the directory
path to the '<strong>c_rehash</strong>' OpenSSL Perl script (a Windows-friendly version of '<strong>c_rehash</strong>', named
'<strong>c_rehash.pl</strong>' is contained inside the '<strong>win32ssl\bin</strong>' subdirectory of the source package). 
Unix users will find proper CA certificates inside the standard install paths of OpenSSL,
while Windows users will find them inside the '<strong>win32ssl\certs</strong>' subdirectory of the
source package. To use '<strong>c_rehash</strong>' you need to have the OpenSSL binaries (executable and
shared libraries) correctly installed in your system, and the executable reachable from
your <strong>PATH</strong>. Then you simply run it by passing the path to the PEM certificates directory
('<strong>CERTS</strong>'). The '<strong>c_rehash</strong>' script will call the OpenSSL binary and will generated
hashed file names (that are either symlinks or copies) that point/replicate the mapped
certificate.</p>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="smtp_commands">SMTP COMMANDS</a></h1>
<p>These are commands understood by ESMTP server:</p>
<dl>
<dt><strong><a name="mail_from" class="item">MAIL FROM:&lt;&gt;</a></strong></dt>

<dt><strong><a name="rcpt_to" class="item">RCPT TO:&lt;&gt;</a></strong></dt>

<dt><strong><a name="data" class="item">DATA</a></strong></dt>

<dt><strong><a name="helo" class="item">HELO</a></strong></dt>

<dt><strong><a name="ehlo" class="item">EHLO</a></strong></dt>

<dt><strong><a name="starttls" class="item">STARTTLS</a></strong></dt>

<dt><strong><a name="auth2" class="item">AUTH</a></strong></dt>

<dt><strong><a name="rset" class="item">RSET</a></strong></dt>

<dt><strong><a name="vrfy" class="item">VRFY</a></strong></dt>

<dt><strong><a name="etrn" class="item">ETRN</a></strong></dt>

<dt><strong><a name="noop" class="item">NOOP</a></strong></dt>

<dt><strong><a name="help" class="item">HELP</a></strong></dt>

<dt><strong><a name="quit" class="item">QUIT</a></strong></dt>

</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="pop3_commands">POP3 COMMANDS</a></h1>
<p>These are commands understood by POP3 server:</p>
<dl>
<dt><strong><a name="user3" class="item">USER</a></strong></dt>

<dt><strong><a name="pass2" class="item">PASS</a></strong></dt>

<dt><strong><a name="capa" class="item">CAPA</a></strong></dt>

<dt><strong><a name="stls2" class="item">STLS</a></strong></dt>

<dt><strong><a name="apop2" class="item">APOP</a></strong></dt>

<dt><strong><a name="stat" class="item">STAT</a></strong></dt>

<dt><strong><a name="list" class="item">LIST</a></strong></dt>

<dt><strong><a name="uidl" class="item">UIDL</a></strong></dt>

<dt><strong><a name="quit2" class="item">QUIT</a></strong></dt>

<dt><strong><a name="retr" class="item">RETR</a></strong></dt>

<dt><strong><a name="top" class="item">TOP</a></strong></dt>

<dt><strong><a name="dele" class="item">DELE</a></strong></dt>

<dt><strong><a name="noop2" class="item">NOOP</a></strong></dt>

<dt><strong><a name="last" class="item">LAST</a></strong></dt>

<dt><strong><a name="rset2" class="item">RSET</a></strong></dt>

</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="command_line">COMMAND LINE</a></h1>
<p>Most of XMail configuration settings are command line tunables.
These are command line switches organized by server.</p>
<dl>
<dt><strong><a name="xmail" class="item">[XMAIL]</a></strong></dt>

<dl>
<dt><strong><a name="ms_pathname" class="item">-Ms pathname</a></strong></dt>

<dd>
<p>Mail root path (also settable with MAIL_ROOT environment).</p>
</dd>
<dt><strong><a name="md" class="item">-Md</a></strong></dt>

<dd>
<p>Activate debug (verbose) mode.</p>
</dd>
<dt><strong><a name="mr_hours" class="item">-Mr hours</a></strong></dt>

<dd>
<p>Set log rotate hours step.</p>
</dd>
<dt><strong><a name="mx_split_level" class="item">-Mx split-level</a></strong></dt>

<dd>
<p>Set the queue split level. The value you set here is rounded to the lower
prime number higher or equal than the value you've set.</p>
</dd>
<dt><strong><a name="mr_bytes" class="item">-MR bytes</a></strong></dt>

<dd>
<p>Set the size of the socket's receive buffer in bytes (rounded up to 1024).</p>
</dd>
<dt><strong><a name="ms_bytes" class="item">-MS bytes</a></strong></dt>

<dd>
<p>Set the size of the socket's send buffer in bytes (rounded up to 1024).</p>
</dd>
<dt><strong><a name="mm" class="item">-MM</a></strong></dt>

<dd>
<p>Setup XMail to use 'Maildir' delivery (default on Unix).</p>
</dd>
<dt><strong><a name="mm" class="item">-Mm</a></strong></dt>

<dd>
<p>Setup XMail to use 'mailbox' delivery (default on Windows).</p>
</dd>
<dt><strong><a name="md_ndirs" class="item">-MD ndirs</a></strong></dt>

<dd>
<p>Set the number of subdirectories allocated for the DNS cache files storage ( default 101 ).</p>
</dd>
<dt><strong><a name="m4" class="item">-M4</a></strong></dt>

<dd>
<p>Use only IPV4 records for host name lookups (default).</p>
</dd>
<dt><strong><a name="m6" class="item">-M6</a></strong></dt>

<dd>
<p>Use only IPV6 records for host name lookups.</p>
</dd>
<dt><strong><a name="m5" class="item">-M5</a></strong></dt>

<dd>
<p>Use IPV4 records if present, or IPV6 records otherwise, for host name lookups.</p>
</dd>
<dt><strong><a name="m7" class="item">-M7</a></strong></dt>

<dd>
<p>Use IPV6 records if present, or IPV4 records otherwise, for host name lookups.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="pop3" class="item">[POP3]</a></strong></dt>

<dl>
<dt><strong><a name="p" class="item">-P-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="p6" class="item">-P6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -PI option is specified)</p>
</dd>
<dt><strong><a name="pp_port" class="item">-Pp port</a></strong></dt>

<dd>
<p>Set POP3 server port (if you change this you must know what you're doing).</p>
</dd>
<dt><strong><a name="pt_timeout" class="item">-Pt timeout</a></strong></dt>

<dd>
<p>Set POP3 session timeout (seconds) after which the server closes.
the connection if it does not receive any commands.</p>
</dd>
<dt><strong><a name="pl" class="item">-Pl</a></strong></dt>

<dd>
<p>Enable POP3 logging.</p>
</dd>
<dt><strong><a name="pw_timeout" class="item">-Pw timeout</a></strong></dt>

<dd>
<p>Set the delay timeout in response to a bad POP3 login. Such time is
doubled at the next bad login.</p>
</dd>
<dt><strong><a name="ph" class="item">-Ph</a></strong></dt>

<dd>
<p>Hang the connection in bad login response.</p>
</dd>
<dt><strong><a name="pi_ip_port" class="item">-PI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
<dt><strong><a name="px_nthreads" class="item">-PX nthreads</a></strong></dt>

<dd>
<p>Set the maximum number of threads for POP3 server.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="pop3s2" class="item">[POP3S]</a></strong></dt>

<dl>
<dt><strong><a name="b" class="item">-B-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="b6" class="item">-B6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -BI option is specified)</p>
</dd>
<dt><strong><a name="bp_port" class="item">-Bp port</a></strong></dt>

<dd>
<p>Set POP3S server port (if you change this you must know what you're doing).</p>
</dd>
<dt><strong><a name="bi_ip_port" class="item">-BI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
</dl>
</dd>
<dt><strong><a name="smtp2" class="item">[SMTP]</a></strong></dt>

<dl>
<dt><strong><a name="s4" class="item">-S-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="s6" class="item">-S6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -SI option is specified)</p>
</dd>
<dt><strong><a name="sp_port" class="item">-Sp port</a></strong></dt>

<dd>
<p>Set SMTP server port (if you change this you must know what you're doing).</p>
</dd>
<dt><strong><a name="st_timeout" class="item">-St timeout</a></strong></dt>

<dd>
<p>Set SMTP session timeout (seconds) after which the server closes
the connection if no commands are received.</p>
</dd>
<dt><strong><a name="sl" class="item">-Sl</a></strong></dt>

<dd>
<p>Enable SMTP logging.</p>
</dd>
<dt><strong><a name="si_ip_port" class="item">-SI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
<dt><strong><a name="sx_nthreads" class="item">-SX nthreads</a></strong></dt>

<dd>
<p>Set the maximum number of threads for SMTP server.</p>
</dd>
<dt><strong><a name="sr_maxrcpts" class="item">-Sr maxrcpts</a></strong></dt>

<dd>
<p>Set the maximum number of recipients for a single SMTP message (default 100).</p>
</dd>
<dt><strong><a name="se_nsecs" class="item">-Se nsecs</a></strong></dt>

<dd>
<p>Set the expire timeout for a POP3 authentication IP (default 900).</p>
</dd>
</dl>
</dd>
<dt><strong><a name="smtps" class="item">[SMTPS]</a></strong></dt>

<dl>
<dt><strong><a name="x" class="item">-X-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="x6" class="item">-X6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -XI option is specified)</p>
</dd>
<dt><strong><a name="xp_port" class="item">-Xp port</a></strong></dt>

<dd>
<p>Set SMTPS server port (if you change this you must know what you're doing).</p>
</dd>
<dt><strong><a name="xi_ip_port" class="item">-XI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
</dl>
</dd>
<dt><strong><a name="smail" class="item">[SMAIL]</a></strong></dt>

<dl>
<dt><strong><a name="qn_nthreads_default_16_maximum_256" class="item">-Qn nthreads. Default 16, maximum 256.</a></strong></dt>

<dd>
<p>Set the number of mailer threads.</p>
</dd>
<dt><strong><a name="qt_timeout" class="item">-Qt timeout</a></strong></dt>

<dd>
<p>Set the time to be wait for a next try after send failure. Default 480.</p>
</dd>
<dt><strong><a name="qi_ratio" class="item">-Qi ratio</a></strong></dt>

<dd>
<p>Set the increment ratio of the reschedule time in sending a messages.
At every failure in delivery a message, reschedule time T is incremented
by (T / ratio), therefore :</p>
<pre>
 T(i) = T(i-1) + T(i-1)/ratio.</pre>
<p>If you set this ratio to zero, T remain unchanged over delivery tentatives.
Default 16.</p>
</dd>
<dt><strong><a name="qr_nretries" class="item">-Qr nretries</a></strong></dt>

<dd>
<p>Set the maximum number of times to try to send the message. Default 32.</p>
</dd>
<dt><strong><a name="ql" class="item">-Ql</a></strong></dt>

<dd>
<p>Enable SMAIL logging.</p>
</dd>
<dt><strong><a name="qt_timeout" class="item">-QT timeout</a></strong></dt>

<dd>
<p>Timeout value for filters commands in seconds. Default 90.</p>
</dd>
<dt><strong><a name="qg" class="item">-Qg</a></strong></dt>

<dd>
<p>Enable filter logging.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="psync" class="item">[PSYNC]</a></strong></dt>

<dl>
<dt><strong><a name="y" class="item">-Y-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="yi_interval" class="item">-Yi interval</a></strong></dt>

<dd>
<p>Set external POP3 accounts sync interval. Setting this to zero will disable
the PSYNC task. Default 120.</p>
</dd>
<dt><strong><a name="yt_nthreads" class="item">-Yt nthreads</a></strong></dt>

<dd>
<p>Set the number of POP3 sync threads.</p>
</dd>
<dt><strong><a name="yt_nsec" class="item">-YT nsec</a></strong></dt>

<dd>
<p>Sets the timeout for POP3 client connections.</p>
</dd>
<dt><strong><a name="yl" class="item">-Yl</a></strong></dt>

<dd>
<p>Enable PSYNC logging.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="finger" class="item">[FINGER]</a></strong></dt>

<dl>
<dt><strong><a name="f" class="item">-F-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="f6" class="item">-F6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -FI option is specified)</p>
</dd>
<dt><strong><a name="fp_port" class="item">-Fp port</a></strong></dt>

<dd>
<p>Set FINGER server port (if you change this you must know what you're doing).</p>
</dd>
<dt><strong><a name="fl" class="item">-Fl</a></strong></dt>

<dd>
<p>Enable FINGER logging.</p>
</dd>
<dt><strong><a name="fi_ip_port" class="item">-FI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
</dl>
</dd>
<dt><strong><a name="ctrl" class="item">[CTRL]</a></strong></dt>

<dl>
<dt><strong><a name="c" class="item">-C-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="c6" class="item">-C6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -CI option is specified)</p>
</dd>
<dt><strong><a name="cp_port" class="item">-Cp port</a></strong></dt>

<dd>
<p>Set CTRL server port (if you change this you must know what you're doing).</p>
</dd>
<dt><strong><a name="ct_timeout" class="item">-Ct timeout</a></strong></dt>

<dd>
<p>Set CTRL session timeout (seconds) after which the server closes
the connection if no commands are received.</p>
</dd>
<dt><strong><a name="cl" class="item">-Cl</a></strong></dt>

<dd>
<p>Enable CTRL logging.</p>
</dd>
<dt><strong><a name="ci_ip_port" class="item">-CI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
<dt><strong><a name="cx_nthreads" class="item">-CX nthreads</a></strong></dt>

<dd>
<p>Set the maximum number of threads for CTRL server.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="ctrls" class="item">[CTRLS]</a></strong></dt>

<dl>
<dt><strong><a name="w2" class="item">-W-</a></strong></dt>

<dd>
<p>Disable the service.</p>
</dd>
<dt><strong><a name="w6" class="item">-W6</a></strong></dt>

<dd>
<p>Bind to IPV6 address (in case no -WI option is specified)</p>
</dd>
<dt><strong><a name="wp_port" class="item">-Wp port</a></strong></dt>

<dd>
<p>Set CTRLS server port.</p>
</dd>
<dt><strong><a name="wi_ip_port" class="item">-WI ip[:port]</a></strong></dt>

<dd>
<p>Bind server to the specified ip address and (optional) port (can be multiple).</p>
</dd>
</dl>
</dd>
<dt><strong><a name="lmail" class="item">[LMAIL]</a></strong></dt>

<dl>
<dt><strong><a name="ln_nthreads" class="item">-Ln nthreads</a></strong></dt>

<dd>
<p>Set the number of local mailer threads.</p>
</dd>
<dt><strong><a name="lt_timeout" class="item">-Lt timeout</a></strong></dt>

<dd>
<p>Set the sleep timeout for LMAIL threads (in seconds, default 2).</p>
</dd>
<dt><strong><a name="ll" class="item">-Ll</a></strong></dt>

<dd>
<p>Enable local mail logging.</p>
</dd>
</dl>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="xmail_admin_protocol">XMAIL ADMIN PROTOCOL</a></h1>
<p>It's possible to remote admin XMail due to the existence of a 'controller server'
that runs with XMail and waits for TCP/IP connections on a port (6017 or tunable
via a '-Cp nport') command line option.</p>
<p>Admin protocol details:</p>
<dl>
<dt><strong><a name="description" class="item"><a href="#description">Description</a></a></strong></dt>

<dt><strong><a name="adding_a_user" class="item"><a href="#adding_a_user">Adding a user</a></a></strong></dt>

<dt><strong><a name="deleting_a_user" class="item"><a href="#deleting_a_user">Deleting a user</a></a></strong></dt>

<dt><strong><a name="changing_a_user_s_password" class="item"><a href="#changing_a_user_s_password">Changing a user's password</a></a></strong></dt>

<dt><strong><a name="authenticate_user" class="item"><a href="#authenticate_user">Authenticate user</a></a></strong></dt>

<dt><strong><a name="retrieve_user_statistics" class="item"><a href="#retrieve_user_statistics">Retrieve user statistics</a></a></strong></dt>

<dt><strong><a name="adding_an_alias" class="item"><a href="#adding_an_alias">Adding an alias</a></a></strong></dt>

<dt><strong><a name="deleting_an_alias" class="item"><a href="#deleting_an_alias">Deleting an alias</a></a></strong></dt>

<dt><strong><a name="listing_aliases" class="item"><a href="#listing_aliases">Listing aliases</a></a></strong></dt>

<dt><strong><a name="listing_user_vars" class="item"><a href="#listing_user_vars">Listing user vars</a></a></strong></dt>

<dt><strong><a name="setting_user_vars" class="item"><a href="#setting_user_vars">Setting user vars</a></a></strong></dt>

<dt><strong><a name="listing_users" class="item"><a href="#listing_users">Listing users</a></a></strong></dt>

<dt><strong><a name="getting_mailproc_tab_file" class="item"><a href="#getting_mailproc_tab_file">Getting mailproc.tab file</a></a></strong></dt>

<dt><strong><a name="setting_mailproc_tab_file" class="item"><a href="#setting_mailproc_tab_file">Setting mailproc.tab file</a></a></strong></dt>

<dt><strong><a name="adding_a_mailing_list_user" class="item"><a href="#adding_a_mailing_list_user">Adding a mailing list user</a></a></strong></dt>

<dt><strong><a name="deleting_a_mailing_list_user" class="item"><a href="#deleting_a_mailing_list_user">Deleting a mailing list user</a></a></strong></dt>

<dt><strong><a name="listing_mailing_list_users" class="item"><a href="#listing_mailing_list_users">Listing mailing list users</a></a></strong></dt>

<dt><strong><a name="adding_a_domain" class="item"><a href="#adding_a_domain">Adding a domain</a></a></strong></dt>

<dt><strong><a name="deleting_a_domain" class="item"><a href="#deleting_a_domain">Deleting a domain</a></a></strong></dt>

<dt><strong><a name="listing_handled_domains" class="item"><a href="#listing_handled_domains">Listing handled domains</a></a></strong></dt>

<dt><strong><a name="adding_a_domain_alias" class="item"><a href="#adding_a_domain_alias">Adding a domain alias</a></a></strong></dt>

<dt><strong><a name="deleting_a_domain_alias" class="item"><a href="#deleting_a_domain_alias">Deleting a domain alias</a></a></strong></dt>

<dt><strong><a name="listing_alias_domains" class="item"><a href="#listing_alias_domains">Listing alias domains</a></a></strong></dt>

<dt><strong><a name="getting_custom_domain_file" class="item"><a href="#getting_custom_domain_file">Getting custom domain file</a></a></strong></dt>

<dt><strong><a name="setting_custom_domain_file" class="item"><a href="#setting_custom_domain_file">Setting custom domain file</a></a></strong></dt>

<dt><strong><a name="listing_custom_domains" class="item"><a href="#listing_custom_domains">Listing custom domains</a></a></strong></dt>

<dt><strong><a name="adding_a_pop3_external_link" class="item"><a href="#adding_a_pop3_external_link">Adding a POP3 external link</a></a></strong></dt>

<dt><strong><a name="deleting_a_pop3_external_link" class="item"><a href="#deleting_a_pop3_external_link">Deleting a POP3 external link</a></a></strong></dt>

<dt><strong><a name="listing_pop3_external_links" class="item"><a href="#listing_pop3_external_links">Listing POP3 external links</a></a></strong></dt>

<dt><strong><a name="enabling_a_pop3_external_link" class="item"><a href="#enabling_a_pop3_external_link">Enabling a POP3 external link</a></a></strong></dt>

<dt><strong><a name="listing_files" class="item"><a href="#listing_files">Listing files</a></a></strong></dt>

<dt><strong><a name="getting_configuration_file" class="item"><a href="#getting_configuration_file">Getting configuration file</a></a></strong></dt>

<dt><strong><a name="setting_configuration_file" class="item"><a href="#setting_configuration_file">Setting configuration file</a></a></strong></dt>

<dt><strong><a name="listing_frozen_messages" class="item"><a href="#listing_frozen_messages">Listing frozen messages</a></a></strong></dt>

<dt><strong><a name="rescheduling_frozen_message" class="item"><a href="#rescheduling_frozen_message">Rescheduling frozen message</a></a></strong></dt>

<dt><strong><a name="deleting_frozen_message" class="item"><a href="#deleting_frozen_message">Deleting frozen message</a></a></strong></dt>

<dt><strong><a name="getting_frozen_message_log_file" class="item"><a href="#getting_frozen_message_log_file">Getting frozen message log file</a></a></strong></dt>

<dt><strong><a name="getting_frozen_message" class="item"><a href="#getting_frozen_message">Getting frozen message</a></a></strong></dt>

<dt><strong><a name="starting_a_queue_flush" class="item"><a href="#starting_a_queue_flush">Starting a queue flush</a></a></strong></dt>

<dt><strong><a name="do_nothing_command" class="item"><a href="#do_nothing_command">Do nothing command</a></a></strong></dt>

<dt><strong><a name="quit_the_connection" class="item"><a href="#quit_the_connection">Quit the connection</a></a></strong></dt>

<dt><strong><a name="do_you_want" class="item"><a href="#do_you_want">Do you want...?</a></a></strong></dt>

</dl>
<p>
</p>
<h2><a name="description">Description</a></h2>
<p>The XMail admin server 'speaks' a given protocol that can be used by external GUI
utilities written with the more disparate scripting languages, to remote administer
the mail server.
The protocol is based on sending formatted command and waiting for formatted
server responses and error codes.
All the lines, commands, and responses are delimited by a &lt;CR&gt;&lt;LF&gt; pair.
The error code string (I'll call it RESSTRING) has the given format:</p>
<pre>
 &quot;+DDDDD OK&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>if the command execution is successful while:</p>
<pre>
 &quot;-DDDDD ErrorString&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>if the command failed.</p>
<p>The &quot; character is not included in responses.
DDDDD is a numeric error code while ErrorString is a description of the error.
If DDDDD equals  00100, a lines list, terminated by a line with a single point
(&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;), follows the response.</p>
<p>The input format for commands is similar to the one used in TAB files:</p>
<pre>
 &quot;cmdstring&quot;[TAB]&quot;param1&quot;[TAB]...&quot;paramN&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where 'cmdstring' is the command string identifying the action to be performed,
and param1,... are the parameters of the command.</p>
<p>Immediately after the connection with XMail controller server is established
the client receives a RESSTRING that is:</p>
<pre>
 +00000 &lt;TimeStamp&gt; XMail ...</pre>
<p>if the server is ready, while:</p>
<pre>
 -DDDDD ...</pre>
<p>(where DDDDDD is an error code) if not.</p>
<p>The  TimeStamp  string has the format:</p>
<pre>
 currtime.pid@ipaddress</pre>
<p>and is used in MD5 authentication procedure.</p>
<p>As the first action immediately after the connection the client must send an
authentication string with this format:</p>
<pre>
 &quot;user&quot;[TAB]&quot;password&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where user must be enabled to remote admin XMail. Clear text authentication should not be
used due server security.
Using MD5 authentication instead, the client must perform an MD5 checksum on the
string composed by (&lt;&gt; included):</p>
<pre>
 &lt;TimeStamp&gt;password</pre>
<p>and then send to the server:</p>
<pre>
 &quot;user&quot;[TAB]&quot;#md5chksum&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where  md5chksum  is the MD5 checksum (note '<strong>#</strong>' as first char of sent digest).
The result of the authentication send is a RESSTRING.
If the user does not receive a positive authentication response, the connection is
closed by the server.
It is possible to establish an SSL session with the server by issuing the &quot;#!TLS&quot;
string as login string. In response to that, the server will send back a RESSTRING.
In case of success RESSTRING, the client can proceed with the SSL link negotiation
with the server.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_a_user">Adding a user</a></h2>
<pre>
 &quot;useradd&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;password&quot;[TAB]&quot;usertype&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="domain" class="item">domain</a></strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong><a name="username" class="item">username</a></strong></dt>

<dd>
<p>username to add.</p>
</dd>
<dt><strong><a name="password" class="item">password</a></strong></dt>

<dd>
<p>user password.</p>
</dd>
<dt><strong><a name="usertype" class="item">usertype</a></strong></dt>

<dd>
<p>'U' for normal user and 'M' for mailing list.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_a_user">Deleting a user</a></h2>
<pre>

 &quot;userdel&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username to delete.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="changing_a_user_s_password">Changing a user's password</a></h2>
<pre>
 &quot;userpasswd&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;password&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username (must exist).</p>
</dd>
<dt><strong>password</strong></dt>

<dd>
<p>new password.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="authenticate_user">Authenticate user</a></h2>
<pre>
 &quot;userauth&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;password&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username.</p>
</dd>
<dt><strong>password</strong></dt>

<dd>
<p>password.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="retrieve_user_statistics">Retrieve user statistics</a></h2>
<pre>
 &quot;userstat&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username/alias.</p>
</dd>
</dl>
<p>The result is a RESSTRING.
If successful (00100), a formatted matching users list follows terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
This is the format of the listing:</p>
<pre>
 &quot;variable&quot;[TAB]&quot;value&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>Where valid variables are:</p>
<dl>
<dt><strong><a name="realaddress" class="item">RealAddress</a></strong></dt>

<dd>
<p>real address (maybe different is the supplied username is an alias).</p>
</dd>
<dt><strong><a name="mailboxsize" class="item">MailboxSize</a></strong></dt>

<dd>
<p>total size of the mailbox in bytes.</p>
</dd>
<dt><strong><a name="mailboxmessages" class="item">MailboxMessages</a></strong></dt>

<dd>
<p>total number of messages.</p>
</dd>
<dt><strong><a name="lastloginip" class="item">LastLoginIP</a></strong></dt>

<dd>
<p>last user login IP address.</p>
</dd>
<dt><strong><a name="lastlogintimedate" class="item">LastLoginTimeDate</a></strong></dt>

<dd>
<p>time of the last login.</p>
</dd>
</dl>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_an_alias">Adding an alias</a></h2>
<pre>
 &quot;aliasadd&quot;[TAB]&quot;domain&quot;[TAB]&quot;alias&quot;[TAB]&quot;account&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong><a name="alias" class="item">alias</a></strong></dt>

<dd>
<p>alias to add.</p>
</dd>
<dt><strong><a name="account" class="item">account</a></strong></dt>

<dd>
<p>real email account (locally handled). This can be a fully qualified email address
or a username inside the same domain.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_an_alias">Deleting an alias</a></h2>
<pre>
 &quot;aliasdel&quot;[TAB]&quot;domain&quot;[TAB]&quot;alias&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong>alias</strong></dt>

<dd>
<p>alias to delete.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_aliases">Listing aliases</a></h2>
<pre>
 &quot;aliaslist&quot;[TAB]&quot;domain&quot;[TAB]&quot;alias&quot;[TAB]&quot;account&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;aliaslist&quot;[TAB]&quot;domain&quot;[TAB]&quot;alias&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;aliaslist&quot;[TAB]&quot;domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;aliaslist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name, optional (can contain wild cards).</p>
</dd>
<dt><strong>alias</strong></dt>

<dd>
<p>alias name, optional (can contain wildcards).</p>
</dd>
<dt><strong>account</strong></dt>

<dd>
<p>account, optional (can contain wildcards).</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;aliaslist&quot;[TAB]&quot;foo.bar&quot;[TAB]&quot;*&quot;[TAB]&quot;mickey&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>lists all aliases of user '<strong>mickey</strong>' in domain '<strong>foo.bar</strong>'.</p>
<p>The result is a RESSTRING.
In successful cases (00100) a formatted matching users list follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
This is the format of the listing:</p>
<pre>
 &quot;domain&quot;[TAB]&quot;alias&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_an_external_alias">Adding an external alias</a></h2>
<pre>
 &quot;exaliasadd&quot;[TAB]&quot;local-address&quot;[TAB]&quot;remote-address&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="local_address" class="item">local-address</a></strong></dt>

<dd>
<p>local email address.</p>
</dd>
<dt><strong><a name="remote_address" class="item">remote-address</a></strong></dt>

<dd>
<p>remote email address.</p>
</dd>
</dl>
<p>For example, the following command string:</p>
<pre>
 &quot;exaliasadd&quot;[TAB]&quot;dlibenzi@home.bogus&quot;[TAB]&quot;dlibenzi@xmailserver.org&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>will link the external email address '<strong>dlibenzi&#64;xmailserver.org</strong>' with the
local email address '<strong>dlibenzi&#64;home.bogus</strong>'. The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_an_external_alias">Deleting an external alias</a></h2>
<pre>
 &quot;exaliasdel&quot;[TAB]&quot;remote-address&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="remote_address2" class="item">remote-address</a></strong></dt>

<dd>
<p>remote email address.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_external_aliases">Listing external aliases</a></h2>
<pre>
 &quot;exaliaslist&quot;[TAB]&quot;local-address&quot;[TAB]&quot;remote-address&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;exaliaslist&quot;[TAB]&quot;local-address&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;exaliaslist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="local_address2" class="item">local-address</a></strong></dt>

<dd>
<p>local email address. This can contain wildcard characters.</p>
</dd>
<dt><strong><a name="remote_address3" class="item">remote-address</a></strong></dt>

<dd>
<p>remote email address. This can contain wildcard characters.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;exaliaslist&quot;[TAB]&quot;*@home.bogus&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>lists all the external aliases linked to local accounts in domain '<strong>home.bogus</strong>'.</p>
<p>The result is a RESSTRING.
In successful cases (00100) a formatted matching users list follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
This is the format of the listing:</p>
<pre>
 &quot;rmt-domain&quot;[TAB]&quot;rmt-name&quot;[TAB]&quot;loc-domain&quot;[TAB]&quot;loc-name&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_user_vars">Listing user vars</a></h2>
<pre>
 &quot;uservars&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username.</p>
</dd>
</dl>
<p>The result is a RESSTRING.
In successfully cases (00100) a formatted list of user vars follow, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
This is the format of the listing:</p>
<pre>
 &quot;varname&quot;[TAB]&quot;varvalue&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="setting_user_vars">Setting user vars</a></h2>
<pre>
 &quot;uservarsset&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;varname&quot;[TAB]&quot;varvalue&quot; ... &lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username.</p>
</dd>
<dt><strong><a name="varname" class="item">varname</a></strong></dt>

<dd>
<p>variable name.</p>
</dd>
<dt><strong><a name="varvalue" class="item">varvalue</a></strong></dt>

<dd>
<p>variable value.</p>
</dd>
</dl>
<p>There can be multiple variable assignments with a single call.
If '<strong>varvalue</strong>' is the string '<strong>.|rm</strong>' the variable '<strong>varname</strong>' is deleted.
The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_users">Listing users</a></h2>
<pre>
 &quot;userlist&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;userlist&quot;[TAB]&quot;domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;userlist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name, optional (can contain wild cards).</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username, optional (can contain wild cards).</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;userlist&quot;[TAB]&quot;spacejam.foo&quot;[TAB]&quot;*admin&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>lists all users of domain '<strong>spacejam.foo</strong>' that end with the word '<strong>admin</strong>'.</p>
<p>The result are a RESSTRING.
If successful (00100), a formatted matching users list follows terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
This is the format of the listing:</p>
<pre>
 &quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;password&quot;[TAB]&quot;usertype&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="getting_mailproc_tab_file">Getting mailproc.tab file</a></h2>
<pre>
 &quot;usergetmproc&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;
 
or</pre>
<pre>
 &quot;usergetmproc&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;flags&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username.</p>
</dd>
<dt><strong><a name="flags" class="item">flags</a></strong></dt>

<dd>
<p>flags specifying which mailproc to retrieve. Use 'U' for user mailproc, or 'D'
for domain mailproc (or 'DU' for a merge of both). If not specified, 'DU' is assumed.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;usergetmproc&quot;[TAB]&quot;spacejam.foo&quot;[TAB]&quot;admin&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>gets mailproc.tab file for user '<strong>admin</strong>' in domain '<strong>spacejam.foo</strong>'.</p>
<p>The result is a RESSTRING.
In successful cases (00100) the mailproc.tab file is listed line by line, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="setting_mailproc_tab_file">Setting mailproc.tab file</a></h2>
<pre>
 &quot;usersetmproc&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;&lt;CR&gt;&lt;LF&gt;
 
or</pre>
<pre>
 &quot;usersetmproc&quot;[TAB]&quot;domain&quot;[TAB]&quot;username&quot;[TAB]&quot;which&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
<dt><strong>username</strong></dt>

<dd>
<p>username.</p>
</dd>
<dt><strong><a name="which" class="item">which</a></strong></dt>

<dd>
<p>which mailproc.tab should be set. Use 'U' for the user one, and 'D' for the domain one.
If not specified, 'U' is assumed.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;usersetmproc&quot;[TAB]&quot;spacejam.foo&quot;[TAB]&quot;admin&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>sets mailproc.tab file for user '<strong>admin</strong>' in domain '<strong>spacejam.foo</strong>'.</p>
<p>The result is a RESSTRING.
If successful (00101), the client must list the mailproc.tab file line by line,
ending with a line containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
If a line of the file begins with a dot, another dot must be added at the beginning of the line.
If the file has zero length the mailproc.tab is deleted.
The client then gets another RESSTRING indicating the final command result.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_a_mailing_list_user">Adding a mailing list user</a></h2>
<pre>
 &quot;mluseradd&quot;[TAB]&quot;domain&quot;[TAB]&quot;mlusername&quot;[TAB]&quot;mailaddress&quot;[TAB]&quot;perms&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;mluseradd&quot;[TAB]&quot;domain&quot;[TAB]&quot;mlusername&quot;[TAB]&quot;mailaddress&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong><a name="mlusername" class="item">mlusername</a></strong></dt>

<dd>
<p>mailing list username.</p>
</dd>
<dt><strong><a name="mailaddress" class="item">mailaddress</a></strong></dt>

<dd>
<p>mail address to add to the mailing list 'mlusername&#64;domain'.</p>
</dd>
<dt><strong>perms</strong></dt>

<dd>
<p>user permissions (R or RW or RA).
When '<strong>perms</strong>' is not specified the default is RW.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_a_mailing_list_user">Deleting a mailing list user</a></h2>
<pre>
 &quot;mluserdel&quot;[TAB]&quot;domain&quot;[TAB]&quot;mlusername&quot;[TAB]&quot;mailaddress&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong>mlusername</strong></dt>

<dd>
<p>mailing list username.</p>
</dd>
<dt><strong>mailaddress</strong></dt>

<dd>
<p>mail address to delete from the mailing list 'mlusername&#64;domain'.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_mailing_list_users">Listing mailing list users</a></h2>
<pre>
 &quot;mluserlist&quot;[TAB]&quot;domain&quot;[TAB]&quot;mlusername&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name (must be handled by the server).</p>
</dd>
<dt><strong>mlusername</strong></dt>

<dd>
<p>mailing list username.</p>
</dd>
</dl>
<p>The result is a RESSTRING.
If successful (00100), a formatted list of mailing list users follows terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_a_domain">Adding a domain</a></h2>
<pre>
 &quot;domainadd&quot;[TAB]&quot;domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name to add.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_a_domain">Deleting a domain</a></h2>
<pre>
 &quot;domaindel&quot;[TAB]&quot;domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name to delete.</p>
</dd>
</dl>
<p>The result is a RESSTRING.
This is not always a safe operation.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_handled_domains">Listing handled domains</a></h2>
<pre>
 &quot;domainlist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or:</p>
<pre>
 &quot;domainlist&quot;[TAB]&quot;wildmatch0&quot;[TAB]...[TAB]&quot;wildmatchN&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
The wild match versions simply returns a filtered list of domains.
If successful (00100), a formatted list of handled domains follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_a_domain_alias">Adding a domain alias</a></h2>
<pre>
 &quot;aliasdomainadd&quot;[TAB]&quot;realdomain&quot;[TAB]&quot;aliasdomain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>Example:</p>
<pre>
 &quot;aliasdomainadd&quot;[TAB]&quot;xmailserver.org&quot;[TAB]&quot;xmailserver.com&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>defines '<strong>xmailserver.com</strong>' as an alias of '<strong>xmailserver.org</strong>', or:</p>
<pre>
 &quot;aliasdomainadd&quot;[TAB]&quot;xmailserver.org&quot;[TAB]&quot;*.xmailserver.org&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>defines all subdomains of '<strong>xmailserver.org</strong>' as aliases of '<strong>xmailserver.org</strong>'.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_a_domain_alias">Deleting a domain alias</a></h2>
<pre>
 &quot;aliasdomaindel&quot;[TAB]&quot;aliasdomain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>Example:</p>
<pre>
 &quot;aliasdomaindel&quot;[TAB]&quot;*.xmailserver.org&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>removes the '<strong>*.xmailserver.org</strong>' domain alias.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_alias_domains">Listing alias domains</a></h2>
<pre>
 &quot;aliasdomainlist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or:</p>
<pre>
 &quot;aliasdomainlist&quot;[TAB]&quot;wild-dom-match&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or:</p>
<pre>
 &quot;aliasdomainlist&quot;[TAB]&quot;wild-dom-match&quot;[TAB]&quot;wild-adom-match&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
The wild match version simply returns a filtered list of alias domains.
If successful (00100), a formatted list of alias domains follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;). The output format is:</p>
<pre>
 &quot;real-domain&quot;[TAB]&quot;alias-domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="getting_custom_domain_file">Getting custom domain file</a></h2>
<pre>
 &quot;custdomget&quot;[TAB]&quot;domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;custdomget&quot;[TAB]&quot;spacejam.foo&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>gets the custom domain file for domain '<strong>spacejam.foo</strong>'.</p>
<p>The result is a RESSTRING.
If successful (00100), the custom domain file is listed line by line terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="setting_custom_domain_file">Setting custom domain file</a></h2>
<pre>
 &quot;custdomset&quot;[TAB]&quot;domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>domain</strong></dt>

<dd>
<p>domain name.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;custdomset&quot;[TAB]&quot;spacejam.foo&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>sets custom domain file for domain '<strong>spacejam.foo</strong>'.</p>
<p>The result is a RESSTRING.
If successful (00101), the client must list the custom domain file line by line,
ending with a line containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
If a line of the file begins with a dot, another dot must be added at the begin of the line.
If the file has zero length the custom domain file is deleted.
The client then gets another RESSTRING indicating the final command result.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_custom_domains">Listing custom domains</a></h2>
<pre>
 &quot;custdomlist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
If successful (00100), a formatted list of custom domains follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="adding_a_pop3_external_link">Adding a POP3 external link</a></h2>
<pre>
 &quot;poplnkadd&quot;[TAB]&quot;loc-domain&quot;[TAB]&quot;loc-username&quot;[TAB]&quot;extrn-domain&quot;=&gt;
   [TAB]&quot;extrn-username&quot;[TAB]&quot;extrn-password&quot;[TAB]&quot;authtype&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="loc_domain" class="item">loc-domain</a></strong></dt>

<dd>
<p>local domain name (must be handled by the server).</p>
</dd>
<dt><strong><a name="loc_username" class="item">loc-username</a></strong></dt>

<dd>
<p>local username which receives mails.</p>
</dd>
<dt><strong><a name="extrn_domain" class="item">extrn-domain</a></strong></dt>

<dd>
<p>external domain.</p>
</dd>
<dt><strong><a name="extrn_username" class="item">extrn-username</a></strong></dt>

<dd>
<p>external username.</p>
</dd>
<dt><strong><a name="extrn_password" class="item">extrn-password</a></strong></dt>

<dd>
<p>external user password.</p>
</dd>
<dt><strong><a name="authtype" class="item">authtype</a></strong></dt>

<dd>
<p>authentication method (see [<a href="#pop3links_tab">POP3LINKS.TAB</a>]).</p>
</dd>
</dl>
<p>The remote server must support '<strong>APOP</strong>' authentication to specify APOP as authtype.
Using APOP authentication is more secure because clear usernames and passwords do not
travel on the network; if you're not sure about it, specify '<strong>CLR</strong>' as authtype.</p>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_a_pop3_external_link">Deleting a POP3 external link</a></h2>
<pre>
 &quot;poplnkdel&quot;[TAB]&quot;loc-domain&quot;[TAB]&quot;loc-username&quot;[TAB]&quot;extrn-domain&quot;=&gt;
   [TAB]&quot;extrn-username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="loc_domain2" class="item">loc-domain</a></strong></dt>

<dd>
<p>local domain name (must be handled by the server).</p>
</dd>
<dt><strong><a name="loc_username2" class="item">loc-username</a></strong></dt>

<dd>
<p>local username which receives mails.</p>
</dd>
<dt><strong><a name="extrn_domain2" class="item">extrn-domain</a></strong></dt>

<dd>
<p>external domain.</p>
</dd>
<dt><strong><a name="extrn_username2" class="item">extrn-username</a></strong></dt>

<dd>
<p>external username.</p>
</dd>
</dl>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_pop3_external_links">Listing POP3 external links</a></h2>
<pre>
 &quot;poplnklist&quot;[TAB]&quot;loc-domain&quot;[TAB]&quot;loc-username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;poplnklist&quot;[TAB]&quot;loc-domain&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;poplnklist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
If successful (00100), a formatted list of handled domains follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
The format of the listing is:</p>
<pre>
 &quot;loc-domain&quot;[TAB]&quot;loc-username&quot;[TAB]&quot;extrn-domain&quot;[TAB]&quot;extrn-username&quot;=&gt;
   [TAB]&quot;extrn-password&quot;[TAB]&quot;authtype&quot;[TAB]&quot;on-off&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="enabling_a_pop3_external_link">Enabling a POP3 external link</a></h2>
<pre>
 &quot;poplnkenable&quot;[TAB]&quot;enable&quot;[TAB]&quot;loc-domain&quot;[TAB]&quot;loc-username&quot;=&gt;
   [TAB]&quot;extrn-domain&quot;[TAB]&quot;extrn-username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>or</p>
<pre>
 &quot;poplnkenable&quot;[TAB]&quot;enable&quot;[TAB]&quot;loc-domain&quot;[TAB]&quot;loc-username&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="enable" class="item">enable</a></strong></dt>

<dd>
<p>1 for enabling - 0 for disabling.</p>
</dd>
<dt><strong><a name="loc_domain3" class="item">loc-domain</a></strong></dt>

<dd>
<p>local domain name.</p>
</dd>
<dt><strong><a name="loc_username3" class="item">loc-username</a></strong></dt>

<dd>
<p>local username which receives mails.</p>
</dd>
<dt><strong><a name="extrn_domain3" class="item">extrn-domain</a></strong></dt>

<dd>
<p>external domain.</p>
</dd>
<dt><strong><a name="extrn_username3" class="item">extrn-username</a></strong></dt>

<dd>
<p>external username.</p>
</dd>
</dl>
<p>In the second format all users, links are affected by the enable operation.</p>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_files">Listing files</a></h2>
<pre>
 &quot;filelist&quot;[TAB]&quot;relative-dir-path&quot;[TAB]&quot;match-string&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="relative_dir_path" class="item">relative-dir-path</a></strong></dt>

<dd>
<p>path relative to MAIL_ROOT path.</p>
</dd>
<dt><strong><a name="match_string" class="item">match-string</a></strong></dt>

<dd>
<p>wild card match string for file list selection.</p>
</dd>
</dl>
<p>The result is a RESSTRING.
If successful (00100), the directory is listed line by line, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;). The listing format is:</p>
<p>&quot;filename&quot;[TAB]&quot;filesize&quot;&lt;CR&gt;&lt;LF&gt;</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="getting_configuration_file">Getting configuration file</a></h2>
<pre>
 &quot;cfgfileget&quot;[TAB]&quot;relative-file-path&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="relative_file_path" class="item">relative-file-path</a></strong></dt>

<dd>
<p>path relative to MAIL_ROOT path.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;cfgfileget&quot;[TAB]&quot;ctrlaccounts.tab&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
If successful (00100), the file is listed line by line, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
You CANNOT use this command with indexed files !</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="setting_configuration_file">Setting configuration file</a></h2>
<pre>
 &quot;cfgfileset&quot;[TAB]&quot;relative-file-path&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="relative_file_path2" class="item">relative-file-path</a></strong></dt>

<dd>
<p>path relative to MAIL_ROOT path.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;cfgfileset&quot;[TAB]&quot;ctrlaccounts.tab&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
IF successful (00101), the client must list the configuration file line by line,
ending with a line containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
If a line of the file begins with a dot, another dot must be added at the beginning of the line.
If the file has zero length the configuration file is deleted.
The client then gets another RESSTRING indicating the final command result.
Remember that configuration files have a strict syntax and that pushing a incorrect one
can make XMail not work properly.
You CANNOT use this command with indexed files!</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="listing_frozen_messages">Listing frozen messages</a></h2>
<pre>
 &quot;frozlist&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.
If successful (00100), a formatted list of frozen messages follows, terminated by a line
containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).
The format of the listing is:</p>
<pre>
 &quot;msgfile&quot;[tab]&quot;lev0&quot;[TAB]&quot;lev1&quot;[TAB]&quot;from&quot;[TAB]&quot;to&quot;[TAB]&quot;time&quot;[TAB]&quot;size&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>Where:</p>
<dl>
<dt><strong><a name="msgfile" class="item">msgfile</a></strong></dt>

<dd>
<p>message name or id.</p>
</dd>
<dt><strong><a name="lev0" class="item">lev0</a></strong></dt>

<dd>
<p>queue fs level 0 (first level directory index).</p>
</dd>
<dt><strong><a name="lev1" class="item">lev1</a></strong></dt>

<dd>
<p>queue fs level 1 (second level directory index).</p>
</dd>
<dt><strong><a name="from" class="item">from</a></strong></dt>

<dd>
<p>message sender.</p>
</dd>
<dt><strong><a name="to" class="item">to</a></strong></dt>

<dd>
<p>message destination.</p>
</dd>
<dt><strong><a name="time" class="item">time</a></strong></dt>

<dd>
<p>message time (&quot;YYYY-MM-DD HH:MM:SS&quot;).</p>
</dd>
<dt><strong><a name="size" class="item">size</a></strong></dt>

<dd>
<p>message size in bytes.</p>
</dd>
</dl>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="rescheduling_frozen_message">Rescheduling frozen message</a></h2>
<pre>
 &quot;frozsubmit&quot;[TAB]&quot;lev0&quot;[TAB]&quot;lev1&quot;[TAB]&quot;msgfile&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>msgfile</strong></dt>

<dd>
<p>message name or id.</p>
</dd>
<dt><strong>lev0</strong></dt>

<dd>
<p>queue fs level 0 (first level directory index).</p>
</dd>
<dt><strong>lev1</strong></dt>

<dd>
<p>queue fs level 1 (second level directory index).</p>
</dd>
</dl>
<p>You can get this information from the <a href="#listing_frozen_messages">frozlist</a> command.
After a message has been successfully rescheduled it is deleted from the frozen fs path.
The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="deleting_frozen_message">Deleting frozen message</a></h2>
<pre>
 &quot;frozdel&quot;[TAB]&quot;lev0&quot;[TAB]&quot;lev1&quot;[TAB]&quot;msgfile&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>msgfile</strong></dt>

<dd>
<p>message name or id.</p>
</dd>
<dt><strong>lev0</strong></dt>

<dd>
<p>queue fs level 0 (first level directory index).</p>
</dd>
<dt><strong>lev1</strong></dt>

<dd>
<p>queue fs level 1 (second level directory index).</p>
</dd>
</dl>
<p>You can get this information from the <a href="#listing_frozen_messages">frozlist</a> command.
The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="getting_frozen_message_log_file">Getting frozen message log file</a></h2>
<pre>
 &quot;frozgetlog&quot;[TAB]&quot;lev0&quot;[TAB]&quot;lev1&quot;[TAB]&quot;msgfile&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>msgfile</strong></dt>

<dd>
<p>message name or id.</p>
</dd>
<dt><strong>lev0</strong></dt>

<dd>
<p>queue fs level 0 (first level directory index).</p>
</dd>
<dt><strong>lev1</strong></dt>

<dd>
<p>queue fs level 1 (second level directory index).</p>
</dd>
</dl>
<p>You can get this information from the <a href="#listing_frozen_messages">frozlist</a> command.
The result is a RESSTRING.
If successful (00100), the frozen message log file follows,
terminated by a line containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="getting_frozen_message">Getting frozen message</a></h2>
<pre>
 &quot;frozgetmsg&quot;[TAB]&quot;lev0&quot;[TAB]&quot;lev1&quot;[TAB]&quot;msgfile&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong>msgfile</strong></dt>

<dd>
<p>message name or id.</p>
</dd>
<dt><strong>lev0</strong></dt>

<dd>
<p>queue fs level 0 (first level directory index).</p>
</dd>
<dt><strong>lev1</strong></dt>

<dd>
<p>queue fs level 1 (second level directory index).</p>
</dd>
</dl>
<p>You can get this information from the <a href="#listing_frozen_messages">frozlist</a> command.
The result is a RESSTRING.
If successful (00100), the frozen message file follows,
terminated by a line containing a single dot (&lt;CR&gt;&lt;LF&gt;.&lt;CR&gt;&lt;LF&gt;).</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="starting_a_queue_flush">Starting a queue flush</a></h2>
<pre>
 &quot;etrn&quot;[TAB]&quot;email-match0&quot;...&lt;CR&gt;&lt;LF&gt;</pre>
<p>where:</p>
<dl>
<dt><strong><a name="email_match0" class="item">email-match0</a></strong></dt>

<dd>
<p>wild card email matching for destination address.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 &quot;etrn&quot;  &quot;*@*.mydomain.com&quot;  &quot;your-domain.org&quot;</pre>
<p>starts queueing all messages with a matching destination address.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="do_nothing_command">Do nothing command</a></h2>
<p>&quot;noop&quot;&lt;CR&gt;&lt;LF&gt;</p>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="quit_the_connection">Quit the connection</a></h2>
<pre>
 &quot;quit&quot;&lt;CR&gt;&lt;LF&gt;</pre>
<p>The result is a RESSTRING.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<h2><a name="do_you_want___">Do you want...?</a></h2>
<p>Do you want to build GUI configuration tools using common scripting
languages (Java, TCL/Tk, etc) and XMail controller protocol?
Do you want to build Web configuration tools?
Please let me know &lt;<a href="mailto:davidel@xmailserver.org">davidel@xmailserver.org</a>&gt;.</p>
<p>[<a href="#xmail_admin_protocol">admin protocol</a>] [<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="xmail_local_mailer">XMAIL LOCAL MAILER</a></h1>
<p>XMail has the ability to deliver locally prepared mail files that if finds
in the '<strong>spool/local</strong>' directory.
The format of these files is strict:</p>
<pre>
 mail from:&lt;...&gt;[CR][LF]
 rcpt to:&lt;...&gt;[CR][LF]
 ...
 [CR][LF]
 message text in RFC822 format with [CR][LF] line termination</pre>
<p>All lines must be [CR][LF] terminated, with one mail-from statement, one or more
rcpt-to statements, an empty line and the message text.
Mail files must not be created directly inside the '<strong>/spool/local</strong>' directory but
instead inside '<strong>/spool/temp</strong>' directory.
When the file is prepared it has to be moved into '<strong>/spool/local</strong>'.
The file name format is:</p>
<pre>
 stime-seqnr.pid.hostname</pre>
<p>where:</p>
<dl>
<dt><strong><a name="stime" class="item">stime</a></strong></dt>

<dd>
<p>system time in sec from 01/01/1970.</p>
</dd>
<dt><strong><a name="seqnr" class="item">seqnr</a></strong></dt>

<dd>
<p>sequence number for the current file.</p>
</dd>
<dt><strong><a name="pid" class="item">pid</a></strong></dt>

<dd>
<p>process or thread id.</p>
</dd>
<dt><strong><a name="hostname" class="item">hostname</a></strong></dt>

<dd>
<p>creator process host name.</p>
</dd>
</dl>
<p>Example:</p>
<pre>
 97456928-001.7892.home.bogus</pre>
<p>XMail has a number of LMAIL threads that periodically scan the '<strong>/spool/local</strong>'
directory watching for locally generated mail files.
You can tune this number of threads with the '<strong>-Ln nthreads</strong>' command line option.
The suggested number ranges from three to seven.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="ctrlclnt__xmail_administration_">CtrlClnt (XMAIL ADMINISTRATION)</a></h1>
<p>You can use CtrlClnt to send administration commands to XMail.
These commands are defined in the previous section (<a href="#xmail_admin_protocol">XMAIL ADMIN PROTOCOL</a>).
The syntax of CtrlClnt is:</p>
<pre>
 CtrlClnt  [-snuptfSLcKCXHD]  ...</pre>
<p>where:</p>
<dl>
<dt><strong><a name="s_server" class="item">-s server</a></strong></dt>

<dd>
<p>set server address.</p>
</dd>
<dt><strong><a name="n_port" class="item">-n port</a></strong></dt>

<dd>
<p>set server port [6017].</p>
</dd>
<dt><strong><a name="u_user" class="item">-u user</a></strong></dt>

<dd>
<p>set username.</p>
</dd>
<dt><strong><a name="p_pass" class="item">-p pass</a></strong></dt>

<dd>
<p>set password.</p>
</dd>
<dt><strong><a name="t_timeout" class="item">-t timeout</a></strong></dt>

<dd>
<p>set timeout [60].</p>
</dd>
<dt><strong><a name="f_filename" class="item">-f filename</a></strong></dt>

<dd>
<p>set dump filename [stdout].</p>
</dd>
<dt><strong><a name="s5" class="item">-S</a></strong></dt>

<dd>
<p>enable SSL link negotiation (talks to a CTRL port)</p>
</dd>
<dt><strong><a name="l" class="item">-L</a></strong></dt>

<dd>
<p>use native SSL link (talks to a CTRLS port)</p>
</dd>
<dt><strong><a name="k_filename" class="item">-K filename</a></strong></dt>

<dd>
<p>set the SSL private key file (the environment variable &quot;CTRL_KEY_FILE&quot; also sets it)</p>
</dd>
<dt><strong><a name="c_filename" class="item">-C filename</a></strong></dt>

<dd>
<p>set the SSL certificate file (the environment variable &quot;CTRL_CERT_FILE&quot; also sets it)</p>
</dd>
<dt><strong><a name="x_filename" class="item">-X filename</a></strong></dt>

<dd>
<p>set the SSL certificate-list file (the environment variable &quot;CTRL_CA_FILE&quot; also sets it).
See [<a href="#ssl_configuration">SSL CONFIGURATION</a>] for more information</p>
</dd>
<dt><strong><a name="h_dir" class="item">-H dir</a></strong></dt>

<dd>
<p>set the SSL certificate-store directory (the environment variable &quot;CTRL_CA_PATH&quot; also sets it).
See [<a href="#ssl_configuration">SSL CONFIGURATION</a>] for more information</p>
</dd>
<dt><strong><a name="d" class="item">-D</a></strong></dt>

<dd>
<p>enable debug output</p>
</dd>
</dl>
<p>With the command and parameters that follow adhering to the command syntax, i.e.:</p>
<pre>
 CtrlClnt  -s mail.foo.org -u davide.libenzi -p ciao=&gt;
   useradd home.bogus foouser foopasswd U</pre>
<p>executes the command  useradd  with parameters '<strong>home.bogus foouser foopasswd U</strong>'.</p>
<p>CtrlClnt returns 0 if the command is successful and != 0 if not.
If the command is a query, then the result is printed to  stdout.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="server_shutdown">SERVER SHUTDOWN</a></h1>
<dl>
<dt><strong><a name="linux" class="item">[Linux]</a></strong></dt>

<dd>
<p>Under Linux, XMail creates a file named XMail.pid in '<strong>/var/run</strong>' that contains the PID
of the main XMail thread.
By issuing a:</p>
<pre>
 kill -INT `cat /var/run/XMail.pid`</pre>
<p>a system administrator can initiate the shutdown process (this can take several seconds).
You can use the supplied '<strong>xmail</strong>' startup script to start / stop / restart XMail:</p>
<pre>
 xmail start / stop / restart</pre>
</dd>
<dt><strong><a name="nt_as_console_service" class="item">[NT as console service]</a></strong></dt>

<dd>
<p>Under NT console service (XMail --debug ...) you can hit Ctrl-C to initiate the
shutdown process.</p>
</dd>
<dt><strong><a name="nt_as_service" class="item">[NT as service]</a></strong></dt>

<dd>
<p>Using [Control Panel]-&gt;[Services] you can start and stop XMail as you wish.</p>
</dd>
<dt><strong><a name="all" class="item">[All]</a></strong></dt>

<dd>
<p>XMail detects a shutdown condition by checking the presence of a file named
'<strong>.shutdown</strong>' in its main directory (MAIL_ROOT).
You can initiate XMail shutdown process by creating (or copying) a file
with that name into MAIL_ROOT.</p>
</dd>
</dl>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="mkusers">MkUsers</a></h1>
<p>This command line utility enables you to create the user accounts structure by giving
it a formatted list of users parameters (or a formatted text file).
The syntax of the list (or file) is:</p>
<pre>
 domain;username;password;real-name;homepage[NEWLINE]</pre>
<p>where a line whose first character is '<strong>#</strong>' is treated as a comment.
This utility can also be used to create a random number users (useful for me
to test server performance).</p>
<p>These are MkUsers command line parameters:</p>
<dl>
<dt><strong><a name="a_numusers" class="item">-a numusers</a></strong></dt>

<dd>
<p>number of users to create in auto-mode.</p>
</dd>
<dt><strong><a name="d_domain" class="item">-d domain</a></strong></dt>

<dd>
<p>domain name in auto-mode.</p>
</dd>
<dt><strong><a name="f_inputfile" class="item">-f inputFile</a></strong></dt>

<dd>
<p>input file name {stdin}.</p>
</dd>
<dt><strong><a name="u_username" class="item">-u username</a></strong></dt>

<dd>
<p>radix user name in auto-mode.</p>
</dd>
<dt><strong><a name="r_rootdir" class="item">-r rootdir</a></strong></dt>

<dd>
<p>mail root path {./}.</p>
</dd>
<dt><strong><a name="s_mboxsize" class="item">-s mboxsize</a></strong></dt>

<dd>
<p>mailbox maximum size {10000}.</p>
</dd>
<dt><strong><a name="i_useridbase" class="item">-i useridbase</a></strong></dt>

<dd>
<p>base user id {1};</p>
</dd>
<dt><strong><a name="m" class="item">-m</a></strong></dt>

<dd>
<p>create Maildir boxes.</p>
</dd>
<dt><strong><a name="h" class="item">-h</a></strong></dt>

<dd>
<p>show this message.</p>
</dd>
</dl>
<p>MkUsers creates, under the specified root directory, the given structure:</p>
<pre>
 rootdir            &lt;dir&gt;
   mailusers.tab    &lt;file&gt;
   domains          &lt;dir&gt;
     domainXXX      &lt;dir&gt;
       userXXX      &lt;dir&gt;
         user.tab   &lt;file&gt;
         mailbox    &lt;dir&gt;
       ...
    ...</pre>
<p>for the mailbox structure, while:</p>
<pre>
 rootdir            &lt;dir&gt;
   mailusers.tab    &lt;file&gt;
   domains          &lt;dir&gt;
     domainXXX      &lt;dir&gt;
       userXXX      &lt;dir&gt;
         user.tab   &lt;file&gt;
         Maildir    &lt;dir&gt;
           tmp      &lt;dir&gt;
           new      &lt;dir&gt;
           cur      &lt;dir&gt;
       ...
     ...</pre>
<p>for the Maildir structure.</p>
<p>If the file '<strong>mailusers.tab</strong>' already exist in the mail root path, MkUsers exits without
overwriting the existing copy.
This protect you from accidentally overwriting your file when playing inside
the real MAIL_ROOT directory.
If you want to setup the root directory (-r ...) as MAIL_ROOT, you must delete
by hand the existing file (you must know what you're doing).
If you setup the root directory (-r ...) as MAIL_ROOT you MUST have XMail stopped
before running MkUsers.
Existing files and directories are not overwritten by MkUsers so you can keep
your users db in the formatted text file (or generate it by a database dump for example)
and run MkUsers to create the structure.
Remember that you have to add new domains in the '<strong>domains.tab</strong>' file by hand.
MkUsers is intended as a bulk-mode utility, not to create single user; for this
CtrlClnt (or other GUI/Web configuration utilities) is better suited.</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="sendmail">sendmail</a></h1>
<p>When building XMail, an executable called '<strong>sendmail</strong>' is created.
This is a replacement of the sendmail program used mostly on Unix systems;
it uses the local mail delivery
of XMail to send email generated onto the server machine.
These sendmail options are supported (other options are simply ignored):</p>
<dl>
<dt><strong><a name="f_mail_from" class="item">-f{mail from}</a></strong></dt>

<dd>
<p>Set the sender of the email.</p>
</dd>
<dt><strong><a name="f_ext_mail_from" class="item">-F{ext mail from}</a></strong></dt>

<dd>
<p>Set the extended sender of the email.</p>
</dd>
<dt><strong><a name="t" class="item">-t</a></strong></dt>

<dd>
<p>Extract recipients from the 'To:'/'Cc:'/'Bcc:' header tags.</p>
</dd>
<dt><strong><a name="i" class="item">-i</a></strong></dt>

<dd>
<p>Read the input until the End Of Stream, instead of stopping at the &quot;\n.\n&quot;
sequence.</p>
</dd>
</dl>
<p>The syntax is:</p>
<pre>
 sendmail [-t] [-f...] [-F...] [--input-file fname] [--xinput-file fname]=&gt;
   [--rcpt-file fname] [--] recipient ...</pre>
<p>The message content is read from the standard input and must be RFC compliant.</p>
<p>The following parameters are XMail extensions meant to be used with mailing lists managers (using
sendmail as a mail list exploder):</p>
<dl>
<dt><strong><a name="input_file_fname" class="item">--input-file fname</a></strong></dt>

<dd>
<p>take the message from the specified file instead from stdin (RFC format).</p>
</dd>
<dt><strong><a name="xinput_file_fname" class="item">--xinput-file fname</a></strong></dt>

<dd>
<p>take the message from the specified file instead from stdin (XMail format).</p>
</dd>
<dt><strong><a name="rcpt_file_fname" class="item">--rcpt-file fname</a></strong></dt>

<dd>
<p>add recipients listed inside the specified file (list exploder).</p>
</dd>
</dl>
<p>To be RFC compliant means that the message MUST have the format:</p>
<pre>
 [Headers]
 NewLine
 Body</pre>
<p>Suppose you have your message in the file 'msg.txt', you're 'xmailuser&#64;smartdomain', and
you want to send the message to 'user1&#64;dom1' and 'user2&#64;dom2'. The syntax is:</p>
<pre>
 sendmail -fxmailuser@smartdomain user1@dom1 user2@dom2 &lt; msg.txt</pre>
<p>or</p>
<pre>
 sendmail -fxmailuser@smartdomain --input-file msg.txt user1@dom1 user2@dom2</pre>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="miscellaneous">MISCELLANEOUS</a></h1>
<ol>
<li>
<p>To handle multiple POP3 domains, the server makes a reverse lookup of the IP address
upon which it receives the connection.
Suppose the reverse lookup results in '<strong>xxxx.yyyy.zzzz</strong>'. XMail checks if
'<strong>xxxx.yyyy.zzzz</strong>' is handled, then it checks '<strong>yyyy.zzzz</strong>',  and then '<strong>zzzz</strong>'.
The first resolved (in the given order) is the POP3 domain.
To avoid the above behavior, it's sufficient that the POP3 client supply the entire
email address as POP3 login username:</p>
<pre>
 foo@foodomain.net   ==&gt; foo@foodomain.net</pre>
<p>and not:</p>
<pre>
 foo@foodomain.net   ==&gt; foo</pre>
<p>This enables XMail to handle multiple domains in cases where more nic-names are mapped
over a single IP address.</p>
<p>To run finger queries you must specify:</p>
<pre>
 foo@foodomain.net@foodomain.net</pre>
<p>or as general rule:</p>
<pre>
 username@pop3domain@hostname</pre>
<p>You can use the optional configuration variable '<strong>POP3Domain</strong>'
(see <a href="#server_tab_variables">SERVER.TAB VARIABLES</a> above) 
to set the default
domain for POP3 clients connections.
This means that users of '<strong>POP3Domain</strong>' can use only the name part of their email address
as POP3 login, while users of other hosted domains must use their entire email as
POP3 login.</p>
</li>
<li>
<p>Important!</p>
<ul>
<li>
<p>'<strong>REMEMBER TO REMOVE THE EXAMPLE ACCOUNT FROM CTRLACCOUNTS.TAB FILE!</strong>'</p>
</li>
<li>
<p>Use ctrl.ipmap.tab to restrict CTRL server access.</p>
</li>
<li>
<p>Use a long password (mixed upper/lower case with digits) for ctrlaccounts.tab.</p>
</li>
</ul>
</li>
<li>
<p>The main cause of bugs with XMail is due a bad line termination of configuration
files, so check that these files being correctly line terminated for your OS.
Linux uses the standard &lt;CR&gt; while M$ uses &lt;CR&gt;&lt;LF&gt;.</p>
</li>
<li>
<p>If you get a bind error in Linux,you must comment pop3, smtp and finger entries
in your /etc/inetd.conf.</p>
</li>
<li>
<p>Remember to compile the file CTRL.IPMAP.TAB to restrict the access to the IPs you
use to remote administer XMail server.</p>
</li>
<li>
<p>If you have an heavily loaded server remember to setup the best number of XMAIL threads
by specifying the '<strong>-Qn nthreads</strong>' option (you must do some tentatives to find the best
value for your needs).
Also you can limit the number of SMTP, POP3 and CTRL service threads by specifying
the options '<strong>-SX maxthreads</strong>', '<strong>-PX maxthreads</strong>' and '<strong>-CX maxthreads</strong>'.</p>
</li>
<li>
<p>If you have enabled logging, remember to setup the '<strong>-Mr hours</strong>' option depending on the
traffic you get in your server.
This avoids XMail having to work with very large log files and can improve server performance.</p>
</li>
<li>
<p>If you are unable to start XMail (even if you followed this document's instructions), check
the MailRoot directory with the one listed above.
More than one unzipper does not restore empty directories by default.</p>
</li>
</ol>
<p>Please report XMail errors and errors in this document.
If you successfully build and run XMail please let me know at <a href="mailto:davidel@xmailserver.org,">davidel@xmailserver.org,</a>
I don't want money ;)</p>
<p>[<a href="#__index__">top</a>]</p>
<p>
</p>
<hr />
<h1><a name="thanks">THANKS</a></h1>
<p>My mother Adelisa, for giving me the light.</p>
<p>My cat Grace, for her patience waiting for food while I'm coding.</p>
<p>All of the free source community, for giving me code and knowledge.</p>
<p>[<a href="#__index__">top</a>]</p>

</body>

</html>