openapi: 3.0.4
info:
title: Mail
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
'/users/{user-id}/inferenceClassification':
get:
tags:
- users.inferenceClassification
summary: Get inferenceClassification from users
description: Relevance classification of the user's messages based on explicit designations that override inferred relevance or importance.
operationId: user_GetInferenceClassification
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.inferenceClassification
summary: Update the navigation property inferenceClassification in users
operationId: user_UpdateInferenceClassification
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/inferenceClassification/overrides':
get:
tags:
- users.inferenceClassification
summary: Get overrides from users
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
operationId: user.inferenceClassification_ListOverride
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.inferenceClassificationOverrideCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.inferenceClassification
summary: Create new navigation property to overrides for users
operationId: user.inferenceClassification_CreateOverride
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/inferenceClassification/overrides/{inferenceClassificationOverride-id}':
get:
tags:
- users.inferenceClassification
summary: Get overrides from users
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
operationId: user.inferenceClassification_GetOverride
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: inferenceClassificationOverride-id
in: path
description: The unique identifier of inferenceClassificationOverride
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: inferenceClassificationOverride
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.inferenceClassification
summary: Update the navigation property overrides in users
operationId: user.inferenceClassification_UpdateOverride
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: inferenceClassificationOverride-id
in: path
description: The unique identifier of inferenceClassificationOverride
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: inferenceClassificationOverride
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.inferenceClassification
summary: Delete navigation property overrides for users
operationId: user.inferenceClassification_DeleteOverride
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: inferenceClassificationOverride-id
in: path
description: The unique identifier of inferenceClassificationOverride
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: inferenceClassificationOverride
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/inferenceClassification/overrides/$count':
get:
tags:
- users.inferenceClassification
summary: Get the number of the resource
operationId: user.inferenceClassification.override_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders':
get:
tags:
- users.mailFolder
summary: Get mailFolders from users
description: The user's mail folders. Read-only. Nullable.
operationId: user_ListMailFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.mailFolderCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to mailFolders for users
operationId: user_CreateMailFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}':
get:
tags:
- users.mailFolder
summary: Get mailFolders from users
description: The user's mail folders. Read-only. Nullable.
operationId: user_GetMailFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
style: form
explode: false
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property mailFolders in users
operationId: user_UpdateMailFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property mailFolders for users
operationId: user_DeleteMailFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders':
get:
tags:
- users.mailFolder
summary: Get childFolders from users
description: The collection of child folders in the mailFolder.
operationId: user.mailFolder_ListChildFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.mailFolderCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to childFolders for users
operationId: user.mailFolder_CreateChildFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}':
get:
tags:
- users.mailFolder
summary: Get childFolders from users
description: The collection of child folders in the mailFolder.
operationId: user.mailFolder_GetChildFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
style: form
explode: false
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property childFolders in users
operationId: user.mailFolder_UpdateChildFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property childFolders for users
operationId: user.mailFolder_DeleteChildFolder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules':
get:
tags:
- users.mailFolder
summary: Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: user.mailFolder.childFolder_ListMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageRuleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to messageRules for users
operationId: user.mailFolder.childFolder_CreateMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules/{messageRule-id}':
get:
tags:
- users.mailFolder
summary: Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: user.mailFolder.childFolder_GetMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: messageRule
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property messageRules in users
operationId: user.mailFolder.childFolder_UpdateMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: messageRule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property messageRules for users
operationId: user.mailFolder.childFolder_DeleteMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: messageRule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.childFolder.messageRule_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages':
get:
tags:
- users.mailFolder
summary: Get messages from users
description: The collection of messages in the mailFolder.
operationId: user.mailFolder.childFolder_ListMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to messages for users
operationId: user.mailFolder.childFolder_CreateMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}':
get:
tags:
- users.mailFolder
summary: Get messages from users
description: The collection of messages in the mailFolder.
operationId: user.mailFolder.childFolder_GetMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property messages in users
operationId: user.mailFolder.childFolder_UpdateMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property messages for users
operationId: user.mailFolder.childFolder_DeleteMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/$value':
get:
tags:
- users.mailFolder
summary: Get media content for the navigation property messages from users
description: The unique identifier for an entity. Read-only.
operationId: user.mailFolder.childFolder_GetMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- users.mailFolder
summary: Update media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: user.mailFolder.childFolder_SetMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- users.mailFolder
summary: Delete media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: user.mailFolder.childFolder_DeleteMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments':
get:
tags:
- users.mailFolder
summary: Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: user.mailFolder.childFolder.message_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to attachments for users
operationId: user.mailFolder.childFolder.message_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/{attachment-id}':
get:
tags:
- users.mailFolder
summary: Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: user.mailFolder.childFolder.message_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property attachments for users
operationId: user.mailFolder.childFolder.message_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.childFolder.message.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.mailFolder
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions':
get:
tags:
- users.mailFolder
summary: Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: user.mailFolder.childFolder.message_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to extensions for users
operationId: user.mailFolder.childFolder.message_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions/{extension-id}':
get:
tags:
- users.mailFolder
summary: Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: user.mailFolder.childFolder.message_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property extensions in users
operationId: user.mailFolder.childFolder.message_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property extensions for users
operationId: user.mailFolder.childFolder.message_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.childFolder.message.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.copy':
post:
tags:
- users.mailFolder
summary: Invoke action copy
description: Copy a message to a folder within the user's mailbox.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-copy?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_copy
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.createForward':
post:
tags:
- users.mailFolder
summary: Invoke action createForward
operationId: user.mailFolder.childFolder.message_createForward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.createReply':
post:
tags:
- users.mailFolder
summary: Invoke action createReply
description: "Create a draft to reply to the sender of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If replyTo is specified in the original message, per Internet Message Format (RFC 2822), you should send the reply to the recipients in replyTo, and not the recipients in from.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply to a message in a single operation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-createreply?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_createReply
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.createReplyAll':
post:
tags:
- users.mailFolder
summary: Invoke action createReplyAll
description: "Create a draft to reply to the sender and all recipients of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), you should send the reply to the recipients in the replyTo and toRecipients properties, and not the recipients in the from and toRecipients properties.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply-all to a message in a single action."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-createreplyall?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_createReplyAll
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.forward':
post:
tags:
- users.mailFolder
summary: Invoke action forward
description: "Forward a message using either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.move':
post:
tags:
- users.mailFolder
summary: Invoke action move
description: Move a message to another folder within the specified user's mailbox. This creates a new copy of the message in the destination folder and removes the original message.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-move?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_move
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.mailFolder
summary: Invoke action permanentDelete
operationId: user.mailFolder.childFolder.message_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.reply':
post:
tags:
- users.mailFolder
summary: Invoke action reply
description: "Reply to the sender of a message using either JSON or MIME format. When using JSON format:\r\n* Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n* If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply to an existing message and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-reply?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_reply
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.replyAll':
post:
tags:
- users.mailFolder
summary: Invoke action replyAll
description: "Reply to all recipients of a message using either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply-all to a message and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-replyall?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_replyAll
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/microsoft.graph.send':
post:
tags:
- users.mailFolder
summary: Invoke action send
description: 'Send an existing draft message. The draft message can be a new message draft, reply draft, reply-all draft, or a forward draft. This method saves the message in the Sent Items folder. Alternatively, send a new message in a single operation.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-send?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_send
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.childFolder.message_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/microsoft.graph.delta()':
get:
tags:
- users.mailFolder
summary: Invoke function delta
description: "Get a set of messages added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls, you can [query for incremental changes in the messages in\r\nthat folder](/graph/delta-query-messages). It allows you to maintain and synchronize a local store of a user's messages without\r\nhaving to fetch the entire set of messages from the server every time."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-delta?view=graph-rest-1.0
operationId: user.mailFolder.childFolder.message_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: changeType
in: query
description: 'A custom query option to filter the delta response based on the type of change. Supported values are created, updated or deleted.'
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of message
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/microsoft.graph.copy':
post:
tags:
- users.mailFolder
summary: Invoke action copy
description: Copy a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/mailfolder-copy?view=graph-rest-1.0
operationId: user.mailFolder.childFolder_copy
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/microsoft.graph.move':
post:
tags:
- users.mailFolder
summary: Invoke action move
description: Move a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/mailfolder-move?view=graph-rest-1.0
operationId: user.mailFolder.childFolder_move
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/microsoft.graph.permanentDelete':
post:
tags:
- users.mailFolder
summary: Invoke action permanentDelete
operationId: user.mailFolder.childFolder_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.childFolder_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/microsoft.graph.delta()':
get:
tags:
- users.mailFolder
summary: Invoke function delta
description: "Get a set of mail folders that have been added, deleted, or removed from the user's mailbox. A delta function call for mail folders in a mailbox is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls,\r\nyou can query for incremental changes in the mail folders. This allows you to maintain and synchronize\r\na local store of a user's mail folders without having to fetch all the mail folders of that mailbox from the server every time."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/mailfolder-delta?view=graph-rest-1.0
operationId: user.mailFolder.childFolder_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of mailFolder
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/mailFolders/{mailFolder-id}/messageRules':
get:
tags:
- users.mailFolder
summary: Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: user.mailFolder_ListMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageRuleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to messageRules for users
operationId: user.mailFolder_CreateMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messageRules/{messageRule-id}':
get:
tags:
- users.mailFolder
summary: Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: user.mailFolder_GetMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: messageRule
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property messageRules in users
operationId: user.mailFolder_UpdateMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: messageRule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property messageRules for users
operationId: user.mailFolder_DeleteMessageRule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: messageRule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messageRules/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.messageRule_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/messages':
get:
tags:
- users.mailFolder
summary: Get messages from users
description: The collection of messages in the mailFolder.
operationId: user.mailFolder_ListMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to messages for users
operationId: user.mailFolder_CreateMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}':
get:
tags:
- users.mailFolder
summary: Get messages from users
description: The collection of messages in the mailFolder.
operationId: user.mailFolder_GetMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property messages in users
operationId: user.mailFolder_UpdateMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property messages for users
operationId: user.mailFolder_DeleteMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/$value':
get:
tags:
- users.mailFolder
summary: Get media content for the navigation property messages from users
description: The unique identifier for an entity. Read-only.
operationId: user.mailFolder_GetMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- users.mailFolder
summary: Update media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: user.mailFolder_SetMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- users.mailFolder
summary: Delete media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: user.mailFolder_DeleteMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments':
get:
tags:
- users.mailFolder
summary: Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: user.mailFolder.message_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to attachments for users
operationId: user.mailFolder.message_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/{attachment-id}':
get:
tags:
- users.mailFolder
summary: Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: user.mailFolder.message_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property attachments for users
operationId: user.mailFolder.message_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.message.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.mailFolder
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.mailFolder.message.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions':
get:
tags:
- users.mailFolder
summary: Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: user.mailFolder.message_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Create new navigation property to extensions for users
operationId: user.mailFolder.message_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions/{extension-id}':
get:
tags:
- users.mailFolder
summary: Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: user.mailFolder.message_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Update the navigation property extensions in users
operationId: user.mailFolder.message_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Delete navigation property extensions for users
operationId: user.mailFolder.message_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.message.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.copy':
post:
tags:
- users.mailFolder
summary: Invoke action copy
description: Copy a message to a folder within the user's mailbox.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-copy?view=graph-rest-1.0
operationId: user.mailFolder.message_copy
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.createForward':
post:
tags:
- users.mailFolder
summary: Invoke action createForward
operationId: user.mailFolder.message_createForward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.createReply':
post:
tags:
- users.mailFolder
summary: Invoke action createReply
description: "Create a draft to reply to the sender of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If replyTo is specified in the original message, per Internet Message Format (RFC 2822), you should send the reply to the recipients in replyTo, and not the recipients in from.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply to a message in a single operation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-createreply?view=graph-rest-1.0
operationId: user.mailFolder.message_createReply
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.createReplyAll':
post:
tags:
- users.mailFolder
summary: Invoke action createReplyAll
description: "Create a draft to reply to the sender and all recipients of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), you should send the reply to the recipients in the replyTo and toRecipients properties, and not the recipients in the from and toRecipients properties.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply-all to a message in a single action."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-createreplyall?view=graph-rest-1.0
operationId: user.mailFolder.message_createReplyAll
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.forward':
post:
tags:
- users.mailFolder
summary: Invoke action forward
description: "Forward a message using either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0
operationId: user.mailFolder.message_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.move':
post:
tags:
- users.mailFolder
summary: Invoke action move
description: Move a message to another folder within the specified user's mailbox. This creates a new copy of the message in the destination folder and removes the original message.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-move?view=graph-rest-1.0
operationId: user.mailFolder.message_move
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.mailFolder
summary: Invoke action permanentDelete
operationId: user.mailFolder.message_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.reply':
post:
tags:
- users.mailFolder
summary: Invoke action reply
description: "Reply to the sender of a message using either JSON or MIME format. When using JSON format:\r\n* Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n* If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply to an existing message and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-reply?view=graph-rest-1.0
operationId: user.mailFolder.message_reply
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.replyAll':
post:
tags:
- users.mailFolder
summary: Invoke action replyAll
description: "Reply to all recipients of a message using either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply-all to a message and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-replyall?view=graph-rest-1.0
operationId: user.mailFolder.message_replyAll
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/microsoft.graph.send':
post:
tags:
- users.mailFolder
summary: Invoke action send
description: 'Send an existing draft message. The draft message can be a new message draft, reply draft, reply-all draft, or a forward draft. This method saves the message in the Sent Items folder. Alternatively, send a new message in a single operation.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-send?view=graph-rest-1.0
operationId: user.mailFolder.message_send
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder.message_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/{mailFolder-id}/messages/microsoft.graph.delta()':
get:
tags:
- users.mailFolder
summary: Invoke function delta
description: "Get a set of messages added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls, you can [query for incremental changes in the messages in\r\nthat folder](/graph/delta-query-messages). It allows you to maintain and synchronize a local store of a user's messages without\r\nhaving to fetch the entire set of messages from the server every time."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-delta?view=graph-rest-1.0
operationId: user.mailFolder.message_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: changeType
in: query
description: 'A custom query option to filter the delta response based on the type of change. Supported values are created, updated or deleted.'
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of message
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/mailFolders/{mailFolder-id}/microsoft.graph.copy':
post:
tags:
- users.mailFolder
summary: Invoke action copy
description: Copy a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/mailfolder-copy?view=graph-rest-1.0
operationId: user.mailFolder_copy
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/microsoft.graph.move':
post:
tags:
- users.mailFolder
summary: Invoke action move
description: Move a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/mailfolder-move?view=graph-rest-1.0
operationId: user.mailFolder_move
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/{mailFolder-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.mailFolder
summary: Invoke action permanentDelete
operationId: user.mailFolder_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: mailFolder
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/mailFolders/$count':
get:
tags:
- users.mailFolder
summary: Get the number of the resource
operationId: user.mailFolder_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/mailFolders/microsoft.graph.delta()':
get:
tags:
- users.mailFolder
summary: Invoke function delta
description: "Get a set of mail folders that have been added, deleted, or removed from the user's mailbox. A delta function call for mail folders in a mailbox is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls,\r\nyou can query for incremental changes in the mail folders. This allows you to maintain and synchronize\r\na local store of a user's mail folders without having to fetch all the mail folders of that mailbox from the server every time."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/mailfolder-delta?view=graph-rest-1.0
operationId: user.mailFolder_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of mailFolder
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/messages':
get:
tags:
- users.message
summary: Get messages from users
description: The messages in a mailbox or folder. Read-only. Nullable.
operationId: user_ListMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: includeHiddenMessages
in: query
description: Include Hidden Messages
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.message
summary: Create new navigation property to messages for users
operationId: user_CreateMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/messages/{message-id}':
get:
tags:
- users.message
summary: Get messages from users
description: The messages in a mailbox or folder. Read-only. Nullable.
operationId: user_GetMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: includeHiddenMessages
in: query
description: Include Hidden Messages
style: form
explode: false
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.message
summary: Update the navigation property messages in users
operationId: user_UpdateMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.message
summary: Delete navigation property messages for users
operationId: user_DeleteMessage
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/messages/{message-id}/$value':
get:
tags:
- users.message
summary: Get media content for the navigation property messages from users
description: The unique identifier for an entity. Read-only.
operationId: user_GetMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- users.message
summary: Update media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: user_SetMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- users.message
summary: Delete media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: user_DeleteMessagesContent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/users/{user-id}/messages/{message-id}/attachments':
get:
tags:
- users.message
summary: Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: user.message_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.message
summary: Create new navigation property to attachments for users
operationId: user.message_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/messages/{message-id}/attachments/{attachment-id}':
get:
tags:
- users.message
summary: Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: user.message_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.message
summary: Delete navigation property attachments for users
operationId: user.message_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/messages/{message-id}/attachments/$count':
get:
tags:
- users.message
summary: Get the number of the resource
operationId: user.message.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/messages/{message-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.message
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.message.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/extensions':
get:
tags:
- users.message
summary: Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: user.message_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.message
summary: Create new navigation property to extensions for users
operationId: user.message_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/messages/{message-id}/extensions/{extension-id}':
get:
tags:
- users.message
summary: Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: user.message_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.message
summary: Update the navigation property extensions in users
operationId: user.message_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.message
summary: Delete navigation property extensions for users
operationId: user.message_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/messages/{message-id}/extensions/$count':
get:
tags:
- users.message
summary: Get the number of the resource
operationId: user.message.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/messages/{message-id}/microsoft.graph.copy':
post:
tags:
- users.message
summary: Invoke action copy
description: Copy a message to a folder within the user's mailbox.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-copy?view=graph-rest-1.0
operationId: user.message_copy
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.createForward':
post:
tags:
- users.message
summary: Invoke action createForward
operationId: user.message_createForward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.createReply':
post:
tags:
- users.message
summary: Invoke action createReply
description: "Create a draft to reply to the sender of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If replyTo is specified in the original message, per Internet Message Format (RFC 2822), you should send the reply to the recipients in replyTo, and not the recipients in from.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply to a message in a single operation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-createreply?view=graph-rest-1.0
operationId: user.message_createReply
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.createReplyAll':
post:
tags:
- users.message
summary: Invoke action createReplyAll
description: "Create a draft to reply to the sender and all recipients of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), you should send the reply to the recipients in the replyTo and toRecipients properties, and not the recipients in the from and toRecipients properties.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply-all to a message in a single action."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-createreplyall?view=graph-rest-1.0
operationId: user.message_createReplyAll
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.forward':
post:
tags:
- users.message
summary: Invoke action forward
description: "Forward a message using either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0
operationId: user.message_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.move':
post:
tags:
- users.message
summary: Invoke action move
description: Move a message to another folder within the specified user's mailbox. This creates a new copy of the message in the destination folder and removes the original message.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-move?view=graph-rest-1.0
operationId: user.message_move
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.message
summary: Invoke action permanentDelete
operationId: user.message_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.reply':
post:
tags:
- users.message
summary: Invoke action reply
description: "Reply to the sender of a message using either JSON or MIME format. When using JSON format:\r\n* Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n* If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply to an existing message and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-reply?view=graph-rest-1.0
operationId: user.message_reply
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.replyAll':
post:
tags:
- users.message
summary: Invoke action replyAll
description: "Reply to all recipients of a message using either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply-all to a message and send it later."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-replyall?view=graph-rest-1.0
operationId: user.message_replyAll
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/{message-id}/microsoft.graph.send':
post:
tags:
- users.message
summary: Invoke action send
description: 'Send an existing draft message. The draft message can be a new message draft, reply draft, reply-all draft, or a forward draft. This method saves the message in the Sent Items folder. Alternatively, send a new message in a single operation.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-send?view=graph-rest-1.0
operationId: user.message_send
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: message
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/messages/$count':
get:
tags:
- users.message
summary: Get the number of the resource
operationId: user.message_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/messages/microsoft.graph.delta()':
get:
tags:
- users.message
summary: Invoke function delta
description: "Get a set of messages added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls, you can [query for incremental changes in the messages in\r\nthat folder](/graph/delta-query-messages). It allows you to maintain and synchronize a local store of a user's messages without\r\nhaving to fetch the entire set of messages from the server every time."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-delta?view=graph-rest-1.0
operationId: user.message_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: changeType
in: query
description: 'A custom query option to filter the delta response based on the type of change. Supported values are created, updated or deleted.'
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of message
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
components:
schemas:
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
type: object
properties:
overrides:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.inferenceClassificationOverride:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassificationOverride
type: object
properties:
classifyAs:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
senderEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
type: object
properties:
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of immediate child mailFolders in the current mailFolder.
format: int32
nullable: true
displayName:
type: string
description: The mailFolder's display name.
nullable: true
isHidden:
type: boolean
description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder.
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder marked as unread.
format: int32
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The collection of child folders in the mailFolder.
x-ms-navigationProperty: true
messageRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
description: The collection of rules that apply to the user's Inbox folder.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The collection of messages in the mailFolder.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.messageRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: messageRule
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.messageRuleActions'
conditions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
displayName:
type: string
description: The display name of the rule.
nullable: true
exceptions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
hasError:
type: boolean
description: Indicates whether the rule is in an error condition. Read-only.
nullable: true
isEnabled:
type: boolean
description: Indicates whether the rule is enabled to be applied to messages.
nullable: true
isReadOnly:
type: boolean
description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
nullable: true
sequence:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Indicates the order in which the rule is executed, among other rules.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
type: object
properties:
bccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Bcc: recipients for the message.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The first 255 characters of the message body. It is in text format.
nullable: true
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the message.'
conversationId:
type: string
description: The ID of the conversation the email belongs to.
nullable: true
conversationIndex:
type: string
description: Indicates the position of the message within the conversation.
format: base64url
nullable: true
flag:
$ref: '#/components/schemas/microsoft.graph.followupFlag'
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as
.'
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
internetMessageHeaders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Requires $select to retrieve. Read-only.
internetMessageId:
type: string
description: The message ID in the format specified by RFC2822.
nullable: true
isDeliveryReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
isDraft:
type: boolean
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
nullable: true
isRead:
type: boolean
description: Indicates whether the message has been read.
nullable: true
isReadReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the message's parent mailFolder.
nullable: true
receivedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
replyTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to use when replying.
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
sentDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
subject:
type: string
description: The subject of the message.
nullable: true
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the message.'
uniqueBody:
$ref: '#/components/schemas/microsoft.graph.itemBody'
webLink:
type: string
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.NOTE: When using this URL to access a message from a mailbox with delegate permissions, both the signed-in user and the target mailbox must be in the same database region. For example, an error is returned when a user with a mailbox in the EUR (Europe) region attempts to access messages from a mailbox in the NAM (North America) region.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: The fileAttachment and itemAttachment attachments for the message.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the message. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false.'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
name:
type: string
description: The attachment's file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: number
description: The length of the attachment in bytes.
format: int32
additionalProperties:
type: object
microsoft.graph.attachmentItem:
title: attachmentItem
type: object
properties:
attachmentType:
$ref: '#/components/schemas/microsoft.graph.attachmentType'
contentId:
type: string
description: The CID or Content-Id of the attachment for referencing for the in-line attachments using the
tag in HTML messages. Optional.
nullable: true
contentType:
type: string
description: The nature of the data in the attachment. Optional.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false. Optional.'
nullable: true
name:
type: string
description: The display name of the attachment. This can be a descriptive string and doesn't have to be the actual file name. Required.
nullable: true
size:
type: number
description: The length of the attachment in bytes. Required.
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.uploadSession:
title: uploadSession
type: object
properties:
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time in UTC that the upload session expires. The complete file must be uploaded before this expiration time is reached. Each fragment uploaded during the session extends the expiration time.
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
description: 'A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format ''start-end'' (for example ''0-26'' to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value ''{start}'', the location in the file where the next upload should begin.'
uploadUrl:
type: string
description: The URL endpoint that accepts PUT requests for byte ranges of the file.
nullable: true
additionalProperties:
type: object
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
additionalProperties:
type: object
microsoft.graph.recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.entity:
title: entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
additionalProperties:
type: object
microsoft.graph.inferenceClassificationType:
title: inferenceClassificationType
enum:
- focused
- other
type: string
microsoft.graph.emailAddress:
title: emailAddress
type: object
properties:
address:
type: string
description: The email address of the person or entity.
nullable: true
name:
type: string
description: The display name of the person or entity.
nullable: true
additionalProperties:
type: object
microsoft.graph.multiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
items:
type: string
nullable: true
description: A collection of property values.
additionalProperties:
type: object
microsoft.graph.singleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
description: A property value.
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRuleActions:
title: messageRuleActions
type: object
properties:
assignCategories:
type: array
items:
type: string
nullable: true
description: A list of categories to be assigned to a message.
copyToFolder:
type: string
description: The ID of a folder that a message is to be copied to.
nullable: true
delete:
type: boolean
description: Indicates whether a message should be moved to the Deleted Items folder.
nullable: true
forwardAsAttachmentTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses of the recipients to which a message should be forwarded as an attachment.
forwardTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses of the recipients to which a message should be forwarded.
markAsRead:
type: boolean
description: Indicates whether a message should be marked as read.
nullable: true
markImportance:
$ref: '#/components/schemas/microsoft.graph.importance'
moveToFolder:
type: string
description: The ID of the folder that a message will be moved to.
nullable: true
permanentDelete:
type: boolean
description: Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder.
nullable: true
redirectTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to which a message should be redirected.
stopProcessingRules:
type: boolean
description: Indicates whether subsequent rules should be evaluated.
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRulePredicates:
title: messageRulePredicates
type: object
properties:
bodyContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.
bodyOrSubjectContains:
type: array
items:
type: string
nullable: true
description: 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:
type: array
items:
type: string
nullable: true
description: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.
fromAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.
hasAttachments:
type: boolean
description: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.
nullable: true
headerContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isApprovalRequest:
type: boolean
description: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.
nullable: true
isAutomaticForward:
type: boolean
description: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.
nullable: true
isAutomaticReply:
type: boolean
description: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.
nullable: true
isEncrypted:
type: boolean
description: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.
nullable: true
isMeetingRequest:
type: boolean
description: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.
nullable: true
isMeetingResponse:
type: boolean
description: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.
nullable: true
isNonDeliveryReport:
type: boolean
description: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.
nullable: true
isPermissionControlled:
type: boolean
description: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.
nullable: true
isReadReceipt:
type: boolean
description: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.
nullable: true
isSigned:
type: boolean
description: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.
nullable: true
isVoicemail:
type: boolean
description: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.
nullable: true
messageActionFlag:
$ref: '#/components/schemas/microsoft.graph.messageActionFlag'
notSentToMe:
type: boolean
description: 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.
nullable: true
recipientContains:
type: array
items:
type: string
nullable: true
description: 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:
type: array
items:
type: string
nullable: true
description: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
sentCcMe:
type: boolean
description: 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.
nullable: true
sentOnlyToMe:
type: boolean
description: 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.
nullable: true
sentToAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.
sentToMe:
type: boolean
description: 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.
nullable: true
sentToOrCcMe:
type: boolean
description: 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.
nullable: true
subjectContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.
withinSizeRange:
$ref: '#/components/schemas/microsoft.graph.sizeRange'
additionalProperties:
type: object
microsoft.graph.outlookItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookItem
type: object
properties:
categories:
type: array
items:
type: string
nullable: true
description: The categories associated with the item
changeKey:
type: string
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.itemBody:
title: itemBody
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
$ref: '#/components/schemas/microsoft.graph.bodyType'
additionalProperties:
type: object
microsoft.graph.followupFlag:
title: followupFlag
type: object
properties:
completedDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
dueDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
flagStatus:
$ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
startDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.importance:
title: importance
enum:
- low
- normal
- high
type: string
microsoft.graph.internetMessageHeader:
title: internetMessageHeader
type: object
properties:
name:
type: string
description: Represents the key in a key-value pair.
nullable: true
value:
type: string
description: The value in a key-value pair.
nullable: true
additionalProperties:
type: object
microsoft.graph.attachmentType:
title: attachmentType
enum:
- file
- item
- reference
type: string
microsoft.graph.ODataErrors.ODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
additionalProperties:
type: object
microsoft.graph.inferenceClassificationOverrideCollectionResponse:
title: Collection of inferenceClassificationOverride
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
ODataCountResponse:
type: integer
format: int32
microsoft.graph.mailFolderCollectionResponse:
title: Collection of mailFolder
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRuleCollectionResponse:
title: Collection of messageRule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.messageCollectionResponse:
title: Collection of message
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.attachmentCollectionResponse:
title: Collection of attachment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.extensionCollectionResponse:
title: Collection of extension
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.messageActionFlag:
title: messageActionFlag
enum:
- any
- call
- doNotForward
- followUp
- fyi
- forward
- noResponseNecessary
- read
- reply
- replyToAll
- review
type: string
microsoft.graph.sensitivity:
title: sensitivity
enum:
- normal
- personal
- private
- confidential
type: string
microsoft.graph.sizeRange:
title: sizeRange
type: object
properties:
maximumSize:
maximum: 2147483647
minimum: -2147483648
type: number
description: The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
format: int32
nullable: true
minimumSize:
maximum: 2147483647
minimum: -2147483648
type: number
description: The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.bodyType:
title: bodyType
enum:
- text
- html
type: string
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
description: 'A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).'
timeZone:
type: string
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
nullable: true
additionalProperties:
type: object
microsoft.graph.followupFlagStatus:
title: followupFlagStatus
enum:
- notFlagged
- complete
- flagged
type: string
microsoft.graph.ODataErrors.MainError:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
x-ms-primary-error-message: true
target:
type: string
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
innerError:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
additionalProperties:
type: object
microsoft.graph.ODataErrors.ErrorDetails:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.InnerError:
type: object
additionalProperties:
type: object
description: The structure of this object is service-specific
responses:
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
microsoft.graph.inferenceClassificationOverrideCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverrideCollectionResponse'
ODataCountResponse:
description: The count of the resource
content:
text/plain:
schema:
$ref: '#/components/schemas/ODataCountResponse'
microsoft.graph.mailFolderCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolderCollectionResponse'
microsoft.graph.messageRuleCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRuleCollectionResponse'
microsoft.graph.messageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageCollectionResponse'
microsoft.graph.attachmentCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentCollectionResponse'
microsoft.graph.extensionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionCollectionResponse'
parameters:
top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
filter:
name: $filter
in: query
description: Filter items by property values
style: form
explode: false
schema:
type: string
count:
name: $count
in: query
description: Include count of items
style: form
explode: false
schema:
type: boolean
securitySchemes:
azureaadv2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
scopes: { }
security:
- azureaadv2: [ ]