Files
modoboa/doc/features/imap-migration.rst
T
2023-04-18 15:44:08 +02:00

56 lines
1.8 KiB
ReStructuredText

IMAP Migration for Modoboa
===========================
.. _imap:
A simple `Modoboa <http://modoboa.org/>`_ extension which provides a
way to transfer your account from another provider/server
provided that you have IMAP access to it.
Configuration
-------------
The plugin configuration is done from the admin panel (*Modoboa >
Parameters > IMAP Migration*). And you have a specific tab to configure
your migration that is visible for SuperAdmins.
These settings are only available on the new admin interface.
.. warning::
You must have enabled "Auto create domain" in modoboa parameters for this extension to work.
This extension can create `OfflineIMAP <https://www.offlineimap.org/doc/installation.html>`_
configuration file with the command:
.. sourcecode:: bash
> python manage.py generate_offlineimap_config
You then need to setup `OfflineIMAP <https://www.offlineimap.org/doc/quick_start.html>`_.
..
This will sync back-and-forth user mailbox.
Providers
---------
Mail server can host multiple domains so the provider address
may be different from the domain part of your email address.
Associated domain is the domain part of the email address.
You can leave "Local Domain" blank if you keep the same domain.
This domain will be auto-created if needed.
you must create the domain beforhand if you want to migrate an account
from `user@domain1.tld` to `user@domain2.tld`.
Migrations
----------
Migrations are automatically handled when providers have been configured.
Users use their old credential to log and the account is automatically created.
They shall use the new domain on next logins if a local domain was set in the provider configuration.
If you have installed OfflineIMAP, you may delete the migration to stop mailbox sync.
SuperAdmins may check migrations in the `IMAP Migration` tab.