outlook package

A subclasse de Item que trata de compromissos.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces subordinadas:

• AppointmentCompose

• AppointmentRead

O modo de organizador de compromissos de Office.context.mailbox.item.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces principais:

• ItemCompose

• Compromisso

O AppointmentForm objeto é utilizado para aceder ao compromisso atualmente selecionado.

O modo de participante do compromisso de Office.context.mailbox.item.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces principais:

• ItemRead

• Compromisso

Fornece as datas e horas atuais do compromisso que elevou o Office.EventType.AppointmentTimeChanged evento.

Representa o conteúdo de um anexo numa mensagem ou item de compromisso.

Representa um anexo em um item do servidor. Somente modo de leitura.

Uma matriz de AttachmentDetails objetos é devolvida como propriedade attachments de um compromisso ou item de mensagem.

Representa um anexo num item. Somente modo de redação.

O método devolve getAttachmentsAsync uma matriz de AttachmentDetailsCompose objetos.

Fornece informações sobre o anexo num item de correio que elevou o Office.EventType.AttachmentsChanged evento.

O objeto body fornece métodos para adicionar e atualizar o conteúdo da mensagem ou compromisso. É devolvido na propriedade body do item selecionado.

Representa as categorias num item.

No Outlook, um utilizador pode etiquetar mensagens e compromissos ao utilizar uma categoria para os codificar. O utilizador define categorias numa lista de master na respetiva caixa de correio. Ele pode, em seguida, aplicar uma ou mais categorias a um item.

Importante: no Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem no modo Compose.

Representa os detalhes de uma categoria, como o nome e a cor associada.

Fornece uma opção para o formato de dados.

Representa os detalhes sobre um contacto (semelhante ao que está num contacto físico ou card empresarial) extraído do corpo do item. Somente modo de leitura.

A lista de contactos extraídos do corpo de uma mensagem de e-mail ou compromisso é devolvida na contacts propriedade do objeto Entidades devolvido pelo getEntities método ou getEntitiesByType do item atual.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram descontinuados. No entanto, as regras de expressão regulares continuam a ser suportadas. Recomendamos que atualize o suplemento contextual para utilizar regras de expressão regulares como uma solução alternativa. Para obter orientações sobre como implementar estas regras, veja Suplementos contextuais do Outlook.

O CustomProperties objeto representa propriedades personalizadas específicas de um item de correio específico e específicas de um suplemento do Outlook. Por exemplo, pode ser necessário um suplemento para guardar alguns dados específicos da mensagem atual que ativou o suplemento. Se o utilizador revisitar a mesma mensagem no futuro e ativar novamente o suplemento, o suplemento poderá obter os dados que foram guardados como propriedades personalizadas.

Para saber mais sobre CustomPropertieso , consulte Obter e definir metadados de suplementos para um suplemento do Outlook.

O DelayDeliveryTime objeto permite-lhe gerir a data e hora de entrega atrasadas de uma mensagem.

Fornece informações de diagnóstico para um suplemento do Outlook.

Fornece propriedades para definir temporariamente o conteúdo apresentado no corpo ou assunto de uma mensagem no modo de leitura.

Fornece um método para definir temporariamente o conteúdo apresentado no corpo de uma mensagem no modo de leitura.

Fornece um método para definir temporariamente o conteúdo apresentado no assunto de uma mensagem no modo de leitura.

Fornece as propriedades de email do remetente ou dos destinatários especificados de um compromisso ou uma mensagem de email.

Representa uma conta de email em um Exchange Server.

Representa o conjunto de localizações num compromisso.

Fornece as localizações melhoradas atuais quando o Office.EventType.EnhancedLocationsChanged evento é gerado.

Representa um conjunto de entidades encontrado em um compromisso ou uma mensagem de email. Somente modo de leitura.

O objeto Entities é um contêiner das matrizes de entidade retornadas pelos métodos getEntities e getEntitiesByType quando o item (uma mensagem de email ou um compromisso) contém uma ou mais entidades que foram encontradas pelo servidor. Você pode usar essas entidades em seu código para fornecer informações adicionais de contexto ao visualizador, como um mapa para um endereço encontrado no item ou para abrir um discador para um número de telefone encontrado no item.

Se não existirem entidades do tipo especificadas na propriedade presentes no item, a propriedade associada a essa entidade é nula. Por exemplo, se uma mensagem contiver um endereço de rua e um número de telefone, a propriedade endereços e a propriedade phoneNumbers conteriam informações e as outras propriedades seriam nulas.

Para ser reconhecida como um endereço, a cadeia de caracteres deve conter um endereço postal norte-americano com ao menos um subconjunto dos elementos de um número de rua, nome de rua, cidade, estado e CEP.

