This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 8 and 9
Revision 8 as of 2017-09-20 13:14:05
Size: 1289
Editor: TimoSirainen
Comment:
Revision 9 as of 2017-09-20 13:14:37
Size: 1291
Editor: TimoSirainen
Comment:
Deletions are marked like this. Additions are marked like this.
Line 30: Line 30:
 #notify_status_mailbox2 = pattern2  #notify_status_mailbox2 = pattern2/*

notify_status plugin (v2.2.33+)

This plugin updates a dict every time a mailbox changes. The status can contain total message count and unseen count. It will update key priv/status/<mailbox name>.

Configuration

mail_plugins = $mail_plugins notify notify_status

dict {
  notify_status = driver:args
}

# optional
service dict {
  unix_listener dict {
     #group = vmail
     # or
     #mode = 0777
  }
} 

plugin {
 notify_status_dict = proxy::notify_status
 # if you want some other syntax, available keys are username, mailbox, messages and unseen
 #notify_status_value = {"messages":%%{messages},"unseen":%%{unseen}}
 # limit mailboxes that are updated, most common is probably setting this to inbox
 #notify_status_mailbox = pattern1
 # you can specify additional patterns
 #notify_status_mailbox2 = pattern2/*
 #...
}

Supported fields

  • mailbox - name of mailbox
  • messages - n. of messages
  • unseen - n. unseen message
  • recent - n. recent messages (not accurate)
  • uidvalidity - current UID validity
  • uidnext - predicted next UID value
  • first_recent_uid - first recent UID
  • highest_modseq - higest modification sequence number
  • highest_pvt_modseq - highest private modification sequence number

None: Plugins/NotifyStatus (last edited 2019-05-08 11:22:46 by TimoSirainen)