Email API
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 101) |
Corinne.chui (Talk | contribs) m (1 revision) |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 38: | Line 38: | ||
* [[Accounts-account-email-domain-usernames-mailboxName-webmail:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail]] - Update OX account | * [[Accounts-account-email-domain-usernames-mailboxName-webmail:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/webmail]] - Update OX account | ||
* [[Email-domain-usernames-mailboxName-webmail:PUT|PUT /email/{domain}/usernames/{mailboxName}/webmail]] - Update OX account | * [[Email-domain-usernames-mailboxName-webmail:PUT|PUT /email/{domain}/usernames/{mailboxName}/webmail]] - Update OX account | ||
| + | * [[Accounts-account-email-domain-webmailLimits:GET|GET /accounts/{account}/email/{domain}/webmailLimits]] - Getting maximum allowed number of mailboxes for each type | ||
| + | * [[Accounts-account-email-domain-webmailUpgrade:GET|GET /accounts/{account}/email/{domain}/webmailUpgrade]] - Getting OX allowUpgrade option for the product | ||
| + | * [[Accounts-account-email-domain-webmailUpgrade:GET|GET /email/{domain}/webmailUpgrade]] - Getting OX allowUpgrade option for the product | ||
| + | |||
| + | == Webmail Names == | ||
| + | * [[Accounts-account-email-domain-webmailNames:GET|GET /accounts/{account}/email/{domain}/webmailNames]] - Returns mapping of allowed OX types with webmail names for the domain | ||
| + | * [[Accounts-account-email-domain-webmailNames:GET|GET /email/{domain}/webmailNames]] - Returns mapping of allowed OX types with webmail names for the domain | ||
| + | |||
| + | == Black/White List == | ||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist]] - Retrieves black/whitelisted addresses | ||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist:PUT|PUT /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist]] - Adds address(es) to black/white list | ||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist-address:GET|GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist/{address}]] - Get particular address info | ||
| + | * [[Accounts-account-email-domain-usernames-mailboxName-blackwhitelist-address:DELETE|DELETE /accounts/{account}/email/{domain}/usernames/{mailboxName}/blackwhitelist/{address}]] - Deletes an address from black/white list | ||
== InfoStore == | == InfoStore == | ||
| Line 57: | Line 70: | ||
== 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 | ||
| + | |||
| + | == Domain Black/White List == | ||
| + | * [[Accounts-account-email-domain-blackwhitelist:GET|GET /accounts/{account}/email/{domain}/blackwhitelist]] - Retrieves black/whitelisted addresses for domain | ||
| + | * [[Accounts-account-email-domain-blackwhitelist:PUT|PUT /accounts/{account}/email/{domain}/blackwhitelist]] - Adds address(es) to black/white list for domain | ||
| + | * [[Accounts-account-email-domain-blackwhitelist-address:GET|GET /accounts/{account}/email/{domain}/blackwhitelist/{address}]] - Get particular address info | ||
| + | * [[Accounts-account-email-domain-blackwhitelist-address:DELETE|DELETE /accounts/{account}/email/{domain}/blackwhitelist/{address}]] - Deletes an address from black/white list | ||
| + | |||
| + | == Domain CleanMailPlus == | ||
| + | * [[Accounts-account-email-domain-cleanmailplus:GET|GET /accounts/{account}/email/{domain}/cleanmailplus]] - Gets domain's CleanMailPlus info | ||
| + | * [[Accounts-account-email-domain-cleanmailplus:PUT|PUT /accounts/{account}/email/{domain}/cleanmailplus]] - Updates domain's CleanMailPlus info | ||
== Secret Questions == | == Secret Questions == | ||
| Line 67: | Line 90: | ||
== Supported Secret Questions == | == Supported Secret Questions == | ||
* [[Email-secretQuestions:GET|GET /email/secretQuestions]] - Get dictionary of supported secret questions with text keys | * [[Email-secretQuestions:GET|GET /email/secretQuestions]] - Get dictionary of supported secret questions with text keys | ||
| + | |||
| + | == Antivirus Antispam == | ||
| + | *[[Avas-SSO:GET|GET /accounts/{accountId}/avas/{domain}/SSOLink]] - Returns a SSO Link for antispam control panel | ||
<!-- Global Address Book API is not supported at this time | <!-- Global Address Book API is not supported at this time | ||
Latest revision as of 12:28, 16 November 2016
[edit] 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
[edit] 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
[edit] Aliases
- GET /accounts/{account}/email/{domain}/aliases - Retrieves a list of domain aliases
[edit] 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
[edit] 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
[edit] 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
[edit] 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
- GET /accounts/{account}/email/{domain}/webmailLimits - Getting maximum allowed number of mailboxes for each type
- GET /accounts/{account}/email/{domain}/webmailUpgrade - Getting OX allowUpgrade option for the product
- GET /email/{domain}/webmailUpgrade - Getting OX allowUpgrade option for the product
[edit] Webmail Names
- GET /accounts/{account}/email/{domain}/webmailNames - Returns mapping of allowed OX types with webmail names for the domain
- GET /email/{domain}/webmailNames - Returns mapping of allowed OX types with webmail names for the domain
[edit] 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
[edit] InfoStore
- GET /accounts/{account}/email/{domain}/infostore - Getting InfoStore usage
- PUT /accounts/{account}/email/{domain}/infostore - Change InfoStore quota
[edit] Mailbox domain statistics
- GET /accounts/{account}/email/{domain}/statistics/mailboxTypeCount - Retrieves per domain statistics about webmail usage
[edit] Mailbox migration failure
- POST /accounts/{account}/email/{domain}/usernames/{mailboxName}/migration - Creating support ticket for failed mailbox migration
[edit] Mailbox Message Count
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/messagestats - Get mailbox message count for INBOX, SENT and SPAM folders
[edit] Exchange Message Count
- GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/exchange/messagestats - Get exchange message count for INBOX, SENT and SPAM folders
[edit] Email Domain
- GET /accounts/{account}/email/{domain} - Gets specific email domain's info
[edit] 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
[edit] Domain CleanMailPlus
- GET /accounts/{account}/email/{domain}/cleanmailplus - Gets domain's CleanMailPlus info
- PUT /accounts/{account}/email/{domain}/cleanmailplus - Updates domain's CleanMailPlus info
[edit] 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)
[edit] Secret Question Settings
- GET /email/secretQuestionSettings - Get franchise specific secret question settings (e.g. minimum required number of secret questions, etc.)
[edit] Supported Secret Questions
- GET /email/secretQuestions - Get dictionary of supported secret questions with text keys
[edit] Antivirus Antispam
- GET /accounts/{accountId}/avas/{domain}/SSOLink - Returns a SSO Link for antispam control panel
[edit] Templates
