Email API
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 96) |
(→Secret Questions) |
||
| Line 4: | Line 4: | ||
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - Create or update mailbox data | * [[Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - Create or update mailbox data | ||
* [[Accounts-account-email-domain-usernames-mailboxName-mailbox:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - Deletes a mailbox | * [[Accounts-account-email-domain-usernames-mailboxName-mailbox:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox]] - Deletes a mailbox | ||
| + | |||
| + | <blockquote> | ||
| + | === Mailbox Actions === | ||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-mailbox-action:POST|POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/action]] - Apply action on a mailbox, e.g. reset password | ||
| + | * [[Email-domain-usernames-mailboxName-mailbox-action:POST|POST /email/{domain}/usernames/{mailboxName}/mailbox/action]] - Apply action on a mailbox, e.g. reset password (shorcut) | ||
| + | |||
| + | === Secret Questions === | ||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-secrets:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets]] - Retrieves a list of mailbox(alias) secret questions | ||
| + | * [[Email-domain-usernames-mailboxName-secrets:GET|GET /email/{domain}/usernames/{mailboxName}/secrets]] - Retrieves a list of mailbox(alias) secret questions (shorcut) | ||
| + | |||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-secrets:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets]] - Set or update all secret questions and answers for mailbox(alias) | ||
| + | * [[Email-domain-usernames-mailboxName-secrets:PUT|PUT /email/{domain}/usernames/{mailboxName}/secrets]] - Set or update all secret questions and answers for mailbox(alias) (shorcut) | ||
| + | </blockquote> | ||
== Aliases == | == Aliases == | ||
| Line 46: | Line 59: | ||
== Email Domain == | == Email Domain == | ||
* [[Accounts-account-email-domain:GET|GET /accounts/{account}/email/{domain}]] - Gets specific email domain's info | * [[Accounts-account-email-domain:GET|GET /accounts/{account}/email/{domain}]] - Gets specific email domain's info | ||
| + | |||
| + | == Supported Secret Questions == | ||
| + | * [[Email-secretQuestions:GET|GET /email/secretQuestions]] - Get dictionary of supported secret questions with text keys | ||
<!-- Global Address Book API is not supported at this time | <!-- Global Address Book API is not supported at this time | ||
Revision as of 10:51, 5 September 2014
Contents |
Mailboxes
- GET /accounts/{account}/email/{domain}/usernames - Retrieves a list of mailboxes
- 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
Mailbox Actions
- POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/action - Apply action on a mailbox, e.g. reset password
- POST /email/{domain}/usernames/{mailboxName}/mailbox/action - Apply action on a mailbox, e.g. reset password (shorcut)
Secret Questions
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets - Retrieves a list of mailbox(alias) secret questions
- GET /email/{domain}/usernames/{mailboxName}/secrets - Retrieves a list of mailbox(alias) secret questions (shorcut)
- PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets - Set or update all secret questions and answers for mailbox(alias)
- PUT /email/{domain}/usernames/{mailboxName}/secrets - Set or update all secret questions and answers for mailbox(alias) (shorcut)
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
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
Email Domain
- GET /accounts/{account}/email/{domain} - Gets specific email domain's info
Supported Secret Questions
- GET /email/secretQuestions - Get dictionary of supported secret questions with text keys
