MAmailforge
Mailboxes

List mailboxes

Returns all mailboxes belonging to the account.

get/mailboxes

Request

  • Base URL
    https://api.mailforge.ai/public
  • Auth
    API key in header Authorization

Query parameters

with_credentialsboolean

Include IMAP/SMTP credentials in the response

Response

OK

createdAtstring
domainstring
domainIdstring
emailstring
failedReasonstring
firstNamestring
forwardingEmailstring
forwardingStatus'pending' | 'active' | 'failed'
idstring
isPrewarmedboolean
isTransferredboolean
lastNamestring
nameserversstring[]
signaturestring
status'draft' | 'active' | 'pending' | 'processing' | 'failed' | 'scheduled_for_deletion' | 'deleting'
updatedAtstring
usernamestring
workspaceIdstring

Example response

[
  {
    "credentials": {
      "imapHost": "imap.server.com",
      "imapPassword": "password",
      "imapPort": 993,
      "imapUsername": "user@example.com",
      "smtpHost": "smtp.server.com",
      "smtpPassword": "password",
      "smtpPort": 587,
      "smtpUsername": "user@example.com"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.