Para ser reconhecida como um número de telefone, a cadeia de caracteres deve conter um formato numérico norte-americano de telefone.

O reconhecimento da entidade depende de reconhecimento de linguagem natural, que é baseado no aprendizado de máquina de grandes quantidades de dados. O reconhecimento de uma entidade não é determinista e o sucesso, às vezes, depende do contexto específico no item.

Quando as matrizes de propriedades são devolvidas pelo getEntitiesByType método , apenas a propriedade da entidade especificada contém dados; todas as outras propriedades são nulas.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram descontinuados. No entanto, as regras de expressão regulares continuam a ser suportadas. Recomendamos que atualize o suplemento contextual para utilizar regras de expressão regulares como uma solução alternativa. Para obter orientações sobre como implementar estas regras, veja Suplementos contextuais do Outlook.

Fornece um método para obter o valor de uma mensagem num suplemento do Outlook.

Fornece detalhes básicos sobre a mensagem de notificação que levantou o Office.EventType.InfobarClicked evento.

Fornece detalhes adicionais sobre a mensagem de notificação que levantou o Office.EventType.InfobarClicked evento.

O InternetHeaders objeto representa cabeçalhos de Internet personalizados que são preservados após o item de mensagem sair do Exchange e ser convertido numa mensagem MIME.

Os cabeçalhos da Internet são armazenados como pares chave-valor de cadeia numa base por item.

Nota: este objeto destina-se a definir e obter os cabeçalhos personalizados num item de mensagem. Para saber mais, consulte Obter e definir cabeçalhos da Internet numa mensagem num suplemento do Outlook.

Fornece métodos para obter e definir o evento durante todo o dia status de uma reunião num suplemento do Outlook.

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

Para ver a lista completa de membros, consulte a página Modelo de Objeto .

Se quiser ver o IntelliSense apenas para um tipo ou modo específico, cast este item para um dos seguintes:

• AppointmentCompose

• AppointmentRead

• MessageCompose

• MessageRead

O modo de composição de Office.context.mailbox.item.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces subordinadas:

• AppointmentCompose

• MessageCompose

O modo de leitura de Office.context.mailbox.item.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces subordinadas:

• AppointmentRead

• MessageRead

Representa uma mensagem no modo de composição que está atualmente carregada. Um LoadedMessageCompose objeto é devolvido quando Office.context.mailbox.loadItemByIdAsync é chamado numa mensagem no modo de composição.

Representa uma mensagem no modo de leitura que está atualmente carregada. Um LoadedMessageRead objeto é devolvido quando Office.context.mailbox.loadItemByIdAsync é chamado numa mensagem no modo de leitura.

Representa uma data e hora no fuso horário local do cliente. Somente modo de leitura.

Fornece métodos para obter e definir o local de uma reunião em um suplemento do Outlook.

Representa uma localização. Somente leitura.

Representa o ID de uma localização.

Fornece acesso ao modelo de objeto de suplemento do Microsoft Outlook.

Propriedades da chave:

• diagnostics : fornece informações de diagnóstico a um suplemento do Outlook.

• item : fornece métodos e propriedades para aceder a uma mensagem ou compromisso num suplemento do Outlook.

• userProfile : fornece informações sobre o utilizador num suplemento do Outlook.

O MailboxEvent objeto é transmitido como um argumento para o processador de eventos de um suplemento que implementa a ativação baseada em eventos, incluindo Alertas Inteligentes ou a funcionalidade integrada de relatórios de spam. Permite ao suplemento significar ao cliente do Outlook que concluiu o processamento de um evento.

Representa as categorias master lista na caixa de correio.

No Outlook, um utilizador pode etiquetar mensagens e compromissos ao utilizar uma categoria para os codificar. O usuário define as categorias em uma lista mestra em sua caixa de correio. Ele pode, em seguida, aplicar uma ou mais categorias a um item.

Importante: em cenários delegados ou partilhados, o delegado pode obter as categorias na lista master, mas não pode adicionar ou remover categorias.

Representa uma reunião sugerida encontrada em um item. Somente modo de leitura.

A lista de reuniões sugeridas numa mensagem de e-mail é devolvida na meetingSuggestions propriedade do Entities objeto que é devolvido quando o getEntities método ou getEntitiesByType é chamado no item ativo.

Os valores de início e de fim são representações de cadeia de carateres de um Date objeto que contém a data e hora em que a reunião sugerida deve começar e terminar. Os valores são no fuso horário padrão especificado para o usuário atual.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram descontinuados. No entanto, as regras de expressão regulares continuam a ser suportadas. Recomendamos que atualize o suplemento contextual para utilizar regras de expressão regulares como uma solução alternativa. Para obter orientações sobre como implementar estas regras, veja Suplementos contextuais do Outlook.

