Docs
⌘K
Email ›

Get email

GET/v1/email

The account's mail: the handle every address of its sandboxes carries, what its plan allows, and what it has had of that today.

RequestTypeScript
  1. import { Agental } from "agental-sdk";
  3. const agental = new Agental();
  4. const email = await agental.email();
Answer200 OK · AccountEmail
  1. {
  2. "handle": string | null,
  3. "domain": string | null,
  4. "limits": {
  5. "receivedPerDay": integer,
  6. "receivedBytesPerDay": integer,
  7. "keptBytes": integer,
  8. "sentPerHour": integer,
  9. "sentPerDay": integer,
  10. "sentBytesPerDay": integer,
  11. },
  12. "today": {
  13. "received": integer,
  14. "receivedBytes": integer,
  15. "sent": integer,
  16. "sentBytes": integer,
  17. },
  18. "keptBytes": integer,
  19. }

The account's handle, limits and use.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 The account's handle, limits and use.

AccountEmail5 fields
handle
stringnull
The account's part of every address.
More It is generated, never chosen, and never given to another account. Null where no mail is offered.
domain
stringnull
What every sandbox's mail domain of this account ends in.
limits
object6 fields
receivedPerDay
integer
receivedBytesPerDay
integer
keptBytes
integer
Stored mail is free up to this.
More Past it, new mail is refused until some is deleted or is 7 days old.
sentPerHour
integer
sentPerDay
integer
sentBytesPerDay
integer
today
object4 fields
What the account has had of its limits in the UTC day it is now, across all its sandboxes.
More Deleting a message gives none of it back.
received
integer
receivedBytes
integer
sent
integer
sentBytes
integer
keptBytes
integer
Bytes of mail the account has stored now.
← Get email message rawGet sandbox metrics →