Referencia de API de REST de correo de Outlook (versión 1.0)

  • Artículo

Se aplica a: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Nota

La versión 1.0 de la API de REST de Outlook está obsoleta. A partir del 1 de noviembre de 2018, las aplicaciones ya no podrán utilizar la autentificación básica con el punto de conexión de REST v1.0. El 1 de noviembre de 2019, el punto de conexión REST v1.0 se retirará completamente, y la documentación de la v1.0 se eliminará poco después. Comience a migrar su aplicación para utilizar la API de REST de Outlook en la v1.0 de Microsoft Graph. Vea más detalles en nuestro anuncio.

La API de correo de Outlook le permite leer, crear y enviar mensajes y archivos adjuntos, ver y responder a mensajes de eventos y administrar carpetas que están protegidas por Azure Active Directory en Office 365. También proporciona la misma funcionalidad en las cuentas Microsoft, específicamente en estos dominios: Hotmail.com, Live.com, MSN.com, Outlook.com y Passport.com.

Nota

Para simplificar la referencia, en el resto de este artículo se utiliza Outlook.com para englobar a estos dominios de cuentas Microsoft.

¿No está interesado en la versión 1.0 de la API? En la tabla de contenido de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione la versión que desee.

Todas las operaciones de la API de correo

Operaciones de mensaje

Los mensajes se almacenan en carpetas de buzones, por lo que los extremos de los mensajes suelen incluir la carpeta que contiene el mensaje. Una carpeta se especifica mediante un Id. o mediante uno de los siguientes nombres de carpeta conocidos: Inbox, Drafts, SentItems o DeletedItems.

Operaciones de carpeta

Las carpetas del buzón de correo pueden contener mensajes y otras carpetas. Puede obtener, crear, cambiar, eliminar y administrar carpetas. Puede utilizar los siguientes nombres de carpeta conocidos en lugar del Id. para especificar la carpeta correspondiente: Inbox, SentItems, Drafts o DeletedItems.

Vea también

Utilizar la API REST de correo

Autenticación

Como cualquier otra API REST de Outlook, para cada solicitud a la API de correo, debería incluir un token de acceso válido. Obtener un token de acceso requiere haber registrado e identificado su aplicación y obtenido la autorización correspondiente.

Puede obtener más información sobre algunas opciones de registro y autorización optimizadas para usted. Tenga esto en cuenta a medida que avance con las operaciones específicas en la API de correo.

Versión de la API

La API REST de correo es compatible con todas las versiones de la API REST de Outlook. La funcionalidad puede variar según la versión específica.

Usuario objetivo

Todas las solicitudes de API de correo se realizan en nombre del usuario con sesión iniciada, a menos que se especifique. Se pueden realizar algunos subconjuntos de API, como la API de Bandeja de entrada priorizada, en el usuario con sesión iniciada, o en un usuario especificado por un Id. de usuario, con los permisos adecuados.

Consulte Utilizar la API REST de Outlook para obtener más información común a todos los subconjuntos de la API REST de Outlook.

Obtener mensajes

Puede obtener una colección de mensajes o un mensaje individual desde una carpeta de buzón.

Cada mensaje en la respuesta contiene varias propiedades, incluida la propiedad Body. El cuerpo del mensaje puede ser de texto o HTML. Si el cuerpo es HTML, de forma predeterminada, cualquier HTML potencialmente inseguro (por ejemplo, JavaScript) insertado en la propiedad Body se eliminaría antes de que se devuelva el contenido del cuerpo en una respuesta REST.

Para obtener todo el contenido HTML original, incluya el siguiente encabezado de solicitud HTTP:

Prefer: outlook.allow-unsafe-html

Actualmente, esta operación GET devuelve los cuerpos de los mensajes solo en formato HTML.

Obtener una colección de mensajes

Ámbito mínimo necesario

Uno de los siguientes:

Nota

El comportamiento de las operaciones en esta sección varía según la versión. Obtenga más información eligiendo una versión en la referencia de API de REST de Office 365 en el índice de la izquierda.

Obtener una colección de mensajes de la Bandeja de entrada

GET https://outlook.office.com/api/v1.0/me/messages

También puede especificar una carpeta en el buzón del usuario y obtener la colección de mensajes de esa carpeta.

