Mailboxes

Create Mailbox

Connect an existing mailbox over IMAP/SMTP.

Credentials are write-only — they are stored encrypted and never returned by this or any other endpoint. Google/Microsoft mailboxes need the browser OAuth flow and cannot be connected here.

Routes to the same CreateMailboxHandler the in-app "add mailbox" screen uses, so validation and provider detection behave identically.

post/mailboxes

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

emailstring required

The mailbox address, e.g. sales@acme.com

smtp_addressstring required

SMTP host, e.g. smtp.acme.com

smtp_usernamestring required
smtp_passwordstring required

Write-only. Never returned by any endpoint.

imap_addressstring required

IMAP host, e.g. imap.acme.com

imap_usernamestring required
imap_passwordstring required

Write-only. Never returned by any endpoint.

display_namestring nullable
smtp_portinteger
imap_portinteger
authenticationstring
enable_starttls_autoboolean
daily_limitinteger

Max sends per day for this mailbox

signature_htmlstring nullable
signature_plainstring nullable
use_html_signatureboolean

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.