modules/pam_mail/pam_mail.8

   1 .\"     Title: pam_mail
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 08/17/2012
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_MAIL" "8" "08/17/2012" "Linux-PAM Manual" "Linux\-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_mail \- Inform about available mail
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_mail\&.so\fR\ 'u
 174 \fBpam_mail\&.so\fR [close] [debug] [dir=\fImaildir\fR] [empty] [hash=\fIcount\fR] [noenv] [nopen] [quiet] [standard]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 The pam_mail PAM module provides the "you have new mail" service to the user\&. It can be plugged into any application that has credential or session hooks\&. It gives a single message indicating the
 179 \fInewness\fR
 180 of any mail it finds in the user\'s mail folder\&. This module also sets the PAM environment variable,
 181 \fBMAIL\fR, to the user\'s mail directory\&.
 182 .PP
 183 If the mail spool file (be it
 184 \FC/var/mail/$USER\F[]
 185 or a pathname given with the
 186 \fBdir=\fR
 187 parameter) is a directory then pam_mail assumes it is in the
 188 \fIMaildir\fR
 189 format\&.
 190 .SH "OPTIONS"
 191 .PP
 192 .PP
 193 \fBclose\fR
 194 .RS 4
 195 Indicate if the user has any mail also on logout\&.
 196 .RE
 197 .PP
 198 \fBdebug\fR
 199 .RS 4
 200 Print debug information\&.
 201 .RE
 202 .PP
 203 \fBdir=\fR\fB\fImaildir\fR\fR
 204 .RS 4
 205 Look for the users\' mail in an alternative location defined by
 206 \FCmaildir/<login>\F[]\&. The default location for mail is
 207 \FC/var/mail/<login>\F[]\&. Note, if the supplied
 208 \FCmaildir\F[]
 209 is prefixed by a \'~\', the directory is interpreted as indicating a file in the user\'s home directory\&.
 210 .RE
 211 .PP
 212 \fBempty\fR
 213 .RS 4
 214 Also print message if user has no mail\&.
 215 .RE
 216 .PP
 217 \fBhash=\fR\fB\fIcount\fR\fR
 218 .RS 4
 219 Mail directory hash depth\&. For example, a
 220 \fIhashcount\fR
 221 of 2 would make the mail file be
 222 \FC/var/spool/mail/u/s/user\F[]\&.
 223 .RE
 224 .PP
 225 \fBnoenv\fR
 226 .RS 4
 227 Do not set the
 228 \fBMAIL\fR
 229 environment variable\&.
 230 .RE
 231 .PP
 232 \fBnopen\fR
 233 .RS 4
 234 Don\'t print any mail information on login\&. This flag is useful to get the
 235 \fBMAIL\fR
 236 environment variable set, but to not display any information about it\&.
 237 .RE
 238 .PP
 239 \fBquiet\fR
 240 .RS 4
 241 Only report when there is new mail\&.
 242 .RE
 243 .PP
 244 \fBstandard\fR
 245 .RS 4
 246 Old style "You have\&.\&.\&." format which doesn\'t show the mail spool being used\&. This also implies "empty"\&.
 247 .RE
 248 .SH "MODULE TYPES PROVIDED"
 249 .PP
 250 The
 251 \fBsession\fR
 252 and
 253 \fBauth\fR
 254 (on establishment and deletion of credentials) module types are provided\&.
 255 .SH "RETURN VALUES"
 256 .PP
 257 PAM_BUF_ERR
 258 .RS 4
 259 Memory buffer error\&.
 260 .RE
 261 .PP
 262 PAM_SERVICE_ERR
 263 .RS 4
 264 Badly formed arguments\&.
 265 .RE
 266 .PP
 267 PAM_SUCCESS
 268 .RS 4
 269 Success\&.
 270 .RE
 271 .PP
 272 PAM_USER_UNKNOWN
 273 .RS 4
 274 User not known\&.
 275 .RE
 276 .SH "EXAMPLES"
 277 .PP
 278 Add the following line to
 279 \FC/etc/pam\&.d/login\F[]
 280 to indicate that the user has new mail when they login to the system\&.
 281 .sp
 282 .if n \{\
 283 .RS 4
 284 .\}
 285 .fam C
 286 .ps -1
 287 .nf
 288 .if t \{\
 289 .sp -1
 290 .\}
 291 .BB lightgray adjust-for-leading-newline
 292 .sp -1
 293
 294 session  optional  pam_mail\&.so standard
 295
 296 .EB lightgray adjust-for-leading-newline
 297 .if t \{\
 298 .sp 1
 299 .\}
 300 .fi
 301 .fam
 302 .ps +1
 303 .if n \{\
 304 .RE
 305 .\}
 306 .sp
 307 .SH "SEE ALSO"
 308 .PP
 309
 310 \fBpam.conf\fR(5),
 311 \fBpam.d\fR(5),
 312 \fBpam\fR(8)
 313 .SH "AUTHOR"
 314 .PP
 315 pam_mail was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.