GET https://outlook.office.com/api/v1.0/me/MailFolders/{folder_id}/messages
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El Id. de carpeta, o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems, si recibe mensajes de una carpeta específica.

Nota

De forma predeterminada, cada mensaje en la respuesta incluye todas sus propiedades. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

El siguiente ejemplo muestra cómo utilizar $select para especificar que se devuelvan solo las propiedades Sender y Subject de cada mensaje en la respuesta. Consulte el ejemplo de respuesta en Obtener un contacto para obtener una lista completa de las propiedades que se devolverían para un contacto si no se utiliza $select.

Solicitud de muestra

GET https://outlook.office.com/api/v1.0/me/folders/sentitems/messages/?$select=Sender,Subject

Respuesta de muestra

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders('sentitems')/Messages(Sender,Subject)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqS\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIzAAAA=",
            "Subject": "Meeting Notes",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=",
            "Subject": "Contract Signing",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        },
        {
            "@odata.type": "#Microsoft.OutlookServices.EventMessage",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CwAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqJ\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy9AAA=",
            "Subject": "Rob:Alex 1:1",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        }
    ]
}

Tipo de respuesta

La colección de mensajes solicitada.

Obtener un mensaje

Ámbito mínimo necesario

Uno de los siguientes:

Obtener un mensaje por Id.

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. de mensaje.

Solicitud de muestra

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=

Respuesta de muestra

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:41:57Z",
  "DateTimeLastModified": "2014-10-20T00:41:57Z",
  "Subject": "Re: Meeting Notes",
  "BodyPreview": "________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP",
  "Body": {
    "ContentType": "Text",
    "Content": "\n________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Katie Jordan"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Katie Jordan"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Alex D"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAEmjRj3pwjRLrbymGMYyEto=",
  "DateTimeReceived": "2014-10-20T00:41:57Z",
  "DateTimeSent": "2014-10-20T00:41:53Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": false
}

Tipo de respuesta

El mensaje solicitado.

Nota

De forma predeterminada, la respuesta incluye todas las propiedades del mensaje especificado. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

El siguiente ejemplo muestra cómo utilizar $select para especificar que se devuelvan solo las propiedades Sender y Subject de cada mensaje en la respuesta.

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGEI5MTAAA=?$select=Sender,Subject

Sincronizar mensajes

Actualmente esta característica está disponible solo en la versión 2.0 y la versión beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione la versión que desee.

Crear y enviar mensajes

Puede enviar un nuevo mensaje al momento, o crear un borrador y luego enviarlo. Puede crear borradores en cualquier carpeta.

Enviar un nuevo mensaje al momento

Ámbito mínimo necesario

Uno de los siguientes:

Envíe el mensaje proporcionado en el cuerpo de la solicitud mediante el método SendMail. Puede incluir uno o más archivos adjuntos en la misma llamada de acción especificándolos en la propiedad de colección Attachments. También puede guardar el mensaje en la carpeta Elementos enviados.

POST https://outlook.office.com/api/v1.0/me/sendmail
Parámetro obligatorio Tipo Descripción
Parámetros de cuerpo
Mensaje Mensaje El mensaje que se enviará.
SaveToSentItems valor booleano Indica si se debe guardar el mensaje en Elementos enviados. El valor predeterminado es true.

Especifique el parámetro Message con la propiedad ToRecipients necesaria y las propiedades message grabables en el cuerpo de la solicitud. El parámetro SaveToSentItems es necesario solo si es false.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/sendmail

{
  "Message": {
    "Subject": "Meet for lunch?",
    "Body": {
      "ContentType": "Text",
      "Content": "The new cafeteria is open."
    },
    "ToRecipients": [
      {
        "EmailAddress": {
          "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
      }
    ],
    "Attachments": [
      {
        "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
        "Name": "menu.txt",
        "ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk="
      }
    ]
  },
  "SaveToSentItems": "false"
}

Respuesta de muestra

Status code: 202

Crear un borrador

Ámbito mínimo necesario

Uno de los siguientes:

Crea un borrador de un mensaje nuevo. Los borradores se pueden crear en cualquier carpeta y, opcionalmente, actualizar antes de enviarlos. Para guardar en la carpeta Borradores, use el acceso directo /me/messages.

POST https://outlook.office.com/api/v1.0/me/messages
POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/messages
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El Id. de la carpeta de destino o el Inbox nombre de la carpeta conocida o Drafts.

Especifique cualquier propiedad message grabable en el cuerpo de la solicitud.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/folders/inbox/messages

Content-Type: application/json

{
  "Subject": "Did you see last night's game?",
  "Importance": "Low",
  "Body": {
    "ContentType": "HTML",
    "Content": "They were <b>awesome</b>!"
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
      }
    }
  ]
}

