Microsoft Outlook Mail Folders API

openapi: 3.1.0
info:
  title: Microsoft Outlook Microsoft Graph Mail Attachments Mail Folders API
  description: API for accessing Outlook email messages, mail folders, and attachments through Microsoft Graph. Provides full CRUD operations on messages, mail folder management, attachment handling, and message actions such as send, reply, forward, copy, and move.
  version: 1.0.0
  contact:
    name: Microsoft Graph Support
    url: https://developer.microsoft.com/en-us/graph/support
  license:
    name: Microsoft API Terms of Use
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
  x-api-id: microsoft-graph-mail
  x-audience: external
servers:
- url: https://graph.microsoft.com/v1.0
  description: Microsoft Graph v1.0 production endpoint
security:
- oauth2: []
tags:
- name: Mail Folders
  description: Operations on mail folders in a user mailbox
paths:
  /me/mailFolders:
    get:
      operationId: listMailFolders
      summary: Microsoft Outlook List Mail Folders
      description: Get all the mail folders in the specified user's mailbox, including any mail search folders. Use the includeHiddenFolders query parameter to include hidden folders.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/filter'
      - name: includeHiddenFolders
        in: query
        description: Include hidden mail folders in the response.
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successfully retrieved mail folders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolderCollectionResponse'
              examples:
                Listmailfolders200Example:
                  summary: Default listMailFolders 200 response
                  x-microcks-default: true
                  value:
                    '@odata.context': example_value
                    '@odata.nextLink': https://www.example.com
                    value:
                    - id: abc123
                      displayName: example_value
                      parentFolderId: '500123'
                      childFolderCount: 10
                      unreadItemCount: 10
                      totalItemCount: 10
                      isHidden: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createMailFolder
      summary: Microsoft Outlook Create Mail Folder
      description: Create a new mail folder in the root folder of the user's mailbox.
      tags:
      - Mail Folders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailFolder'
            examples:
              CreatemailfolderRequestExample:
                summary: Default createMailFolder request
                x-microcks-default: true
                value:
                  id: abc123
                  displayName: example_value
                  parentFolderId: '500123'
                  childFolderCount: 10
                  unreadItemCount: 10
                  totalItemCount: 10
                  isHidden: true
      responses:
        '201':
          description: Successfully created mail folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolder'
              examples:
                Createmailfolder201Example:
                  summary: Default createMailFolder 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    parentFolderId: '500123'
                    childFolderCount: 10
                    unreadItemCount: 10
                    totalItemCount: 10
                    isHidden: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /me/mailFolders/{mailFolder-id}:
    get:
      operationId: getMailFolder
      summary: Microsoft Outlook Get Mail Folder
      description: Read the properties and relationships of a mail folder object.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: Successfully retrieved mail folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolder'
              examples:
                Getmailfolder200Example:
                  summary: Default getMailFolder 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    parentFolderId: '500123'
                    childFolderCount: 10
                    unreadItemCount: 10
                    totalItemCount: 10
                    isHidden: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateMailFolder
      summary: Microsoft Outlook Update Mail Folder
      description: Update the properties of a mail folder object.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailFolder'
            examples:
              UpdatemailfolderRequestExample:
                summary: Default updateMailFolder request
                x-microcks-default: true
                value:
                  id: abc123
                  displayName: example_value
                  parentFolderId: '500123'
                  childFolderCount: 10
                  unreadItemCount: 10
                  totalItemCount: 10
                  isHidden: true
      responses:
        '200':
          description: Successfully updated mail folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolder'
              examples:
                Updatemailfolder200Example:
                  summary: Default updateMailFolder 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    parentFolderId: '500123'
                    childFolderCount: 10
                    unreadItemCount: 10
                    totalItemCount: 10
                    isHidden: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteMailFolder
      summary: Microsoft Outlook Delete Mail Folder
      description: Delete the specified mail folder. The folder can be a mailSearchFolder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      responses:
        '204':
          description: Successfully deleted mail folder.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /me/mailFolders/{mailFolder-id}/childFolders:
    get:
      operationId: listChildFolders
      summary: Microsoft Outlook List Child Folders
      description: Get the folder collection under the specified folder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: Successfully retrieved child folders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolderCollectionResponse'
              examples:
                Listchildfolders200Example:
                  summary: Default listChildFolders 200 response
                  x-microcks-default: true
                  value:
                    '@odata.context': example_value
                    '@odata.nextLink': https://www.example.com
                    value:
                    - id: abc123
                      displayName: example_value
                      parentFolderId: '500123'
                      childFolderCount: 10
                      unreadItemCount: 10
                      totalItemCount: 10
                      isHidden: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createChildFolder
      summary: Microsoft Outlook Create Child Folder
      description: Create a new child mail folder under the specified folder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailFolder'
            examples:
              CreatechildfolderRequestExample:
                summary: Default createChildFolder request
                x-microcks-default: true
                value:
                  id: abc123
                  displayName: example_value
                  parentFolderId: '500123'
                  childFolderCount: 10
                  unreadItemCount: 10
                  totalItemCount: 10
                  isHidden: true
      responses:
        '201':
          description: Successfully created child folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolder'
              examples:
                Createchildfolder201Example:
                  summary: Default createChildFolder 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    parentFolderId: '500123'
                    childFolderCount: 10
                    unreadItemCount: 10
                    totalItemCount: 10
                    isHidden: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /me/mailFolders/{mailFolder-id}/messages:
    get:
      operationId: listMessagesInFolder
      summary: Microsoft Outlook List Messages in Folder
      description: Get all the messages in the specified mail folder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderby'
      responses:
        '200':
          description: Successfully retrieved messages from folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageCollectionResponse'
              examples:
                Listmessagesinfolder200Example:
                  summary: Default listMessagesInFolder 200 response
                  x-microcks-default: true
                  value:
                    '@odata.context': example_value
                    '@odata.count': 10
                    '@odata.nextLink': https://www.example.com
                    value:
                    - id: abc123
                      createdDateTime: '2026-01-15T10:30:00Z'
                      lastModifiedDateTime: '2026-01-15T10:30:00Z'
                      changeKey: example_value
                      categories: {}
                      receivedDateTime: '2026-01-15T10:30:00Z'
                      sentDateTime: '2026-01-15T10:30:00Z'
                      hasAttachments: true
                      internetMessageId: '500123'
                      internetMessageHeaders: {}
                      subject: example_value
                      bodyPreview: example_value
                      importance: low
                      parentFolderId: '500123'
                      conversationId: '500123'
                      conversationIndex: example_value
                      isDeliveryReceiptRequested: true
                      isReadReceiptRequested: true
                      isRead: true
                      isDraft: true
                      webLink: https://www.example.com
                      inferenceClassification: focused
                      toRecipients: {}
                      ccRecipients: {}
                      bccRecipients: {}
                      replyTo: {}
                      attachments: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createMessageInFolder
      summary: Microsoft Outlook Create Message in Folder
      description: Create a new message draft in the specified mail folder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
            examples:
              CreatemessageinfolderRequestExample:
                summary: Default createMessageInFolder request
                x-microcks-default: true
                value:
                  id: abc123
                  createdDateTime: '2026-01-15T10:30:00Z'
                  lastModifiedDateTime: '2026-01-15T10:30:00Z'
                  changeKey: example_value
                  categories:
                  - example_value
                  receivedDateTime: '2026-01-15T10:30:00Z'
                  sentDateTime: '2026-01-15T10:30:00Z'
                  hasAttachments: true
                  internetMessageId: '500123'
                  internetMessageHeaders:
                  - name: Example Title
                    value: example_value
                  subject: example_value
                  body:
                    contentType: text
                    content: example_value
                  bodyPreview: example_value
                  importance: low
                  parentFolderId: '500123'
                  conversationId: '500123'
                  conversationIndex: example_value
                  isDeliveryReceiptRequested: true
                  isReadReceiptRequested: true
                  isRead: true
                  isDraft: true
                  webLink: https://www.example.com
                  inferenceClassification: focused
                  flag:
                    flagStatus: notFlagged
                  from: {}
                  sender: {}
                  toRecipients:
                  - {}
                  ccRecipients:
                  - {}
                  bccRecipients:
                  - {}
                  replyTo:
                  - {}
                  uniqueBody:
                    contentType: text
                    content: example_value
                  attachments:
                  - '@odata.type': '#microsoft.graph.fileAttachment'
                    id: abc123
                    name: Example Title
                    contentType: example_value
                    size: 10
                    isInline: true
                    lastModifiedDateTime: '2026-01-15T10:30:00Z'
                    contentBytes: example_value
                    contentId: '500123'
                    contentLocation: example_value
      responses:
        '201':
          description: Successfully created message in folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              examples:
                Createmessageinfolder201Example:
                  summary: Default createMessageInFolder 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    createdDateTime: '2026-01-15T10:30:00Z'
                    lastModifiedDateTime: '2026-01-15T10:30:00Z'
                    changeKey: example_value
                    categories:
                    - example_value
                    receivedDateTime: '2026-01-15T10:30:00Z'
                    sentDateTime: '2026-01-15T10:30:00Z'
                    hasAttachments: true
                    internetMessageId: '500123'
                    internetMessageHeaders:
                    - name: Example Title
                      value: example_value
                    subject: example_value
                    body:
                      contentType: text
                      content: example_value
                    bodyPreview: example_value
                    importance: low
                    parentFolderId: '500123'
                    conversationId: '500123'
                    conversationIndex: example_value
                    isDeliveryReceiptRequested: true
                    isReadReceiptRequested: true
                    isRead: true
                    isDraft: true
                    webLink: https://www.example.com
                    inferenceClassification: focused
                    flag:
                      flagStatus: notFlagged
                    from: {}
                    sender: {}
                    toRecipients:
                    - {}
                    ccRecipients:
                    - {}
                    bccRecipients:
                    - {}
                    replyTo:
                    - {}
                    uniqueBody:
                      contentType: text
                      content: example_value
                    attachments:
                    - '@odata.type': '#microsoft.graph.fileAttachment'
                      id: abc123
                      name: Example Title
                      contentType: example_value
                      size: 10
                      isInline: true
                      lastModifiedDateTime: '2026-01-15T10:30:00Z'
                      contentBytes: example_value
                      contentId: '500123'
                      contentLocation: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /me/mailFolders/{mailFolder-id}/copy:
    post:
      operationId: copyMailFolder
      summary: Microsoft Outlook Copy Mail Folder
      description: Copy a mail folder and its contents to another mail folder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                destinationId:
                  type: string
                  description: The destination folder ID or well-known folder name.
              required:
              - destinationId
            examples:
              CopymailfolderRequestExample:
                summary: Default copyMailFolder request
                x-microcks-default: true
                value:
                  destinationId: '500123'
      responses:
        '200':
          description: Successfully copied mail folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolder'
              examples:
                Copymailfolder200Example:
                  summary: Default copyMailFolder 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    parentFolderId: '500123'
                    childFolderCount: 10
                    unreadItemCount: 10
                    totalItemCount: 10
                    isHidden: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /me/mailFolders/{mailFolder-id}/move:
    post:
      operationId: moveMailFolder
      summary: Microsoft Outlook Move Mail Folder
      description: Move a mail folder and its contents to another mail folder.
      tags:
      - Mail Folders
      parameters:
      - $ref: '#/components/parameters/mailFolderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                destinationId:
                  type: string
                  description: The destination folder ID or well-known folder name.
              required:
              - destinationId
            examples:
              MovemailfolderRequestExample:
                summary: Default moveMailFolder request
                x-microcks-default: true
                value:
                  destinationId: '500123'
      responses:
        '200':
          description: Successfully moved mail folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailFolder'
              examples:
                Movemailfolder200Example:
                  summary: Default moveMailFolder 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    parentFolderId: '500123'
                    childFolderCount: 10
                    unreadItemCount: 10
                    totalItemCount: 10
                    isHidden: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    MailFolderCollectionResponse:
      type: object
      description: Collection of mail folder resources with optional pagination link.
      properties:
        '@odata.context':
          type: string
          example: example_value
        '@odata.nextLink':
          type: string
          format: uri
          example: https://www.example.com
        value:
          type: array
          items:
            $ref: '#/components/schemas/MailFolder'
          example: []
    Attachment:
      type: object
      description: Base resource for file, item, and reference attachments. Use the @odata.type property to specify the derived type.
      properties:
        '@odata.type':
          type: string
          description: 'The OData type of the attachment. Use #microsoft.graph.fileAttachment for file attachments or #microsoft.graph.itemAttachment for item attachments.'
          enum:
          - '#microsoft.graph.fileAttachment'
          - '#microsoft.graph.itemAttachment'
          - '#microsoft.graph.referenceAttachment'
          example: '#microsoft.graph.fileAttachment'
        id:
          type: string
          description: The unique identifier of the attachment. Read-only.
          readOnly: true
          example: abc123
        name:
          type: string
          description: The display name of the attachment.
          example: Example Title
        contentType:
          type: string
          description: The MIME type of the attachment.
          example: example_value
        size:
          type: integer
          format: int32
          description: The length of the attachment in bytes.
          example: 10
        isInline:
          type: boolean
          description: True if the attachment is an inline attachment.
          example: true
        lastModifiedDateTime:
          type: string
          format: date-time
          description: The date and time the attachment was last modified in UTC.
          example: '2026-01-15T10:30:00Z'
        contentBytes:
          type: string
          format: byte
          description: The base64-encoded contents of the file. Only applicable for fileAttachment.
          example: example_value
        contentId:
          type: string
          description: The ID of the attachment in the Exchange store. Only applicable for fileAttachment.
          example: '500123'
        contentLocation:
          type: string
          description: The Uniform Resource Identifier (URI) corresponding to the location of the content of the attachment.
          example: example_value
    MessageCollectionResponse:
      type: object
      description: Collection of message resources with optional pagination link.
      properties:
        '@odata.context':
          type: string
          description: The OData context URL.
          example: example_value
        '@odata.count':
          type: integer
          description: The total count of matching resources.
          example: 10
        '@odata.nextLink':
          type: string
          format: uri
          description: The URL for the next page of results.
          example: https://www.example.com
        value:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          example: []
    Message:
      type: object
      description: A message in a mailFolder.
      properties:
        id:
          type: string
          description: Unique identifier for the message. Read-only.
          readOnly: true
          example: abc123
        createdDateTime:
          type: string
          format: date-time
          description: The date and time the message was created in UTC (ISO 8601).
          readOnly: true
          example: '2026-01-15T10:30:00Z'
        lastModifiedDateTime:
          type: string
          format: date-time
          description: The date and time the message was last changed in UTC (ISO 8601).
          readOnly: true
          example: '2026-01-15T10:30:00Z'
        changeKey:
          type: string
          description: The version of the message.
          readOnly: true
          example: example_value
        categories:
          type: array
          items:
            type: string
          description: The categories associated with the message.
          example: []
        receivedDateTime:
          type: string
          format: date-time
          description: The date and time the message was received in UTC (ISO 8601).
          example: '2026-01-15T10:30:00Z'
        sentDateTime:
          type: string
          format: date-time
          description: The date and time the message was sent in UTC (ISO 8601).
          example: '2026-01-15T10:30:00Z'
        hasAttachments:
          type: boolean
          description: Indicates whether the message has attachments. Does not include inline attachments.
          example: true
        internetMessageId:
          type: string
          description: The message ID in the format specified by RFC 2822.
          example: '500123'
        internetMessageHeaders:
          type: array
          items:
            $ref: '#/components/schemas/InternetMessageHeader'
          description: Collection of message headers defined by RFC 5322. Returned only on applying a $select query option.
          example: []
        subject:
          type: string
          description: The subject of the message.
          example: example_value
        body:
          $ref: '#/components/schemas/ItemBody'
        bodyPreview:
          type: string
          description: The first 255 characters of the message body in text format.
          readOnly: true
          example: example_value
        importance:
          type: string
          enum:
          - low
          - normal
          - high
          description: The importance of the message.
          example: low
        parentFolderId:
          type: string
          description: The unique identifier for the message's parent mailFolder.
          example: '500123'
        conversationId:
          type: string
          description: The ID of the conversation the email belongs to.
          example: '500123'
        conversationIndex:
          type: string
          format: binary
          description: Indicates the position of the message within the conversation.
          example: example_value
        isDeliveryReceiptRequested:
          type: boolean
          description: Indicates whether a delivery receipt is requested.
          example: true
        isReadReceiptRequested:
          type: boolean
          description: Indicates whether a read receipt is requested.
          example: true
        isRead:
          type: boolean
          description: Indicates whether the message has been read.
          example: true
        isDraft:
          type: boolean
          description: Indicates whether the message is a draft.
          example: true
        webLink:
          type: string
          format: uri
          description: The URL to open the message in Outlook on the web.
          readOnly: true
          example: https://www.example.com
        inferenceClassification:
          type: string
          enum:
          - focused
          - other
          description: The classification of the message based on inferred relevance or importance, or on an explicit override.
          example: focused
        flag:
          $ref: '#/components/schemas/FollowupFlag'
        from:
          $ref: '#/components/schemas/Recipient'
        sender:
          $ref: '#/components/schemas/Recipient'
        toRecipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
          description: The To recipients for the message.
          example: []
        ccRecipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
          description: The Cc recipients for the message.
          example: []
        bccRecipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
          description: The Bcc recipients for the message.
          example: []
        replyTo:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
          description: The email addresses to use when replying.
          example: []
        uniqueBody:
          $ref: '#/components/schemas/ItemBody'
        attachments:
       

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-outlook/refs/heads/main/openapi/microsoft-outlook-mail-folders-api-openapi.yml