NAME
pam_mail - Inform about available mail
SYNOPSIS
pam_mail.so [close] [debug] [dir=maildir] [empty] [hash=count] [noenv] [nopen] [quiet] [standard]
DESCRIPTION
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 newness of any mail it finds in the user's mail folder. This module also sets the PAM environment variable, MAIL, to the user's mail directory.
If the mail spool file (be it /var/mail/$USER or a pathname given with the dir= parameter) is a directory then pam_mail assumes it is in the Maildir format.
OPTIONS
close
debug
dir=maildir
empty
hash=count
noenv
nopen
quiet
standard
MODULE TYPES PROVIDED
The session and auth (on establishment and deletion of credentials) module types are provided.
RETURN VALUES
PAM_BUF_ERR
PAM_SERVICE_ERR
PAM_SUCCESS
PAM_USER_UNKNOWN
EXAMPLES
Add the following line to /etc/pam.d/login to indicate that the user has new mail when they login to the system.
session optional pam_mail.so standard
\nSEE ALSO
pam.conf(5), pam.d(5), pam(7)
AUTHOR
pam_mail was written by Andrew G. Morgan <[email protected]>.