tipo de recurso de mensagem

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Uma mensagem em uma pasta da caixa de correio.

O número total máximo de destinatários incluídos nas propriedades toRecipients, ccRecipients e bccRecipients para uma única mensagem de email enviada de uma caixa de correio do Exchange A é de 500. Para obter mais informações, veja limites de envio.

Esse recurso permite:

  • Adicionar seus próprios dados como cabeçalhos personalizados de mensagens da Internet. Adicionar cabeçalhos personalizados somente ao criar uma mensagem e nomes que começam com"x-". Depois que a mensagem for enviada, você não poderá modificar os cabeçalhos. Para obter os cabeçalhos de uma mensagem, aplique o parâmetro de consulta $select em uma operação get message.
  • Adicionar seus próprios dados como propriedades personalizadas como extensions.
  • Assinar as notificações de alteração.
  • Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.

Métodos

Método Tipo de retorno Descrição
Listar mensagens Coleção message Obter todas as mensagens na caixa de correio do usuário conectado (incluindo as pastas Itens Excluídos e Email Secundário).
Criar mensagem message Criar um rascunho de uma nova mensagem.
Obter mensagem message Ler propriedades e relações do objeto mensage.
Update message Atualizar o objeto message.
Delete None Excluir o objeto message.
copy Message Copiar uma mensagem para uma pasta.
createForward Mensagem Crie uma mensagem de encaminhamento de rascunho para incluir um comentário ou atualizar todas as propriedades da mensagem em uma chamada createForward. Em seguida, você pode atualizar ou enviar esse rascunho.
createReply Mensagem Crie uma mensagem de resposta de rascunho para incluir um comentário ou atualizar todas as propriedades da mensagem em uma chamada createReply. Em seguida, você pode atualizar ou enviar esse rascunho.
createReplyAll Mensagem Crie uma mensagem para responder a todos de rascunho para incluir um comentário ou atualizar todas as propriedades da mensagem em uma chamada createReplyAll. Em seguida, você pode atualizar ou enviar esse rascunho.
delta Coleção message Obtenha um conjunto de mensagens que foram adicionadas, excluídas ou atualizadas em uma pasta especificada.
forward Nenhum Encaminhe uma mensagem, adicione um comentário ou modifique todas as propriedades atualizáveis em uma única chamada forward. A mensagem é então salva na pasta Itens Enviados.
markAsJunk message Marque uma mensagem como lixo eletrônico. Essa API adiciona o remetente à lista de remetentes bloqueados e move a mensagem para a pasta Junk Email, quando moveToJunk é true.
markAsNotJunk message Marque uma mensagem como não lixo eletrônico. Essa API remove o remetente da lista de remetentes bloqueados e move a mensagem para a pasta Caixa de Entrada , quando moveToInbox é true.
move Message Mover a mensagem para uma pasta. Isso cria uma nova cópia da mensagem na pasta de destino.
reply Nenhum Responda ao remetente de uma mensagem, adicione um comentário ou modifique todas as propriedades atualizáveis em uma única chamada reply. A mensagem é então salva na pasta Itens Enviados.
replyAll Nenhum Responda a todos os destinatários de uma mensagem especificando um comentário e modificando quaisquer **propriedades atualizáveis** da resposta, tudo isso usando o método ReplyAll. A mensagem é então salva na pasta Itens Enviados.
send Nenhum Envia um rascunho de mensagem anteriormente criado. A mensagem é então salva na pasta Itens Enviados.
unsubscribe Nenhum Envie uma mensagem usando os dados e o endereço especificados no primeiro comando mailto no cabeçalho List-Unsubscribe.
Anexos
Listar anexos Coleção Attachment Obtenha todos os anexos em uma mensagem.
Add attachment Attachment Adicione um novo anexo a uma mensagem postando na coleção attachments.
Extensões abertas
Criar extensão aberta openTypeExtension Crie uma extensão aberta e adicione propriedades personalizadas a uma instância nova ou existente de um recurso.
Obter extensão aberta Coleção openTypeExtension Obtenha uma extensão aberta identificada pelo nome da extensão.
Extensões de esquema
Adicionar valores de extensões de esquema Cria uma definição para a extensão de esquema e usa-a para adicionar dados digitados personalizados a um recurso.
Propriedades estendidas
Criar uma propriedade estendida de valor único message Criar uma ou mais propriedades estendidas de valor único em uma mensagem nova ou existente.
Obter mensagem com propriedade estendida de valor único message Obter mensagens que contenham uma propriedade estendida de valor único usando $expand ou $filter.
Criar propriedade estendida de vários valores message Criar uma ou mais propriedades estendidas de vários valores em uma mensagem nova ou existente.
Obter mensagem com propriedade estendida de vários valores message Obter uma mensagem que contenha uma propriedade estendida de vários valores usando $expand.

