Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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, Compose de mensagens ou Mensagem lida |
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
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 (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]) | ler/escrever item | 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]) | 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 | ||
| closeAsync([opções], [chamada de retorno]) | ler/escrever item | Composição da mensagem | 11.4 |
| disableClientSignatureAsync([options], [callback]) | ler/escrever item | 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([opções], chamada de retorno) | 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([options], [callback]) | ler item | Organizador de Compromissos | 1.8 |
| Composição da mensagem | 1.8 | ||
| getComposeTypeAsync([opções], chamada de retorno) | ler item | Composição da mensagem | 1.10 |
| getConversationIndexAsync([opções], chamada de retorno) | 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(name) (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([opções], chamada de retorno) | ler item | Composição da mensagem | 11.4 |
| getItemIdAsync([opções], chamada de retorno) | 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, [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 | ||
| getSharedPropertiesAsync([opções], chamada de retorno) | ler item | Organizador de Compromissos |
1.8 (suporte de pastas partilhadas) 1.13 (suporte de caixa de correio partilhada) |
| Participante do Compromisso |
1.8 (suporte de pastas partilhadas) 1.13 (suporte de caixa de correio partilhada) |
||
| Composição da mensagem |
1.8 (suporte de pastas partilhadas) 1.13 (suporte de caixa de correio partilhada) |
||
| Mensagem lida |
1.8 (suporte de pastas partilhadas) 1.13 (suporte de caixa de correio partilhada) |
||
| isClientSignatureEnabledAsync([opções], chamada de retorno) | 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]) | 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 | ||
| sendAsync([opções], [chamada de retorno]) | caixa de correio de leitura/escrita | Organizador de Compromissos | 1.15 |
| Composição da mensagem | 1.15 | ||
| 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.
| Event | Descrição | Minimum conjunto de requisitos |
|---|---|---|
AppointmentTimeChanged |
A data ou hora do compromisso ou série selecionado foi alterada. Apenas disponível com a implementação do painel de tarefas. | 1.7 |
AttachmentsChanged |
Foi adicionado ou removido um anexo do item. Apenas disponível com a implementação do painel de tarefas. | 1.8 |
EnhancedLocationsChanged |
A localização do compromisso selecionado foi alterada. Apenas disponível com a implementação do painel de tarefas. | 1.8 |
InfobarClicked |
Foi selecionada uma ação a partir de uma mensagem de notificação. Apenas disponível com a implementação do painel de tarefas. | 1.10 |
InitializationContextChanged |
O painel de tarefas de um suplemento foi aberto a partir de uma mensagem acionável, InsightMessage notificação, caixa de diálogo Alertas Inteligentes ou caixa de diálogo de relatório de spam integrado. Apenas disponível com a implementação do painel de tarefas. |
1.15 |
RecipientsChanged |
A lista de destinatários do item selecionado ou da localização do compromisso foi alterada. Apenas disponível com a implementação do painel de tarefas. | 1.7 |
RecurrenceChanged |
O padrão de periodicidade da série selecionada foi alterado. Apenas disponível com a implementação do painel de tarefas. | 1.7 |
SensitivityLabelChanged |
A etiqueta de confidencialidade de uma mensagem ou compromisso no modo de composição foi alterada. Apenas disponível com a implementação do painel de tarefas. | 1.13 |
SpamReporting |
Foi reportada uma mensagem não solicitada no Outlook. Disponível apenas com um comando de função. | 11.4 |
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.
});
};