Sign in

v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB
emailService

Add a new folder to an email account

Adds a new folder to the email account specified by emailId.

post/email/v1/folders/{emailId}

Path parameters

emailIdinteger required
Example:10

The ID of the email

Request body

folder_namestring
pathstring
delimitterstring
is_trashboolean
is_spamboolean
is_draftboolean
is_junkboolean
is_sentboolean
is_inboxboolean
is_pendingboolean
has_childrenboolean
is_rootboolean

Example request

{
  "folder_name": "INBOX",
  "path": "INBOX",
  "delimitter": "/",
  "is_inbox": true,
  "is_root": true
}

Response

OK

idinteger
email_idinteger
parent_idinteger nullable
folder_namestring
pathstring
delimitterstring
is_trashboolean
is_spamboolean
is_draftboolean
is_junkboolean
is_sentboolean
is_inboxboolean
is_pendingboolean
has_childrenboolean
is_rootboolean
is_deletedboolean
message_countinteger
unread_message_countinteger

Example response

{
  "id": 61,
  "email_id": 10,
  "folder_name": "INBOX",
  "path": "INBOX",
  "delimitter": "/",
  "is_inbox": true,
  "is_root": true,
  "message_count": 4998,
  "unread_message_count": 43
}