Respuesta de muestra

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEPAAAmP1Ln1wcHRariNdTMGAO9AAASz7k0AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5",
  "Categories": [],
  "DateTimeCreated": "2014-10-18T20:06:51Z",
  "DateTimeLastModified": "2014-10-18T20:06:51Z",
  "Subject": "Did you see last night's game?",
  "BodyPreview": "They were awesome!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nThey were <b>awesome</b>!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Low",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEPAAA=",
  "From": null,
  "Sender": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAQADXiGXoAtX9IubRTpv2hisc=",
  "DateTimeReceived": "2014-10-18T20:06:51Z",
  "DateTimeSent": "2014-10-18T20:06:51Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

Tipo de respuesta

El borrador.

Enviar un borrador

Ámbito mínimo necesario

Uno de los siguientes:

Envíe un nuevo borrador, un Borrador Responder, un borrador Responder a todos o un borrador Reenviar mediante el me´todo Send. A continuación, el mensaje se guarda en la carpeta Elementos enviados.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/send
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del borrador que se enviará.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz7k0AAA=/send

Respuesta de muestra

Status code: 202

Mensaje de Responder o Responder a todos

Nota

El comportamiento de las operaciones en esta sección varía según la versión. Obtenga más información eligiendo una versión en la referencia de API de REST de Office 365 en el índice de la izquierda.

Puede responder con un comentario al momento, o puede primero crear un borrador de respuesta, luego actualizar y enviar el borrador.

Puede responder solo al remitente del mensaje o responder a todos los destinatarios a la vez.

Responder al remitente al momento

Ámbito mínimo necesario

Uno de los siguientes:

Responda al remitente de un mensaje especificando un comentario y mediante el método Reply. A continuación, el mensaje se guarda en la carpeta Elementos enviados.

Opcionalmente, si necesita modificar alguna propiedad actualizable para la respuesta, puede en primer lugar crear un borrador Responder, actualizar las propiedades del mensaje y, a continuación, enviar la respuesta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/reply
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del mensaje que se va a responder.
Parámetros de cuerpo
Comentario cadena Comentario que se va a incluir. Puede ser una cadena vacía.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/reply
Content-Type: application/json

{
  "Comment": "Sounds great! See you tomorrow."
}

Respuesta de muestra

Status code: 202

Responder a todos al momento

Ámbito mínimo necesario

Uno de los siguientes:

Responda a todos los destinatarios de un mensaje especificando un comentario y mediante el método ReplyAll. A continuación, el mensaje se guarda en la carpeta Elementos enviados.

Opcionalmente, si necesita modificar alguna propiedad actualizable para la respuesta, puede en primer lugar crear un borrador Responder a todos, actualizar las propiedades del mensaje y, a continuación, enviar la respuesta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/replyall
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del mensaje que se va a responder.
Parámetros de cuerpo
Comentario cadena Comentario que se va a incluir. Puede ser una cadena vacía.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0MSz8DmAAA=/replyall
Content-Type: application/json

{
  "Comment": "Thanks for the heads up."
}

Respuesta de muestra

Status code: 202

Crear un mensaje de respuesta en borrador

Ámbito mínimo necesario

Uno de los siguientes:

Cree un borrador para responder al mensaje especificado. A continuación, puede actualizar el borrador para agregar el contenido de la respuesta a la propiedad body o cambiar otras propiedades del mensaje o, simplemente, enviar el borrador.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreply
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del mensaje que se va a responder.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkADA1MTAAAAqldOAAA=/createreply

