notify-status plugin

New in version v2.2.33.

See also

See notify-status plugin for configuration information.

Settings

notify_status_dict

  • Default: <empty>

  • Values: String

The URI of the dictionary to use. This MUST be set for the plugin to be active.

See Dovecot Dictionaries for how to configure dictionaries.

Example:

plugin {
  notify_status_dict = proxy:dict-async:notify_status
}

notify_status_mailbox

  • Default: <empty>

  • Values: String

A mailbox pattern to exclude from status updates. Wildcards are acceptable.

By default, all mailboxes are processed.

You can define multiple quota roots by appending an increasing number to the setting label.

Example:

plugin {
  notify_status_mailbox = Spam
  notify_status_mailbox2 = Archive/*
}

notify_status_value

  • Default: {"messages":%%{messages},"unseen":%%{unseen}}

  • Values: String

A template of the string that will be written to the dictionary.

The template supports variable substitution of the form %%{variable_name}.

Support variable substitutions:

Field

Value

first_recent_uid

First recent UID

highest_modseq

Higest modification sequence number

highest_pvt_modseq

Highest private modification sequence number

mailbox

Mailbox name

messages

Number of messages

recent

Number of recent messages (deprecated)

uidnext

Predicted next UID value

uidvalidity

Current UID validity

unseen

Number of unseen messages

username

Username (user@domain)