v1

latestOpenAPI 3.0.02026-07-13474670.4 KB

Messages

List starred (saved) messages on the account

Get a list of messages that have been saved and made private for the entire account using the "star message" feature.

Messages recieved via the Capture Service will also show up as starred IF the capturePrivate flag on the account is enabled.

get/addresses/starred/messages

Response

List of email messages

_idstring string

Unique Mailsac-generated identifier for an email message

subjectstring

Email subject header line. Can be an empty string.

savedBystring

Indicates a starred message by your account Account._id. Otherwise null.

originalInboxstring

Same as inbox unless sent to the encryptedInbox, in which case it would be the encryptedInbox.

inboxstring email

Email address to which this message belongs.

domainstring domain

hostname domain for the inbox

receivedstring date

Date in ISO 8601

sizenumber

Content length in bytes of the original raw email message

attachmentsMd5sum[]

null or array of MD5 hashes of attachments. Use the Attachments API to get metadata and download attachments.

ipstring

The remote SMTP server that send the mail to the server at via

viastring

IP address of SMTP server that received the message from ip

folder'inbox' | 'all' | 'spam' | 'trash'

Inbox folder that this message has been put into

labelsstring[]

Custom inbox labels created by the end user

readboolean

Read/uread status. true=read, false=unread. Only set from the Inbox UI app.

rtlsboolean

When true, indicates the SMTP message was received over TLS (encrypted).

linksstring[]

List of any URLs that were found in the text and HTML body of the message.

spamnumber

Experimental - result of spam filter scan, between 0.0 and 1.0, where 1.0 indicates a high likelihood of being spam

Example response

[
  {
    "_id": "m3phnJ2ag3example-0",
    "domain": "example.com",
    "received": "1985-04-12T23:20:50.52Z",
    "attachments": [
      "5ea9c924627e68f988c9c7ca44340892"
    ],
    "spam": 0.345
  }
]