Respuesta de muestra

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKoAAA=')",
  "@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO\"",
  "Id": "AAMkADA1MTAAAH5JKoAAA=",
  "CreatedDateTime": "2016-03-15T08:33:43Z",
  "LastModifiedDateTime": "2016-03-15T08:33:43Z",
  "ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-15T08:33:43Z",
  "SentDateTime": "2016-03-15T08:33:43Z",
  "HasAttachments": false,
  "InternetMessageId": "<DM2PR00MB00571796B16132601E1F286CF7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
  "Subject": "RE: Let's start a group",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<body>Fanny, would you name the group if the project is approved, please?\r\n<b>From:</b> Fanny Downs<br>\r\n<b>Sent:</b> Friday, March 4, 2016 12:23:35 AM<br>\r\n<b>To:</b> Admin<br>\r\n<b>Subject:</b> Re: Let's start a group</font>\r\n<p>That's a great idea!<br>\r\n</body>\r\n</html>"
  },
  "BodyPreview": "Fanny, would you name the group if the project is approved, please?\r\n________________________________\r\nFrom: Fanny Downs\r\nSent: Friday, March 4, 2016 12:23:35 AM\r\nTo: Admin\r\nSubject: Re: Let's start a group\r\n\r\n\r\nThat's a gre",
  "Importance": "Normal",
  "ParentFolderId": "AQMkADA1MTAAAAIBDwAAAA==",
  "Sender": {
    "EmailAddress": {
      "Name": "Admin",
      "Address": "admin@contoso.onmicrosoft.com"
    }
  },
  "From": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Name": "Fanny Downs",
        "Address": "fannyd@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkADA1MTVGjIwpLvWmGtIo-aFE=",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": true,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKoAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "MentionedMe": null,
  "AppliedHashtagsPreview": null,
  "LikesPreview": null,
  "MentionsPreview": null,
  "Mentioned": [ ],
  "InferenceClassification": "Focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "FlagStatus": "NotFlagged" }
}

Tipo de respuesta

message del borrador Responder con ToRecipient, IsDraft y otras propiedades apropiadas rellenadas previamente.

Crear un borrador Responder a todos

Ámbito mínimo necesario

Uno de los siguientes:

Cree un borrador para responder al remitente y a todos los destinatarios del mensaje especificado. Después, puede actualizar el borrador para agregar el contenido de la respuesta al cuerpo, cambiar otras propiedades del mensaje o, simplemente, enviar el borrador.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreplyall
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del mensaje que se va a responder.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/createreplyall

Respuesta de muestra

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k5AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF\"",
  "Id": "AAMkAGE0Mz7k5AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF",
  "Categories": [],
  "CreatedDateTime": "2014-10-18T21:21:06Z",
  "LastModifiedDateTime": "2014-10-18T21:21:06Z",
  "Subject": "RE: Check out the new Office 365 APIs",
  "BodyPreview": "If the project gets approved, please decide on the name.\r\n_________________________________\r\nFrom: Alex D\r\nSent: Saturday, October 18, 2014 9:18:18 PM\r\nTo: Katie Jordan; Garth Fort\r\nSubj",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0M3HbTkEU=",
  "ReceivedDateTime": "2014-10-18T21:21:06Z",
  "SentDateTime": "2014-10-18T21:21:06Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

Tipo de respuesta

El borrador del mensaje responder a todos con ToRecipient, IsDraft y otras propiedades adecuadas ya rellenadas.

Reenviar mensajes nuevos o borradores

Nota

El comportamiento de las operaciones en esta sección varía según la versión. Obtenga más información eligiendo una versión en la referencia de API de REST de Office 365 en el índice de la izquierda.

Puede reenviar un mensaje directamente, o puede crear un borrador para reenviar, actualizarlo y a continuación enviarlo.

Reenviar un mensaje directamente

Ámbito mínimo necesario

Uno de los siguientes:

Reenvíe un mensaje mediante el método Forward y, opcionalmente, especificando un comentario. A continuación, el mensaje se guarda en la carpeta Elementos enviados.

Opcionalmente, si necesita modificar alguna propiedad actualizable en el mensaje que se reenviará, primero puede crear un borrador Reenviar, actualizar las propiedades del mensaje y, a continuación, enviar la respuesta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/forward
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena El Id. del mensaje a reenviar.
Parámetros de cuerpo
Comentario cadena Comentario que se va a incluir. Puede ser una cadena vacía.
ToRecipients Colección(destinatario) La lista de destinatarios.

