outlook package

Interfaces

Office.Appointment

A subclasse de Item que trata de compromissos.

Importante: este é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

Interfaces filho:

Office.AppointmentCompose

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

Importante: este é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

Interfaces pai:

Office.AppointmentForm

Representa os detalhes do formulário para criar um novo compromisso.

Office.AppointmentRead

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

Importante: este é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

Interfaces pai:

Office.AttachmentDetails

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

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

Office.Body

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

Office.CoercionTypeOptions

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

Office.Contact

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

A lista de contatos extraídos do corpo de uma mensagem de email ou compromisso é retornada na contacts propriedade do objeto Entities retornado pelo getEntities método ou getEntitiesByType do item atual.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram desativados. No entanto, as regras de expressão regular ainda têm suporte. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regular como uma solução alternativa. Para obter orientação sobre como implementar essas regras, consulte Suplementos contextuais do Outlook.

Office.CustomProperties

O CustomProperties objeto representa propriedades personalizadas específicas de um determinado item de email e de um suplemento do Outlook. Por exemplo, pode ser necessário um suplemento para salvar alguns dados específicos da mensagem atual que ativou o suplemento. Se o usuário revisitar a mesma mensagem no futuro e ativar o suplemento novamente, o suplemento poderá recuperar os dados que foram salvos como propriedades personalizadas.

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

Office.Diagnostics

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

Office.DragAndDropEventArgs

Fornece detalhes sobre a posição do ponteiro do mouse e as mensagens ou anexos de arquivo que estão sendo arrastados e soltos no painel de tarefas de um suplemento quando o Office.EventType.DragAndDropEvent evento é gerado.

Office.DragoverEventData

Representa o DragAndDropEventArgs.dragAndDropEventData objeto quando mensagens ou anexos de arquivo são arrastados sobre o painel de tarefas de um suplemento.

Office.DropEventData

Representa o DragAndDropEventArgs.dragAndDropEventData objeto quando mensagens ou anexos de arquivo são soltos no painel de tarefas de um suplemento.

Office.DroppedItemDetails

Fornece o conteúdo e os detalhes da mensagem ou do anexo de arquivo que está sendo arrastado e solto no painel de tarefas de um suplemento.

Office.DroppedItems

Fornece as mensagens ou anexos de arquivo que estão sendo arrastados e soltos no painel de tarefas de um suplemento.

Office.EmailAddressDetails

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

Office.EmailUser

Representa uma conta de email em um Exchange Server.

Office.Entities

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 nenhuma entidade do tipo especificado na propriedade estiver presente no item, a propriedade associada a essa entidade será nula. Por exemplo, se uma mensagem contiver um endereço e um número de telefone, as propriedades addresses e phoneNumbers conterão informações e as outras propriedades serão 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 propriedade são retornadas getEntitiesByType pelo método, somente 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 desativados. No entanto, as regras de expressão regular ainda têm suporte. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regular como uma solução alternativa. Para obter orientação sobre como implementar essas regras, consulte Suplementos contextuais do Outlook.

Office.Item

O namespace do item é usado para acessar a mensagem, a solicitação de reunião ou o compromisso selecionado no momento. Você pode determinar o tipo do item usando a itemType propriedade.

Se você quiser ver o IntelliSense apenas para um tipo ou modo específico, converta esse item em um dos seguintes:

Office.ItemCompose

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

Importante: este é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

Interfaces filho:

Office.ItemRead

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

Importante: este é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

Interfaces filho:

Office.LocalClientTime

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

Office.Location

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

Office.Mailbox

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

Propriedades principais:

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

  • item : fornece métodos e propriedades para acessar uma mensagem ou compromisso em um suplemento do Outlook.

  • userProfile : fornece informações sobre o usuário em um suplemento do Outlook.

Office.MeetingSuggestion

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

A lista de reuniões sugeridas em uma mensagem de email é retornada na meetingSuggestions propriedade do Entities objeto que é retornado quando o getEntities método ou getEntitiesByType é chamado no item ativo.

Os valores inicial e final são representações de cadeia de caracteres de um Date objeto que contém a data e a 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 desativados. No entanto, as regras de expressão regular ainda têm suporte. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regular como uma solução alternativa. Para obter orientação sobre como implementar essas regras, consulte Suplementos contextuais do Outlook.

Office.Message

Uma subclasse de Item para mensagens.