Uma subclasse de Item para mensagens.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces subordinadas:

• MessageCompose

• MessageRead

O modo de composição de mensagens de Office.context.mailbox.item.

Importante:

• Este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

• Ao chamar Office.context.mailbox.item uma mensagem, tenha em atenção que o Painel de Leitura no cliente do Outlook tem de estar ativado. Para obter orientações sobre como configurar o Painel de Leitura, consulte Utilizar e configurar o Painel de Leitura para pré-visualizar mensagens.

Interfaces principais:

• ItemCompose

• Mensagem

O modo de leitura da mensagem office.context.mailbox.item.

Importante:

• Este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

• Ao chamar Office.context.mailbox.item uma mensagem, tenha em atenção que o Painel de Leitura no cliente do Outlook tem de estar ativado. Para obter orientações sobre como configurar o Painel de Leitura, consulte Utilizar e configurar o Painel de Leitura para pré-visualizar mensagens.

Interfaces principais:

• ItemRead

• Mensagem

A definição da ação para uma mensagem de notificação.

Uma matriz de objetos NotificationMessageDetails é retornada pelo método NotificationMessages.getAllAsync.

O objeto NotificationMessages é retornado como a propriedade notificationMessages de um item.

Fornece o tema atualizado do Office que levantou o Office.EventType.OfficeThemeChanged evento.

Representa o organizador do compromisso, mesmo que tenha sido utilizado um alias ou um delegado para criar o compromisso. Este objeto fornece um método para obter o valor de organizador de um compromisso num suplemento do Outlook.

Representa um número de telefone identificado em um item. Somente modo de leitura.

Uma matriz de PhoneNumber objetos que contém os números de telefone encontrados numa mensagem de e-mail é devolvida na phoneNumbers propriedade do Entities objeto que é devolvido quando chama o getEntities método no item selecionado.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram descontinuados. No entanto, as regras de expressão regulares continuam a ser suportadas. Recomendamos que atualize o suplemento contextual para utilizar regras de expressão regulares como uma solução alternativa. Para obter orientações sobre como implementar estas regras, veja Suplementos contextuais do Outlook.

Representa os destinatários de um item. Somente modo de redação.

Fornece alterações status de campos de destinatários quando o Office.EventType.RecipientsChanged evento é gerado.

Representa o RecipientsChangedEventArgs.changedRecipientFields objeto .

O Recurrence objeto fornece métodos para obter e definir o padrão de periodicidade dos compromissos, mas apenas obtém o padrão de periodicidade dos pedidos de reunião. Terá um dicionário com as seguintes chaves: seriesTime, recurrenceType, recurrencePropertiese recurrenceTimeZone (opcional).

Fornece o objeto de periodicidade atualizado que elevou o Office.EventType.RecurrenceChanged evento.

Representa as propriedades da periodicidade.

Representa o fuso horário da periodicidade.

Um ficheiro ou anexo de item. Utilizado ao apresentar um formulário de resposta.

Um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de chamada de retorno. Utilizado ao apresentar um formulário de resposta.

As configurações criadas com os métodos do objeto RoamingSettings são salvas de acordo de acordo com o suplemento e o usuário. Ou seja, só estão disponíveis para o suplemento que os criou e apenas a partir da caixa de correio do utilizador na qual são guardados.

Embora a API de suplemento do Outlook limite o acesso a estas definições apenas ao suplemento que as criou, estas definições não devem ser consideradas armazenamento seguro. Elas podem ser acessadas pelos Serviços Web do Exchange ou por MAPI estendido. Não devem ser utilizadas para armazenar informações confidenciais, como credenciais de utilizador ou tokens de segurança.

O nome de uma configuração é uma String, enquanto o valor pode ser uma String, um Number, um Boolean, nulo, um Object ou uma Array.

O objeto RoamingSettings pode ser acessado por meio da propriedade roamingSettings no namespace Office.context.

Para saber mais sobre RoamingSettingso , consulte Obter e definir metadados de suplementos para um suplemento do Outlook.

Representa as propriedades de uma mensagem que está atualmente selecionada no Outlook.

Fornece métodos para obter e definir o nível de confidencialidade de um compromisso. Para saber mais sobre os níveis de confidencialidade, consulte Marcar o seu e-mail como Normal, Pessoal, Privado ou Confidencial.

Fornece métodos para obter ou definir a etiqueta de confidencialidade de uma mensagem ou compromisso. Para obter mais informações sobre etiquetas de confidencialidade, consulte Saiba mais sobre etiquetas de confidencialidade.