Especifque los parámetros Comment y ToRecipients en el cuerpo de la solicitud.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/forward
Content-Type: application/json

{
  "Comment": "FYI",
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
      }
    }
  ]
}

Respuesta de muestra

Status code: 202

Crear un borrador para reenviar

Ámbito mínimo necesario

Uno de los siguientes:

Cree un borrador para reenviar el mensaje especificado. A continuación, puede actualizar el borrador para agregar contenido al cuerpo, cambiar otras propiedades del mensaje o, simplemente, enviar el borrador.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createforward
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena El Id. del mensaje a reenviar.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/createforward

Respuesta de muestra

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k6AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG\"",
  "Id": "AAMkAGE0Mz7k6AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG",
  "Categories": [],
  "CreatedDateTime": "2016-03-15T08:42:10Z",
  "LastModifiedDateTime": "2016-03-15T08:42:10Z",
  "Subject": "FW: Let's start a group",
  "BodyPreview": "Dana, just want to make sure you get this.\r\n________________________________\r\nFrom: Admin\r\nSent: Tuesday, March 15, 2016 6:47:54 AM\r\nTo: Fanny Downs; Randi Welch\r\nSubject: RE: Let's st",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": {
    "EmailAddress": {
      "Address": "'alexd@contoso.onmicrosoft.com'",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0M3HbTkEU=",
  "ReceivedDateTime": "2016-03-15T08:42:10Z",
  "SentDateTime": "2016-03-15T08:42:10Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

Tipo de respuesta

Elborrador Reenviar con IsDraft y otras propiedades apropiadas rellenadas previamente.

Actualizar mensajes

Cambie las propiedades grabables en un mensaje y guarde los cambios.

Actualizar un mensaje

Ámbito mínimo necesario

Uno de los siguientes:

Cambiar las propiedades grabables en un borrador o mensaje existente. Solo se modifican las propiedades que especifique.

PATCH https://outlook.office.com/api/v1.0/me/messages/{message_id}
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena El Id. del mensaje que se va a actualizar.

Especifique una o varias propiedades message grabables en el cuerpo de la solicitud.

Solicitud de muestra

PATCH https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAAmP1Ln1wcHRariNdTMGAO9AAASz8S-AAA=

Content-Type: application/json

{
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "IsRead": true
}

Respuesta de muestra

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAAmP1Ln1wcHRariNdTMGAO9AAASz8S-AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP",
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "DateTimeCreated": "2014-10-17T17:12:15Z",
  "DateTimeLastModified": "2014-10-19T03:24:35Z",
  "Subject": "Meeting notes from today",
  "BodyPreview": "See attached",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<style type=\"text/css\" style=\"display:none\"><!-- p { margin-top: 0px; margin-bottom: 0px; }--></style>\r\n</head>\r\n<body dir=\"ltr\">\r\n<div id=\"divtagdefaultwrapper\" style=\"color: rgb(0, 0, 0); font-family: Calibri,Arial,Helvetica,sans-serif; font-size: 12pt; background-color: rgb(255, 255, 255);\">\r\n<p>See attached</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAQANKneItHNYxNlwnKip-qvhs=",
  "DateTimeReceived": "2014-10-17T17:12:15Z",
  "DateTimeSent": "2014-10-17T17:12:12Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

Tipo de respuesta

El mensaje actualizado.

Eliminar mensajes

Nota

Tenga cuidado al eliminar mensajes. Es posible que el contenido eliminado no se pueda recuperar. Para obtener más información, consulte Eliminar elementos.

Eliminar un mensaje

Ámbito mínimo necesario

Uno de los siguientes:

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del mensaje que se va a eliminar.

Solicitud de muestra

DELETE https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8TBAAA=

Respuesta de muestra

Status code: 204

Mover o copiar mensajes

Puede mover o copiar un mensaje a una carpeta.

Mover un mensaje

Ámbito mínimo necesario

Uno de los siguientes:

Mueve un mensaje a una carpeta. Se crea una nueva copia del mensaje en la carpeta de destino.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/move
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena ID. del mensaje a mover.
Parámetros de cuerpo
DestinationId cadena El ID de la carpeta de destino o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=/move

Content-Type: application/json

{
  "DestinationId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA="
}

Respuesta de muestra

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTshBhAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:13:21Z",
  "DateTimeLastModified": "2014-10-20T00:13:23Z",
  "Subject": "Contract Signing",
  "BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
  "Body": {
    "ContentType": "Text",
    "Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
  "DateTimeReceived": "2014-10-20T00:13:21Z",
  "DateTimeSent": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

Tipo de respuesta

El mensaje se ha movido.

Copiar un mensaje

Ámbito mínimo necesario

Uno de los siguientes:

Copia un mensaje a una carpeta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/copy
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. del mensaje a copiar.
Parámetros de cuerpo
DestinationId cadena El ID de la carpeta de destino o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=/copy

Content-Type: application/json

{
  "DestinationId": "inbox"
}

Respuesta de muestra

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIS\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADT8DtAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:13:21Z",
  "DateTimeLastModified": "2014-10-20T00:13:23Z",
  "Subject": "Contract Signing",
  "BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
  "Body": {
    "ContentType": "Text",
    "Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
  "DateTimeReceived": "2014-10-20T00:13:21Z",
  "DateTimeSent": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

Tipo de respuesta

La nueva copia del mensaje.

Administrar Bandeja de entrada Prioritarios

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Administrar @-Mentions (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Administrar reglas (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Cancelar suscripción (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Obtener opciones de idioma (versión preliminar)

Actualmente, esta característica solo está disponible en la versión beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Obtener opciones de zona horaria (versión preliminar)

Actualmente, esta característica solo está disponible en la versión beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Obtener configuración del buzón

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Obtener la configuración de respuesta automática

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Actualizar la configuración de respuesta automática

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Obtener sugerencias de correo electrónico (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Obtener datos adjuntos

Puede obtener una colección de datos adjuntos o recibir datos adjuntos. Los datos adjuntos pueden ser archivos (por ejemplo,

Recibir una recopilación de datos adjuntos

Ámbito mínimo necesario

Uno de los siguientes:

Obtenga los datos adjuntos de un mensaje determinado.

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. de mensaje.

Nota

De forma predeterminada, cada elemento de datos adjuntos en la respuesta incluye todas sus propiedades correspondientes a ese tipo de datos adjuntos. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Tipo de respuesta

Una recopilación de datos adjuntos que puede ser del tipo FileAttachment o ItemAttachment.

Ejemplo de solicitudes y respuestas

El siguiente ejemplo muestra cómo utilizar $select para especificar que se devuelva solo la propiedad Nombre de cada archivo adjunto en la respuesta. Consulte la respuesta de ejemplo en Obtener datos adjuntos para obtener una lista completa de las propiedades que se devolverían para datos adjuntos si no se utiliza $select.

Solicitud de muestra

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=/attachments?$select=Name

Respuesta de muestra

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAABEgAQANQEWV4bM8FIlPwxj4kShdM=",
      "Name": "minutes.docx",
      "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "Size": 11585,
      "IsInline": false,
      "DateTimeLastModified": "2014-10-20T00:41:52Z",
      "ContentId": null,
      "ContentLocation": null,
      "IsContactPhoto": false,
      "ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA="
    }
  ]
}

El siguiente ejemplo muestra cómo obtener el único elemento de datos adjunto que es un elemento de correo de Outlook. La respuesta incluye un Id. de datos adjuntos que también es el Id. del mensaje adjunto.

GET https://outlook.office.com/api/v1.0/me/messages('AAMkADFiNTPAAA=')/attachments

Content-Type: application/json

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkADFiNTPAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.ItemAttachment",
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-20075df800e5@1717622f-1d94-4d0c-9d74-f907ad6677b4')/Messages('AAMkADFiNTPAAA=')/Attachments('AAMkADFiNTAUhhYuYi0=')",
      "Id": "AAMkADFiNTAUhhYuYi0=",
      "Name": "How to retrieve item attachment using Outlook REST API",
      "ContentType": message/rfc822,
      "Size": 71094,
      "IsInline": false,
      "DateTimeLastModified": "2015-09-24T05:57:59Z",
    }
  ]
}

Recibir datos adjuntos

Ámbito mínimo necesario

Uno de los siguientes:

Obtener datos adjuntos de un mensaje determinado.

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments/{attachment_id}

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. de mensaje.
attachment_id cadena El identificador de los datos adjuntos.

Nota

De forma predeterminada, la respuesta incluye todas las propiedades de los datos adjuntos. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. Consulte Obtener una colección de datos adjuntos para ver un ejemplo. La propiedad Id se devuelve siempre. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Tipo de respuesta

El archivo adjunto o elemento adjunto solicitado.

Solicitud de muestra

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAABEgAQANQEWV4bM8FIlPwxj4kShdM=

Respuesta de muestra

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA%3D')/Attachments/$entity",
  "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2j4kShdM=",
  "Name": "minutes.docx",
  "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "Size": 11585,
  "IsInline": false,
  "DateTimeLastModified": "2014-10-20T00:41:52Z",
  "ContentId": null,
  "ContentLocation": null,
  "IsContactPhoto": false,
  "ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA=",
}

Crear adjuntos

Puede crear un archivo adjunto o crear un elemento adjunto para un mensaje

Crear un archivo adjunto

Ámbito mínimo necesario

Uno de los siguientes:

Agregue un archivo adjunto a un mensaje.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. de mensaje.
Parámetros de cuerpo
@odata.type cadena #Microsoft.OutlookServices.FileAttachment
Nombre cadena El nombre de los datos adjuntos.
ContentBytes binario El archivo a adjuntar.

Especifique los parámetros Name y ContentBytes y cualquier propiedad file attachment grabable en el cuerpo de la solicitud.

Tipo de respuesta

El nuevo archivo adjunto.

Crear un elemento adjunto

Ámbito mínimo necesario

Uno de los siguientes:

Agregue un elemento adjunto a un mensaje.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. de mensaje.
Parámetros de cuerpo
@odata.type cadena #Microsoft.OutlookServices.ItemAttachment
Nombre cadena El nombre de los datos adjuntos.
Ítem Una entidadMessage o Event. El elemento a adjuntar.

Especifique los parámetros Name e Item y cualquier propiedad iteme attachment grabable en el cuerpo de la solicitud.

Tipo de respuesta

El nuevo elemento adjunto.

Crear una referencia adjunta

Ámbito mínimo necesario

Uno de los siguientes:

Agregue un archivo adjunto de referencia a un mensaje.

Esta característica está actualmente disponible solo en la versión beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Eliminar archivos adjuntos

Ámbito mínimo necesario

Uno de los siguientes:

Elimine los datos adjuntos especificados de un mensaje. Los datos adjuntos pueden ser un archivo adjunto oelemento adjunto.

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments/{attachment_id}
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
message_id cadena Id. de mensaje.
attachment_id cadena El identificador de los datos adjuntos.

Solicitud de muestra

DELETE https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8S-AAA=/attachments/AAMkAGE0Mg67gL7o=

Respuesta de muestra

Status code: 204

Obtener carpetas

Puede obtener una colección de carpetas u obtener una carpeta del buzón del usuario.

Obtener una colección de carpetas

Ámbito mínimo necesario

Uno de los siguientes:

Obtenga una colección de carpetas en la carpeta raíz del usuario que ha iniciado sesión (.../me/folders) o en la carpeta especificada. Puede utilizar el acceso directo .../me/folders para obtener la colección de carpetas de nivel superior y navegar a otra carpeta.

GET https://outlook.office.com/api/v1.0/me/folders
GET https://outlook.office.com/api/v1.0/me/folders/{folder_id}/childfolders

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El Id. de carpeta, o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems, si recibe mensajes de una carpeta específica.

Solicitud de muestra

GET https://outlook.office.com/api/v1.0/me/folders

Respuesta de muestra

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEfAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Conversation Action Settings",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEKAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Deleted Items",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEPAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Drafts",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEMAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Inbox",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEQAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Journal",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEeAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Junk Email",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAERAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Notes",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAELAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Outbox",
      "ChildFolderCount": 0
    }
  ]
}

