Email Footer plugin for SquirrelMail
====================================
Ver 0.6, 2009/03/02


Copyright (c) 2001 Ray Black III <allah@accessnode.net>
Copyright (c) 2003-2009 Paul Lesniewski <paul@squirrelmail.org>



Description
===========

This plugin automatically appends a custom footer onto the
end of messages sent using SquirrelMail.

If you have the "HTML Mail" plugin installed, you can also
specify a HTML-formatted version of the footer for users who
send their email in HTML.

You may also specify the email footer text on a per-domain,
per-IMAP server, or per-user basis using the Login Manager or
Multilogin plugins.  If you use Login Manger, you must set
$useSessionBased to 1 for its override email footer value to
take effect (remember to log out and back in again after you
change the footer in Login Manager).  The footer must be
specified in the Login Manager or Multilogin configuration
file as "email_footer" (and/or "email_footer_HTML" for the
HTML version of the footer).

If you use the Vadmin plugin, you can also allow administrators
to set the email footer for their domain using the Vadmin
interface.



License
======= 

This plugin is released under the GNU General Public
License (see COPYING for details).



Donations
=========

If you or your company make regular use of this software, please
consider supporting Open Source development by donating to the authors
or inquire about hiring them to consult on other projects.  Donation/
wish list links for the author(s) are as follows:

Paul Lesniewski: https://sourceforge.net/donate/index.php?user_id=508228



Requirements
============

  * SquirrelMail version 1.4.2 or above (although this plugin may
    very well not work with 1.5.0 and 1.5.1, which are unsupported)



Troubleshooting
===============

  * If changes to the configuration file don't seem to be showing
    in the user interface, ensure that you are editing the correct
    configuration file.  If one is located in the main SquirrelMail
    config directory (named "config_email_footer.php"), it will
    always be used.  Otherwise, "config.php" in the email_footer
    plugin directory will be used.

  * If the footer text you specified in the Login Manager plugin
    is not appearing on outgoing messages, first make sure you
    have enabled $useSessionBased in the Login Manager
    configuration and applied the corresponding source patch found
    in the Multilogin plugin as explained in the Login Manager
    documentation.  Next, make sure you have logged out and signed
    in again in order to refresh the footer value in the user
    session.



Help Requests
=============

Before looking for help elsewhere, please try to help yourself:

  * Read the Troubleshooting section herein.

  * Look to see if others have already asked about the same issue.
    There are tips and links for the best places to do this in
    the SquirrelMail mailing list posting guidelines:
    http://squirrelmail.org/wiki/MailingListPostingGuidelines
    You should also try Google or some other search engine.

  * If you cannot find any information about your issue, please
    first mail your help request to the squirrelmail-plugins
    mailing list.  Information about it can be found here:
    http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
    You MUST read the mailing list posting guidelines (see above)
    and include as much information about your issue (and your
    system) as possible.  Including configtest output, any debug
    output, the plugin configuration settings you've made and
    anything else you can think of to make it easier to diagnose
    your problem will get you the most useful responses.  Inquiries
    that do not comply with the posting guidelines are liable to
    be ignored.

  * If you don't get any replies on the mailing list, you are
    welcome to send a help request to the authors' personal
    address(es), but please be patient with the mailing list.



Change Log
==========

  v0.6  2009/03/02  Paul Lesniewski <paul@squirrelmail.org>
    * Allow footers to be controlled by Vadmin administrators
      for users of the Vadmin plugin (version 3.0+)
    * Allow configuration file to be stored in main SquirrelMail
      config directory

  v0.5  2008/04/21  Paul Lesniewski <paul@squirrelmail.org>
    * Updated and cleaned up code; ensured compatibility with
      SquirrelMail 1.5.2
    * No longer appends footers to saved drafts (footer is
      appended when mail actually gets sent)
    * Configuration file setting names have all changed; when
      upgrading, re-configuration from scratch is recommended.

  v0.4  2004/09/02  Paul Lesniewski <paul@squirrelmail.org>
    * Looks for footer text set by the Login Manager (vlogin) or
      Multilogin plugins, if available

  v0.3  2003/10/01  Paul Lesniewski <paul@squirrelmail.org>
    * Updated to work with HTML_Mail plugin, such that
      a separate footer in HTML may be specified, or
      the same plain text footer can be used, and lines 
      won't get concatenated on top of one another when 
      sending HTML-formatted emails

  v0.2  2003  Paul Lesniewski <paul@squirrelmail.org>
    * Updated to work with SquirrelMail 1.4.2
    * Updated for compatibility with new faster plugin design.
    * Updated for SquirrelMail version reporting API.
    * Moved message configuration to separate file that
      will not be overwritten by subsequent plugin upgrades.

  v0.1  2001/05/29  Ray Black III <allah@accessnode.net>
    * Initial release

