Skip to main content
GET
/
api
/
v1
/
mails
/
{mailServerID}
/
messages
get all mails
curl --request GET \
  --url https://mail-service.iran.liara.ir/api/v1/mails/{mailServerID}/messages \
  --header 'Authorization: <api-key>'
{
  "status": "<string>",
  "data": {
    "total": 123,
    "messages": [
      {
        "createdAt": "<string>",
        "direction": "<string>",
        "from": "<string>",
        "hasHtml": true,
        "isDev": true,
        "isFree": true,
        "spamScore": true,
        "subject": "<string>",
        "to": "<string>",
        "text": "<string>",
        "status": {
          "event": "<string>",
          "state": "<string>",
          "details": "<string>"
        },
        "id": "<string>",
        "spamReson": {}
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Enter the token with the Bearer: prefix, e.g. "Bearer abcde12345". #

Path Parameters

mailServerID
string
required

Query Parameters

page
number
default:1
count
number
default:15
Required range: x <= 100
direction
enum<string>
required
Available options:
incoming,
outgoing
state
string
subject
string
from
string
to
string
isTrash
boolean
default:false

Response

OK

status
string
data
object