Tipo de respuesta

La colección de carpetas solicitada.

Obtener una carpeta

Ámbito mínimo necesario

Uno de los siguientes:

Obtenga una carpeta por Id.

GET https://outlook.office.com/api/v1.0/me/folders/{folder_id}

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El ID de la carpeta o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.

Solicitud de muestra

GET https://outlook.office.com/api/v1.0/me/folders/inbox

Respuesta de muestra

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA=",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
  "DisplayName": "Inbox",
  "ChildFolderCount": 0,
  "UnreadItemCount": 2,
  "TotalItemCount": 2
}

Tipo de respuesta

La carpeta solicitada.

Sincronizar jerarquía de carpetas

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Crear carpetas

Agregue una nueva carpeta a una colección de carpetas.

Crear una carpeta

Ámbito mínimo necesario

Uno de los siguientes:

Cree una carpeta secundaria por el nombre especificado en DisplayName. DisplayName es la única propiedad grabable para un carpeta.

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/childfolders
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El ID de la carpeta o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.
Parámetros de cuerpo
Nombre para mostrar cadena El nombre para mostrar de la carpeta.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/folders/inbox/childfolders

Content-Type: application/json

{
  "DisplayName": "Company"
}

Respuesta de muestra

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders('inbox')/ChildFolders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Company",
  "ChildFolderCount": 0,
  "UnreadItemCount": 2,
  "TotalItemCount": 27
}

