Modelo de objeto do Item do Outlook

Use o Office.context.mailbox.item objeto para acessar e executar operações em mensagens e compromissos no modo de leitura ou redação.

Importante

Android e iOS: há limitações sobre quando os suplementos são ativados e quais APIs estão disponíveis. Para saber mais, consulte Adicionar suporte móvel a um suplemento do Outlook.

Propriedades

Propriedade Nível de permissão mínimo Detalhes por modo Tipo de retorno Requisito mínimo definido
anexos Ler item Participante do compromisso matriz.<Detalhes do anexo> 1.1
Mensagem lida matriz.<Detalhes do anexo> 1.1
bcc Ler item Composição da mensagem Destinatários 1.1
corpo Ler item Organizador de compromissos Body 1.1
Participante do compromisso Body 1.1
Composição da mensagem Body 1.1
Mensagem lida Body 1.1
categories Ler item Organizador de compromissos Categories 1.8
Participante do compromisso Categories 1.8
Composição da mensagem Categories 1.8
Mensagem lida Categories 1.8
cc Ler item Composição da mensagem Destinatários 1.1
Mensagem lida matriz.<EmailAddressDetails> 1.1
conversationId Ler item Composição da mensagem Cadeia de caracteres 1.1
Mensagem lida Cadeia de caracteres 1.1
dateTimeCreated Ler item Participante do compromisso Data 1.1
Mensagem lida Data 1.1
dateTimeModified Ler item Participante do compromisso Data 1.1
Mensagem lida Data 1.1
delayDeliveryTime Ler item Composição da mensagem DelayDeliveryTime 1.13
Ecrã item de leitura/gravação Mensagem lida Display Visualização
end Ler item Organizador de compromissos Time 1.1
Participante do compromisso Data 1.1
Mensagem lida Data 1.1
enhancedLocation Ler item Organizador de compromissos EnhancedLocation 1.8
Participante do compromisso EnhancedLocation 1.8
from Ler item Composição da mensagem De 1.7
Mensagem lida EmailAddressDetails 1.1
inReplyTo Ler item Composição da mensagem Cadeia de caracteres 11.4
internetHeaders Ler item Composição da mensagem InternetHeaders 1.8
internetMessageId Ler item Mensagem lida Cadeia de caracteres 1.1
isAllDayEvent Ler item Organizador de compromissos IsAllDayEvent Visualização
Participante do compromisso Booliano Visualização
itemClass Ler item Participante do compromisso Cadeia de caracteres 1.1
Mensagem lida Cadeia de caracteres 1.1
itemID Ler item Participante do compromisso Cadeia de caracteres 1.1
Mensagem lida Cadeia de caracteres 1.1
itemType Ler item Organizador de compromissos MailboxEnums.ItemType 1.1
Participante do compromisso MailboxEnums.ItemType 1.1
Composição da mensagem MailboxEnums.ItemType 1.1
Mensagem lida MailboxEnums.ItemType 1.1
localização Ler item Organizador de compromissos Location 1.1
Participante do compromisso Cadeia de caracteres 1.1
Mensagem lida Cadeia de caracteres 1.1
normalizedSubject Ler item Participante do compromisso Cadeia de caracteres 1.1
Mensagem lida Cadeia de caracteres 1.1
notificationMessages Ler item Organizador de compromissos NotificationMessages 1.3
Participante do compromisso NotificationMessages 1.3
Composição da mensagem NotificationMessages 1.3
Mensagem lida NotificationMessages 1.3
opcionaisParticipantes Ler item Organizador de compromissos Destinatários 1.1
Participante do compromisso matriz.<EmailAddressDetails> 1.1
organizer item de leitura/gravação Organizador de compromissos Organizador 1.7
Ler item Participante do compromisso EmailAddressDetails 1.1
recurrence Ler item Organizador de compromissos Recurrence 1.7
Participante do compromisso Recurrence 1.7
Mensagem lida Recurrence 1.7
requiredAttendees Ler item Organizador de compromissos Destinatários 1.1
Participante do compromisso matriz.<EmailAddressDetails> 1.1
sender Ler item Mensagem lida EmailAddressDetails 1.1
sensitivity Ler item Organizador de compromissos Sensitivity 11.4
Participante do compromisso MailboxEnums.AppointmentSensitivityType 11.4
sensitivityLabel item de leitura/gravação Organizador de compromissos SensitivityLabel 1.13
Composição da mensagem SensitivityLabel 1.13
seriesId Ler item Organizador de compromissos Cadeia de caracteres 1.7
Participante do compromisso Cadeia de caracteres 1.7
Composição da mensagem Cadeia de caracteres 1.7
Mensagem lida Cadeia de caracteres 1.7
sessionData Ler item Organizador de compromissos SessionData 1.11
Composição da mensagem SessionData 1.11
iniciar Ler item Organizador de compromissos Time 1.1
Participante do compromisso Data 1.1
Mensagem lida Data 1.1
assunto Ler item Organizador de compromissos Assunto 1.1
Participante do compromisso Cadeia de caracteres 1.1
Composição da mensagem Assunto 1.1
Mensagem lida Cadeia de caracteres 1.1
para Ler item Composição da mensagem Destinatários 1.1
Mensagem lida matriz.<EmailAddressDetails> 1.1

