> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Charter works for any HTTP API, including the user's own. The packs are examples of the result, not the limit: an API with no pack is declared the same way, following https://raw.githubusercontent.com/r28ai/charter/main/docs/.mintlify/skills/declaring-charter-tools/SKILL.md.
> Charter is for agents that act in customers' accounts: every call is checked field by field before it's sent, the app says whose account each call is for, and the same declarations list what each tool can reach. https://docs.r28.ai/charter/llms.txt says what it is and lists every page.

# Objects

> Every object and enum the Inbox rules tools accept.

## Model tree

[MessageRule](#messagerule)[MessageRuleActions](#messageruleactions)[MessageRulePredicates](#messagerulepredicates)[SizeRange](#sizerange)[MessageRuleUpdate](#messageruleupdate)[MessageRuleActions](#messageruleactions)[MessageRulePredicates](#messagerulepredicates) above

## MessageRule

A rule that applies to messages in the Inbox of a user.

| Field | Type | Description |
| - | - | - |
| `displayName` \* | `string` | The display name of the rule. |
| `sequence` \* | `integer` | Indicates the order in which the rule is executed, among other rules. |
| `actions` \* | [MessageRuleActions](#messageruleactions) | Actions to be taken on a message when the corresponding conditions, if any, are fulfilled. |
| `conditions` | [MessageRulePredicates](#messagerulepredicates) | Conditions that when fulfilled, will trigger the corresponding actions for that rule. |
| `exceptions` | [MessageRulePredicates](#messagerulepredicates) | Represents exception conditions for the rule. |
| `isEnabled` | `boolean` | Indicates whether the rule is enabled to be applied to messages. |
| `isReadOnly` | `boolean` | Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API. |

## MessageRuleActions

Represents the set of actions that are available to a rule.

| Field | Type | Description |
| - | - | - |
| `assignCategories` | `string`\[] | A list of categories to be assigned to a message. |
| `copyToFolder` | `string` | The ID of a folder that a message is to be copied to. |
| `delete` | `boolean` | Indicates whether a message should be moved to the Deleted Items folder. |
| `forwardAsAttachmentTo` | [Recipient](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#recipient)\[] | The email addresses of the recipients to which a message should be forwarded as an attachment. |
| `forwardTo` | [Recipient](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#recipient)\[] | The email addresses of the recipients to which a message should be forwarded. |
| `markAsRead` | `boolean` | Indicates whether a message should be marked as read. |
| `markImportance` | [Importance](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#importance) | Sets the importance of the message, which can be: `low`, `normal`, `high`. |
| `moveToFolder` | `string` | The ID of the folder that a message will be moved to. |
| `permanentDelete` | `boolean` | Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder. |
| `redirectTo` | [Recipient](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#recipient)\[] | The email addresses to which a message should be redirected. |
| `stopProcessingRules` | `boolean` | Indicates whether subsequent rules should be evaluated. |

## MessageRulePredicates

Represents the set of conditions and exceptions that are available for a rule.

| Field | Type | Description |
| - | - | - |
| `bodyContains` | `string`\[] | Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply. |
| `bodyOrSubjectContains` | `string`\[] | Represents the strings that should appear in the body or subject of an incoming message in order for the condition or exception to apply. |
| `categories` | `string`\[] | Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply. |
| `fromAddresses` | [Recipient](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#recipient)\[] | Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply. |
| `hasAttachments` | `boolean` | Indicates whether an incoming message must have attachments in order for the condition or exception to apply. |
| `headerContains` | `string`\[] | Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply. |
| `importance` | [Importance](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#importance) | The importance that is stamped on an incoming message in order for the condition or exception to apply: `low`, `normal`, `high`. |
| `isApprovalRequest` | `boolean` | Indicates whether an incoming message must be an approval request in order for the condition or exception to apply. |
| `isAutomaticForward` | `boolean` | Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply. |
| `isAutomaticReply` | `boolean` | Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply. |
| `isEncrypted` | `boolean` | Indicates whether an incoming message must be encrypted in order for the condition or exception to apply. |
| `isMeetingRequest` | `boolean` | Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply. |
| `isMeetingResponse` | `boolean` | Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply. |
| `isNonDeliveryReport` | `boolean` | Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply. |
| `isPermissionControlled` | `boolean` | Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply. |
| `isReadReceipt` | `boolean` | Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply. |
| `isSigned` | `boolean` | Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply. |
| `isVoicemail` | `boolean` | Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply. |
| `messageActionFlag` | [MessageActionFlag](#messageactionflag) | Represents the flag-for-action value that appears on an incoming message in order for the condition or exception to apply. The possible values are: `any`, `call`, `doNotForward`, `followUp`, `fyi`, `forward`, `noResponseNecessary`, `read`, `reply`, `replyToAll`, `review`. |
| `notSentToMe` | `boolean` | Indicates whether the owner of the mailbox must not be a recipient of an incoming message in order for the condition or exception to apply. |
| `recipientContains` | `string`\[] | Represents the strings that appear in either the toRecipients or ccRecipients properties of an incoming message in order for the condition or exception to apply. |
| `senderContains` | `string`\[] | Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply. |
| `sensitivity` | [Sensitivity](#sensitivity) | Represents the sensitivity level that must be stamped on an incoming message in order for the condition or exception to apply. The possible values are: `normal`, `personal`, `private`, `confidential`. |
| `sentCcMe` | `boolean` | Indicates whether the owner of the mailbox must be in the ccRecipients property of an incoming message in order for the condition or exception to apply. |
| `sentOnlyToMe` | `boolean` | Indicates whether the owner of the mailbox must be the only recipient in an incoming message in order for the condition or exception to apply. |
| `sentToAddresses` | [Recipient](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#recipient)\[] | Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply. |
| `sentToMe` | `boolean` | Indicates whether the owner of the mailbox must be in the toRecipients property of an incoming message in order for the condition or exception to apply. |
| `sentToOrCcMe` | `boolean` | Indicates whether the owner of the mailbox must be in either a toRecipients or ccRecipients property of an incoming message in order for the condition or exception to apply. |
| `subjectContains` | `string`\[] | Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply. |
| `withinSizeRange` | [SizeRange](#sizerange) | Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply. |

## SizeRange

Specifies the maximum and minimum sizes (in kilobytes) that an incoming message must fall in between.

| Field | Type | Description |
| - | - | - |
| `maximumSize` | `integer` | The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply. |
| `minimumSize` | `integer` | The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply. |

## MessageRuleUpdate

MessageRule, with every field optional.

| Field | Type | Description |
| - | - | - |
| `displayName` | `string` | The display name of the rule. |
| `sequence` | `integer` | Indicates the order in which the rule is executed, among other rules. |
| `actions` | [MessageRuleActions](#messageruleactions) | Actions to be taken on a message when the corresponding conditions, if any, are fulfilled. |
| `conditions` | [MessageRulePredicates](#messagerulepredicates) | Conditions that when fulfilled, will trigger the corresponding actions for that rule. |
| `exceptions` | [MessageRulePredicates](#messagerulepredicates) | Represents exception conditions for the rule. |
| `isEnabled` | `boolean` | Indicates whether the rule is enabled to be applied to messages. |
| `isReadOnly` | `boolean` | Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API. |

## MessageActionFlag

| Value |
| - |
| `any` |
| `call` |
| `doNotForward` |
| `followUp` |
| `fyi` |
| `forward` |
| `noResponseNecessary` |
| `read` |
| `reply` |
| `replyToAll` |
| `review` |

## Sensitivity

| Value |
| - |
| `normal` |
| `personal` |
| `private` |
| `confidential` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.