Tipo de recurso eventMessage

Artigo
03/15/2023

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 que representa uma solicitação, cancelamento ou resposta de reunião (que pode ser uma destas: aceitação, aceitação provisória ou recusa).

A entidade eventMessage é derivada de message. eventMessage é o tipo base para eventMessageRequest e eventMessageResponse. A propriedade meetingMessageType identifica o tipo de mensagem do evento.

Quando um organizador ou aplicativo envia uma solicitação de reunião, a solicitação de reunião chega na caixa de correio de um convidado como uma instância eventMessage com o meetingMessageType de meetingRequest. Além disso, o Outlook cria automaticamente uma instância de evento no calendário do convidado, com a propriedade showAs como provisória.

Para obter as propriedades do evento associado na caixa de correio do convidado, o aplicativo pode usar a propriedade de navegação de evento do eventMessage, conforme mostrado neste exemplo de mensagem de evento get. O aplicativo também pode responder ao evento em nome do convidado de forma programática, aceitando, aceitando ou recusando o evento.

Além de uma solicitação de reunião, uma instância eventMessage pode ser encontrada na caixa de correio de um convidado como resultado de um organizador de eventos cancelar uma reunião ou na caixa de correio do organizador como resultado de um convidado respondendo à solicitação da reunião. Um aplicativo pode atuar em mensagens de evento da mesma maneira que atua em mensagens com poucas diferenças.

Representação JSON

A representação JSON a seguir mostra o tipo de 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": "DateTimeOffset",
  "endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "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",
  "isAllDay": "Boolean",
  "isDelegated": true,
  "isDeliveryReceiptRequested": true,
  "isDraft": true,
  "isOutOfDate": "Boolean",
  "isRead": true,
  "isReadReceiptRequested": true,
  "lastModifiedDateTime": "DateTimeOffset",
  "location": {"@odata.type": "microsoft.graph.location"},
  "meetingMessageType": {"@odata.type": "microsoft.graph.meetingMessageType"},
  "mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
  "parentFolderId": "string",
  "receivedDateTime": "DateTimeOffset",
  "recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
  "replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
  "sender": {"@odata.type": "microsoft.graph.recipient"},
  "sentDateTime": "DateTimeOffset",
  "startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "subject": "string",
  "toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "type": "string",
  "uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
  "UnsubscribeData": "string",
  "UnsubscribeEnabled": true,
  "webLink": "string"
}

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.
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.
endDateTime	dateTimeTimeZone	A hora final da reunião solicitada.
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.
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	String	A importância da mensagem: `low`, `normal`, `high`.
inferenceClassification	String	Os valores possíveis são: `focused` e `other`.
internetMessageHeaders	Coleção internetMessageHeader	A coleção de cabeçalhos da mensagem, definida por RFC5322, que fornece detalhes do caminho de rede adotado por uma mensagem do remetente para o destinatário. Somente leitura.
internetMessageId	String	A ID da mensagem no formato especificado por RFC5322.
isAllDay	Booliano	Indica se o evento dura o dia inteiro. Ajustar essa propriedade requer ajustar as propriedades startDateTime e endDateTime do evento também.
isDelegated	Booliano	True se essa solicitação de reunião estiver acessível a um delegado, false caso contrário. O padrão é false.
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.
isOutOfDate	Booliano	Indica se essa solicitação de reunião foi feita desatualizada por uma solicitação mais recente.
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.
location	location	O local da reunião solicitada.
meetingMessageType	String	O tipo de mensagem de evento: `none`, `meetingRequest`, `meetingCancelled`, `meetingAccepted`, `meetingTentativelyAccepted`, `meetingDeclined`.
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.
recurrence	patternedRecurrence	O padrão de recorrência da reunião solicitada.
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.
startDateTime	dateTimeTimeZone	A hora de início da reunião solicitada.
assunto	String	O assunto da mensagem.
toRecipients	Coleção recipient	Os destinatários Para: da mensagem.
type	Cadeia de caracteres	O tipo de reunião solicitada: `singleInstance`, , `occurence`, `exception`. `seriesMaster`
uniqueBody	itemBody	A parte do corpo da mensagem que é exclusiva para a mensagem atual.
Cancelar assinaturaData	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 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	A coleção de anexos fileAttachment, itemAttachment e referenceAttachment para a mensagem. Somente leitura. Anulável.
event	event	O evento associado à mensagem de evento. A pressuposição dos participantes ou recursos da sala é que o Atendedor de Calendário esteja definido para atualizar automaticamente o calendário com um evento quando mensagens de evento de solicitação de reunião chegarem. Propriedade de navegação. Somente leitura.
extensions	Coleção extension	A coleção de extensões abertas definidas para o eventMessage. Somente leitura. 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 eventMessage. Somente leitura. Anulável.
singleValueExtendedProperties	Coleção singleValueLegacyExtendedProperty	A coleção de propriedades estendidas de valor único definidas para a eventMessage. Somente leitura. Anulável.

Métodos

Método	Tipo de retorno	Descrição
Get eventMessage	eventMessage	Ler propriedades e relações do objeto eventMessage.
Update	eventMessage	Atualizar o objeto eventMessage.
Excluir	Nenhum	Excluir o objeto eventMessage.
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.
forward	Nenhum	Encaminhar uma mensagem. A mensagem é então salva na pasta Itens Enviados.
move	message	Mover uma 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.
unsubscribe	Nenhum	Envie uma mensagem usando os dados e o endereço especificados no primeiro comando mailto no cabeçalho List-Unsubscribe.
Anexos
List attachments	Coleção attachment	Obtenha todos os anexos em um eventMessage.
Add attachment	attachment	Adicionar um novo anexo a um eventMessage 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	Obtenha uma extensão aberta identificada pelo nome.
Propriedades estendidas
Criar uma propriedade estendida de valor único	eventMessage	Criar uma ou mais propriedades estendidas de valor único em uma eventMessage nova ou existente.
Obter eventMessage com propriedade estendida de valor único	eventMessage	Obter eventMessages que contenham uma propriedade estendida de valor único usando `$expand` ou `$filter`.
Criar propriedade estendida de vários valores	eventMessage	Criar uma ou mais propriedades estendidas de vários valores em uma eventMessage nova ou existente.
Obter eventMessage com propriedade estendida de vários valores	eventMessage	Obter um eventMessage que contenha uma propriedade estendida de vários valores usando `$expand`.

Share via