Importante: este é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

Interfaces filho:

Office.MessageCompose

O modo de redação de mensagem de Office.context.mailbox.item.

Importante:

  • Esse é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

  • Ao chamar Office.context.mailbox.item uma mensagem, observe que o Painel de Leitura no cliente Outlook deve estar ativado. Para obter orientações sobre como configurar o Painel de Leitura, confira Usar e configurar o Painel de Leitura para visualizar mensagens.

Interfaces pai:

Office.MessageRead

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

Importante:

  • Esse é um objeto interno do Outlook, não exposto diretamente por meio de interfaces existentes. Você deve tratar isso como um modo de Office.context.mailbox.item. Para obter mais informações, consulte Modelo de objeto do Item do Outlook.

  • Ao chamar Office.context.mailbox.item uma mensagem, observe que o Painel de Leitura no cliente Outlook deve estar ativado. Para obter orientações sobre como configurar o Painel de Leitura, confira Usar e configurar o Painel de Leitura para visualizar mensagens.

Interfaces pai:

Office.NotificationMessageDetails

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

Office.NotificationMessages

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

Office.PhoneNumber

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

Uma matriz de objetos contendo os números de telefone encontrados em uma mensagem de PhoneNumber email é retornada na phoneNumbers propriedade do Entities objeto retornado quando você chama o getEntities método no item selecionado.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram desativados. No entanto, as regras de expressão regular ainda têm suporte. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regular como uma solução alternativa. Para obter orientação sobre como implementar essas regras, consulte Suplementos contextuais do Outlook.

Office.Recipients

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

Office.ReplyFormAttachment

Um anexo de arquivo ou item. Usado ao exibir um formulário de resposta.

Office.ReplyFormData

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

Office.RoamingSettings

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, eles estão disponíveis apenas para o suplemento que os criou e somente na caixa de correio do usuário em que estão salvos.

Embora a API do suplemento do Outlook limite o acesso a essas configurações somente ao suplemento que as criou, essas configurações não devem ser consideradas armazenamento seguro. Elas podem ser acessadas pelos Serviços Web do Exchange ou por MAPI estendido. Eles não devem ser usados para armazenar informações confidenciais, como credenciais de usuário 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 RoamingSettings, consulte Obter e definir metadados de suplemento para um suplemento do Outlook.

Office.Subject

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

Office.TaskSuggestion

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

A lista de tarefas sugeridas em uma mensagem de email é retornada na taskSuggestions propriedade do objeto Entities retornado quando o getEntities método ou getEntitiesByType é chamado no item ativo.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram desativados. No entanto, as regras de expressão regular ainda têm suporte. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regular como uma solução alternativa. Para obter orientação sobre como implementar essas regras, consulte Suplementos contextuais do Outlook.

Office.Time

O Time objeto é retornado como a propriedade start ou end de um compromisso no modo de redação.

Office.UserProfile

Informações sobre o usuário associado à caixa de correio. Isso inclui o tipo de conta, nome de exibição, endereço de email e fuso horário.

Enumerações

Office.MailboxEnums.AttachmentType

Especifica o tipo do anexo.

Office.MailboxEnums.BodyMode

Especifica a parte do corpo de uma mensagem exibida para respostas a um tópico de conversa com mais de uma mensagem.

Office.MailboxEnums.EntityType

Especifica o tipo da entidade.

Aviso: os suplementos contextuais do Outlook baseados em entidades foram desativados. No entanto, as regras de expressão regular ainda têm suporte. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regular como uma solução alternativa. Para obter orientação sobre como implementar essas regras, consulte Suplementos contextuais do Outlook.

Office.MailboxEnums.ItemNotificationMessageType

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

Office.MailboxEnums.ItemType

Especifica o tipo de um item.

Office.MailboxEnums.OpenLocation

Especifica o local do qual um suplemento deseja acessar os dados.

Office.MailboxEnums.OWAView

Representa a exibição atual do Outlook na Web.

Office.MailboxEnums.RecipientType

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

Office.MailboxEnums.ResponseType

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

Office.MailboxEnums.RestVersion

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

Office.MailboxEnums.SaveLocation

Especifica o local no qual um suplemento deseja salvar os dados.

Office.MailboxEnums.SourceProperty

Especifica a origem dos dados selecionados em um item (consulte Office.mailbox.item.getSelectedDataAsync para obter detalhes).