item (Requisito da caixa de correio definido como 1.7)

Office.context.mailbox.item

item é utilizado para aceder à mensagem, pedido de reunião ou compromisso atualmente selecionado. Pode determinar o tipo do item com a itemType propriedade .

Requisitos

Requisito	Valor
Versão do conjunto de requisitos mínimos da caixa de correio	1.1
Nível de permissão mínimo	restrito
Modo do Outlook aplicável	Organizador do Compromisso, Participante do Compromisso, Composição de Mensagens ou Leitura de Mensagens

Importante

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

Propriedades

Propriedade	Minimum nível de permissão	Detalhes por modo	Tipo de retorno	Minimum conjunto de requisitos
anexos	ler item	Participante do Compromisso	Matriz.<AttachmentDetails>	1.1
		Mensagem lida	Matriz.<AttachmentDetails>	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
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
end	ler item	Organizador de Compromissos	Time	1.1
		Participante do Compromisso	Data	1.1
		Mensagem lida (Pedido de Reunião)	Data	1.1
from	ler/escrever item	Composição da mensagem	De	1.7
	ler item	Mensagem lida	EmailAddressDetails	1.1
internetMessageId	ler item	Mensagem lida	Cadeia de caracteres	1.1
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 (Pedido de Reunião)	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
optionalAttendees	ler item	Organizador de Compromissos	Destinatários	1.1
		Participante do Compromisso	Matriz.<EmailAddressDetails>	1.1
organizer	ler/escrever item	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 (Pedido de Reunião)	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
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
iniciar	ler item	Organizador de Compromissos	Time	1.1
		Participante do Compromisso	Data	1.1
		Mensagem lida (Pedido de Reunião)	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	Minimum nível de permissão	Detalhes por modo	Minimum conjunto de requisitos
addFileAttachmentAsync(uri, attachmentName, [options], [callback])	ler/escrever item	Organizador de Compromissos	1.1
		Composição da mensagem	1.1
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])	ler/escrever item	Organizador de Compromissos	1.1
		Composição da mensagem	1.1
close()	restrito	Organizador de Compromissos	1.3
		Composição da mensagem	1.3
displayReplyAllForm(formData)	ler item	Participante do Compromisso	1.1
		Mensagem lida	1.1
displayReplyForm(formData)	ler item	Participante do Compromisso	1.1
		Mensagem lida	1.1
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(name) (preterido)	ler item	Participante do Compromisso	1.1
		Mensagem lida	1.1
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, [opções], chamada de retorno)	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
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])	ler/escrever item	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)	ler/escrever item	Organizador de Compromissos	1.3
		Composição da mensagem	1.3
setSelectedDataAsync(data, [options], callback)	ler/escrever item	Organizador de Compromissos	1.2
		Composição da mensagem	1.2

Eventos

Pode subscrever e anular a subscrição dos seguintes eventos com addHandlerAsync e removeHandlerAsync respetivamente.

Importante

Os eventos só estão disponíveis com a implementação do painel de tarefas.

Event	Descrição	Minimum conjunto de requisitos
AppointmentTimeChanged	A data ou hora do compromisso ou série selecionado foi alterada.	1.7
RecipientsChanged	A lista de destinatários do item selecionado ou da localização do compromisso foi alterada.	1.7
RecurrenceChanged	O padrão de periodicidade da série selecionada foi alterado.	1.7

Exemplo

O exemplo de código JavaScript a seguir mostra como acessar a propriedade subject do item atual no Outlook.

// The initialize function is required for all apps.
Office.initialize = function () {
  // Checks for the DOM to load using the jQuery ready method.
  $(document).ready(function () {
    // After the DOM is loaded, app-specific code can run.
    const item = Office.context.mailbox.item;
    const subject = item.subject;
    // Continue with processing the subject of the current item,
    // which can be a message or appointment.
  });
};