FM / html

/usr/share/doc/pam/html

Name	Size	Mode	Actions
Linux-PAM_SAG.html	9196	0644	edit dl rm
sag-author.html	3111	0644	edit dl rm
sag-configuration-directory.html	2966	0644	edit dl rm
sag-configuration-example.html	5522	0644	edit dl rm
sag-configuration-file.html	17519	0644	edit dl rm
sag-configuration.html	3065	0644	edit dl rm
sag-copyright.html	3617	0644	edit dl rm
sag-introduction.html	4446	0644	edit dl rm
sag-module-reference.html	38152	0644	edit dl rm
sag-overview.html	7995	0644	edit dl rm
sag-pam_access.html	18120	0644	edit dl rm
sag-pam_cracklib.html	20271	0644	edit dl rm
sag-pam_debug.html	8087	0644	edit dl rm
sag-pam_deny.html	4704	0644	edit dl rm
sag-pam_echo.html	5752	0644	edit dl rm
sag-pam_env.html	12796	0644	edit dl rm
sag-pam_exec.html	8371	0644	edit dl rm
sag-pam_faildelay.html	4590	0644	edit dl rm
sag-pam_filter.html	9342	0644	edit dl rm
sag-pam_ftp.html	6203	0644	edit dl rm
sag-pam_group.html	10136	0644	edit dl rm
sag-pam_issue.html	6378	0644	edit dl rm
sag-pam_keyinit.html	7015	0644	edit dl rm
sag-pam_lastlog.html	8524	0644	edit dl rm
sag-pam_limits.html	18114	0644	edit dl rm
sag-pam_listfile.html	10534	0644	edit dl rm
sag-pam_localuser.html	5446	0644	edit dl rm
sag-pam_loginuid.html	5209	0644	edit dl rm
sag-pam_mail.html	7762	0644	edit dl rm
sag-pam_mkhomedir.html	6196	0644	edit dl rm
sag-pam_motd.html	7753	0644	edit dl rm
sag-pam_namespace.html	20640	0644	edit dl rm
sag-pam_nologin.html	5332	0644	edit dl rm
sag-pam_permit.html	4304	0644	edit dl rm
sag-pam_pwhistory.html	8476	0644	edit dl rm
sag-pam_rhosts.html	6404	0644	edit dl rm
sag-pam_rootok.html	5109	0644	edit dl rm
sag-pam_securetty.html	6480	0644	edit dl rm
sag-pam_selinux.html	8313	0644	edit dl rm
sag-pam_shells.html	4261	0644	edit dl rm
sag-pam_succeed_if.html	9154	0644	edit dl rm
sag-pam_time.html	9725	0644	edit dl rm
sag-pam_timestamp.html	6889	0644	edit dl rm
sag-pam_umask.html	6318	0644	edit dl rm
sag-pam_unix.html	15056	0644	edit dl rm
sag-pam_userdb.html	8585	0644	edit dl rm
sag-pam_warn.html	4569	0644	edit dl rm
sag-pam_wheel.html	7181	0644	edit dl rm
sag-pam_xauth.html	8420	0644	edit dl rm
sag-security-issues-other.html	2993	0644	edit dl rm
sag-security-issues-wrong.html	2963	0644	edit dl rm
sag-security-issues.html	2161	0644	edit dl rm
sag-see-also.html	2283	0644	edit dl rm
sag-text-conventions.html	3187	0644	edit dl rm