Tipo de respuesta

La nueva carpeta.

Comentarios

No puede crear una carpeta de nivel superior. Solo puede agregar una carpeta a un extremo childfolders.

Actualizar carpetas

Cambie el nombre de una carpeta.

Actualizar una carpeta

Ámbito mínimo necesario

Uno de los siguientes:

Cambie el nombre de la carpeta al nombre especificado en DisplayName. El nombre es la única propiedad grabable para una carpeta.

PATCH https://outlook.office.com/api/v1.0/me/folders/{folder_id}
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El ID de la carpeta o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.
Parámetros de cuerpo
Nombre para mostrar cadena El nuevo nombre para mostrar de la carpeta.

Solicitud de muestra

PATCH https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=

Content-Type: application/json

{
  "DisplayName": "Business"
}

Respuesta de muestra

Código de estado: 200

}
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

Tipo de respuesta

La carpeta actualizada.

Eliminar carpetas

Elimine una carpeta y todo su contenido.

Nota

Tenga cuidado al eliminar carpetas. Es posible que el contenido eliminado no se pueda recuperar. Para obtener más información, consulte Eliminar elementos.

Eliminar una carpeta

Ámbito mínimo necesario

Uno de los siguientes:

Elimine la carpeta especificada en folder_id.

DELETE https://outlook.office.com/api/v1.0/me/folders/{folder_id}
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El ID de la carpeta o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.

