Email API
From Hostway API Documentation
Revision as of 13:14, 24 July 2015 by Mike.robski (Talk | contribs)
Mailboxes
- GET /accounts/{account}/email/{domain}/usernames - Retrieves a list of mailboxes
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName} - Details about a username
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox - 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
- POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/action - Apply action on a mailbox, e.g. reset password
Exchange
- PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange - Create or update exchange mailbox
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange - Get exchange mailbox info
- DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange - Delete exchange mailbox
- POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/action - Apply action on exchange mailbox, e.g. reset password
Aliases
- GET /accounts/{account}/email/{domain}/aliases - Retrieves a list of domain aliases
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
- GET /email/{domain}/usernames/{mailboxName}/webmail - Getting OX account
- 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 OX account
- PUT /email/{domain}/usernames/{mailboxName}/webmail - Update OX account
Black/White List
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist - Retrieves black/whitelisted addresses
- PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist - Adds address(es) to black/white list
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist/{address} - Get particular address info
- DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist/{address} - Deletes an address from black/white list
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
Mailbox Message Count
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats - Get mailbox message count for INBOX, SENT and SPAM folders
Exchange Message Count
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/exchange/messagestats - Get exchange message count for INBOX, SENT and SPAM folders
Email Domain
- GET /accounts/{account}/email/{domain} - Gets specific email domain's info
Domain Black/White List
- GET /accounts/{account}/email/{domain}/blackwhitelist - Retrieves black/whitelisted addresses for domain
- PUT /accounts/{account}/email/{domain}/blackwhitelist - Adds address(es) to black/white list for domain
- GET /accounts/{account}/email/{domain}/blackwhitelist/{address} - Get particular address info
- DELETE /accounts/{account}/email/{domain}/blackwhitelist/{address} - Deletes an address from black/white list
Domain CleanMailPlus
- GET /accounts/{account}/email/{domain}/cleanmailplus - Gets domain's CleanMailPlus info
- PUT /accounts/{account}/email/{domain}/cleanmailplus - Updates domain's CleanMailPlus info
Secret Questions
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets - Retrieves a list of mailbox(alias) secret questions
- PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets - Set or update all secret questions and answers for mailbox(alias)
Secret Question Settings
- GET /email/secretQuestionSettings - Get franchise specific secret question settings (e.g. minimum required number of secret questions, etc.)
Supported Secret Questions
- GET /email/secretQuestions - Get dictionary of supported secret questions with text keys
Templates
