read

Search mail (iCloud Mail)

Search one folder by sender, recipient, subject, text, date or flags, newest first, without bodies; while code and link hiding is on, terms with digits or URL punctuation miss very recent mail.

post/v1/icloud_mail/search

Request

  • Base URL: https://muse.space
  • URL: https://muse.space/v1/icloud_mail/search
  • Auth: HTTP bearer

Request body

folderstring

Folder path as given by list_folders.

fromstring

Sender name or address contains this.

tostring

Recipient name or address contains this.

subjectstring

Subject contains this. Recent mail is left out as for text.

textstring

Subject or body contains this. While hiding is on, a term with a digit misses the last hour of mail, one with URL punctuation (= ? & / % : #) the last day.

sincestring date-time

Received at or after this time: with Z or an offset, or a date, from its start in UTC.

beforestring date-time

Received before this time: with Z or an offset, or a date, from its start in UTC.

unreadboolean

True for unread only, false for read only.

flaggedboolean

True for flagged only, false for unflagged only.

limitinteger

How many messages to return.

cursorstring

next_cursor of the previous page, same filters.

Response

The result.

totalinteger required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.