GET /mail/{id}/log

Get a listing of the emails sent through this system

Path parameters

  • id integer Required

    Mail ID number

Query parameters

  • id integer(int64)

    The ID of your mail order this will be sent through.

  • origin string

    originating ip address sending mail

  • mx string

    mx record mail was sent to

  • from string

    from email address

  • to string

    to/destination email address

  • subject string

    subject containing this string

  • mailid string

    mail id

  • skip integer(int32)

    number of records to skip for pagination

    Minimum value is 0. Default value is 0.

  • limit integer(int32)

    maximum number of records to return

    Minimum value is 1, maximum value is 10000. Default value is 100.

  • startDate integer(int64)

    earliest date to get emails in unix timestamp format

    Minimum value is 0, maximum value is 9999999999.

  • endDate integer(int64)

    earliest date to get emails in unix timestamp format

    Minimum value is 0, maximum value is 9999999999.

Responses

  • 200 application/json

    search results matching criteria

    Hide response attributes Show response attributes object
    • total integer Required

      total number of mail log entries

    • skip integer Required

      number of emails skipped in listing

    • limit integer Required

      number of emails to return

    • emails array[object] Required

      An email record

      Hide emails attributes Show emails attributes object
      • _id integer Required

        internal db id

      • id string Required

        mail id

      • from string Required

        from address

      • to string Required

        to address

      • subject string Required

        email subject

      • messageId string

        message id

      • created string Required

        creation date

      • time integer Required

        creation timestamp

      • user string Required

        user account

      • transtype string Required

        transaction type

      • origin string Required

        origin ip

      • interface string Required

        interface name

      • sendingZone string Required

        sending zone

      • bodySize integer Required

        email body size in bytes

      • seq integer Required

        index of email in the to adderess list

      • recipient string Required

        to address this email is being sent to

      • domain string Required

        to address domain

      • locked integer Required

        locked status

      • lockTime integer Required

        lock timestamp

      • assigned string Required

        assigned server

      • queued string Required

        queued timestamp

      • mxHostname string Required

        mx hostname

      • response string Required

        mail delivery response

  • 400

    bad input parameter

GET /mail/{id}/log
curl \
 --request GET 'https://my.interserver.net/apiv2/mail/{id}/log' \
 --header "X-API-KEY: $API_KEY"
Response examples (200)
{
  "skip": 0,
  "limit": 100,
  "total": 1,
  "emails": [
    {
      "id": "17c7eda538e0005d03",
      "to": "client@isp.com",
      "_id": 103172,
      "seq": 1,
      "from": "person@mysite.com",
      "time": 1634215809,
      "user": "mb5658",
      "domain": "interserver.net",
      "locked": 1,
      "origin": "199.231.189.154",
      "queued": "2021-10-14T12:50:15.487Z",
      "created": "2021-10-14 08:50:10",
      "subject": "sell 0.005 shares",
      "assigned": "relay1",
      "bodySize": 63,
      "lockTime": "1634215818533",
      "response": "250 2.0.0 Ok queued as C91D83E128C",
      "interface": "feeder",
      "messageId": "<vmiLEebsuCbSpUxD7oN3REpaN4VbN6BrdCAbNKIrdAo@relay0.mailbaby.net>",
      "recipient": "client@isp.com",
      "transtype": "ESMTPSA",
      "mxHostname": "mx.j.is.cc",
      "sendingZone": "interserver"
    }
  ]
}