Solicitud de muestra

DELETE https://outlook.office.com/api/v1.0/me/MailFolders/AAMkAGE0Mz-l_AAA=

Respuesta de muestra

Status code: 204

Mover o copiar carpetas

Puede mover o copiar una carpeta a otra carpeta.

Mover una carpeta

Ámbito mínimo necesario

Uno de los siguientes:

Mueva una carpeta y su contenido a otra carpeta mediante el método Move.

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/move
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El ID de la carpeta o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.
Parámetros de cuerpo
DestinationId cadena El ID de la carpeta de destino o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=/move

Content-Type: application/json

{
  "DestinationId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAOyxQ9AAA="
}

Respuesta de muestra

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAOyxQ9AAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

Tipo de respuesta

La carpeta se ha movido.

Copiar una carpeta

Ámbito mínimo necesario

Uno de los siguientes:

Copie una carpeta y su contenido a otra carpeta mediante el método Copy.

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/copy
Parámetro obligatorio Tipo Descripción
Parámetros de dirección URL
folder_id
cadena El ID de la carpeta o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.
Parámetros de cuerpo
DestinationId cadena El ID de la carpeta de destino o el nombre de carpeta conocido Inbox, Drafts, SentItems o DeletedItems.

Solicitud de muestra

POST https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=/copy

Content-Type: application/json

{
  "DestinationId": "inbox"
}

Respuesta de muestra

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-mAAAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

Tipo de respuesta

La nueva copia de la carpeta.

Pasos siguientes

Tanto si está listo para empezar a compilar una aplicación como si simplemente desea obtener más información, tenemos todo lo que necesita.

O bien, obtenga más información sobre el uso de la plataforma de Office 365: