Notify Status Plugin (notify-status)

This plugin updates a dictionary with mailbox status information every time a mailbox changes.

Settings

WARNING

This plugin requires that the notify plugin is loaded.

mailbox_notify_status

Default	no
Value	boolean

Whether notifications for a single mailbox or mailbox wildcards are enabled.

Example:

mailbox INBOX {
  notify_status = yes
}
mailbox Spam {
  notify_status = yes
}
mailbox *BOX {
  notify_status = yes
}

notify_status

Default	[None]
Value	string
Dependencies	dictionary

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

See dictionary for how to configure dictionaries.

notify_status {
  dict proxy {
    name = notify_status
    socket_path = dict-async
  }
}

notify_status_value

Default	{"messages":%{messages},"unseen":%{unseen}}
Value	String without variables

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

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

Supported variable substitutions:

Field	Value
first_recent_uid	First recent UID
highest_modseq	Highest 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)

Configuration

Dictionary Configuration

See dictionary for how to configure dictionaries.

This plugin updates the priv/status/<mailbox name> key.

Example

mail_plugins {
  notify = yes
  notify_status = yes
}

notify_status {
  dict proxy {
    name = notify_status
    socket_path = dict-async
  }
}

# By default no mailbox is added to dict. To enable all notify_status for
# all mailboxes add:
#mailbox_notify_status = yes

# If you keep the default mailbox_notify_status = no you can enable it per
# mailbox like this:
mailbox inbox {
  notify_status = yes
}
mailbox TestBox {
  notify_status = yes
}

SQL dict Example

Dictionary Map

dict_map priv/status/$box {
  sql_table = mailbox_status
  username_field = username

  key_field mailbox {
    value = $box
  }
  value_field status {
  }
}

SQL Schema

CREATE TABLE mailbox_status (
  username VARCHAR(255) NOT NULL,
  mailbox VARCHAR(255) NOT NULL,
  status VARCHAR(255),
  PRIMARY KEY (username, mailbox)
);