Referência da API REST de email do Outlook (versão 1.0)

Aplica-se a: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Observação

A versão 1.0 da API REST do Outlook está sendo preterida. A partir de 1º de novembro de 2018, os aplicativos não poderão mais usar a Autenticação Básica com o ponto de extremidade v1.0 REST. Em 1º de novembro de 2019, o ponto de extremidade v1.0 REST será totalmente desativado e a documentação da v1.0 será removida logo em seguida. Comece a fazer a migração do seu aplicativo para usar a API REST do Outlook na v1.0 do Microsoft Graph. Veja mais detalhes em nosso anúncio.

A API do E-mail do Outlook permite ler, criar e enviar mensagens e anexos, visualizar e responder a mensagens de eventos e gerenciar pastas protegidas pelo Active Directory do Azure no Office 365. Também fornece a mesma funcionalidade em contas da Microsoft, especificamente nestes domínios: Hotmail.com, Live.com, MSN.com, Outlook.com e Passport.com.

Observação

Para simplificar a referência, o restante deste artigo usa o Outlook.com para incluir esses domínios de conta da Microsoft.

Interessado na v1.0 da API? No tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione a versão desejada.

Todas as operações da API de email

Operações de mensagem

As mensagens são armazenadas nas pastas da caixa de correio, portanto, os pontos de extremidade da mensagem geralmente incluem a pasta que contém a mensagem. Uma pasta é especificada por ID ou por um dos seguintes nomes de pastas conhecidos: Inbox, Drafts, SentItemsou DeletedItems.

• Obter mensagens
• Sincronizar mensagens
• Criar e enviar mensagens
• Mensagens para responder ou responder a todos
• Encaminhar mensagens novas ou rascunhos
• Atualizar mensagens
• Excluir mensagens
• Mover ou copiar mensagens
• Gerenciar a Caixa de Entrada Prioritária
• Gerenciar @-Menções (versão prévia)
• Gerenciar regras (versão prévia)
• Cancelar assinatura (versão prévia)
• Obter opções de idioma (versão prévia)
• Obter opções de fuso horário (versão prévia)
• Obter configurações da caixa de correio
• Obter configurações de resposta automática
• Atualizar configurações de resposta automática
• Obtenha dicas de email (versão prévia)
• Obter anexos
• Criar anexos
• Excluir anexos

Operações de pasta

As pastas podem conter mensagens e outras pastas. Você pode obter, criar, alterar, excluir e gerenciar pastas. Você pode usar os seguintes nomes de pasta conhecidos em vez do ID para especificar a pasta correspondente: Inbox, SentItems, Drafts ou DeletedItems.

• Obter pastas
• Sincronizar pastas
• Criar pastas
• Atualizar pastas
• Excluir pastas
• Mover ou copiar pastas

Confira também

• Recursos de mensagem da API REST
• Recursos de pasta da API REST

Usar a API REST de E-mail

Autenticação

Assim como acontece com outras APIs REST do Outlook, para cada solicitação à API de E-mail você deve incluir um token de acesso válido. Para obter um token de acesso você deve ter registrado e identificado o seu aplicativo e obtido a autorização adequada.

Você pode saber mais sobre algumas opções simplificadas de registro e autorização. Tenha isso em mente ao prosseguir com as operações específicas na API de E-mail.

Versão da API

A API REST de E-mail é suportada em todas as versões da API REST do Outlook. A funcionalidade pode variar dependendo da versão específica.

Usuário de destino

Todas as solicitações da API de E-mail são realizadas em nome do usuário conectado, a menos que especificado. Alguns subconjuntos de API, como a API de Caixa de Entrada Prioritária, podem ser executados no usuário conectado ou em um usuário especificado por uma ID de usuário, mediante as permissões apropriadas.

Veja Usar a API REST do Outlook para obter mais informações comuns a todos os subconjuntos da API REST do Outlook.

Obter mensagens

Você pode obter uma coleção de mensagens ou uma única mensagem de uma pasta de caixa de correio.