Métodos

Método Nível de permissão mínimo Detalhes por modo Requisito mínimo definido
addFileAttachmentAsync(uri, attachmentName, [options], [callback]) item de leitura/gravação Organizador de compromissos 1.1
(Windows clássico, Mac)

1.8
(Web, novo Windows)
Composição da mensagem 1.1
(Windows clássico, Mac)

1.8
(Web, novo Windows)
addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) item de leitura/gravação Organizador de compromissos 1.8
Composição da mensagem 1.8
addHandlerAsync(eventType, handler, [options], [callback]) Ler item Organizador de compromissos 1.7
Participante do compromisso 1.7
Composição da mensagem 1.7
Mensagem lida 1.7
addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) item de leitura/gravação Organizador de compromissos 1.1
Composição da mensagem 1.1
close() Restrito Organizador de compromissos 1.3
Composição da mensagem 1.3
closeAsync([options], [callback]) item de leitura/gravação Composição da mensagem 11.4
disableClientSignatureAsync([options], [callback]) item de leitura/gravação Organizador de compromissos 1.10
Composição da mensagem 1.10
displayReplyAllForm(formData) Ler item Participante do compromisso 1.1
Mensagem lida 1.1
displayReplyAllFormAsync(formData, [options], [callback]) Ler item Participante do compromisso 1.9
Mensagem lida 1.9
displayReplyForm(formData) Ler item Participante do compromisso 1.1
Mensagem lida 1.1
displayReplyFormAsync(formData, [options], [callback]) Ler item Participante do compromisso 1.9
Mensagem lida 1.9
getAllInternetHeadersAsync([options], [callback]) Ler item Mensagem lida 1.8
getAsFileAsync([options], callback) Ler item Mensagem lida 11.4
getAttachmentContentAsync(attachmentId, [options], [callback]) Ler item Organizador de compromissos 1.8
Participante do compromisso 1.8
Composição da mensagem 1.8
Mensagem lida 1.8
getAttachmentsAsync([opções], [retorno de chamada]) Ler item Organizador de compromissos 1.8
Composição da mensagem 1.8
getComposeTypeAsync([options], callback) Ler item Composição da mensagem 1.10
getConversationIndexAsync([options], callback) Ler item Composição da mensagem 11.4
getEntities() (preterido) Ler item Participante do compromisso 1.1
Mensagem lida 1.1
getEntitiesByType(entityType) (preterido) Restrito Participante do compromisso 1.1
Mensagem lida 1.1
getFilteredEntitiesByName(nome) (preterido) Ler item Participante do compromisso 1.1
Mensagem lida 1.1
getInitializationContextAsync([options], callback) Ler item Organizador de compromissos 1.8
Participante do compromisso 1.8
Composição da mensagem 1.8
Mensagem lida 1.8
getItemClassAsync([options], callback) Ler item Composição da mensagem 11.4
getItemIdAsync([options], callback) Ler item Organizador de compromissos 1.8
Composição da mensagem 1.8
getRegExMatches() Ler item Participante do compromisso 1.1
Mensagem lida 1.1
getRegExMatchesByName(name) Ler item Participante do compromisso 1.1
Mensagem lida 1.1
getSelectedDataAsync(coercionType, [options], callback) Ler item Organizador de compromissos 1.2
Composição da mensagem 1.2
getSelectedEntities() (preterido) Ler item Participante do compromisso 1.6
Mensagem lida 1.6
getSelectedRegExMatches() Ler item Participante do compromisso 1.6
Mensagem lida 1.6
getSharedPropertiesAsync([options], callback) Ler item Organizador de compromissos 1.8
(suporte a pasta compartilhada)

