End-of-life for Opalstack API v0 and the WebFaction migration tool

‼️ If your WebFaction account is now closed then the automatic "email" migration procedures below are not going to work for you. You'll need to create your mailboxes and email addresses manually via your Opalstack dashboard. If you have a mail archive from WebFaction already then you can still do the "email-data" migration to import your mail.

The automatic migration tool for WebFaction customers can import your mailbox and email address configuration from WF. This can save you a lot of time if you need to migrate dozens or hundreds of mail accounts from WF!

To use the email migrator you'll need:

A shell user: https://docs.opalstack.com/user-guide/shell-users/
An API token: https://docs.opalstack.com/user-guide/api/
A WebFaction account (of course!)

The steps to use the email migrator are:

Run the following command to get the configration template for the migration:

cp /opt/app_migrators/wf_generic_email/config-template.ini ./config.ini

Edit the configuration file for your migration - note that the imap_server setting needs to be either imap1.us.opalstack.com (for the US mail system) or imap1.de.opalstack.com (for the DE mail system).

[opalstack]
account = my_opalstack_account_name
apitoken = my_opalstack_api_token
imap_server = imap1.us.opalstack.com

[webfaction]
account = my_webfaction_account_name
account_pass = my_webfaction_account_password
ssh_pass = my_webfaction_ssh_password
server = web1

[email]
include_domains = domain1.com, domain2.com    (comma-separated) list of domains to include. Empty = all
include_subdomains = True                     (bool) whether or not include_domains should be extended to subdomains

exclude_domains = domain1.com, domain2.com    (comma-separated) list of domains to exclude. Empty = none
exclude_subdomains = True                     (bool) whether or not exclude_domains should be extended to subdomains

exclude_mailboxes = box1, box2                (comma-separated) list of mailboxes to exclude. Empty = none

Do a dry run of the migration by running the following command:

wfmigrate email ./config.ini --mode simulate

The script will run, test your credentials, and verify that it can run with the configuration you've provided. Pay attention to any WARNING that you see in the output to avoid deleting any existing email addresses and mail users.

Assuming the dry run succeeds, proceed with the live migration:

wfmigrate email ./config.ini --mode do

The migrator will run and do the following things in your Opalstack account:
- Add the domains if they don't exist already.
- Create a mail user for each of your WebFaction mailboxes which are used by email addresses on the domains, including any procmail rules for those mailboxes.
- Create the email addresses that you had at WF for the domains, complete with their mail user and forwarding targets.

It will take at least 3 minutes or longer to run, so please be patient.

Pretty easy, right? Wellllll, there are a couple of things left for you to do:

⚠️ The email migrator will not migrate any autoresponders that are defined at WF, so you'll need to set those up manually for whichever mail users need them via the dashboard.
⚠️ The email migrator will not migrate your email messages that are stored on WebFaction's mail server. To copy your mail over please use the email-data migrator or refer to Importing Email from Another Provider for other options.

Here's a run-through that covers an entire email migration: https://gist.github.com/defulmere/b4f0e33a811d78d6772e78052210a4d4