Create a Mailbox

Creates a Mailbox resource for a given account.

smtppy.createmailbox(path, accountId)

Parameters

  • accountId (string) (required) - Filter by active status

  • path (string) (required) - The collection page number

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