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

   1 .TH WHOM %manext1% "April 14, 2013" "%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.  The
 106 .B \-saslmaxssf
 107 switch can be used to select the maximum value of the Security Strength Factor.
 108 This is an integer value and the exact meaning of this value depends on the
 109 underlying SASL mechanism.  A value of 0 disables encryption.
 110 .PP
 111 If
 112 .B nmh
 113 has been compiled with TLS support, the
 114 .B \-tls
 115 and
 116 .B \-notls
 117 switches will require and disable the negotiation of TLS support when connecting to the
 118 SMTP MTA.  Encrypted data is labelled with `(tls-encrypted)' and
 119 `(tls-decrypted)' when viewing the SMTP transction with the
 120 .B \-snoop
 121 switch.
 122 .PP
 123 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
 124 additional alias files given by the
 125 .B \-alias
 126 .I aliasfile
 127 switch will be
 128 read (more than one file, each preceded by
 129 .BR \-alias ,
 130 can be named). See
 131 .IR mh\-alias (5)
 132 for more information.
 133 .SH FILES
 134 .fc ^ ~
 135 .nf
 136 .ta \w'%nmhetcdir%/ExtraBigFileName  'u
 137 ^$HOME/\&.mh\(ruprofile~^The user profile
 138 .fi
 139 .SH "PROFILE COMPONENTS"
 140 .fc ^ ~
 141 .nf
 142 .ta 2.4i
 143 .ta \w'ExtraBigProfileName  'u
 144 ^Path:~^To determine the user's nmh directory
 145 ^Draft\-Folder:~^To find the default draft\-folder
 146 ^Aliasfile:~^For a default alias file
 147 ^postproc:~^Program to post the message
 148 .fi
 149 .SH "SEE ALSO"
 150 .IR mh\-alias (5),
 151 .IR mh\-profile (5),
 152 .IR post (8)
 153 .SH DEFAULTS
 154 .nf
 155 .RB ` file "' defaults to <mh\-dir>/draft"
 156 .RB ` \-nocheck '
 157 .RB ` \-alias "' defaults to  %nmhetcdir%/MailAliases"
 158 .fi
 159 .SH CONTEXT
 160 None
 161 .SH BUGS
 162 With the
 163 .B \-check
 164 option,
 165 .B whom
 166 makes no guarantees that the
 167 addresses listed as being ok are really deliverable, rather, an address
 168 being listed as ok means that at the time that
 169 .B whom
 170 was run
 171 the address was thought to be deliverable by the transport service.
 172 For local addresses, this is absolute; for network addresses, it means
 173 that the host is known; for uucp addresses, it (often) means that the
 174 .B UUCP
 175 network is available for use.