Fornece a alteração status da etiqueta de confidencialidade aplicada a uma mensagem ou compromisso no modo de composição. Estas informações são fornecidas quando o Office.EventType.SensitivityLabelChanged evento é gerado.

Representa as propriedades das etiquetas de confidencialidade disponíveis no Outlook.

Fornece métodos para marcar a status do catálogo de etiquetas de confidencialidade no Outlook e obter todas as etiquetas de confidencialidade disponíveis se o catálogo estiver ativado.

O SeriesTime objeto fornece métodos para obter e definir as datas e horas dos compromissos numa série periódica e obter as datas e horas dos pedidos de reunião numa série periódica.

Fornece métodos para gerir os dados de sessão de um item.

Importante: todo o objeto SessionData está limitado a 50 000 carateres por suplemento.

Representa as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada.

Para obter mais informações sobre como este objeto é utilizado, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.

Especifica o comportamento de um suplemento De Alertas Inteligentes quando conclui o processamento de um OnMessageSend evento ou OnAppointmentSend .

Fornece informações sobre o Office.EventType.SpamReporting evento que ocorre quando uma mensagem não solicitada é comunicada.

Especifica o comportamento de um suplemento integrado de relatórios de spam depois de concluir o processamento de um evento SpamReporting .

Fornece métodos para obter e definir o assunto de um compromisso ou uma mensagem em um suplemento do Outlook.

Representa uma tarefa sugerida identificada em um item. Somente modo de leitura.

A lista de tarefas sugeridas numa mensagem de e-mail é devolvida na taskSuggestions propriedade do objeto Entidades que é devolvido quando o getEntities método ou getEntitiesByType é chamado no item ativo.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram descontinuados. No entanto, as regras de expressão regulares continuam a ser suportadas. Recomendamos que atualize o suplemento contextual para utilizar regras de expressão regulares como uma solução alternativa. Para obter orientações sobre como implementar estas regras, veja Suplementos contextuais do Outlook.

O Time objeto é devolvido como a propriedade de início ou fim de um compromisso no modo de composição.

Informações sobre o utilizador associado à caixa de correio. Isto inclui o tipo de conta, o nome a apresentar, o endereço de e-mail e o fuso horário.

Especifica o tipo de ação personalizada numa mensagem de notificação.

Especifica o nível de confidencialidade de um compromisso.

Especifica a formatação que se aplica ao conteúdo de um anexo.

Especifica se um anexo foi adicionado ou removido de um item.

Especifica o tipo do anexo.

Especifica a cor da categoria.

Especifica o tipo de composição de uma mensagem.

Especifica o dia da semana ou o tipo de dia.

Esta máscara de bits representa as permissões de um delegado numa pasta partilhada ou as permissões de um utilizador numa caixa de correio partilhada.

Especifica o tipo da entidade.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram descontinuados. No entanto, as regras de expressão regulares continuam a ser suportadas. Recomendamos que atualize o suplemento contextual para utilizar regras de expressão regulares como uma solução alternativa. Para obter orientações sobre como implementar estas regras, veja Suplementos contextuais do Outlook.

Tipos de ação suportados por Office.EventType.InfobarClicked.

Tipo de notificação permitida por Office.EventType.InfobarClicked.

Especifica o tipo de mensagem de notificação para um compromisso ou uma mensagem.

Especifica o tipo de um item.

Especifica o tipo de localização de um compromisso.

Especifica o mês.

Especifica a pasta para a qual uma mensagem de spam ou phishing reportada é movida assim que é processada por um suplemento de relatório de spam.

Para saber mais sobre a funcionalidade de spam-reporting integrada, veja Implementar um suplemento integrado de relatórios de spam.

Especifica a localização a partir da qual um suplemento quer aceder aos dados.

Representa a vista atual de Outlook na Web.

Especifica o tipo de destinatário de uma mensagem ou compromisso.

Especifica o fuso horário aplicado à periodicidade.

Especifica o tipo de periodicidade.

Especifica o tipo de resposta a um convite de reunião.

Especifica a versão da API REST que corresponde a uma ID de item formatado para REST.

Especifica a localização na qual um suplemento quer guardar dados.

Especifica a opção de modo de envio que substitui o conjunto de opções no manifesto no runtime.

Para obter informações sobre como implementar um suplemento De Alertas Inteligentes, consulte Handle OnMessageSend e OnAppointmentSend events in your Outlook add-in with Smart Alerts (Processar eventos OnMessageSend e OnAppointmentSend no seu suplemento do Outlook com Alertas Inteligentes).

Especifica a origem dos dados selecionados num item (veja Office.mailbox.item.getSelectedDataAsync para obter detalhes).

Especifica a semana do mês.