MAILMUNGE DOCUMENTATION

This is an index to the Mailmunge documentation.

Overview

Start with the overview document before reading anything else.

Mailmunge Overview

Installation

A guide to installing Mailmunge from source and configuring your MTA and Mailmunge.

Installation

Upgrading from MIMEDefang

If you're here because you're upgrading your mail filter from MIMEDefang to Mailmunge, please see "CONVERTING FROM MIMEDefang" in Mailmunge::Filter::Compat.

Perl Modules

The Most Important Perl Modules

You must be familiar with these modules to write your filter policy.

Mailmunge::Filter

Mailmunge::Filter::Compat (useful if you are upgrading from MIMEDefang, but also a generally more convenient base for writing a filter.)

Mailmunge::Context

Mailmunge::Response

Mailmunge::Constants

MIME::Entity

More Perl Modules for Writing Filters

These are handy modules that give additional capabilities to your filter.

Mailmunge::Action::Boilerplate

Mailmunge::Action::DKIMSigner

Mailmunge::Action::Stream

Mailmunge::Test::GetMX

Mailmunge::Test::SMTPForward

Mailmunge::Test::Greylist

Mailmunge::Test::SpamAssassin

Mailmunge::Test::Rspamd

Command-Line Program Man Pages

The man pages for the various command-line tools.

mailmunge

mailmunge-multiplexor

mm-mx-ctrl

watch-multiple-mailmunges

Protocol Internals

Internal details about how Perl workers communicate with mailmunge

mailmunge-protocol

mailmunge-notify

Perl Modules of Interest to Developers Only

Mailmunge::Base

Mailmunge::Action

Mailmunge::Test

Perl Modules for Writing Unit Tests

Test::Mailmunge::Filter

Test::Mailmunge::Utils

Test::Mailmunge::SMTPServer

Test::Mailmunge::Tmpdir

Perl Modules for Writing Regression Tests

Test::Mailmunge::RegressionUtils