Imported Debian patch 4.84-8
[hcoop/debian/exim4.git] / debian / manpages / exim_checkaccess.8
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH EXIM_CHECKACCESS 8 "March 26, 2003"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .\" \(oqthis text is enclosed in single quotes\(cq
19 .\" \(lqthis text is enclosed in double quotes\(rq
20 .SH NAME
21 exim_checkaccess \- Check address acceptance from given IP
22 .SH SYNOPSIS
23 .B exim_checkaccess
24 .I IP-address email@address [more Exim options]
25
26 .SH DESCRIPTION
27 .B Exim's
28 .I \-bh
29 command line argument allows you to run a fake SMTP session with debugging
30 output, in order to check what Exim is doing when it is applying policy
31 controls to incoming SMTP mail.
32 However, not everybody is sufficiently familiar with the SMTP protocol to
33 be able to make full use of \-bh, and sometimes you just want to answer the
34 question \(lqDoes this address have access?\(rq without bothering with any
35 further details.
36
37 The
38 .B exim_checkaccess
39 utility is a \(oqpackaged\(cq version of
40 .I \-bh.
41 It takes two arguments, an IP address and an email address:
42
43 exim_checkaccess 10.9.8.7 A.User@a.domain.example
44
45 The utility runs a call to
46 .B Exim
47 with the \-bh option, to test whether the given email address would be
48 accepted in a RCPT command in a TCP/IP connection from the host with the
49 given IP address.
50 The output of the utility is either the word \(oqaccepted\(cq, or the SMTP error
51 response, for example:
52
53 Rejected:
54 550 Relay not permitted
55
56 When running this test, the utility uses \(lq<>\(rq as the envelope sender
57 address for the MAIL command, but you can change this by providing additional
58 options. These are passed directly to the Exim command.
59 For example, to specify that the test is to be run with the sender address
60 \(lqhimself@there.example\(rq you can use:
61
62 exim_checkaccess 10.9.8.7 A.User@a.domain.example \\
63 \-f himself@there.example
64
65 Note that these additional Exim command line items must be given after the
66 two mandatory arguments.
67
68 .SH BUGS
69 This manual page needs a major re-work. If somebody knows better groff
70 than us and has more experience in writing manual pages, any patches
71 would be greatly appreciated.
72
73 .SH SEE ALSO
74 .BR exim (8),
75 /usr/share/doc/exim4\-base/
76
77 .SH AUTHOR
78 This manual page was stitched together from spec.txt by
79 Andreas Metzler <ametzler at downhill.at.eu.org>,
80 for the Debian GNU/Linux system (but may be used by others).