238 lines
4.3 KiB
HTML
238 lines
4.3 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of PAM_MAIL</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>PAM_MAIL</H1>
|
|
Section: Linux-PAM Manual (8)<BR>Updated: 05/18/2017<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
pam_mail - Inform about available mail
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1">
|
|
<B>pam_mail.so</B> [close] [debug] [dir=<I>maildir</I>] [empty] [hash=<I>count</I>] [noenv] [nopen] [quiet] [standard]
|
|
</DL>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
<DD>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
|
|
<I>newness</I>
|
|
of any mail it finds in the user's mail folder. This module also sets the PAM environment variable,
|
|
<B>MAIL</B>, to the user's mail directory.
|
|
<P>
|
|
|
|
If the mail spool file (be it
|
|
/var/mail/$USER
|
|
or a pathname given with the
|
|
<B>dir=</B>
|
|
parameter) is a directory then pam_mail assumes it is in the
|
|
<I>Maildir</I>
|
|
format.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<P>
|
|
|
|
<P>
|
|
|
|
<B>close</B>
|
|
<DL COMPACT><DT id="2"><DD>
|
|
Indicate if the user has any mail also on logout.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>debug</B>
|
|
<DL COMPACT><DT id="3"><DD>
|
|
Print debug information.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>dir=</B><B></B><I>maildir</I>
|
|
<DL COMPACT><DT id="4"><DD>
|
|
Look for the user's mail in an alternative location defined by
|
|
maildir/<login>. The default location for mail is
|
|
/var/mail/<login>. Note, if the supplied
|
|
maildir
|
|
is prefixed by a '~', the directory is interpreted as indicating a file in the user's home directory.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>empty</B>
|
|
<DL COMPACT><DT id="5"><DD>
|
|
Also print message if user has no mail.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>hash=</B><B></B><I>count</I>
|
|
<DL COMPACT><DT id="6"><DD>
|
|
Mail directory hash depth. For example, a
|
|
<I>hashcount</I>
|
|
of 2 would make the mail file be
|
|
/var/spool/mail/u/s/user.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>noenv</B>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
Do not set the
|
|
<B>MAIL</B>
|
|
environment variable.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>nopen</B>
|
|
<DL COMPACT><DT id="8"><DD>
|
|
Don't print any mail information on login. This flag is useful to get the
|
|
<B>MAIL</B>
|
|
environment variable set, but to not display any information about it.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>quiet</B>
|
|
<DL COMPACT><DT id="9"><DD>
|
|
Only report when there is new mail.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>standard</B>
|
|
<DL COMPACT><DT id="10"><DD>
|
|
Old style "You have..." format which doesn't show the mail spool being used. This also implies "empty".
|
|
</DL>
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>MODULE TYPES PROVIDED</H2>
|
|
|
|
<P>
|
|
|
|
The
|
|
<B>session</B>
|
|
and
|
|
<B>auth</B>
|
|
(on establishment and deletion of credentials) module types are provided.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>RETURN VALUES</H2>
|
|
|
|
<P>
|
|
|
|
PAM_BUF_ERR
|
|
<DL COMPACT><DT id="11"><DD>
|
|
Memory buffer error.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
PAM_SERVICE_ERR
|
|
<DL COMPACT><DT id="12"><DD>
|
|
Badly formed arguments.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
PAM_SUCCESS
|
|
<DL COMPACT><DT id="13"><DD>
|
|
Success.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
PAM_USER_UNKNOWN
|
|
<DL COMPACT><DT id="14"><DD>
|
|
User not known.
|
|
</DL>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
<P>
|
|
|
|
Add the following line to
|
|
/etc/pam.d/login
|
|
to indicate that the user has new mail when they login to the system.
|
|
<P>
|
|
<DL COMPACT><DT id="15"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
session optional pam_mail.so standard
|
|
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+pam.conf">pam.conf</A></B>(5),
|
|
<B><A HREF="/cgi-bin/man/man2html?5+pam.d">pam.d</A></B>(5),
|
|
<B><A HREF="/cgi-bin/man/man2html?7+pam">pam</A></B>(7)
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
<P>
|
|
|
|
pam_mail was written by Andrew G. Morgan <<A HREF="mailto:morgan@kernel.org">morgan@kernel.org</A>>.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">MODULE TYPES PROVIDED</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">RETURN VALUES</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">EXAMPLES</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">SEE ALSO</A><DD>
|
|
<DT id="24"><A HREF="#lbAJ">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:14 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|