diplodocus.org Git - nmh/blob - man/whom.man

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