List rules
Namespace: microsoft.graph
Get all the messageRule objects defined for the user's Inbox.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | MailboxSettings.Read |
Delegated (personal Microsoft account) | MailboxSettings.Read |
Application | MailboxSettings.Read |
HTTP request
GET /me/mailFolders/inbox/messageRules
GET /users/{id | userPrincipalName}/mailFolders/inbox/messageRules
Optional query parameters
This method supports the OData Query Parameters to help customize the response.
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and collection of messageRule objects in the response body.
Example
Request
Here is an example of the request.
GET https://graph.microsoft.com/v1.0/me/mailFolders/inbox/messageRules
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Me/mailFolders('inbox')/messageRules",
"value":[
{
"id":"AQAAAJ5dZp8=",
"displayName":"Remove spam",
"sequence":1,
"isEnabled":true,
"hasError":false,
"isReadOnly":false,
"conditions":{
"subjectContains":[
"enter to win"
]
},
"actions":{
"delete":true,
"stopProcessingRules":true
}
},
{
"id":"AQAAAJ5dZqA=",
"displayName":"From partner",
"sequence":2,
"isEnabled":true,
"hasError":false,
"isReadOnly":false,
"conditions":{
"senderContains":[
"ADELE"
]
},
"actions":{
"stopProcessingRules":true,
"forwardTo":[
{
"emailAddress":{
"name":"Alex Wilbur",
"address":"AlexW@contoso.onmicrosoft.com"
}
}
]
}
}
]
}