~ubuntu-branches/debian/squeeze/xmail/squeeze

« back to all changes in this revision

Viewing changes to docs/Readme.txt

  • Committer: Bazaar Package Importer
  • Author(s): Radu Spineanu
  • Date: 2007-02-16 12:16:16 UTC
  • mfrom: (3.1.2 feisty)
  • Revision ID: james.westby@ubuntu.com-20070216121616-c1eczdj65j5pp2mh
Tags: 1.22-5
Updated Czech debconf translation. (closes: #408660)
Thanks to Miroslav Kure.

Show diffs side-by-side

added added

removed removed

Lines of Context:
69
69
 
70
70
  current
71
71
 
72
 
    1.20
 
72
    1.22
73
73
 
74
74
  release type
75
75
 
77
77
 
78
78
  release date
79
79
 
80
 
    05-30-2004
 
80
    Oct 12, 2005
81
81
 
82
82
  project by
83
83
 
1202
1202
        used with 'external' command but in this case it's external program
1203
1203
        responsibility to delete the temporary file. Do not use it with
1204
1204
        'filter' commands since the filter will have no way to modify the
1205
 
        real spool file.
 
1205
        real spool file
 
1206
 
 
1207
    @@USERAUTH
 
1208
        name of the SMTP authenticated user, or "-" if no authentication has
 
1209
        been supplied
1206
1210
 
1207
1211
    Supported commands:
1208
1212
 
1558
1562
    @@TMPFILE
1559
1563
        creates a copy of the message file to a temporary one. It can be
1560
1564
        used with 'external' command but in this case it's external
1561
 
        program's responsibility to delete the temporary file.
 
1565
        program's responsibility to delete the temporary file
 
1566
 
 
1567
    @@USERAUTH
 
1568
        name of the SMTP authenticated user, or "-" if no authentication has
 
1569
        been supplied
1562
1570
 
1563
1571
    Supported commands:
1564
1572
 
1773
1781
        Enable null sender ('MAIL FROM:<>') messages to be accepted by
1774
1782
        XMail.
1775
1783
 
 
1784
    [NoSenderBounce]
 
1785
        When building bounce messages, use the null SMTP sender ('MAIL
 
1786
        FROM:<>') instead of the 'PostMaster' address. This will affect only
 
1787
        the SMTP sender, while the message RFC822 headers will still contain
 
1788
        the correct From: header.
 
1789
 
1776
1790
    [MaxMTAOps]
1777
1791
        Set the maximum number of MTA relay steps before to declare the
1778
1792
        message as looped (default 16).
1808
1822
        The string "+X-Deliver-To,To,Cc" is the default if nothing is
1809
1823
        specified.
1810
1824
 
 
1825
    [SMTP-MaxErrors]
 
1826
        Set the maximum number of errors allowed in a single SMTP session.
 
1827
        When the maximum number of allowed errors is exceeded, the
 
1828
        connection will be automatically dropped. If such variable is not
 
1829
        set, or it is set to zero, the maximum number of errors will be
 
1830
        unlimited.
 
1831
 
1811
1832
    [SmtpMsgIPBanSpammers]
1812
1833
        Used to set the message that is sent to the SMTP client when the
1813
1834
        client IP is listed inside the file SPAMMER.TAB.
1902
1923
         dns.home.bogus.net:tcp,192.168.1.1:udp,...
1903
1924
 
1904
1925
    [DisableEmitAuthUser]
1905
 
        Enable/disable the emission the the 'X-Auth-User:' mail header for
 
1926
        Enable/disable the emission the the 'X-AuthUser:' mail header for
1906
1927
        authenticated users. Valid values are "0" or '1', default is "0"
1907
1928
        (emission enabled).
1908
1929
 
2017
2038
 
2018
2039
     "command"[TAB]"arg-or-macro"[TAB]...[NEWLINE]
2019
2040
 
 
2041
    or:
 
2042
 
 
2043
     "!flags"[TAB]"command"[TAB]"arg-or-macro"[TAB]...[NEWLINE]
 
2044
 
2020
2045
    Each file may contain multiple commands, that will be executed in
2021
2046
    strictly sequential order. The first command that will trigger a
2022
 
    rejection code will make the filtering process to end. Each argument can
2023
 
    be a macro also:
 
2047
    rejection code will make the filtering process to end. The 'flags'
 
2048
    parameter is a comma-separated list of flags that drives the filter
 
2049
    execution. The syntax of each flag is either FLAG or FLAG=VAL. Currently
 
2050
    supported flags are:
 
2051
 
 
2052
    aex exclude filter execution in case of authenticated sender
 
2053
 
 
2054
    Each argument can be a macro also:
2024
2055
 
2025
2056
    @@FROM
2026
2057
        the sender of the message
2052
2083
    @@MSGREF
2053
2084
        the reference SMTP message id
2054
2085
 
 
2086
    @@USERAUTH
 
2087
        name of the SMTP authenticated user, or "-" if no authentication has
 
2088
        been supplied
 
2089
 
2055
2090
    Here 'command' is the name of an external program that processes the
2056
2091
    message and returns its processing result. If it returns '6' the message
2057
2092
    is rejected and a notification message is sent to the sender. By
2114
2149
 
2115
2150
     "command"[TAB]"arg-or-macro"[TAB]...[NEWLINE]
2116
2151
 
 
2152
    or:
 
2153
 
 
2154
     "!flags"[TAB]"command"[TAB]"arg-or-macro"[TAB]...[NEWLINE]
 
2155
 
2117
2156
    Each file may contain multiple commands, that will be executed in
2118
2157
    strictly sequential order. The first command that will trigger a
2119
 
    rejection code will make the filtering process to end. Each argument can
2120
 
    be a macro also:
 
2158
    rejection code will make the filtering process to end. The 'flags'
 
2159
    parameter is a comma-separated list of flags that drives the filter
 
2160
    execution. The syntax of each flag is either FLAG or FLAG=VAL. Currently
 
2161
    supported flags are:
 
2162
 
 
2163
    aex exclude filter execution in case of authenticated sender
 
2164
 
 
2165
    Each argument can be a macro also:
2121
2166
 
2122
2167
    @@FILE
2123
2168
        message file path
2124
2169
 
2125
2170
    @@USERAUTH
2126
 
        name of the SMTP authenticated user, or "-" if not authentication
2127
 
        has been granted
 
2171
        name of the SMTP authenticated user, or "-" if no authentication has
 
2172
        been supplied
2128
2173
 
2129
2174
    @@REMOTEADDR
2130
2175
        remote IP address and port of the sender
2248
2293
        through the server. Overrides the SERVER.TAB variable.
2249
2294
 
2250
2295
    [DisableEmitAuthUser]
2251
 
        Enable/disable the emission the the 'X-Auth-User:' mail header for
 
2296
        Enable/disable the emission the the 'X-AuthUser:' mail header for
2252
2297
        authenticated users. Valid values are '0' or '1', default is '0'
2253
2298
        (emission enabled). This variable overrides the SERVER.TAB one when
2254
2299
        present.
2459
2504
        -QT timeout
2460
2505
                Timeout value for filters commands in seconds. Default 90.
2461
2506
 
 
2507
        -Qg     Enable filter logging.
 
2508
 
2462
2509
    [PSYNC]
2463
2510
 
2464
2511
        -Yi interval
2744
2791
    LastLoginIP
2745
2792
        last user login IP address.
2746
2793
 
 
2794
    LastLoginTimeDate
 
2795
        time of the last login.
 
2796
 
2747
2797
    [admin protocol] [top]
2748
2798
 
2749
2799
  Adding an alias
2823
2873
 
2824
2874
    [admin protocol] [top]
2825
2875
 
 
2876
  Adding an external alias
 
2877
 
 
2878
     "exaliasadd"[TAB]"local-address"[TAB]"remote-address"<CR><LF>
 
2879
 
 
2880
    where:
 
2881
 
 
2882
    local-address
 
2883
        local email address.
 
2884
 
 
2885
    remote-address
 
2886
        remote email address.
 
2887
 
 
2888
    For example, the following command string:
 
2889
 
 
2890
     "exaliasadd"[TAB]"dlibenzi@home.bogus"[TAB]"dlibenzi@xmailserver.org"<CR><LF>
 
2891
 
 
2892
    will link the external email address 'dlibenzi@xmailserver.org' with the
 
2893
    local email address 'dlibenzi@home.bogus'. The result is a RESSTRING.
 
2894
 
 
2895
    [admin protocol] [top]
 
2896
 
 
2897
  Deleting an external alias
 
2898
 
 
2899
     "exaliasdel"[TAB]"remote-address"<CR><LF>
 
2900
 
 
2901
    where:
 
2902
 
 
2903
    remote-address
 
2904
        remote email address.
 
2905
 
 
2906
    The result is a RESSTRING.
 
2907
 
 
2908
    [admin protocol] [top]
 
2909
 
 
2910
  Listing external aliases
 
2911
 
 
2912
     "exaliaslist"[TAB]"local-address"[TAB]"remote-address"<CR><LF>
 
2913
 
 
2914
    or
 
2915
 
 
2916
     "exaliaslist"[TAB]"local-address"<CR><LF>
 
2917
 
 
2918
    or
 
2919
 
 
2920
     "exaliaslist"<CR><LF>
 
2921
 
 
2922
    where:
 
2923
 
 
2924
    local-address
 
2925
        local email address. This can contain wildcard characters.
 
2926
 
 
2927
    remote-address
 
2928
        remote email address. This can contain wildcard characters.
 
2929
 
 
2930
    Example:
 
2931
 
 
2932
     "exaliaslist"[TAB]"*@home.bogus"<CR><LF>
 
2933
 
 
2934
    lists all the external aliases linked to local accounts in domain
 
2935
    'home.bogus'.
 
2936
 
 
2937
    The result is a RESSTRING. In successful cases (00100) a formatted
 
2938
    matching users list follows, terminated by a line containing a single
 
2939
    dot (<CR><LF>.<CR><LF>). This is the format of the listing:
 
2940
 
 
2941
     "rmt-domain"[TAB]"rmt-name"[TAB]"loc-domain"[TAB]"loc-name"<CR><LF>
 
2942
 
 
2943
    [admin protocol] [top]
 
2944
 
2826
2945
  Listing user vars
2827
2946
 
2828
2947
     "uservars"[TAB]"domain"[TAB]"username"<CR><LF>
3713
3832
 
3714
3833
    -t  Extract recipients from the 'To:'/'Cc:'/'Bcc:' header tags.
3715
3834
 
 
3835
    -i  Read the input until the End Of Stream, instead of stopping at the
 
3836
        "\n.\n" sequence.
 
3837
 
3716
3838
    The syntax is:
3717
3839
 
3718
3840
     sendmail [-t] [-f...] [-F...] [--input-file fname] [--xinput-file fname]=>