Outlook data contract | PatchOps Knowledge

Provenance

PublisherOutlook

API basehttps://graph.microsoft.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (OAuth)

Methods (34)

outlookMail_list_messages_from_folder

read

List Outlook messages from a folder with filtering, sorting, paging, and field selection. Use folderId:"archive" for the standard Outlook Archive folder.

Required paramsfolderId

Input schema

{
  "type": "object",
  "properties": {
    "folderId": {
      "type": "string",
      "description": "Folder ID or well-known folder name such as archive, inbox, sentitems, drafts, or deleteditems."
    },
    "top": {
      "type": "number",
      "description": "Maximum messages to return."
    },
    "skip": {
      "type": "number",
      "description": "Number of messages to skip."
    },
    "select": {
      "type": "string"
    },
    "orderBy": {
      "type": "string",
      "description": "Microsoft Graph $orderby expression."
    },
    "filter": {
      "type": "string",
      "description": "Microsoft Graph $filter expression."
    },
    "search": {
      "type": "string",
      "description": "Literal mailbox search text; the handler quotes it for Microsoft Graph.",
      "x-patchops-inference": "literal-search-term"
    }
  },
  "additionalProperties": true,
  "required": [
    "folderId"
  ]
}

outlookMail_list_attachments

read

List attachments for a specific Outlook message by message identifier.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_search_contacts

read

Search Outlook contacts by query with optional result limit.

Input schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "query"
  ]
}

outlookMail_advanced_search

read

Search Outlook messages by sender, recipient, subject, status, importance, dates, or attachments.

Input schema

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "hasAttachments": {
      "type": "boolean"
    },
    "importance": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "Low"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Normal"
          ]
        },
        {
          "type": "string",
          "enum": [
            "High"
          ]
        }
      ]
    },
    "isRead": {
      "type": "boolean"
    },
    "receivedAfter": {
      "type": "string"
    },
    "receivedBefore": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

outlookMail_send_draft

write

Send an Outlook draft message by message identifier.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_mark_as_read

read

Update an Outlook message's read or unread status.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "isRead": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId",
    "isRead"
  ]
}

outlookMail_move_message

unknown

Move an Outlook message to a destination mail folder.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "destinationFolderId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId",
    "destinationFolderId"
  ]
}

outlookMail_delete_message

write

Delete a specific Outlook message from the mailbox.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_set_importance

write

Update an Outlook message's importance level directly in the mailbox.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "importance": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "Low"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Normal"
          ]
        },
        {
          "type": "string",
          "enum": [
            "High"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId",
    "importance"
  ]
}

outlookMail_set_categories

write

Update categories assigned to a specific Outlook message.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId",
    "categories"
  ]
}

outlookMail_create_mail_folder

write

Create an Outlook mail folder under an optional parent folder.

Input schema

{
  "type": "object",
  "properties": {
    "displayName": {
      "type": "string"
    },
    "parentFolderId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "displayName"
  ]
}

outlookMail_delete_folder

write

Delete an Outlook mail folder by folder identifier.

Input schema

{
  "type": "object",
  "properties": {
    "folderId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "folderId"
  ]
}

outlookMail_get_mail_folder_details

read

Retrieve details for a specific Outlook mail folder.

Input schema

{
  "type": "object",
  "properties": {
    "folderId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "folderId"
  ]
}

outlookMail_update_folder_display_name

write

Rename an Outlook mail folder by setting its display name.

Input schema

{
  "type": "object",
  "properties": {
    "folderId": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "folderId",
    "displayName"
  ]
}

outlookMail_update_draft

write

Update an Outlook draft's subject, body, and recipient lists.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "object",
      "properties": {
        "contentType": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "Text"
              ]
            },
            {
              "type": "string",
              "enum": [
                "HTML"
              ]
            }
          ]
        },
        "content": {
          "type": "string"
        }
      },
      "required": [
        "content"
      ],
      "additionalProperties": false
    },
    "toRecipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "emailAddress": {
            "type": "object",
            "properties": {
              "address": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "address"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "emailAddress"
        ],
        "additionalProperties": false
      }
    },
    "ccRecipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "emailAddress": {
            "type": "object",
            "properties": {
              "address": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "address"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "emailAddress"
        ],
        "additionalProperties": false
      }
    },
    "bccRecipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "emailAddress": {
            "type": "object",
            "properties": {
              "address": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "address"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "emailAddress"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_delete_draft

write

Delete a specific Outlook draft message permanently from the mailbox.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_create_forward_draft

write

Create a forwarded Outlook draft from a message for specified recipients.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "comment": {
      "type": "string"
    },
    "toRecipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "emailAddress": {
            "type": "object",
            "properties": {
              "address": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "address"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "emailAddress"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_create_reply_draft

write

Create a reply draft for an Outlook message with an optional comment.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "comment": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_download_attachment

read

Download an attachment from a specific Outlook message using the requested mode.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "attachmentId": {
      "type": "string"
    },
    "mode": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "metadata"
          ]
        },
        {
          "type": "string",
          "enum": [
            "path"
          ]
        },
        {
          "type": "string",
          "enum": [
            "inline"
          ]
        },
        {
          "type": "string",
          "enum": [
            "model"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId",
    "attachmentId"
  ]
}

