openemail app-host

Returns the web app address of the workspace with everything the Branded app tab shows: the address, such as mailbox.example.com, the verified domain it sits under, its status, whether people can sign in there right now, the DNS records to publish and when it was last checked. A workspace has at most one.

The address can be on one of the verified domains of the workspace, where it needs only the CNAME record in record, or on any other domain the workspace controls, where it also needs the TXT record in ownershipRecord that proves the domain is yours. domain and domainId are null for an address on another domain.

With no address set, status is none, host, record and the other fields about the address are null, domains lists the verified domains of the workspace and suggested is the address the app would offer, mailbox. in front of the first of them.

Reading it checks the address again when its last check is more than 15 seconds old, so polling get is one way to wait for it to go live: active turns true on the read whose check finds it live. verify checks straight away.

Only the members of the workspace, the people who sign in with one of its addresses and anyone with a pending invitation can sign in at the address, and they see the workspace brand there. On the free plan the address is kept but paused: paused is true, active is false and nobody can sign in there until the workspace is on a paid plan again.

Sets the web app address of the workspace, replacing any it had, and returns it in the same shape as get. host is a subdomain such as mailbox.example.com, on a verified domain of the workspace or on any other domain you control, and the workspace has to be on a paid plan. Setting the address it already has changes nothing and checks it again.

On a verified domain of the workspace the address is set up during the call. On any other domain it is set up once the TXT record in ownershipRecord answers, which proves the domain is yours. Either way it stays pending until its records answer and its certificate is issued, usually a few minutes after they are published. Publish record, and ownershipRecord when it is not null, at your DNS provider exactly as given, then call verify or poll get until active is true. The call writes no DNS record itself.

An address on another domain replaces the old one once it is set up, and an address on the same domain replaces it straight away. Everyone signed in at a replaced address is signed out.

Only the members of the workspace, the people who sign in with one of its addresses and anyone with a pending invitation can sign in at the address, under the workspace brand. Anyone else gets the usual wrong email or password answer, and an invited person can create their account there.

Checks the web app address straight away, whether its DNS records answer and its certificate is issued, and returns it in the same shape as get.

When the last check ran less than 10 seconds ago, nothing new is checked and the address comes back as it stands, so calling it faster than that gains nothing. With no address set, nothing is checked and status comes back as none. A record published a moment ago can take a few minutes to show up in public DNS.

Removes the web app address of the workspace. Everyone signed in there is signed out, the address stops opening the workspace, and emails link to openemail.uk again. People keep working at openemail.uk with the same accounts.

Its DNS records are left at your DNS provider, so remove them there when you no longer need them. Removing the address when none is set changes nothing and answers deleted: false. Setting the same address again later sets it up from scratch.