]> diplodocus.org Git - nmh/blob - man/whom.man
Simplified m_strn() per Ralph's suggestions.
[nmh] / man / whom.man
1 .TH WHOM %manext1% 2016-09-23 "%nmhversion%"
2 .
3 .\" %nmhwarning%
4 .
5 .SH NAME
6 whom \- report to whom an nmh message would go
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B whom
11 .RB [ \-help ]
12 .RB [ \-version ]
13 .RB [ \-alias
14 .IR aliasfile ]
15 .RB [ \-check " | " \-nocheck ]
16 .RB [ \-draftfolder
17 .IR +folder ]
18 .RB [ \-draftmessage
19 .IR msg ]
20 .RB [ \-nodraftfolder ]
21 .RB [ \-mts
22 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
23 .RB [ \-server
24 .IR servername ]
25 .RB [ \-port
26 .IR port-name/number ]
27 .RB [ \-sasl ]
28 .RB [ \-saslmech
29 .IR mechanism ]
30 .RB [ \-snoop ]
31 .RB [ \-user
32 .IR username ]
33 .RB [ \-tls ]
34 .RB [ \-initialtls ]
35 .RB [ \-notls ]
36 .RI [ file ]
37 .RB [ \-draft ]
38 .ad
39 .SH DESCRIPTION
40 .B whom
41 is used to expand the headers of a message into a set of
42 addresses and optionally verify that those addresses are deliverable at
43 that time (if
44 .B \-check
45 is given).
46 .PP
47 The
48 .B \-draftfolder
49 .I +folder
50 and
51 .B \-draftmessage
52 .I msg
53 switches invoke
54 the
55 .B nmh
56 draft folder facility. This is an advanced (and highly
57 useful) feature. Consult the
58 .IR mh-draft (5)
59 man page for more information.
60 .PP
61 The mail transport system default is provided in
62 .I %nmhetcdir%/mts.conf
63 but can be overridden here with the
64 .B \-mts
65 switch.
66 .PP
67 If nmh is using the SMTP MTA, the
68 .B \-server
69 and the
70 .B \-port
71 switches can be used to override the default mail server (defined by the
72 .I %nmhetcdir%/mts.conf
73 .RI servers
74 entry). The
75 .B \-snoop
76 switch can be used to view the SMTP transaction. (Beware that the
77 SMTP transaction may contain authentication information either in
78 plaintext or easily decoded base64.)
79 .PP
80 If
81 .B nmh
82 has been compiled with SASL support, the
83 .B \-sasl
84 switch will enable
85 the use of SASL authentication with the SMTP MTA. Depending on the
86 SASL mechanism used, this may require an additional password prompt from the
87 user (but the
88 .I netrc
89 file can be used to store this password, as described in the
90 mh-profile(5) man page). The
91 .B \-saslmech
92 switch can be used to select a particular SASL mechanism,
93 and the
94 .B \-user
95 switch can be used to select a authorization userid to provide to SASL
96 other than the default. The credentials profile entry in the
97 mh\-profile(5) man page describes the ways to supply a username and
98 password.
99 .PP
100 If SASL authentication is successful,
101 .BR nmh
102 will attempt to negotiate a security layer for session encryption.
103 Encrypted data is labelled with `(encrypted)' and `(decrypted)' when
104 viewing the SMTP transaction with the
105 .B \-snoop
106 switch; see the
107 .B post
108 man page description of
109 .B \-snoop
110 for its other features.
111 .PP
112 If
113 .B nmh
114 has been compiled with TLS support, the
115 .BR \-tls ,
116 .BR \-initialtls ,
117 and
118 .B \-notls
119 switches will require and disable the negotiation of TLS support when connecting to the
120 SMTP MTA. Encrypted data is labelled with `(tls-encrypted)' and
121 `(tls-decrypted)' when viewing the SMTP transaction with the
122 .B \-snoop
123 switch; see the
124 .B post
125 man page description of
126 .B \-snoop
127 and the TLS flags for more details.
128 .PP
129 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
130 additional alias files given by the
131 .B \-alias
132 .I aliasfile
133 switch will be
134 read (more than one file, each preceded by
135 .BR \-alias ,
136 can be named). See
137 .IR mh\-alias (5)
138 for more information.
139 .SH FILES
140 .fc ^ ~
141 .nf
142 .ta \w'%nmhetcdir%/ExtraBigFileName 'u
143 ^$HOME/.mh_profile~^The user profile
144 .fi
145 .SH "PROFILE COMPONENTS"
146 .fc ^ ~
147 .nf
148 .ta 2.4i
149 .ta \w'ExtraBigProfileName 'u
150 ^Path:~^To determine the user's nmh directory
151 ^Draft\-Folder:~^To find the default draft-folder
152 ^Aliasfile:~^For a default alias file
153 ^postproc:~^Program to post the message
154 .fi
155 .SH "SEE ALSO"
156 .IR mh\-alias (5),
157 .IR mh\-profile (5),
158 .IR post (8)
159 .SH DEFAULTS
160 .nf
161 .RB ` file "' defaults to <mh-dir>/draft"
162 .RB ` \-nocheck '
163 .RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"
164 .fi
165 .SH CONTEXT
166 None
167 .SH BUGS
168 With the
169 .B \-check
170 option,
171 .B whom
172 makes no guarantees that the
173 addresses listed as being ok are really deliverable, rather, an address
174 being listed as ok means that at the time that
175 .B whom
176 was run
177 the address was thought to be deliverable by the transport service.
178 For local addresses, this is absolute; for network addresses, it means
179 that the host is known; for uucp addresses, it (often) means that the
180 .B UUCP
181 network is available for use.