Hosting Email User

/hosting-email-user

GET

JSON response

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-email-user" | python -m json.tool

POST

JSON request

hosting_account string The hosting account ID for which to create the object.
username string An email address which is used at the username.
password string  
type string One of ‘basic’, ‘business’ or ‘pro’.
drive_storage_quota number The drive storage quota in MB.
storage_quota number The email user storage quota in MB.
is_documents_enabled boolean Enable Open-Xchange document editor.
is_hosted_remote boolean If true, no email box is created locally.
imap_username string Optional IMAP user name Open-Xchange uses for authentication if different from the username field.

JSON response

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "account": "ac-12345",
        "username": "info@example.com",
        "password": "welcome123",
        "type": "business",
        "drive_storage_quota": 5120,
        "storage_quota": 10240,
        "is_documents_enabled": false
    }
' \
"{{api_base_url}}/hosting-email-user" | python -m json.tool

/hosting-email-user/{id}

GET

JSON response

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-email-user/{id}" | python -m json.tool

PUT

JSON request

password string  
type string One of ‘basic’, ‘business’ or ‘pro’.
drive_storage_quota number The drive storage quota in MB.
storage_quota number The email user storage quota in MB.
is_documents_enabled boolean Enable Open-Xchange document editor.
imap_username string Optional IMAP user name Open-Xchange uses for authentication if different from the username field.

JSON response

Sample

curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "password": "welcome123",
        "type": "business",
        "drive_storage_quota": 5120,
        "storage_quota": 10240,
        "is_documents_enabled": false,
        "imap_username": "example",
    }
' \
"{{api_base_url}}/hosting-email-user/{id}" | python -m json.tool

DELETE

Sample

curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-email-user/{id}" | python -m json.tool