Skip to main content
GET
/
api
/
v1
/
mail
/
{folder}
List emails in folder
curl --request GET \
  --url http://localhost:3001/api/v1/mail/{folder} \
  --cookie nut-session=
{
  "success": true,
  "data": {
    "messages": [
      {
        "id": "<string>",
        "emailId": "<string>",
        "from": "Acme <hello@acme.com>",
        "to": [
          "<string>"
        ],
        "subject": "<string>",
        "folder": "inbox",
        "cc": [
          "<string>"
        ],
        "bcc": [
          "<string>"
        ],
        "messageId": "<string>",
        "attachments": [
          {
            "id": "<string>",
            "filename": "<string>",
            "contentType": "<string>",
            "contentDisposition": "<string>",
            "contentId": "<string>"
          }
        ],
        "receivedAt": "2023-11-07T05:31:56Z",
        "content": "<string>"
      }
    ]
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Path Parameters

folder
enum<string>
required

Mail folder Mail folder name

Available options:
inbox,
read,
sent

Response

List of emails

success
boolean
required
data
object