Cada mensagem na resposta contém várias propriedades, incluindo a propriedade Body. O corpo da mensagem pode ser de texto ou HTML. Se o corpo for HTML, por padrão, qualquer HTML potencialmente inseguro (por exemplo, JavaScript) incorporado na propriedade Corpo seria removido antes que o conteúdo do corpo fosse retornado em uma resposta REST.

Para obter todo o conteúdo HTML original, inclua o seguinte cabeçalho de solicitação HTTP:

Prefer: outlook.allow-unsafe-html

Atualmente, a operação GET retorna corpos de mensagens somente no formato HTML.

• Obter uma coleção de mensagens
• Obter uma mensagem

Obter uma coleção de mensagens

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.read
• wl.imap

Observação

O comportamento das operações nesta seção varia de acordo com a versão. Saiba mais sobre como escolher uma versão em Referência de API REST do Office 365 na tabela de conteúdo à esquerda.

Obter coleção de mensagens da Caixa de Entrada.

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

Você também pode especificar uma pasta na caixa de correio do usuário e obter a coleção de mensagens dessa pasta.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou o Inbox, Drafts, SentItems ou DeletedItems nome de pasta conhecido se estiver recebendo mensagens de uma pasta específica.

Observação

Por padrão, cada mensagem na resposta inclui todas as suas propriedades. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

O exemplo a seguir mostra como usar $select para especificar o retorno de apenas as propriedades Remetente e Assunto de cada mensagem na resposta. Consulte o exemplo de resposta em Obter uma mensagem para ver uma lista completa das propriedades retornadas para uma mensagem caso você não use $select.

Solicitação de amostra

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

Resposta de amostra

Código de status: 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 resposta

A coleção de mensagens solicitada.

Obter uma mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.read
• wl.imap

Obter uma mensagem por ID.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem.

Solicitação de amostra

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

Resposta de amostra

Código de status: 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 resposta

A mensagem solicitada.

Observação

Por padrão, a resposta inclui todas as propriedades da mensagem especificada. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

O exemplo a seguir mostra como usar $select para especificar o retorno de apenas as propriedades Remetente e Assunto de cada mensagem na resposta.

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

Sincronizar mensagens

No momento, este recurso está disponível apenas na versão beta e v2.0. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma das versões.

Criar e enviar mensagens

Você pode enviar uma nova mensagem em tempo real ou criar um rascunho de mensagem e enviá-lo. Você pode criar rascunhos em qualquer pasta.

• Enviar uma nova mensagem em tempo real
• Criar um rascunho de mensagem
• Enviar um rascunho de mensagem

Enviar uma nova mensagem em tempo real

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.send
• wl.imap

Envie a mensagem fornecida no corpo da solicitação usando o método SendMail. Você pode incluir um ou mais anexos no mesmo chamado de ação, especificando-os na propriedade Anexos da coleção. Você também pode salvar a mensagem na pasta Itens Enviados.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de corpo
Mensagem	Mensagem	A mensagem a ser enviada.
SavetoSentItems	booleano	Indica se você deseja salvar a mensagem em Itens Enviados. O padrão é verdadeiro.

Especifique o parâmetro Mensagem com a propriedade obrigatória ToRecipients e quaisquer propriedades graváveis de mensagem no corpo da solicitação. O parâmetro SaveToSentItems é necessário apenas se falso.

Solicitação de amostra

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

Resposta de amostra

Status code: 202

Criar um rascunho de mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Criar um rascunho de uma nova mensagem. Rascunhos podem ser criados em qualquer pasta e, opcionalmente, atualizados antes do envio. Para salvar na pasta Rascunhos, utilize o atalho /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 obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta de destino ou nomes de pasta conhecidos, como Inbox ou Drafts.

Especifique quaisquer propriedades graváveis da mensagem no corpo da solicitação.

Solicitação de amostra

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

Resposta de amostra

Código do status: 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 resposta

