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