Get an Account

Get an Account resource by its id

smtppy.getaccount(accountId)

Parameters

  • accountId (string) (required) - The account you want to get by id

Response

{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "string",
  "address": "user@example.com",
  "quota": 0,
  "used": 0,
  "isActive": false,
  "isDeleted": true,
  "mailboxes": [
    {
      "@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