outlookMail_add_attachment

write

Upload an attachment to an Outlook message from supplied content or a file path.

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "fileName": {
      "type": "string"
    },
    "contentBytes": {
      "type": "string"
    },
    "contentBase64": {
      "type": "string"
    },
    "contentText": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "contentType": {
      "type": "string"
    },
    "maxAttachmentSizeMB": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId"
  ]
}

outlookMail_list_contacts

read

List Outlook contacts with optional search, sorting, paging, and field selection.

Input schema

{
  "type": "object",
  "properties": {
    "search": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "select": {
      "type": "string"
    },
    "orderBy": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

outlookMail_get_contact

read

Retrieve a specific Outlook contact by contact identifier.

Input schema

{
  "type": "object",
  "properties": {
    "contactId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "contactId"
  ]
}

outlookMail_create_contact

write

Create an Outlook contact with personal, phone, company, and job details.

Input schema

{
  "type": "object",
  "properties": {
    "givenName": {
      "type": "string"
    },
    "surname": {
      "type": "string"
    },
    "emailAddresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "address"
        ],
        "additionalProperties": false
      }
    },
    "businessPhones": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "mobilePhone": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "jobTitle": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "givenName"
  ]
}

outlookMail_update_contact

write

Update an Outlook contact's personal, phone, company, or job details.

Input schema

{
  "type": "object",
  "properties": {
    "contactId": {
      "type": "string"
    },
    "givenName": {
      "type": "string"
    },
    "surname": {
      "type": "string"
    },
    "emailAddresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "address"
        ],
        "additionalProperties": false
      }
    },
    "businessPhones": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "mobilePhone": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "jobTitle": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "contactId"
  ]
}

outlookMail_batch_get_messages

read

Retrieve multiple Outlook messages by their identifiers with selected fields.

Input schema

{
  "type": "object",
  "properties": {
    "messageIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "select": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "messageIds"
  ]
}

outlookMail_flag_message

unknown

Set, clear, or complete the follow-up flag on one message.

Entitiesemail

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    },
    "flagStatus": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "complete"
          ]
        },
        {
          "type": "string",
          "enum": [
            "notFlagged"
          ]
        },
        {
          "type": "string",
          "enum": [
            "flagged"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "messageId",
    "flagStatus"
  ]
}

outlookMail_list_messages

read

List messages in the default mailbox view with optional search and paging.

Input schema

{
  "type": "object",
  "properties": {
    "top": {
      "type": "number",
      "description": "Maximum messages to return."
    },
    "skip": {
      "type": "number",
      "description": "Number of messages to skip."
    },
    "select": {
      "type": "string"
    },
    "orderBy": {
      "type": "string",
      "description": "Microsoft Graph $orderby expression."
    },
    "filter": {
      "type": "string",
      "description": "Microsoft Graph $filter expression."
    },
    "search": {
      "type": "string",
      "description": "Literal mailbox search text; the handler quotes it for Microsoft Graph.",
      "x-patchops-inference": "literal-search-term"
    }
  },
  "additionalProperties": true
}

outlookMail_read_message

read

Fetch one Outlook message by ID.

Required paramsmessageId

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "description": "Outlook message ID."
    }
  },
  "additionalProperties": true,
  "required": [
    "messageId"
  ]
}

outlookMail_send_email

write

Send a new Outlook email.

Required paramssubjectbodytoRecipients

Input schema

