Microsoft: Get messages from users — users Mail Folder mail Folders Child Folders List Messages

Microsoft usersMailFolder.mailFoldersChildFoldersListMessages: arguments, response, policy and SDK examples.

← Users mail folder operations · Get started

Operation microsoft.users_mailfolders_childfolders_listmessages

Provider route: GET /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MicrosoftIntegration } from "@alter-ai/microsoft";

async function execute(input: Parameters<MicrosoftIntegration["usersMailFolder"]["mailFoldersChildFoldersListMessages"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.usersMailFolder.mailFoldersChildFoldersListMessages(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_microsoft import MicrosoftIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.users_mail_folder.mail_folders_child_folders_list_messages(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.user-id`	string	Required within parent
`path.mailFolder-id`	string	Required within parent
`path.mailFolder-id1`	string	Required within parent
`query`	Model	Optional	Expand List rules — request body — query

Referenced models: List rules — request body — query

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand List messages — me Message list Messages — response body

Referenced models: List messages — me Message list Messages — response body

Schemas

8 more schemas are linked from the tables above, on the schema pages.

List messages — me Message list Messages — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`$ (allOf 1)`	Model	All variants apply	Expand List rules — response body — @odata count, @odata next Link
`$ (allOf 2)`	object	All variants apply
`$ (allOf 2).value`	array	Optional
`$ (allOf 2).value[]`	Model	Each item	Expand Get message — response body

Referenced models: List rules — response body — @odata count, @odata next Link, Get message — response body

List rules — request body — query

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`$top`	integer	Optional	Minimum: 0
`$skip`	integer	Optional	Minimum: 0
`$search`	string	Optional
`$filter`	string	Optional
`$count`	boolean	Optional
`$orderby`	array	Optional	Unique items: true
`$orderby[]`	string	Each item
`$select`	array	Optional	Unique items: true
`$select[]`	string	Each item
`$expand`	array	Optional	Unique items: true
`$expand[]`	string	Each item
`$skiptoken`	string	Optional

List rules — response body — @odata count, @odata next Link

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.count`	JSON	Optional
`@odata.count (anyOf 1)`	JSON	Alternative
`@odata.count (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`@odata.count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`@odata.count (anyOf 2)`	null	Alternative
`@odata.nextLink`	JSON	Optional
`@odata.nextLink (anyOf 1)`	string	Alternative
`@odata.nextLink (anyOf 2)`	null	Alternative

Get attachment — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply	discriminator: {"mapping": {}, "propertyName": "@odata.type"}
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).contentType`	JSON	Optional
`$ (allOf 2).contentType (anyOf 1)`	string	Alternative	The MIME type.
`$ (allOf 2).contentType (anyOf 2)`	null	Alternative
`$ (allOf 2).isInline`	boolean	Optional	true if the attachment is an inline attachment; otherwise, false.
`$ (allOf 2).lastModifiedDateTime`	JSON	Optional
`$ (allOf 2).lastModifiedDateTime (anyOf 1)`	string	Alternative	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 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])$
`$ (allOf 2).lastModifiedDateTime (anyOf 2)`	null	Alternative
`$ (allOf 2).name`	JSON	Optional
`$ (allOf 2).name (anyOf 1)`	string	Alternative	The attachment's file name.
`$ (allOf 2).name (anyOf 2)`	null	Alternative
`$ (allOf 2).size`	JSON	Optional
`$ (allOf 2).size (anyOf 1)`	number	Alternative	The length of the attachment in bytes. Format: int32 Maximum: 2147483647 Minimum: -2147483648
`$ (allOf 2).size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get rule — response body — @odata type, id

Create open extension — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply	discriminator: {"mapping": {}, "propertyName": "@odata.type"}
`$ (allOf 2).@odata.type`	string	Optional

Referenced models: Get rule — response body — @odata type, id

Get message — response body — @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link flag @odata type, completed Date Time, due Date Time, flag Status, start Date Time

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`completedDateTime`	JSON	Optional	The date and time that the follow-up was finished.
`completedDateTime (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`completedDateTime (anyOf 2)`	JSON	Alternative
`completedDateTime (anyOf 2) (anyOf 1)`	object	Alternative
`completedDateTime (anyOf 2) (anyOf 2)`	null	Alternative
`dueDateTime`	JSON	Optional	The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response.
`dueDateTime (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`dueDateTime (anyOf 2)`	JSON	Alternative
`dueDateTime (anyOf 2) (anyOf 1)`	object	Alternative
`dueDateTime (anyOf 2) (anyOf 2)`	null	Alternative
`flagStatus`	JSON	Optional	The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.
`flagStatus (anyOf 1)`	string	Alternative	Known values: notFlagged, complete, flagged
`flagStatus (anyOf 2)`	JSON	Alternative
`flagStatus (anyOf 2) (anyOf 1)`	object	Alternative
`flagStatus (anyOf 2) (anyOf 2)`	null	Alternative
`startDateTime`	JSON	Optional	The date and time that the follow-up is to begin.
`startDateTime (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`startDateTime (anyOf 2)`	JSON	Alternative
`startDateTime (anyOf 2) (anyOf 1)`	object	Alternative
`startDateTime (anyOf 2) (anyOf 2)`	null	Alternative

Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	Represents the key in a key-value pair.
`name (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The value in a key-value pair.
`value (anyOf 2)`	null	Alternative

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`content`	JSON	Optional
`content (anyOf 1)`	string	Alternative	The content of the item.
`content (anyOf 2)`	null	Alternative
`contentType`	JSON	Optional	The type of the content. Possible values are text and html.
`contentType (anyOf 1)`	string	Alternative	Known values: text, html
`contentType (anyOf 2)`	JSON	Alternative
`contentType (anyOf 2) (anyOf 1)`	object	Alternative
`contentType (anyOf 2) (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: microsoft.users_mailfolders_childfolders_listmessages. Catalog operation: users_mailfolders_childfolders_listmessages. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page