Skip to Content

Configure vanity hostname.

Claims and verifies a custom vanity subdomain for a specific protocol service (mail, smtp, webmail, dav, mx).

openemail.hostnames.set(
  domain: string,
  service: ('mail' | 'smtp' | 'webmail' | 'dav' | 'mx'),
  body: HostnamesSetBody,
  options?: CallOptions,
): ApiPromise<DomainHostnameList>

It calls PUT /domains/{domain}/hostnames/{service}: Configure vanity hostname in the API reference.

Example

const domainHostnameList = await openemail.hostnames.set(domain, service, { hostname: 'mail.example.com' })

Arguments

ArgumentTypeDescription
domainstringCustomer domain name (e.g. example.com). The path's {domain}.
service('mail' | 'smtp' | 'webmail' | 'dav' | 'mx')Which client-facing service the hostname fronts. The path's {service}.
bodyHostnamesSetBodyThe request's body.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, DomainHostnameList. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, invalid_hostname, hostname_not_subdomain, hostname_reserved, or hostname_in_foreign_domain
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403vanity_hosts_disabled — not enabled for this account
404Domain not found or not accessible to this principal
409hostname_taken, service_unavailable, or domain_is_alias
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

HostnamesSetBody

/** The body of `hostnames.set`. */
type HostnamesSetBody = {
  /** Subdomain FQDN to claim (e.g. 'mail.example.com') */
  hostname: string
}

It names these types of the API, each on a page of its own: DomainHostnameList.