1.13
(suporte a caixa de correio compartilhada)
Participante do compromisso 1.8
(suporte a pasta compartilhada)

1.13
(suporte a caixa de correio compartilhada)
Composição da mensagem 1.8
(suporte a pasta compartilhada)

1.13
(suporte a caixa de correio compartilhada)
Mensagem lida 1.8
(suporte a pasta compartilhada)

1.13
(suporte a caixa de correio compartilhada)
isClientSignatureEnabledAsync([options], callback) Ler item Organizador de compromissos 1.10
Composição da mensagem 1.10
loadCustomPropertiesAsync(callback, [userContext]) Ler item Organizador de compromissos 1.1
Participante do compromisso 1.1
Composição da mensagem 1.1
Mensagem lida 1.1
removeAttachmentAsync(attachmentId, [options], [callback]) item de leitura/gravação Organizador de compromissos 1.1
Composição da mensagem 1.1
removeHandlerAsync(eventType, handler, [options], [callback]) Ler item Organizador de compromissos 1.7
Participante do compromisso 1.7
Composição da mensagem 1.7
Mensagem lida 1.7
saveAsync([options], callback) item de leitura/gravação Organizador de compromissos 1.3
Composição da mensagem 1.3
sendAsync([options], [callback]) Caixa de correio de leitura/gravação Organizador de compromissos 1.15
Composição da mensagem 1.15
setSelectedDataAsync(data, [options], [callback]) item de leitura/gravação Organizador de compromissos 1.2
Composição da mensagem 1.2

Eventos

Você pode assinar e cancelar a assinatura dos seguintes eventos usando addHandlerAsync e removeHandlerAsync respectivamente. Para obter mais informações, confira Office.EventType.

Evento Descrição Requisito mínimo definido
AppointmentTimeChanged Ocorre quando qualquer data ou hora do compromisso ou série selecionada é alterada no Outlook. Disponível somente com a implementação do painel de tarefas. 1.7
AttachmentsChanged Ocorre quando um anexo é adicionado ou removido de um item. Disponível somente com a implementação do painel de tarefas. 1.8
EnhancedLocationsChanged Ocorre quando o local do compromisso é alterado no Outlook. Disponível somente com a implementação do painel de tarefas. 1.8
InfobarClicked Ocorre no Outlook quando uma ação é selecionada em uma mensagem de notificação com uma ação personalizada definida. Disponível somente com a implementação do painel de tarefas. 1.10
InitializationContextChanged Ocorre no Outlook quando o painel de tarefas de um suplemento é aberto a partir de uma mensagem acionável, notificação InsightMessage, caixa de diálogo Alertas Inteligentes ou caixa de diálogo integrada de relatórios de spam. Disponível somente com a implementação do painel de tarefas. 1.15
RecipientsChanged Ocorre quando a lista de destinatários do item selecionado ou o local do compromisso é alterado no Outlook. Disponível somente com a implementação do painel de tarefas. 1.7
RecurrenceChanged Ocorre quando o padrão de recorrência da série selecionada é alterado no Outlook. Disponível somente com a implementação do painel de tarefas. 1.7
SensitivityLabelChanged Ocorre no Outlook quando o rótulo de confidencialidade de uma mensagem ou compromisso é alterado. Disponível somente com a implementação do painel de tarefas. 1.13
SpamReporting Ocorre no Outlook quando uma mensagem não solicitada é relatada. 11.4

Observação

Para eventos com suporte em um suplemento de ativação baseada em eventos, consulte Ativar suplementos com eventos.

  • Last updated on