pop3-uidl-migrate plugin

Note

pop3-uidl-migrate plugin is only available as part of OX Dovecot Pro.

The pop3-uidl-migrate plugin is used to preserve POP3 UIDLs. It’s a more efficient way than using pop3-migration plugin, because it doesn’t require a separate POP3 connection to get the UIDLs. However, this plugin can be used only for a few POP3 servers.

Warning

Always do a test migration to verify that POP3 UIDLs are preserved correctly. If the UIDL format is wrong, all the mails have to be re-migrated.

Settings

pop3_uidl_migrate_format

• Default: <empty>

• Values: String

A template of the UIDL format to use when migrating messages.

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

Variable substitutions available:

Field	Value
owm	OpenWave: If Message-ID header is valid POP3 UIDL, use it. Otherwise, use MD5 of the Message-ID header.
uid	IMAP message UID
uidvalidity	Current UID validity

Example:

plugin {
  # Critical Path: IMAP UIDVALIDITY-IMAP UID
  pop3_uidl_migrate_format = %%{uidvalidity}-%%{uid}
  # OpenWave:
  pop3_uidl_migrate_format = %%{owm}
}