O rascunho da mensagem.

Enviar um rascunho de mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.send
• wl.imap

Envie um rascunho de nova mensagem, um rascunho de Resposta, um rascunho de Resposta a todos, ou um rascunho de Encaminhamento usando o método Send. A mensagem é então salva na pasta Itens Enviados.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/send

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem de rascunho a ser enviada.

Solicitação de amostra

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

Resposta de amostra

Status code: 202

Mensagens para responder ou responder a todos

Observação

O comportamento das operações nesta seção varia de acordo com a versão. Saiba mais sobre como escolher uma versão em Referência de API REST do Office 365 na tabela de conteúdo à esquerda.

Você pode responder com um comentário em tempo real ou pode criar primeiro um rascunho de resposta, atualizá-lo e depois enviar o rascunho.

Você pode responder apenas ao remetente da mensagem ou responder a todos os destinatários de uma só vez.

• Responder ao remetente dinamicamente
• Responder a todos dinamicamente
• Criar um rascunho de mensagem de resposta
• Criar um rascunho de mensagem de resposta a todos

Responder ao remetente dinamicamente

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.send
• wl.imap

Responda ao remetente de uma mensagem especificando um comentário e usando o método Reply. A mensagem é então salva na pasta Itens Enviados.

Se você precisar modificar propriedades atualizáveis da resposta, outra opção é primeiro criar um rascunho de mensagem de resposta, atualizar as propriedades da mensagem e, em seguida, enviar a resposta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/reply

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem a ser respondida.
Parâmetros de corpo
Comentário	sequência de caracteres	Um comentário a incluir. Não pode ficar vazio.

Solicitação de amostra

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

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

Resposta de amostra

Status code: 202

Responder a todos dinamicamente

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.send
• wl.imap

Responda a todos os destinatários de uma mensagem especificando um comentário e usando o método ReplyAll. A mensagem é então salva na pasta Itens Enviados.

Se você precisar modificar propriedades atualizáveis da resposta, outra opção é primeiro criar um rascunho de mensagem de resposta a todos, atualizar as propriedades da mensagem e, em seguida, enviar a resposta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/replyall

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem a ser respondida.
Parâmetros de corpo
Comentário	sequência de caracteres	Um comentário a incluir. Não pode ficar vazio.

Solicitação de amostra

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

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

Resposta de amostra

Status code: 202

Criar um rascunho de mensagem de resposta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Crie um rascunho da resposta para a mensagem especificada. Você pode atualizar o rascunho para adicionar conteúdo de resposta à propriedade body, alterar outras propriedades da mensagem ou simplesmente enviar o rascunho.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreply

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem a ser respondida.

Solicitação de amostra

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

Resposta de amostra

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 resposta

O rascunho de mensagem de resposta com as propriedades ToRecipient, IsDraft e outras apropriadas pré-preenchidas.

Criar um rascunho de mensagem de resposta a todos

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Crie um rascunho para responder ao remetente e a todos os destinatários da mensagem especificada. Você pode atualizar o rascunho para adicionar conteúdo de resposta ao corpo ou alterar outras propriedades da mensagem, ou, simplesmente enviar o rascunho.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreplyall

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser respondida.

Solicitação de amostra

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

Resposta de amostra

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 resposta

O rascunho de mensagem de resposta a todos com as propriedades ToRecipient, IsDraft e outras propriedades apropriadas pré-preenchidas.

Encaminhar mensagens novas ou rascunhos

Observação

O comportamento das operações nesta seção varia de acordo com a versão. Saiba mais sobre como escolher uma versão em Referência de API REST do Office 365 na tabela de conteúdo à esquerda.

Você pode encaminhar uma mensagem diretamente ou pode criar um rascunho de mensagem de encaminhamento, atualizá-lo e depois enviá-lo.

• Encaminhar uma mensagem diretamente
• Criar um rascunho de mensagem de encaminhamento

Encaminhar uma mensagem diretamente

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.send
• wl.imap

