Email API

Revision as of 16:24, 15 November 2013

Mailboxes

• GET /accounts/{account}/email/{domain}/usernames - Retrieves a list of mailboxes
• GET /accounts/{account}/email/{domain}/usernames/{mailboxName} - Gets mailbox details
• PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox - Create or update mailbox data
• DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox - Deletes a mailbox

Forwards

• POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/forwards - Sets mailbox forwarding
• GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/forwards - Gets mailbox forwarding info
• DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/forwards/{fwd-mailbox} - Deletes mailbox forwarding

Autoresponder

• PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/autoresponder - Sets an auto-responder
• GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/autoresponder - Gets auto-responder info

CleanMailPlus

• GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/cleanmailplus - Gets mailbox's CleanMailPlus info
• PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/cleanmailplus - Updates mailbox's CleanMailPlus info

Webmail

• GET /accounts/{account}/email/{domain}/webmail - Getting OX allowUpgrade option for the domain
• PUT /accounts/{account}/email/{domain}/webmail - Change the OX allowUpgrade option for the domain
• GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail - Getting OX account type
• GET /email/{domain}/usernames/{mailboxName}/webmail - Getting OX account type
• POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail - Create OX account
• POST /email/{domain}/usernames/{mailboxName}/webmail - Create OX account
• PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail - Update/Downgrade OX account
• PUT /email/{domain}/usernames/{mailboxName}/webmail - Update/Downgrade OX account

InfoStore

• GET /accounts/{account}/email/{domain}/infostore - Getting InfoStore usage
• PUT /accounts/{account}/email/{domain}/infostore - Change InfoStore quota

Mailbox domain statistics

• GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount - Retrieves per domain statistics about webmail usage

Mailbox migration failure

• POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/migration - Creating support ticket for failed mailbox migration

Global Address Book

• POST /accounts/{account}/email/{domain}/contacts - Creates global address book contact for domain
• GET /accounts/{account}/email/{domain}/contacts - Search/Filter domain's global address book contacts list
• GET /accounts/{account}/email/{domain}/contacts/{contact} - Gets domain's global address book contact info
• PUT /accounts/{account}/email/{domain}/contacts/{contact} - Updates domain's global address book contact info
• DELETE /accounts/{account}/email/{domain}/contacts/{contact} - Deletes domain's global address book contact