PHP Imap Sync

Why?

Well, we had a little problem when migrating clients from other hosts to our servers. Moving the files and MySQL databases was the easy part! We developed PHP-IMAP-Sync to make it easier to transfer these accounts and even keep our servers updated while the transfer was going on...

How to Use

From sh goto the project folder and run:

php phpimapsync.php --source imap-ssl://[email protected]:[email protected]:993/ --target imap-ssl://[email protected]:[email protected]:993/.

Dont forget to change the details.

Requirements

• PHP 7.4+

Parameter

Required:
--source                    Source server
--target                    Target server

Optional:
-v, --verbose               Verbose output
-t, --test, --dry-run       Test run, do nothing
--listFolder                Only list folder, no synchronizing
-w, --wipe                  Remove all messages on target
--mapFolder                 JSON to map between folders
-m, --memory                PHP Memory Limit

Optional overwrite parameters:
--sourceUsername            Overwrite source username
--sourcePassword            Overwrite source password
--targetUsername            Overwrite target username
--targetPassword            Overwrite target password

Available protocols

• imap-ssl
• imap-ssl-novalidate
• imap-tls

Examples

Synchronize mails between server:

# Just list folder
imap-sync.phar --listFolder \
    --source '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}' \
    --target '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}'

# Synchronize
imap-sync.phar -v \
    --source '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}' \
    --target '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}'

Show folders with folder mapping:

imap-sync.phar --listFolder \
    --source '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}' \
    --target '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}' \
    --mapFolder '{"Papierkorb": "Trash", "Spam": "Junk", "Gesendete Objekte": "Sent", "Entw&APw-rfe": "Drafts"}'

Synchronize with new source markup and old target markup:

imap-sync.phar \
    --source '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}' \
    --target 'imap-ssl://[email protected]:[email protected]:993/'

Synchronize and overwrite fields username and password (you should not need that):

imap-sync.phar \
    --source '{"url": "imap-ssl://mail.server.org:993/", "username": "oldUsername", "password": "oldPassword"}' --sourceUsername 'newUsername' --sourcePassword 'newPassword' \
    --target 'imap-ssl://oldUsername:[email protected]:993/' --targetUsername 'newUsername' --targetPassword 'oldPassword'

Script example

#!/usr/bin/env bash
set -e

# Test synchronization, with extra parameters
imap-sync.phar -t -w -m 1024M \
    --source '{"url": "imap-ssl://mail.server.org:993/", "username": "[email protected]", "password": "PassWord"}' \
    --target '{"url": "imap-ssl://mail.server.org:993/subfolder", "username": "[email protected]", "password": "PassWord"}' \
    --mapFolder '{"Papierkorb": "Trash", "Spam": "Junk", "Gesendete Objekte": "Sent", "Entw&APw-rfe": "Drafts"}'

Build package

./build.sh

Credits

Special thanks to David Busby - edoceo, their script worked well, but not well enough for what we wanted to do!

https://github.com/edoceo/imap-move