DevHub API Documentation
  • Introduction
  • Authentication
  • Errors
  • Getting started guides
    • Business-focused Sites
    • Location-focused Sites
    • Location pages and store locator with custom theme
    • Site publishing with site builder access
  • Code examples
    • Python
    • PHP
    • Perl
  • Best practices
    • Our unique IDs, versus yours
    • State and country codes
  • Core Resources
    • Sites
    • Businesses
    • Locations
    • Domains
    • Proxies
  • Content Resources
    • Pages
    • Content
    • Images
    • Files
    • Modules
    • Plugins
    • Themes
  • Logging and analytics
    • Analytics
    • Contact Logs
  • Single Sign On (SSO)
    • Introduction
    • Assigning a site's user
  • Live Preview API
    • What is the Live Preview API?
  • Advanced
    • Domain aliases
    • Language codes
    • Projects
    • Site Check
    • Traces
    • Webmail
  • Local Storage API
    • What is the Local Storage API?
  • Headless CMS
    • Locations search
  • Visitor Localization SDK
    • Visitor Localization SDK
Powered by GitBook
On this page
  • Email domains
  • Email domain model
  • Create an Email domain
  • List Email domains
  • Email mailboxes
  • Email mailbox object
  • Create Email mailbox
  • List Email mailboxes
  • Delete Email mailbox

Was this helpful?

  1. Advanced

Webmail

Email domains

The email domains resource is used to create the main email record for a domain (i.e. customerdomain.com) in which Email mailboxes will be created.

Email domain model

A email domain object contains the following fields

Attribute
Type
Description

id

integer

Unique id of the email domain

domain

string

Domain for the email domain (i.e. customerdomain.com)

Example object:

{
    "id": 12345,
    "domain": "customerdomain.com"
}

Create an Email domain

POST /api/v2/email_domain/

List Email domains

List all email domains under an instance

GET /api/v2/email_domain/

Email mailboxes

The email mailboxes resource is used to create the individual email mailboxes under an Email domain (example: johndoe@customerdomain.com)

Email mailbox object

Attribute
Type
Description

id

integer

Unique ID for the email mailbox

domain_id

integer

Email domain ID

name

string

Mailbox name under the domain. Example: an email of johndoe@customer.com would have a name value of "johndoe"

Example object:

{
    "id": 54321,
    "domain_id": 12345,
    "name": "johndoe"
}

Create Email mailbox

POST /api/v2/email_mailbox/

List Email mailboxes

List all the email mailboxes under a domain

GET /api/v2/email_mailbox/?domain=customerdomain.com

Delete Email mailbox

DELETE /api/v2/email_mailbox/:email_mailbox_id/

PreviousTracesNextWhat is the Local Storage API?

Last updated 2 years ago

Was this helpful?