Propriedades

Propriedade Tipo Descrição
bccRecipients Coleção recipient Os destinatários Cco: da mensagem.
body itemBody O corpo da mensagem. Pode estar no formato HTML ou no formato de texto. Saiba mais sobre HTML seguro no corpo da mensagem.
bodyPreview String Os primeiros 255 caracteres do corpo da mensagem. Está no formato de texto. Se a mensagem contiver instâncias de menção, essa propriedade também conteria uma concatenação dessas menções.
ccRecipients Coleção recipient Os destinatários Cc: da mensagem.
changeKey String A versão da mensagem.
conversationId String A ID da conversa à qual o email pertence.
conversationIndex Edm.Binary Indica a posição da mensagem dentro da conversa.
createdDateTime DateTimeOffset A data e a hora em que a mensagem foi criada.

As informações de data e hora usam o formato ISO 8601 e estão sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
flag followupFlag O valor do sinalizador que indica o status, a data de início, a data de conclusão ou a data de finalização da mensagem.
from recipient O proprietário da caixa de correio da qual a mensagem foi enviada. Na maioria dos casos, esse valor é o mesmo que o da propriedade remetente, exceto para cenários de compartilhamento ou delegação. O valor deve corresponder à caixa de correio real que foi usada. Saiba mais sobre como definir as propriedades from e sender de uma mensagem.
hasAttachments Boolean Indica se a mensagem tem anexos. Essa propriedade não inclui anexos embutidos, portanto, se uma mensagem contém apenas anexos embutidos, essa propriedade será falsa. Para verificar a existência de anexos embutidos, analise a propriedade do corpo para procurar um src atributo, como <IMG src="cid:image001.jpg@01D26CD8.6C05F070">.
id Cadeia de caracteres Identificador exclusivo da mensagem. Por padrão, esse valor muda quando o item é transferido de um contêiner (como uma pasta ou calendário) para outro. Para alterar esse comportamento, use o cabeçalho Prefer: IdType="ImmutableId". Para obter mais informações, consulte o artigo Obter identificadores imutáveis para recursos do Outlook. Somente leitura.
importância importância A importância da mensagem. Os valores possíveis são low, normal e high.
inferenceClassification inferenceClassificationType A classificação da mensagem para o usuário, com base na relevância ou importância deduzida, ou em uma substituição explícita. Os valores possíveis são: focused e other.
internetMessageHeaders Coleção internetMessageHeader Uma coleção de cabeçalhos de mensagens definidos por RFC5322. O conjunto inclui cabeçalhos de mensagens que indicam o caminho de rede adotado por uma mensagem do remetente para o destinatário. Também pode conter cabeçalhos de mensagens personalizados com dados do aplicativo para a mensagem.

Retornado apenas mediante aplicação da opção de consulta $select. Somente leitura.
internetMessageId String A ID da mensagem no formato especificado por RFC5322. Atualizável apenas se isDraft for true.
isDeliveryReceiptRequested Boolean Indica se uma confirmação de leitura foi solicitada para a mensagem.
isDraft Boolean Indica se a mensagem é um rascunho. Uma mensagem é um rascunho quando ela ainda não foi enviada.
isRead Boolean Indica se a mensagem foi lida.
isReadReceiptRequested Boolean Indica se uma confirmação de leitura foi solicitada para a mensagem.
lastModifiedDateTime DateTimeOffset A data e a hora em que a mensagem foi alterada pela última vez.

As informações de data e hora usam o formato ISO 8601 e estão sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
mentionsPreview mentionsPreview Informações sobre menções na mensagem. Ao processar uma solicitação GET /messages, o servidor define essa propriedade e a inclui na resposta por padrão. O servidor retornará null se não houver menções na mensagem. Opcional.
parentFolderId String O identificador exclusivo para a mailFolder pai da mensagem.
receivedDateTime DateTimeOffset A data e a hora em que a mensagem foi recebida.