{
  "type": "object",
  "properties": {
    "subject": {
      "type": "string",
      "description": "Email subject line."
    },
    "body": {
      "type": "object",
      "properties": {
        "contentType": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "Text"
              ]
            },
            {
              "type": "string",
              "enum": [
                "HTML"
              ]
            }
          ]
        },
        "content": {
          "type": "string"
        }
      },
      "required": [
        "content"
      ],
      "additionalProperties": false,
      "description": "Message body with content and contentType."
    },
    "toRecipients": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Recipient list in Microsoft Graph recipient shape."
    },
    "ccRecipients": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Optional CC recipients."
    },
    "bccRecipients": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Optional BCC recipients."
    },
    "importance": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "Low"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Normal"
          ]
        },
        {
          "type": "string",
          "enum": [
            "High"
          ]
        }
      ]
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Optional Graph fileAttachment objects. Each provides a name plus exactly one of contentBytes (base64) OR sourceUrl (public/HTTPS URL the server fetches server-side — use INSTEAD of contentBytes to avoid inlining large files)."
    },
    "saveToSentItems": {
      "type": "boolean",
      "description": "Whether to save the message to Sent Items."
    }
  },
  "additionalProperties": true,
  "required": [
    "subject",
    "body",
    "toRecipients"
  ]
}

outlookMail_send_email_with_files

write

Send an Outlook email with attachments: attach generated or local files to an outgoing message and send it.

Required paramssubjectbodytoRecipientsfiles

Input schema

{
  "type": "object",
  "properties": {
    "subject": {
      "type": "string",
      "description": "Email subject line."
    },
    "body": {
      "type": "object",
      "properties": {
        "contentType": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "Text"
              ]
            },
            {
              "type": "string",
              "enum": [
                "HTML"
              ]
            }
          ]
        },
        "content": {
          "type": "string"
        }
      },
      "required": [
        "content"
      ],
      "additionalProperties": false,
      "description": "Message body with content and contentType."
    },
    "toRecipients": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Recipient list in Microsoft Graph recipient shape."
    },
    "ccRecipients": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "bccRecipients": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "importance": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "Low"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Normal"
          ]
        },
        {
          "type": "string",
          "enum": [
            "High"
          ]
        }
      ]
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Files with fileName/name plus contentText, contentBase64, or path."
    },
    "saveToSentItems": {
      "type": "boolean"
    },
    "maxAttachmentSizeMB": {
      "type": "number",
      "description": "Per-file size cap."
    }
  },
  "additionalProperties": true,
  "required": [
    "subject",
    "body",
    "toRecipients",
    "files"
  ]
}

outlookMail_get_emails_with_attachments

read

Find Outlook emails and return attachment metadata.

Input schema

{
  "type": "object",
  "properties": {
    "top": {
      "type": "number",
      "description": "Maximum emails to return."
    },
    "search": {
      "type": "string",
      "description": "Mailbox search text."
    },
    "hasAttachmentsOnly": {
      "type": "boolean",
      "description": "Only include emails with files."
    },
    "from": {
      "type": "string",
      "description": "Sender email filter."
    },
    "subject": {
      "type": "string",
      "description": "Subject search filter."
    },
    "receivedAfter": {
      "type": "string",
      "description": "ISO received lower bound."
    },
    "receivedBefore": {
      "type": "string",
      "description": "ISO received upper bound."
    }
  },
  "additionalProperties": true
}

outlookMail_parse_email_attachments

unknown

Parse supported attachments from one Outlook email.

Required paramsmessageId

Input schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "description": "Outlook message ID."
    },
    "fileTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional extensions such as pdf, docx, xlsx, csv."
    },
    "maxFileSizeMB": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 25,
      "description": "Maximum file size to parse (hard cap: 25MB)."
    }
  },
  "additionalProperties": true,
  "required": [
    "messageId"
  ]
}

outlookMail_get_and_parse_emails

read

Find emails with files and parse supported attachments.

Input schema

{
  "type": "object",
  "properties": {
    "fileTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional extensions such as pdf, docx, xlsx, csv."
    },
    "maxFileSizeMB": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 25,
      "description": "Maximum file size to parse (hard cap: 25MB)."
    },
    "top": {
      "type": "number",
      "description": "Maximum emails to inspect."
    },
    "search": {
      "type": "string",
      "description": "Mailbox search text."
    },
    "hasAttachmentsOnly": {
      "type": "boolean",
      "description": "Only include emails with files."
    },
    "from": {
      "type": "string",
      "description": "Sender email filter."
    },
    "subject": {
      "type": "string",
      "description": "Subject search filter."
    },
    "receivedAfter": {
      "type": "string",
      "description": "ISO received lower bound."
    },
    "receivedBefore": {
      "type": "string",
      "description": "ISO received upper bound."
    }
  },
  "additionalProperties": true
}

outlookMail_list_folders

read

List mail folders before doing folder-scoped message operations.

Input schema

{
  "type": "object",
  "properties": {
    "parentFolderId": {
      "type": "string"
    },
    "includeHiddenFolders": {
      "type": "boolean",
      "description": "Whether to include hidden Outlook folders."
    }
  },
  "additionalProperties": true
}