yippiemove-cli is a Command Line Interface (CLI) for YippieMove written in Python. With this tool you can create and manage email migrations directly on the command line.

To install the required libraries, simply run:

$ pip install -r requirements.txt

To use the YippieMove API, you'll need to create an API client if you haven't already. Doing so is easily done from your YippieMove Account preferences page located here.

Enter a name for your application and click "Create client". Your new application will be listed in the table wih the Application Key and Secret you'll need later for obtaining tokens to use YippieMove through your client.

To use the YippieMove API you'll need a user's access token (usually yours). For each request you make to the YippieMove API you'll need to provide the access token, though we provide two ways to do this using this utility.

You may provide the token per each usage:

$ ./yippiemove.py --token=ceaba709b1 read email_account 76

Or if you'll be making multiple actions using the same token, you may set the token, which will be saved in a file named .ymo_token (write-access is required). After doing so you are not required to specify the token manually each time.

$ ./yippiemove.py token set ceaba709b1
Token set as ceaba709b1

To read the current saved token, you may use token get:

$ ./yippiemove.py token get
Token is: ceaba709b1

To remove the current token:

$ ./yippiemove.py token delete
Token removed.

If you do not have a token to use for the API, you can obtain one for your own account by using the token wizard:

$ ./yippiemove.py token wizard

The wizard will ask you for the Application Key and Secret for your application, and then provide you with a URL to visit in your web browser. There, you'll give permission to the application to use your account and will be provided an access code. Copy the access code and paste it into the wizard when it asks for it. With the access code, the wizard will request a token for your account and automatically set it for you. For your records, the wizard will also tell you the token should you choose to save it elsewhere.

The simplest way to create a new email transfer using this utility is to use the wizard:

$ ./yippiemove.py wizard

This will guide you through the process of choosing the source and destination email accounts, providing login credentials for them, confirming they are correct, starting YippieMove's indexing of the account, and choosing which email folders to transfer to the destination account. Finally, you can then issue a payment for the new transfer to have it start processing as soon as possible.

You can use low-level CRUD (create, read, update, delete) methods to interact with objects on the YippieMove API.

To create objects, you may use the create subcommand:

$ ./yippiemove.py create order
{
    "batches": [],
    "created_at": "2012-09-10T08:24:50.556",
    "credits": 0,
    "move_jobs": [
        {
            "link": "/api/users/3/move_jobs/5/"
        }
    ],
    "link": "/api/users/3/orders/10/",
    "payments": [],
    "owner": {
        "link": "/api/users/3/"
    },
    "id": 10
}

The response is the JSON-encoded representation of the object you've created. Take note of the object's ID — you can use this to make further operations on this object.

To read objects, use the read subcommand and provide the object's type and its ID:

$ ./yippiemove.py read order 10
{
    "batches": [],
    "created_at": "2012-09-10T08:24:50.556",
    "credits": 0,
    "move_jobs": [
        {
            "link": "/api/users/3/move_jobs/5/"
        }
    ],
    "link": "/api/users/3/orders/10/",
    "payments": [],
    "owner": {
        "link": "/api/users/3/"
    },
    "id": 10
}

To update objects, use the update subcommand and provide the object's type, its ID, and the properties you'd like to change:

$ ./yippiemove.py update email_account 68 login=yippiemove

To delete objects, use the delete subcommand and provide the object's type and its ID. Please note that in most cases with the YippieMove API, you cannot delete objects after they've been created.

$ ./yippiemove.py delete email_account 68

To obtain a list of objects, use the list subcommand and provide the object's type and specific details needed for that query. For example, to obtain a list of email_account you must provide the move_job you want to list the accounts of. If you haven't provided the necessary properties an error will show, telling you exactly which property you were missing.

$ ./yippiemove.py list email_account move_job=77
[
    {
        "xoauth_requestor_id": "",
        "imap_port": 993,
        "xoauth_token_or_consumer_key": "",
        "updated_at": "2012-09-07T20:03:14.181",
        "imap_provider": null,
        "imap_host": "imap.gmail.com",
        "link": "/api/users/3/move_jobs/77/accounts/67/",
        "move_job": {
            "link": "/api/users/3/move_jobs/77/"
        },
        "login": "yippiemove",
        "is_destination": false,
        "id": 67,
        "imap_ssl": true
    },
    {
        "xoauth_requestor_id": "",
        "imap_port": 143,
        "xoauth_token_or_consumer_key": "",
        "updated_at": "2012-09-10T08:54:42.838",
        "imap_provider": null,
        "imap_host": "imap.mail.yahoo.com",
        "link": "/api/users/3/move_jobs/77/accounts/68/",
        "move_job": {
            "link": "/api/users/3/move_jobs/77/"
        },
        "login": "yippiemove",
        "is_destination": true,
        "id": 68,
        "imap_ssl": false
    }
]