pam_mail(8)

1PAM_MAIL(8)                    Linux-PAM Manual                    PAM_MAIL(8)
2
3
4

NAME

6       pam_mail - Inform about available mail
7

SYNOPSIS

9       pam_mail.so [close] [debug] [dir=maildir] [empty] [hash=count] [noenv]
10                   [nopen] [quit] [standard]
11

DESCRIPTION

13       The pam_mail PAM module provides the "you have new mail" service to the
14       user. It can be plugged into any application that has credential or
15       session hooks. It gives a single message indicating the newness of any
16       mail it finds in the user's mail folder. This module also sets the PAM
17       environment variable, MAIL, to the user's mail directory.
18
19       If the mail spool file (be it /var/mail/$USER or a pathname given with
20       the dir= parameter) is a directory then pam_mail assumes it is in the
21       Maildir format.
22

OPTIONS

24       close
25          Indicate if the user has any mail also on logout.
26
27       debug
28          Print debug information.
29
30       dir=maildir
31          Look for the users' mail in an alternative location defined by
32          maildir/<login>. The default location for mail is /var/mail/<login>.
33          Note, if the supplied maildir is prefixed by a '~', the directory is
34          interpreted as indicating a file in the user's home directory.
35
36       empty
37          Also print message if user has no mail.
38
39       hash=count
40          Mail directory hash depth. For example, a hashcount of 2 would make
41          the mail file be /var/spool/mail/u/s/user.
42
43       noenv
44          Do not set the MAIL environment variable.
45
46       nopen
47          Don't print any mail information on login. This flag is useful to
48          get the MAIL environment variable set, but to not display any
49          information about it.
50
51       quiet
52          Only report when there is new mail.
53
54       standard
55          Old style "You have..." format which doesn't show the mail spool
56          being used. This also implies "empty".
57

MODULE SERVICES PROVIDED

59       The auth and account services are supported.
60

RETURN VALUES

62       PAM_BUF_ERR
63          Memory buffer error.
64
65       PAM_SERVICE_ERR
66          Badly formed arguments.
67
68       PAM_SUCCESS
69          Success.
70
71       PAM_USER_UNKNOWN
72          User not known.
73

EXAMPLES

75       Add the following line to /etc/pam.d/login to indicate that the user
76       has new mail when they login to the system.
77
78          session  optional  pam_mail.so standard
79
80
81

AUTHOR

86       pam_mail was written by Andrew G. Morgan <morgan@kernel.org>.
87
88
89
90Linux-PAM Manual                  06/09/2006                       PAM_MAIL(8)