PAM_MAIL(8)

  .SH "NAME" pam_mail - Inform about available mail
  .SH "SYNOPSIS"
    .HP u
      pam_mail.so
       [close]
       [debug]
       [dir=maildir]
       [empty]
       [hash=count]
       [noenv]
       [nopen]
       [quiet]
       [standard]

  .SH "DESCRIPTION"

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

  .SH "OPTIONS"

    .PP
        .PP close

                Indicate if the user has any mail also on logout.

            .RE
            .PP debug

                    Print debug information.

                .RE
                .PP 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.

                .RE
                    .PP empty

                            Also print message if user has no mail.

                        .RE
                        .PP hash=count

                                Mail directory hash depth. For example, a hashcount of 2 would make the mail file be /var/spool/mail/u/s/user.

                            .RE
                            .PP noenv

                                    Do not set the MAIL environment variable.

                                .RE
                                .PP 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.

                                    .RE
                                    .PP quiet

                                            Only report when there is new mail.

                                        .RE
                                        .PP standard

                                                Old style "You have..." format which doesn't show the mail spool being used. This also implies "empty".

                                            .RE

                                      .SH "MODULE TYPES PROVIDED"

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

                                      .SH "RETURN VALUES"

                                          .PP PAM_BUF_ERR

                                                   Memory buffer error.

                                              .RE
                                              .PP PAM_SERVICE_ERR

                                                      Badly formed arguments.

                                                  .RE
                                                  .PP PAM_SUCCESS

                                                          Success.

                                                      .RE
                                                      .PP PAM_USER_UNKNOWN

                                                              User not known.

                                                          .RE

                                                      .SH "EXAMPLES"

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

                                                      .SH "SEE ALSO"

                                                        .PP pam.conf(5), pam.d(5), pam(8)

                                                      .SH "AUTHOR"

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