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 - mailboxMoveRuleType

  • Article
  • 1 minutes to read

Description

One entry of the interactive message move rules: given a message of a particular origin sitting in a folder of a particular type, the folder types it may be moved into.

        'toFolderType' is repeated once for each permitted destination type, and is absent altogether when the
        combination permits no move at all - a message in the Outbox, or a draft in Deleted Items. An absent
        'toFolderType' therefore means "no destination is valid", not "this rule is unknown".<br/><br/>

        The rules are expressed in folder TYPES, so a permitted 'userDefined' destination means any user-created
        folder of the mailbox. A move from a folder to itself is never useful and is not described here; a client
        must exclude the message's own folder from the destinations it offers.

Properties

Name Type Occurrence Description
fromFolderType mailFolderType Required The type of the folder the message is currently in.
originType messageOriginType Required The origin classification of the message, as reported by the ‘originType’ field of messageInfoType and the getMessage response.
toFolderType Array<mailFolderType> Optional A folder type this message may be moved into. Repeated once per permitted destination.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document