Crear reglaCreate rule

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Crear un objeto messageRule especificando un conjunto de condiciones y acciones.Create a messageRule object by specifying a set of conditions and actions.

Outlook lleva a cabo esas acciones si un mensaje entrante en la Bandeja de entrada del usuario cumple las condiciones especificadas.Outlook carries out those actions if an incoming message in the user's Inbox meets the specified conditions.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) MailboxSettings.ReadWriteMailboxSettings.ReadWrite
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) MailboxSettings.ReadWriteMailboxSettings.ReadWrite
AplicaciónApplication MailboxSettings.ReadWriteMailboxSettings.ReadWrite

Solicitud HTTPHTTP request

POST /me/mailFolders/inbox/messageRules
POST /users/{id | userPrincipalName}/mailFolders/inbox/messageRules

Encabezados de solicitudRequest headers

NombreName DescripciónDescription
AuthorizationAuthorization {token} de portador. Obligatorio.Bearer {token}. Required.

Cuerpo de la solicitudRequest body

En el cuerpo de la solicitud, proporcione los parámetros que se aplican a la regla.In the request body, supply the parameters that are applicable to your rule. Estos son los parámetros de cuerpo que suelen usarse al crear reglas.The following are body parameters that are typically used when creating rules. Puede especificar cualquier otra propiedad messageRule modificable que corresponda en el cuerpo de la solicitud.You can specify any other writable messageRule properties as appropriate in the request body.

NombreName TipoType DescriptionDescription
actionsactions messageRuleActionsmessageRuleActions Acciones que se van a realizar en un mensaje cuando las condiciones correspondientes, si las hubiera, se cumplan.Actions to be taken on a message when the corresponding conditions, if any, are fulfilled. Necesario.Required.
conditionsconditions messageRulePredicatesmessageRulePredicates Condiciones que, cuando se cumplan, activarán las acciones correspondientes a esa regla.Conditions that when fulfilled, will trigger the corresponding actions for that rule. Opcional.Optional.
displayNamedisplayName CadenaString Nombre para mostrar de la regla.The display name of the rule. Necesario.Required.
exceptionsexceptions messageRulePredicatesmessageRulePredicates Representa las condiciones de excepción de la regla.Represents exception conditions for the rule. Opcional.Optional.
isEnabledisEnabled BooleanBoolean Indica si la regla está habilitada para que se aplique a los mensajes.Indicates whether the rule is enabled to be applied to messages. Opcional.Optional.
sequencesequence Int32Int32 Indica el orden en que se ejecuta la regla entre otras reglas.Indicates the order in which the rule is executed, among other rules. Necesario.Required.

RespuestaResponse

Si se ejecuta correctamente, este método devuelve un código de respuesta 201 Created y el objeto messageRule en el cuerpo de la respuesta.If successful, this method returns 201 Created response code and a messageRule object in the response body.

EjemploExample

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.Here is an example of the request.

POST https://graph.microsoft.com/v1.0/me/mailFolders/inbox/messageRules
Content-type: application/json

{      
    "displayName": "From partner",      
    "sequence": 2,      
    "isEnabled": true,          
    "conditions": {
        "senderContains": [
          "adele"       
        ]
     },
     "actions": {
        "forwardTo": [
          {
             "emailAddress": {
                "name": "Alex Wilbur",
                "address": "AlexW@contoso.onmicrosoft.com"
              }
           }
        ],
        "stopProcessingRules": true
     }    
}

RespuestaResponse

Aquí tiene un ejemplo de la respuesta. Nota: Puede que el objeto de respuesta que aparece aquí se trunque para abreviar. Todas las propiedades se devolverán de una llamada real.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 201 Created
Content-type: application/json

{
  "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"
          }
        }
      ]
  }
}