Encaminhe uma mensagem usando o método Forward e, opcionalmente, especificando um comentário. A mensagem é então salva na pasta Itens Enviados.

Outra opção, se você precisar modificar propriedades atualizáveis da mensagem a ser encaminhada, é primeiro criar um rascunho de mensagem de encaminhamento, atualizar as propriedades da mensagem e, em seguida, enviar a resposta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/forward

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser encaminhada.
Parâmetros de corpo
Comentário	sequência de caracteres	Um comentário a incluir. Não pode ficar vazio.
ToRecipients	Coleção (Destinatário)	A lista de destinatários.

Especifique os parâmetros Comment e ToRecipients no corpo da solicitação.

Solicitação de amostra

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

Resposta de amostra

Status code: 202

Criar um rascunho de mensagem de encaminhamento

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Crie um rascunho para encaminhar a mensagem especificada. Você pode atualizar o rascunho para adicionar conteúdo ao corpo ou alterar outras propriedades da mensagem ou, simplesmente, enviar o rascunho.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createforward

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser encaminhada.

Solicitação de amostra

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

Resposta de amostra

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 resposta

O rascunho da mensagem de encaminhamento com a propriedade IsDraft e outras apropriadas pré-preenchidas.

Atualizar mensagens

Altere as propriedades graváveis ​​em uma mensagem e salve as alterações.

• Atualizar uma mensagem

Atualizar uma mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Alterar propriedades graváveis ​​em um rascunho ou uma mensagem existente. Apenas as propriedades especificadas são alteradas.

PATCH https://outlook.office.com/api/v1.0/me/messages/{message_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser atualizada.

Especifique uma ou mais propriedades graváveis de mensagem no corpo da solicitação.

Solicitação de amostra

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
}

Resposta de amostra

Código de status: 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 resposta

A mensagem atualizada.

Excluir mensagens

• Excluir uma mensagem

Observação

Tenha cuidado ao excluir mensagens. O conteúdo excluído pode não ser recuperável. Para saber mais, consulte Excluir itens.

Excluir uma mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser excluída.

Solicitação de amostra

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

Resposta de amostra

Status code: 204

Mover ou copiar mensagens

Você pode mover ou copiar uma mensagem para uma pasta.

• Mover uma mensagem
• Copiar uma mensagem

Mover uma mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Mover uma mensagem para uma pasta. Isso cria uma nova cópia da mensagem na pasta de destino.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/move

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser movida.
Parâmetros de corpo
DestinationId	sequência de caracteres	O ID da pasta de destino ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.

Solicitação de amostra

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

Content-Type: application/json

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

Resposta de amostra

Código do status: 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 resposta

A mensagem movida.

Copiar uma mensagem

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Copiar uma mensagem para uma pasta.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/copy

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	O ID da mensagem a ser copiada.
Parâmetros de corpo
DestinationId	sequência de caracteres	O ID da pasta de destino ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.

Solicitação de amostra

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

Content-Type: application/json

{
  "DestinationId": "inbox"
}

Resposta de amostra

Código do status: 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 resposta

A nova cópia da mensagem.

Gerenciar a Caixa de Entrada Prioritária

Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione uma dessas versões.

