Mail Logger Plugin (mail-log)

This plugin can be used to log several actions done in a mail session:

• Setting and removing \Deleted flag
• Expunging (includes autoexpunge)
• Copying mails
• Saves
• Mailbox creations
• Mailbox deletions
• Mailbox renames
• Any flag changes

Messages' IMAP UID and Message-ID header is logged for each action.

Example:

imap(user): copy -> Trash: uid=908, msgid=<123.foo@bar>
imap(user): delete: uid=908, msgid=<123.foo@bar>
imap(user): expunged: uid=908, msgid=<123.foo@bar>

The notify plugin is required the mail_log plugin's operation, so be certain it's also enabled.

Settings

mail_log_cached_only

Default	no
Value	boolean

If enabled, everything except save event will log only the fields that can be looked up from cache. This improves performance if some of the fields aren't cached and it's not a strict requirement to log them.

mail_log_events

Default	[None]
Value	Boolean List

List of events to log.

Available events:

• delete
• undelete
• expunge
• save
• copy
• mailbox_create
• mailbox_delete
• mailbox_rename
• flag_change

mail_log_fields

Default	[None]
Value	Boolean List

List of fields to log.

Field	Restrictions
uid
box
msgid
size	Only available for expunge and copy events.
vsize	Only available for expunge and copy events.
vsize
flags
from
subject

Example Configuration

# Enable the plugin globally for all services
mail_plugins {
  notify = yes
  mail_log = yes
}

mail_log_events = delete undelete expunge mailbox_delete mailbox_rename
mail_log_fields = uid box msgid size from
mail_log_cached_only = yes