Edit: /usr/share/doc/pam/html/sag-pam_mail.html (7762B)

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>6.19. pam_mail - inform about available mail</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="Linux-PAM_SAG.html" title="The Linux-PAM System Administrators' Guide"><link rel="up" href="sag-module-reference.html" title="Chapter 6. A reference guide for available modules"><link rel="prev" href="sag-pam_loginuid.html" title="6.18. pam_loginuid - record user's login uid to the process attribute"><link rel="next" href="sag-pam_mkhomedir.html" title="6.20. pam_mkhomedir - create users home directory"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.19. pam_mail - inform about available mail</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sag-pam_loginuid.html">Prev</a> </td><th width="60%" align="center">Chapter 6. A reference guide for available modules</th><td width="20%" align="right"> <a accesskey="n" href="sag-pam_mkhomedir.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sag-pam_mail"></a>6.19. pam_mail - inform about available mail</h2></div></div></div><div class="cmdsynopsis"><p><code class="command">pam_mail.so</code>  [
	close
      ] [
	debug
      ] [
        dir=<em class="replaceable"><code>maildir</code></em>
      ] [
	empty
      ] [
	hash=<em class="replaceable"><code>count</code></em>
      ] [
	noenv
      ] [
	nopen
      ] [
	quiet
      ] [
	standard
      ]</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sag-pam_mail-description"></a>6.19.1. DESCRIPTION</h3></div></div></div><p>
      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 <span class="emphasis"><em>newness</em></span> of any mail it finds
      in the user's mail folder. This module also sets the PAM
      environment variable, <span class="emphasis"><em>MAIL</em></span>, to the
      user's mail directory.
    </p><p>
      If the mail spool file (be it <code class="filename">/var/mail/$USER</code>
      or a pathname given with the <code class="option">dir=</code> parameter) is
      a directory then pam_mail assumes it is in the
      <span class="emphasis"><em>Maildir</em></span> format.
    </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sag-pam_mail-options"></a>6.19.2. OPTIONS</h3></div></div></div><p>
      </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
            <code class="option">close</code>
          </span></dt><dd><p>
              Indicate if the user has any mail also on logout.
            </p></dd><dt><span class="term">
            <code class="option">debug</code>
          </span></dt><dd><p>
	      Print debug information.
            </p></dd><dt><span class="term">
            <code class="option">dir=<em class="replaceable"><code>maildir</code></em></code>
          </span></dt><dd><p>
              Look for the user's mail in an alternative location defined by
             <code class="filename">maildir/&lt;login&gt;</code>.  The default
             location for mail is <code class="filename">/var/mail/&lt;login&gt;</code>.
             Note, if the supplied
             <code class="filename">maildir</code> is prefixed by a '~', the
             directory is interpreted as indicating a file in the user's
             home directory.
            </p></dd><dt><span class="term">
            <code class="option">empty</code>
          </span></dt><dd><p>
              Also print message if user has no mail.
            </p></dd><dt><span class="term">
            <code class="option">hash=<em class="replaceable"><code>count</code></em></code>
          </span></dt><dd><p>
              Mail directory hash depth. For example, a
              <span class="emphasis"><em>hashcount</em></span> of 2 would
              make the mail file be
              <code class="filename">/var/spool/mail/u/s/user</code>.
            </p></dd><dt><span class="term">
            <code class="option">noenv</code>
          </span></dt><dd><p>
	      Do not set the <span class="emphasis"><em>MAIL</em></span>
              environment variable.
            </p></dd><dt><span class="term">
            <code class="option">nopen</code>
          </span></dt><dd><p>
	      Don't print any mail information on login. This flag is
              useful to get the <span class="emphasis"><em>MAIL</em></span>
              environment variable set, but to not display any information
              about it.
            </p></dd><dt><span class="term">
            <code class="option">quiet</code>
          </span></dt><dd><p>
	      Only report when there is new mail.
            </p></dd><dt><span class="term">
            <code class="option">standard</code>
          </span></dt><dd><p>
	      Old style "You have..." format which doesn't show the
              mail spool being used. This also implies "empty".
            </p></dd></dl></div><p>

</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sag-pam_mail-types"></a>6.19.3. MODULE TYPES PROVIDED</h3></div></div></div><p>
      The <code class="option">session</code> and
      <code class="option">auth</code> (on establishment and
      deletion of credentials) module types are provided.
    </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sag-pam_mail-return_values"></a>6.19.4. RETURN VALUES</h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">PAM_BUF_ERR</span></dt><dd><p>
             Memory buffer error.
          </p></dd><dt><span class="term">PAM_SERVICE_ERR</span></dt><dd><p>
	    Badly formed arguments.
          </p></dd><dt><span class="term">PAM_SUCCESS</span></dt><dd><p>
            Success.
          </p></dd><dt><span class="term">PAM_USER_UNKNOWN</span></dt><dd><p>
            User not known.
          </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sag-pam_mail-examples"></a>6.19.5. EXAMPLES</h3></div></div></div><p>
      Add the following line to <code class="filename">/etc/pam.d/login</code> to
      indicate that the user has new mail when they login to the system.
      </p><pre class="programlisting">
session  optional  pam_mail.so standard
      </pre><p>
    </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sag-pam_mail-author"></a>6.19.6. AUTHOR</h3></div></div></div><p>
        pam_mail was written by Andrew G. Morgan &lt;morgan@kernel.org&gt;.
      </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sag-pam_loginuid.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="sag-module-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sag-pam_mkhomedir.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.18. pam_loginuid - record user's login uid to the process attribute </td><td width="20%" align="center"><a accesskey="h" href="Linux-PAM_SAG.html">Home</a></td><td width="40%" align="right" valign="top"> 6.20. pam_mkhomedir - create users home directory</td></tr></table></div></body></html>

6.19. pam_mail - inform about available mail

6.19. pam_mail - inform about available mail
Prev	Chapter 6. A reference guide for available modules	Next

6.19. pam_mail - inform about available mail

pam_mail.so [ close ] [ debug ] [ dir=maildir ] [ empty ] [ hash=count ] [ noenv ] [ nopen ] [ quiet ] [ standard ]

6.19.1. 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.

6.19.2. OPTIONS

close: Indicate if the user has any mail also on logout.
debug: Print debug information.
dir=maildir: 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.
empty: Also print message if user has no mail.
hash=count: Mail directory hash depth. For example, a hashcount of 2 would make the mail file be /var/spool/mail/u/s/user.
noenv: Do not set the MAIL environment variable.
nopen: Don't print any mail information on login. This flag is useful to get the MAIL environment variable set, but to not display any information about it.
quiet: Only report when there is new mail.
standard: Old style "You have..." format which doesn't show the mail spool being used. This also implies "empty".

6.19.3. MODULE TYPES PROVIDED

The session and auth (on establishment and deletion of credentials) module types are provided.

6.19.4. RETURN VALUES

PAM_BUF_ERR: Memory buffer error.
PAM_SERVICE_ERR: Badly formed arguments.
PAM_SUCCESS: Success.
PAM_USER_UNKNOWN: User not known.

6.19.5. 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

6.19.6. AUTHOR

pam_mail was written by Andrew G. Morgan <morgan@kernel.org>.

Prev	Up	Next
6.18. pam_loginuid - record user's login uid to the process attribute	Home	6.20. pam_mkhomedir - create users home directory