tipo de recurso de mensagem

  • Artigo

Namespace: microsoft.graph

Uma mensagem em uma mailFolder.

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-". Após a mensagem ter sido enviada, não será possível alterar 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 Message Criar um rascunho da mensagem de encaminhamento. Em seguida, você pode atualizar ou enviar esse rascunho.
createReply Message Criar um rascunho da mensagem de resposta. Em seguida, você pode atualizar ou enviar esse rascunho.
createReplyAll Message Criar um rascunho da mensagem Responder a Todos. 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 Encaminhar uma mensagem. A mensagem é então salva na pasta Itens Enviados.
move Message Mover a mensagem para uma pasta. Isso cria uma nova cópia da mensagem na pasta de destino.
reply Nenhum Responder ao remetente de uma mensagem. A mensagem é então salva na pasta Itens Enviados.
replyAll Nenhum Responder a todos os destinatários de uma mensagem. 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.
Anexos
Listar anexos Coleção Attachment Obtém 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 Criar uma extensão aberta e adicionar propriedades personalizadas em uma instância nova ou existente de um recurso.
Obter extensão aberta Coleção openTypeExtension Obter um ou mais objetos de extensão ou identificados por nome ou nome totalmente qualificado.
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.
categories String collection As categorias associadas à mensagem.
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 ou 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 RFC2822.
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.
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.
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 a entrada for definida como 0, o navegador mostrará a mensagem no painel de revisão do Outlook na Web.

A mensagem será aberta no navegador se você estiver conectado à sua caixa de correio através do Outlook na Web. Você será solicitado a fazer o login, se ainda não estiver conectado 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.
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)",
  "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"},
  "webLink": "string",

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

Confira também