read

Read a message (iCloud Mail)

Read one message as headers, plain body text and attachment details, with one-time codes and reset links removed.

post/v1/icloud_mail/read

Request

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

Request body

idstring required

Message id from search or an event.

max_charsinteger

Most characters of body text to return.

cursorstring

next_cursor of the previous part, to continue.

mark_readboolean

Also mark the message as read, which needs write access.

Response

The result.

idstring required
datestring date-time required
fromstring required
tostring[] required
ccstring[]
reply_tostring
subjectstring required
unreadboolean required
flaggedboolean required
body_textstring required
truncatedboolean required
next_cursorstring nullable required

Changes

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