Skip to content

MailMailboxesApi.md

Latest commit

 

History

History
322 lines (221 loc) · 11 KB

MailMailboxesApi.md

File metadata and controls

322 lines (221 loc) · 11 KB
Raw

hostinger_api.MailMailboxesApi

All URIs are relative to https://developers.hostinger.com

Method HTTP request Description
change_mailbox_password_v1 PATCH /api/mail/v1/mailboxes/{mailboxId}/password Change mailbox password
create_mailbox_v1 POST /api/mail/v1/orders/{orderId}/mailboxes Create mailbox
delete_mailbox_v1 DELETE /api/mail/v1/mailboxes/{mailboxId} Delete mailbox
get_mailbox_list_v1 GET /api/mail/v1/orders/{orderId}/mailboxes Get mailbox list

change_mailbox_password_v1

CommonSuccessEmptyResource change_mailbox_password_v1(mailbox_id, mail_v1_schema_change_mailbox_password_request_schema)

Change mailbox password

Change the password of a mailbox.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.models.mail_v1_schema_change_mailbox_password_request_schema import MailV1SchemaChangeMailboxPasswordRequestSchema
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.MailMailboxesApi(api_client)
    mailbox_id = 'AC1a2b3c4d5e6f7g' # str | Mailbox resource ID
    mail_v1_schema_change_mailbox_password_request_schema = hostinger_api.MailV1SchemaChangeMailboxPasswordRequestSchema() # MailV1SchemaChangeMailboxPasswordRequestSchema | 

    try:
        # Change mailbox password
        api_response = api_instance.change_mailbox_password_v1(mailbox_id, mail_v1_schema_change_mailbox_password_request_schema)
        print("The response of MailMailboxesApi->change_mailbox_password_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MailMailboxesApi->change_mailbox_password_v1: %s\n" % e)

Parameters

Name Type Description Notes
mailbox_id str Mailbox resource ID
mail_v1_schema_change_mailbox_password_request_schema MailV1SchemaChangeMailboxPasswordRequestSchema

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
400 Error response -
404 Error response -
422 Error response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_mailbox_v1

MailV1MailboxesMailboxResource create_mailbox_v1(order_id, mail_v1_schema_create_mailbox_request_schema)

Create mailbox

Create a mailbox under the given mail order. The full email address is composed from the given local part and the domain of the order.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.mail_v1_mailboxes_mailbox_resource import MailV1MailboxesMailboxResource
from hostinger_api.models.mail_v1_schema_create_mailbox_request_schema import MailV1SchemaCreateMailboxRequestSchema
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.MailMailboxesApi(api_client)
    order_id = 'OR1a2b3c4d5e6f7g' # str | Order resource ID
    mail_v1_schema_create_mailbox_request_schema = hostinger_api.MailV1SchemaCreateMailboxRequestSchema() # MailV1SchemaCreateMailboxRequestSchema | 

    try:
        # Create mailbox
        api_response = api_instance.create_mailbox_v1(order_id, mail_v1_schema_create_mailbox_request_schema)
        print("The response of MailMailboxesApi->create_mailbox_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MailMailboxesApi->create_mailbox_v1: %s\n" % e)

Parameters

Name Type Description Notes
order_id str Order resource ID
mail_v1_schema_create_mailbox_request_schema MailV1SchemaCreateMailboxRequestSchema

Return type

MailV1MailboxesMailboxResource

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created response -
401 Unauthenticated response -
404 Error response -
409 Error response -
422 Error response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_mailbox_v1

CommonSuccessEmptyResource delete_mailbox_v1(mailbox_id)

Delete mailbox

Delete a mailbox. The mailbox is soft-deleted and stays restorable for a limited period before it is permanently removed.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.MailMailboxesApi(api_client)
    mailbox_id = 'AC1a2b3c4d5e6f7g' # str | Mailbox resource ID

    try:
        # Delete mailbox
        api_response = api_instance.delete_mailbox_v1(mailbox_id)
        print("The response of MailMailboxesApi->delete_mailbox_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MailMailboxesApi->delete_mailbox_v1: %s\n" % e)

Parameters

Name Type Description Notes
mailbox_id str Mailbox resource ID

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
404 Error response -
409 Error response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_mailbox_list_v1

MailGetMailboxListV1200Response get_mailbox_list_v1(order_id, search=search, sort=sort, page=page, per_page=per_page)

Get mailbox list

Retrieve a paginated list of mailboxes belonging to a mail order.

Use this endpoint to monitor mailboxes of your mail service, including their status, enabled protocols, attached resource counts, and periodically synced usage numbers (usage may lag behind live values).

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.mail_get_mailbox_list_v1200_response import MailGetMailboxListV1200Response
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.MailMailboxesApi(api_client)
    order_id = 'OR1a2b3c4d5e6f7g' # str | Order resource ID
    search = 'info' # str | Filter mailboxes whose email address contains the given string (optional)
    sort = address # str | Sort mailboxes by field. Prefix with `-` for descending order. (optional) (default to address)
    page = 1 # int | Page number (optional)
    per_page = 25 # int | Number of items per page (optional) (default to 25)

    try:
        # Get mailbox list
        api_response = api_instance.get_mailbox_list_v1(order_id, search=search, sort=sort, page=page, per_page=per_page)
        print("The response of MailMailboxesApi->get_mailbox_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MailMailboxesApi->get_mailbox_list_v1: %s\n" % e)

Parameters

Name Type Description Notes
order_id str Order resource ID
search str Filter mailboxes whose email address contains the given string [optional]
sort str Sort mailboxes by field. Prefix with `-` for descending order. [optional] [default to address]
page int Page number [optional]
per_page int Number of items per page [optional] [default to 25]

Return type

MailGetMailboxListV1200Response

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
404 Error response -
422 Error response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]