README 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. pam_mail — Inform about available mail
  2. ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  3. DESCRIPTION
  4. The pam_mail PAM module provides the "you have new mail" service to the user.
  5. It can be plugged into any application that has credential or session hooks. It
  6. gives a single message indicating the newness of any mail it finds in the
  7. user's mail folder. This module also sets the PAM environment variable, MAIL,
  8. to the user's mail directory.
  9. If the mail spool file (be it /var/mail/$USER or a pathname given with the dir=
  10. parameter) is a directory then pam_mail assumes it is in the Maildir format.
  11. OPTIONS
  12. close
  13. Indicate if the user has any mail also on logout.
  14. debug
  15. Print debug information.
  16. dir=maildir
  17. Look for the user's mail in an alternative location defined by maildir/
  18. <login>. The default location for mail is /var/mail/<login>. Note, if the
  19. supplied maildir is prefixed by a '~', the directory is interpreted as
  20. indicating a file in the user's home directory.
  21. empty
  22. Also print message if user has no mail.
  23. hash=count
  24. Mail directory hash depth. For example, a hashcount of 2 would make the
  25. mail file be /var/spool/mail/u/s/user.
  26. noenv
  27. Do not set the MAIL environment variable.
  28. nopen
  29. Don't print any mail information on login. This flag is useful to get the
  30. MAIL environment variable set, but to not display any information about it.
  31. quiet
  32. Only report when there is new mail.
  33. standard
  34. Old style "You have..." format which doesn't show the mail spool being
  35. used. This also implies "empty".
  36. EXAMPLES
  37. Add the following line to /etc/pam.d/login to indicate that the user has new
  38. mail when they login to the system.
  39. session optional pam_mail.so standard
  40. AUTHOR
  41. pam_mail was written by Andrew G. Morgan <morgan@kernel.org>.