GuidesAPI Reference
HostingEmail accounts

Create email account

POST/api/domains/{domain_code}/email_accounts

Creates a new email account on the domain and queues its activation.

Authorization

api_key
X-Api-Token<token>

API token used to authenticate requests.

In: header

Path Parameters

domain_code*string

Domain code: D followed by 9 digits. Example: D123456789.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Email account local part, without the domain.

description?string

Deprecated display name. Use firstname/lastname address book fields instead.

password_change_disabled?boolean

Prevent the user from changing their password.

autoresponder_enabled?boolean

Enable autoresponder.

autoresponder_subject?string

Autoresponder subject.

autoresponder_body?string

Autoresponder body.

password*string

Initial account password. Must be at least 8 characters long and contain at least one letter and one number.

password_confirmation*string

Must match password.

spam_in_inbox?boolean

Deliver spam to the inbox instead of the spam folder.

outbound_limit?integer

Outbound limit id. Use 0 to restore the default outbound limit.

Format int32
tags?string[]

Tags assigned to the email account.

forwards?string[]

Forwarding destination email addresses.

keep_copy?boolean

Keep a copy of forwarded messages in the mailbox.

max_email_quota?integer

Mailbox quota in bytes.

  • 52428800 = 50 MB.
  • 1073741824 = 1 GB.
  • 2147483648 = 2 GB.
  • 3221225472 = 3 GB.
  • 4294967296 = 4 GB.
  • 5368709120 = 5 GB.
  • 6442450944 = 6 GB.
  • 7516192768 = 7 GB.
  • 8589934592 = 8 GB.
  • 17179869184 = 16 GB.
  • 26843545600 = 25 GB.
  • 53687091200 = 50 GB.
  • 107374182400 = 100 GB.
Format int32Values 52428800 | 1073741824 | 2147483648 | 3221225472 | 4294967296 | 5368709120 | 6442450944 | 7516192768 | 8589934592 | 17179869184 | 26843545600 | 53687091200 | 107374182400
bounce_mail?boolean

Reject incoming mail for this account.

allow_nets?string[]

Allowed IP addresses or networks for account access.

pop_disabled?boolean

Disable POP access.

imap_disabled?boolean

Disable IMAP access.

smtp_disabled?boolean

Disable SMTP access.

webmail_disabled?boolean

Disable webmail access.

bounce_msg?string

Bounce message used when mail is rejected.

firstname*string

Address book first name. Required when creating an email account.

lastname?string

Address book last name.

language?string

Mailbox language.

  • it = Italian.
  • en = English.
  • es = Spanish.
Values it | en | es
timezone?string

Mailbox timezone.

secondary_email_account?string

Secondary/recovery email address.

country?string

Address book country.

state?string

Address book state/province.

zip?string

Address book postal code.

address?string

Address book street address.

company?string

Address book company.

role?string

Address book role/job title.

team_manager?string

Address book team manager.

telephone?string

Address book telephone number.

mobilephone?string

Address book mobile phone number.

fax?string

Address book fax number.

chat?boolean

Enable chat service.

activesync?boolean

Enable ActiveSync service.

meeting?boolean

Enable meeting service.

calendar?boolean

Enable calendar service.

dav?boolean

Enable DAV service.

password_expiration?integer

Password expiration interval in months.

  • -1 = never expire.
  • 3 = expire after 3 months.
  • 6 = expire after 6 months.
  • 12 = expire after 12 months.
Format int32Values -1 | 3 | 6 | 12
password_recovery_disabled?boolean

Disable password recovery for this account.

block_old_password?boolean

Prevent reusing old passwords.

api_enabled?boolean

Enable API access for this account.

force_otp?boolean

Require OTP for this account.

apply_allow_nets_webmail?boolean

Apply allowed-network restrictions to webmail access too.

webmail_language?string

Webmail UI language.

  • it = Italian.
  • en = English.
  • nl = Dutch.
  • sv = Swedish.
  • es = Spanish.
  • pt = Portuguese.
  • de = German.
  • gr = Greek.
  • fr = French.
Values it | en | nl | sv | es | pt | de | gr | fr
webmail_time_format?string

Webmail time format.

  • 12h = 12-hour clock.
  • 24h = 24-hour clock.
Values 12h | 24h
webmail_date_format?string

Webmail date format.

  • YYYY/MM/DD = year/month/day.
  • DD/MM/YYYY = day/month/year.
  • MM/DD/YYYY = month/day/year.
  • DD MMM YYYY = day abbreviated-month year.
  • MMM DD YYYY = abbreviated-month day year.
  • DD.MM.YYYY = day.month.year.
Values YYYY/MM/DD | DD/MM/YYYY | MM/DD/YYYY | DD MMM YYYY | MMM DD YYYY | DD.MM.YYYY
webmail_timezone?string

Webmail timezone.

organizational_unit?string

Address book organizational unit.

destroy_sessions_on_password_expiration?boolean

Destroy active sessions when the password expires.

restrict_from_field?boolean

Restrict the sender From field for this account.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/domains/string/email_accounts" \  -H "X-Api-Token: YOUR_API_TOKEN" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "password": "string",    "password_confirmation": "string",    "firstname": "string"  }'
{
  "message": "string",
  "resource_code": "string"
}
{
  "message": "Unauthorized",
  "errors": []
}
{
  "message": "Forbidden",
  "errors": []
}
{
  "message": "Not found",
  "errors": []
}
{
  "message": "Validation failed",
  "errors": [
    {
      "field": "name",
      "description": "is not valid"
    }
  ]
}

List email accounts GET

Previous Page

Get email account GET

Next Page