reseller

is added when reseller has a customer specific business

Get Mailing Lists Of Domain

Description

Fetches all the mailing lists of domain of the specified Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglists.json?auth-userid=0&api-key=key&order-id=0

Response

Returns the list of all the mailing lists.

Modify Mailing List

Description

Modifies the specified mailing list.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
list-address String Required An email address representing mailing list
subscription-held Boolean Required Values can be: true or false.
who-can-post String Required Values can be: anyone, only_members or only_moderators.
send-messages-for-moderation Boolean Required Values can be: true or false.
reply-to String Required Values can be: sender, entire_list or custom_address.
custom-email String Optional An email address, required in case reply_to=custom_address
footer-text String Optional Text value for the footer

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/update.json?auth-userid=0&api-key=key&order-id=0&list-address=list-name@domainname.com&subscription-held=false&who-can-post=only_members&send-messages-for-moderation=false&reply-to=sender

Response

Returns "SUCCESS" as the status if a mailing list modified successfully.

Add Mailing List

Description

Adds a new mailing list.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
list-address String Required An email address representing mailing-list
subscription-held Boolean Required Values can be: true or false.
who-can-post String Required Values can be: anyone, only_members or only_moderators.
send-messages-for-moderation Boolean Required Values can be: true or false.
reply-to String Required Values can be: sender, entire_list or custom_address.
moderators String Required A CSV of email addresses
custom-email String Optional An email address, required in case reply_to=custom_address
footer-text String Optional Text value for the footer

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/add.json?auth-userid=0&api-key=key&order-id=0&list-address=list-name@domainname.com&subscription-held=false&who-can-post=only_members&send-messages-for-moderation=false&reply-to=sender&moderators=user1@domainname.com,user2@domainname.com

Response

Returns "SUCCESS" as the status if a mailing list added successfully.

Deactivate Catch-all Account

Description

Deactivates catch-all account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/deactivate-catchall.json?auth-userid=0&api-key=key&order-id=0

Response

Returns "SUCCESS" as the status if catch-all account deactivated successfully.

Activate Catch-all Account

Description

Activates catch-all account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
catchall-email String Required Email address which is a part of the domain of the order-id

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/activate-catchall.json?auth-userid=0&api-key=key&order-id=0&catchall-email=user1@domainname.com

Response

Returns "SUCCESS" as the status if catch-all account activated successfully.

Modify Notification Email

Description

Modifies the domain's notification(alternate) email address.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
notification-email String Required Notification email address

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/update-notification-email.json?auth-userid=0&api-key=key&order-id=0&notification-email=user1@emailaddress2.com

Response

Returns "SUCCESS" as the status if notification(alternate) email address of domain updated successfully.

Delete Domain Alias

Description

Deletes domain alias.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
alias String Required Alias Domain name

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/delete-alias.json?auth-userid=0&api-key=key&order-id=0&alias=alias-domainname.com

Response

Returns "SUCCESS" as the status if domain alias deleted successfully.

Add Domain Alias

Description

Adds domain alias.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
alias String Required Alias Domain name

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/add-alias.json?auth-userid=0&api-key=key&order-id=0&alias=alias-domainname.com

Response

Returns "SUCCESS" as the status if domain alias added successfully.

Check If Domain Ownership Verified

Description

Checks if domain ownership verified.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/domain/is-ownership-verified.json?auth-userid=0&api-key=key&order-id=0

Response

Returns true if domain ownership is verified.

Delete User Forwards

Note

This method will be deprecated on 30th march. All email accounts will be migrated to Open-Xchange and need to be managed from the Open-Xchange panel.

Description

Deletes user forwards.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user
forwards String Required Comma-separated email addresses

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/delete-user-forwards.json?auth-userid=0&api-key=key&order-id=0&email=username@domainname.com&forwards=user1@domainname.com,user2@domainname.com

Response

Returns "SUCCESS" as the status if user forwards deleted successfully.