As informações de data e hora usam o formato ISO 8601 e estão sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
replyTo Coleção recipient Os endereços de email a serem usados ao responder.
sender recipient A conta que é realmente usada para gerar a mensagem. Na maioria dos casos, esse valor é o mesmo da propriedade from. Você pode definir essa propriedade como um valor diferente ao enviar uma mensagem de uma caixa de correio compartilhada, ou ao enviar uma mensagem como um delegado. De qualquer forma, o valor deve corresponder à caixa de correio real que foi usada. Saiba mais sobre como definir as propriedades from e sender de uma mensagem.
sentDateTime DateTimeOffset A data e a hora em que a mensagem foi enviada.

As informações de data e hora usam o formato ISO 8601 e estão sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
assunto String O assunto da mensagem.
toRecipients Coleção recipient Os destinatários Para: da mensagem.
uniqueBody itemBody A parte do corpo da mensagem que é exclusiva para a mensagem atual. uniqueBody não é retornado por padrão, mas pode ser recuperado para uma determinada mensagem usando a ?$select=uniqueBody consulta. Pode estar no formato HTML ou no formato de texto.
unsubscribeData String As entradas válidas analisadas no cabeçalho List-Unsubscribe. Esses são os dados para o comando mail no cabeçalho List-Unsubscribe, se a propriedade UnsubscribeEnabled for true.
unsubscribeEnabled Booliano Indica se a mensagem está habilitada para o cancelamento da assinatura. valueTrue se o cabeçalho list-Unsubscribe estiver em conformidade com o rfc-2369.
webLink String O URL para abrir a mensagem no Outlook na Web.

Você pode acrescentar um argumento ispopout ao final da URL para alterar como a mensagem é exibida. Se ispopout não houver presente ou estiver definido como 1, a mensagem será mostrada em uma janela pop-up. Se ispopout estiver definido como 0, o navegador mostrará a mensagem no painel de revisão Outlook na Web.

A mensagem será aberta no navegador se você estiver conectado à caixa de correio por meio de Outlook na Web. Você será solicitado a entrar se ainda não tiver entrado com o navegador.

Este URL não pode ser acessado a partir de um iFrame.

Relações

Relação Tipo Descrição
attachments Coleção Attachment Os anexos fileAttachment e itemAttachment da mensagem.
extensions Coleção Extension A coleção de extensões abertas definidas para a mensagem. Anulável.
menções Coleção mention Uma coleção de menções na mensagem, ordenada pelo createdDateTime, do mais novo para o mais antigo. Por padrão, um GET /messages não retorna essa propriedade, a menos que você aplique $expand à propriedade.
multiValueExtendedProperties Coleção multiValueLegacyExtendedProperty A coleção de propriedades estendidas de vários valores definidas para a mensagem. Anulável.
singleValueExtendedProperties Coleção singleValueLegacyExtendedProperty A coleção de propriedades estendidas de valor único definidas para a mensagem. Anulável.

Representação JSON

Veja a seguir uma representação JSON do recurso

{
  "bccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "body": {"@odata.type": "microsoft.graph.itemBody"},
  "bodyPreview": "string",
  "categories": ["string"],
  "ccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "changeKey": "string",
  "conversationId": "string",
  "conversationIndex": "String (binary)",
  "createdDateTime": "String (timestamp)",
  "flag": {"@odata.type": "microsoft.graph.followupFlag"},
  "from": {"@odata.type": "microsoft.graph.recipient"},
  "hasAttachments": true,
  "id": "string (identifier)",
  "importance": "String",
  "inferenceClassification": "String",
  "internetMessageHeaders": [{"@odata.type": "microsoft.graph.internetMessageHeader"}],
  "internetMessageId": "String",
  "isDeliveryReceiptRequested": true,
  "isDraft": true,
  "isRead": true,
  "isReadReceiptRequested": true,
  "lastModifiedDateTime": "String (timestamp)",
  "mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
  "parentFolderId": "string",
  "receivedDateTime": "String (timestamp)",
  "replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
  "sender": {"@odata.type": "microsoft.graph.recipient"},
  "sentDateTime": "String (timestamp)",
  "subject": "string",
  "toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
  "unsubscribeData": "string",
  "unsubscribeEnabled": true,
  "webLink": "string",

  "attachments": [{"@odata.type": "microsoft.graph.attachment"}],
  "extensions": [{"@odata.type": "microsoft.graph.extension"}],
  "mentions": [{"@odata.type": "microsoft.graph.mention"}],
  "multiValueExtendedProperties": [{"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"}],
  "singleValueExtendedProperties": [{"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"}]
}

Conteúdo relacionado