Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - messageInfoType

  • Article
  • 2 minutes to read

Description

This type lists all the message.

Properties

Name Type Occurrence Description
messageId mailMessageIdType Required The message id.
subject xs:string Optional The message subject.
priority messagePriorityType Required The message priority.
deliveryStatus mailDeliveryStatusType Required The message delivery status.
unread xs:boolean Optional The message is currently marked as read/unread. true-unread, false=read.
flagged xs:boolean Optional The message has been flagged.
body xs:string Optional The message body (plain text version). The message body is truncated to 256 characters.
folderId mailFolderIdType Optional The ID of the folder.
timeSent xs:dateTime Optional Time sent.
timeReceived xs:dateTime Optional Time received.
senderName xs:string Optional The display name of the sender.
recipientNameTo xs:string Optional The display name or email-id of the recipient in TO list seperated by comma.
recipientNameCc xs:string Optional The display name or email-id of the recipient in CC list seperated by comma.
originType messageOriginType Optional The origin classification of the message (draft / inbound / outbound). See messageOriginType.
fileAttachmentCount numberType Optional The number of user-visible file attachments on the message (does not include inline/embedded images).
embeddedImageCount numberType Optional The number of inline/embedded images referenced from the HTML body of the message.
lockedBy accountIdType Optional The account that currently holds this message, or absent when nobody does. This carries two related meanings, depending on where the message lives.

For a message in the Drafts folder it is the draft’s owner - the account that composed it. Drafts are per-user: a draft owned by another account is never returned to you at all, so a value here is always your own account, and an absent value means the draft is unowned and visible to everyone with access to the mailbox. That is the distinction which decides the mail right needed to discard it - your own draft needs only editMessage, an unowned one needs deleteMessage.

For a message in any other folder it is an edit lock, taken by mail::lockMessage and released by mail::unlockMessage, and may name any account with access to the mailbox.
lockedAt xs:dateTime Optional When lockedBy was set, and absent whenever lockedBy is absent. For a draft this is effectively when composing started, because the owner is stamped as the draft is created and is not restamped by later saves - pair it with timeUpdated to see how long a draft has been sitting unfinished. For a message elsewhere it is when the edit lock was taken, which is what tells you whether a lock is stale.
timeUpdated xs:dateTime Optional When the message was last written - set as it is created and refreshed by every save, so for a draft this is the last-saved time. Unlike timeSent it moves, and unlike timeSent it means the same thing in every folder.

Absent on messages that were last written before this was recorded, so treat an absent value as unknown rather than as “never modified”; timeSent remains the creation time in that case.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document