Get a Mailbox

Retrieves a Mailbox resource by its id.

smtppy.getmailbox(accountId, mailboxId)

Parameters

  • accountId (string) (required) - The account identifier.

  • mailboxId (string) (required) - The mailbox identifier.

Response

{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "string",
  "path": "string",
  "totalMessages": 0,
  "totalUnreadMessages": 0,
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z"
}

Want to learn about writing content from scratch? Head to the Basics section to learn more.

Last updated