Gerenciar @-Menções (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Gerenciar regras (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Cancelar assinatura (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Obter opções de idioma (versão prévia)

Atualmente, este recurso está disponível somente na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Obter opções de fuso horário (versão prévia)

Atualmente, este recurso está disponível somente na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Obter configurações da caixa de correio

Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione uma dessas versões.

Obter configurações de resposta automática

Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione uma dessas versões.

Atualizar configurações de resposta automática

Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione uma dessas versões.

Obter Dicas de E-mail (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Obter anexos

Você pode obter uma coleção de anexos ou um único anexo. Anexos podem ser arquivos (por exemplo,

• Obter uma coleção de anexos
• Obter um anexo

Obter uma coleção de anexos

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.read
• wl.imap

Obter os anexos de uma mensagem específica.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem.

Observação

Por padrão, cada anexo da resposta inclui todas as propriedades correspondentes a esse tipo de anexo. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. A propriedade Id é sempre retornada. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Tipo de resposta

Uma coleção de anexos que pode ser do tipo FileAttachment ou ItemAttachment.

Exemplos de solicitações e respostas

O exemplo a seguir mostra como usar $select para especificar o retorno de apenas a propriedade Nome de cada arquivo anexado na resposta. Veja a resposta de amostra em Receber um anexo para obter uma lista completa das propriedades que serão retornadas para um anexo se você não usar $select.

Solicitação de amostra

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

Resposta de amostra

Código de status: 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="
    }
  ]
}

O exemplo a seguir mostra como obter o único anexo que é um item de e-mail do Outlook. A resposta inclui um ID de anexo, que também é o ID da mensagem anexada.

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

Obter um anexo

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.read
• wl.imap

Obter um anexo de uma mensagem específica.

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

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem.
attachment_id	sequência de caracteres	O ID do anexo.

Observação

Por padrão, a resposta inclui todas as propriedades do anexo. Use $select para especificar somente as propriedades necessárias para um melhor desempenho. Veja Obter uma coleção de anexos por exemplo. A propriedade Id é sempre retornada. Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Tipo de resposta

O anexo de arquivo ou anexo de item solicitado.

Solicitação de amostra

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

Resposta de amostra

{
  "@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=",
}

Criar anexos

Você pode criar um anexo de arquivo ou de item para uma mensagem.

• Criar um anexo de arquivo
• Criar um anexo de item
• Criar um anexo de referência

Criar um anexo de arquivo

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Adicione um anexo de arquivo a uma mensagem.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem.
Parâmetros de corpo
@odata.type	sequência de caracteres	#Microsoft.OutlookServices.FileAttachment
Nome	sequência de caracteres	O nome do anexo.
ContentBytes	binário	O arquivo a ser anexado.

Especifique os parâmetros Nome e ContentBytes e qualquer propriedade gravável do anexo de arquivo no corpo da solicitação.

Tipo de resposta

O novo anexo de arquivo.

Criar um anexo de item

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Adicione um anexo de item a uma mensagem.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem.
Parâmetros de corpo
@odata.type	sequência de caracteres	#Microsoft.OutlookServices.ItemAttachment
Nome	sequência de caracteres	O nome do anexo.
Item	Uma entidade de Mensagem ou Evento.	O item a ser anexado.

Especifique os parâmetros Nome e Item e qualquer propriedade gravável do anexo de item no corpo da solicitação.

Tipo de resposta

O novo anexo de item.

Criar um anexo de referência

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Adicione um anexo de referência a uma mensagem.

No momento, este recurso está disponível apenas na versão beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Excluir anexos

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Excluir o anexo especificado de uma mensagem. O anexo pode ser um anexo de arquivo ou anexo de item.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
message_id	sequência de caracteres	A ID da mensagem.
attachment_id	sequência de caracteres	O ID do anexo.

Solicitação de amostra

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

Resposta de amostra

Status code: 204

Obter pastas

Você pode obter uma coleção de pastas ou uma pasta na caixa de correio do usuário.

• Obter uma coleção de pastas
• Obter uma pasta

Obter uma coleção de pastas

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.read
• wl.imap

Obtenha a coleção de pastas na pasta raiz do usuário conectado (.../me/folders), ou na pasta especificada. Você pode usar o atalho .../me/folders para obter a coleção de pastas de nível superior e navegar para outra pasta.

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

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou o Inbox, Drafts, SentItemsou DeletedItems nome de pasta conhecido se estiver recebendo pastas de uma pasta específica.

Solicitação de amostra

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

Resposta de amostra

{
  "@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 resposta

A coleção de pastas solicitada.

Obter uma pasta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.read
• wl.imap

Obtenha uma pasta por ID.

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

Observação

Confira Parâmetros de consulta do OData para ver parâmetros de filtragem, classificação e paginação.

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.

Solicitação de amostra

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

Resposta de amostra

Código de status: 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 resposta

A pasta solicitada.

Sincronizar hierarquia de pastas

Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione uma dessas versões.

Criar pastas

Adicionar uma nova pasta a uma coleção de pastas.

• Criar uma pasta

Criar uma pasta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Crie uma pasta filho com o nome especificado em DisplayName. DisplayName é a única propriedade gravável de uma pasta.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.
Parâmetros de corpo
DisplayName	sequência de caracteres	O nome para exibição da nova pasta.

Solicitação de amostra

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

Content-Type: application/json

{
  "DisplayName": "Company"
}

Resposta de amostra

Código do status: 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 resposta

A nova pasta.

Comentários

Você não pode criar uma pasta de nível superior. Você só pode adicionar uma pasta a um ponto de extremidade childfolders.

Atualizar pastas

Alterar o nome de uma pasta.

• Atualizar uma pasta

Atualizar uma pasta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Alterar o nome da pasta para o especificado em DisplayName. O nome é a única propriedade gravável de uma pasta.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.
Parâmetros de corpo
DisplayName	sequência de caracteres	O novo nome para exibição da nova pasta.

Solicitação de amostra

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

Content-Type: application/json

{
  "DisplayName": "Business"
}

Resposta de amostra

Código de status: 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 resposta

A pasta atualizada.

Excluir pastas

Exclua uma pasta e todo o seu conteúdo.

Observação

Tenha cuidado ao excluir pastas. O conteúdo excluído pode não ser recuperável. Para saber mais, veja Excluir itens.

• Excluir uma pasta

Excluir uma pasta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Exclua a pasta especificada em folder_id.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.

Solicitação de amostra

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

Resposta de amostra

Status code: 204

Mover ou copiar pastas

Você pode mover ou copiar uma pasta para outra pasta.

• Mover uma pasta
• Copiar uma pasta

Mover uma pasta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Mova uma pasta e seu conteúdo para outra pasta usando o método Move.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.
Parâmetros de corpo
DestinationId	sequência de caracteres	O ID da pasta de destino ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.

Solicitação de amostra

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="
}

Resposta de amostra

Código do status: 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 resposta

A pasta movida.

Copiar uma pasta

Escopo mínimo necessário

Uma das seguintes opções:

• https://outlook.office.com/mail.readwrite
• wl.imap

Copiar uma pasta e seu conteúdo para outra pasta usando o método Copy.

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

Parâmetro obrigatório	Tipo	Descrição
Parâmetros de URL
folder_id	sequência de caracteres	O ID da pasta ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.
Parâmetros de corpo
DestinationId	sequência de caracteres	O ID da pasta de destino ou nomes de pasta bem conhecidos, como Inbox, Drafts, SentItems ou DeletedItems.

Solicitação de amostra

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

Content-Type: application/json

{
  "DestinationId": "inbox"
}

Resposta de amostra

Código do status: 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 resposta

A nova cópia da pasta.

Próximas etapas

Se você estiver pronto para começar a criar um aplicativo ou apenas quiser aprender mais, temos tudo o que você precisa.

• Comece com as APIs REST de Email, Calendário e Contatos.
• Quer exemplos? Nós temos.

Se preferir, aprenda mais sobre como usar a plataforma do Office 365:

• API REST do Outlook no Centro de Desenvolvimento do Outlook
• Visão geral sobre desenvolvimento na plataforma do Office 365
• Autenticação de aplicativo do Office 365 e autorização de recursos
• Registre manualmente seu aplicativo no AD do Azure para que ele possa acessar as APIs do Office 365
• Referência da API de calendário
• Referência da API de contatos
• API REST de tarefa (versão prévia)
• API do OneDrive
• Referência de operações da API REST do Serviço de Descoberta
• Referência de recursos para as APIs REST de E-mail, Calendário e Contatos