Version 14 (modified by dmorton, 16 years ago) (diff)


Welcome to Maia Mailguard

Pardon the mess, we had a serious loss of data and so the wiki and ticket system has been restored from a backup in December. We're working on restoring the rest. Tickets and source code have been restored.

Maia Mailguard is a web-based interface and management system based on the popular amavisd-new e-mail scanner and SpamAssassin. Written in Perl and PHP, Maia Mailguard gives end-users control over how their mail is processed by virus scanners and spam filters, while giving mail administrators the power to configure site-wide defaults and limits.


User-Oriented Quarantine Management

  • Users can manage their own content filtering settings
  • Users can maintain their own whitelists and blacklists
  • Lets users see a list of their quarantined spam, sorted by score
  • Lets users see a list of their quarantined viruses, sorted by date
  • Users can view text or HTML contents of quarantined mail in decoded or raw form in a "safe" mail viewer
  • Users can rescue quarantined items to have them redelivered, delete them, or confirm them as spam
  • Users can report "false negatives" (i.e. spam that gets past the filters)
  • Optional auto-whitelisting for senders of rescued quarantine items

User-Friendly Web Interface

  • Cross-browser support (Internet Explorer, Mozilla, etc.)
  • Easily-customised appearance through Cascading Style Sheets and templates
  • Template themes allow users to select from a number of different layout designs
  • Graphical toolbars with icons
  • Online help pages for users and administrators
  • Localisation support for different languages
  • Safe mail viewer for spam and viruses, including image-blocking

Flexible User Authentication

  • Users can authenticate via an external POP3, IMAP, LDAP, Exchange, or SQL server
  • Internal authentication is also supported
  • Supports login sessions with or without cookies, transparently and automatically
  • Accounts are automatically created for users when they login if necessary
  • Accounts can be auto-created as mail arrives for users, if necessary
  • Multiple e-mail addresses can be linked to a single account
  • Individual settings can be maintained for each e-mail address

Powerful Administration Tools

  • Users, Domain Administrators, and a Super-Administrator
  • A Super-Administrator account can grant/revoke Administrator privileges
  • Administrators can add domain-class users and configure per-domain defaults (e.g. @domain)
  • Administrators can "impersonate" regular users to help with support issues
  • Scheduled e-mail reminders to encourage users to review their quarantine areas
  • Scheduled e-mail digests of quarantined items to enable users to manage their quarantines directly from their mail clients
  • Configurable auto-expiry schedule for neglected quarantined items
  • Per-domain and system-wide settings can be defined by Administrators
  • Virus alias administration functions

Effective Spam and Virus Management Tools

  • Built on SpamAssassin and amavisd-new (v. 2.2.0)
  • Supports a wide range of virus scanners, and can use multiple scanners for layered protection
  • Supports scanning for viruses, spam, banned attachment types, and invalid mail headers
  • Confirmed spam and ham is used to automatically train SpamAssassin's Bayes engine.
  • Confirmed spam can be automatically reported to spam-monitoring networks, e.g. Vipul's Razor, the Distributed Checksum Clearinghouse, Pyzor, and SpamCop?
  • Supports the use of "spam-trap" accounts to gather and report evidence
  • Auto-accept or auto-reject mail larger than a specified size

Scalable Design

  • Mail servers, database servers, web servers and content filters can be hosted on separate machines
  • Supports arrays of content filtering machines, all controlled from a single interface
  • Supports virtual hosting of multiple domains, with per-domain features
  • SQL database storage for all e-mail, no more files

Data Security and Integrity

  • Unless explicitly discarded, no mail is ever "lost"
  • Mail is stored in pristine form, no amavisd/SA headers
  • Strong Blowfish/CBC encryption of stored e-mail can be enabled
  • Privacy settings can be configured to prevent or allow administrators to read users' e-mail

Statistics Tracking

  • Tracks viruses, spam, and ham (i.e. "non-spam") for statistical purposes
  • Tracks bandwidth consumption for viruses, spam and ham
  • Tracks financial costs associated with bandwidth for each type of item
  • Filter effectiveness stats
  • Statistics available in table form and as graphic charts (with JpGraph?)
  • New charts and visualizations of the data can be added easily
  • Condensed stats table

System Requirements

  • Two SMTP-based mail servers in a dual-MTA arrangement OR an SMTP server with re-injection capability (e.g. Postfix)
  • SpamAssassin 2.55-2.63, 3.00 or newer (if you want spam filtering)
  • PHP 4.2.0 or newer
  • Perl 5.6 or newer
  • Any PHP-compatible web server
  • One or more virus scanners supported by amavisd-new (if you want virus scanning)
  • One of the following SQL databases:
    • MySQL 4.0.x or newer
    • PostgreSQL 7.1 or newer
  • Perl DBI database module 1.40 or newer
  • Perl DBD-mysql database driver 2.9003 or newer (for MySQL)
  • Perl DBD-pg database driver 1.31 or newer (for PostgreSQL)
  • Smarty template engine 2.6.2 or newer
  • PHP IMAP extensions 2002d or newer
  • PEAR::DB library 1.3 or newer
  • PEAR::DB_Pager library 0.7 or newer
  • PEAR::Mail_Mime library 1.2.1 or newer
  • PEAR::Image_Graph library 0.7.0 or newer (if you want graphical charts)
  • MCrypt library 2.5.7 or newer (if you want database encryption)

Installing Maia Mailguard

Before installing Maia Mailguard in a production environment, take a look at the issues raised in the CAVEATS file, which explains some of the current limitations of this product. As with any application that needs to interact with other server-side components, you should perform a trial installation on a test system first, to ensure that this product will work in your environment and will meet your needs. Only once you've performed these tests and determined that Maia Mailguard will work in your production environment should you consider deploying it there.

To learn more about installing Maia Mailguard, please read the INSTALL file), and the scripts/README file. Read the FAQ. Join the mailing lists.

This web site is built with Trac, allowing it to be easily updated and work with software issue tracking.

Maia Mailguard is copyright 2003-2004 by Robert LeBlanc?, all rights reserved.