Plugins
=======

Distributed with Dovecot:

 * <acl> [ACL.txt]: Access Control Lists for mailboxes
 * <autocreate> [Plugins.Autocreate.txt]: Automatically create/subscribe
   mailboxes when user logs in
 * <expire> [Plugins.Expire.txt]: Delete mails from specified mailboxes after a
   designated number of days
 * <fts> [Plugins.FTS.txt]: Full text search indexing
 * <last_login> [Plugins.LastLogin.txt]: Last-login timestamp updating
 * <lazy_expunge> [Plugins.Lazyexpunge.txt]: Make EXPUNGE and DELETE commands
   just rename the mails elsewhere
 * <listescape> [Plugins.Listescape.txt]: Allow using characters in mailbox
   names that would otherwise be illegal
 * <mailbox_alias> [Plugins.MailboxAlias.txt]: Map multiple names to the same
   mailbox.
 * <mail_filter> [Plugins.MailFilter.txt]: Filter mails while reading/writing
   through a script
 * <mail_log> [Plugins.MailLog.txt]: Log several mail actions
 * <notify> [Plugins.Notify.txt]: Wrapper plugin for easily developing other
   plugins that act on mailbox changes.
 * <push_notification> [Plugins.PushNotification.txt]: Push notification
   framework
    * <push_notification_driver_ox> [Plugins.PushNotification.txt]:
      Open-Xchange driver for push notification
    * <push_notification_driver_dlog> [Plugins.PushNotification.txt]: dlog
      driver for push notification
 * <snarf> [Plugins.Snarf.txt]: UW-IMAP style (mbox) snarfing, i.e. keeps
   moving all mails from one mailbox to INBOX
 * <quota> [Quota.txt]: Quota tracking and enforcing
    * imap_quota: IMAP commands for requesting current quota
    * <quota_clone> [Plugins.QuotaClone.txt]: Copy the current quota usage to a
      dict.
 * <stats> [Plugins.Stats.txt]: Send statistics from mail processes to the
   stats process
 * <trash> [Plugins.Trash.txt]: Delete mails from Trash when user would go over
   quota
 * <virtual> [Plugins.Virtual.txt]: Virtual mailboxes
 * <welcome> [Plugins.Welcome.txt]: Call a script on user's first login.
 * <zlib> [Plugins.Zlib.txt]: Access compressed mails
 * <imap_zlib> [Plugins.Compress.txt]: Enable IMAP COMPRESS
   [http://www.ietf.org/rfc/rfc4978.txt] extension
 * <mail_crypt> [Plugins.MailCrypt.txt]: In-rest mail encryption
 * <var_expand_crypt> [Plugins.VarExpandCrypt.txt]: Variable
   encryption/decryption

External:

 * <antispam> [Plugins.Antispam.txt]: Integrates spam learning into Dovecot
 * drac [http://sourceforge.jp/projects/dovecot2-drac/]: Pop-before-SMTP plugin
   using DRAC
 * whoson [http://ftp.ufanet.ru/pub/boco/dovecot/whoson-plugin-2/]:
   Pop-before-SMTP plugin using WHOSON protocol [http://whoson.sourceforge.net]

 * alert [http://dovecot.org/patches/1.0/imap-alert-plugin.c]: Send IMAP ALERT
   message from '/etc/dovecot.alert'.
 * <Pigeonhole Sieve> [Pigeonhole.Sieve.txt]: Use the Sieve
   [http://sieve.info/] language to perform actions upon message delivery, such
   as filtering, forwarding, vacation replies, notifications and many other
   actions. See the <documentation> [Pigeonhole.Sieve.txt] for a full list.
 * Fetchmail wakeup [http://github.com/marschap/fetchmail_wakeup]: Wakes
   fetchmail when Dovecot looks for new mail. This is a heavily extended and
   updated version that is tested to work with Dovecot 1.1.x and 1.2.x.
   Versions 2.x including the freshly released version 2.0.3 work with Dovecot
   2.0.x.
 * Fetchmail wake [http://guichaz.free.fr/misc/]: Wakes fetchmail when Dovecot
   looks for new mail. This is the original version that only works with
   dovecot 1.0.x
 * <deleted-to-trash> [Plugins.deleted-to-trash.txt]: Automatically move
   deleted item to trash folder, if client side doesn't do it, such as outlook
   and evolution.
 * extra-copies [https://github.com/vandry/dovecot-plugin-extra-copies]: allows
   extra copies of messages to be made in other folders whenever a message is
   added to a particular folder.
 * fts-elasticsearch [https://github.com/ascendantcom/fts-elasticsearch]:
   Allows for the use of <ElasticSearch.txt> as a full-text search backend.
 * openchange
   [https://github.com/openchange/openchange/tree/master/mapiproxy/services/plugins/dovecot]:
   Allows <OpenChange.txt> to update Microsoft Outook mailboxes automatically
   when new emails are received by Dovecot 2.x.
 * TREES [https://0xacab.org/riseuplabs/trees]: A NaCL-based Dovecot encryption
   plugin

Experimental Plugins:

 * <xexec> [Plugins.xexec.txt]: Execute any server side application and
   communicate with it through plugins over IMAP

To enable / disable plugins per user you can make your userdb return
'mail_plugins' extra field. See <UserDatabase.ExtraFields.txt> for examples.

(This file was created from the wiki on 2017-05-11 04:42)