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 a página Modelo de Objeto .

Interfaces filho:

Office.AppointmentCompose

O modo organizador de compromissos do 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 a página Modelo de Objeto .

Interfaces pai:

Office.AppointmentForm

O AppointmentForm objeto é usado para acessar o compromisso selecionado no momento.

Office.AppointmentRead

O modo de participante de compromisso do 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 a página Modelo de Objeto .

Interfaces pai:

Office.AttachmentDetails

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

Uma matriz de AttachmentDetails objetos é retornada como a propriedade anexos de um item de compromisso ou 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 cartão comercial) extraído 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 Entidades retornado pelo getEntities método ou getEntitiesByType do item atual.

Office.CustomProperties

O CustomProperties objeto representa propriedades personalizadas específicas para um determinado item de email e específicas para um suplemento do Outlook. Por exemplo, pode haver a necessidade de 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 salvos como propriedades personalizadas.

Para saber mais sobre CustomProperties, confira 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.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.

EmailUser os objetos são recebidos principalmente nas entidades MeetingSuggestion e TaskSuggestion extraídas de um item do Outlook. Para saber mais sobre esse cenário, consulte Extrair cadeias de caracteres de entidade de um item do Outlook.

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 especificada na propriedade estiver presente no item, a propriedade associada a essa entidade será nula. Por exemplo, se uma mensagem contiver um endereço de rua e um número de telefone, a propriedade 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 pelo getEntitiesByType método, apenas a propriedade da entidade especificada contém dados; todas as outras propriedades são nulas.

Office.Item

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

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

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

Office.ItemCompose

O modo de composição do 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 a página Modelo de Objeto .

Interfaces filho:

Office.ItemRead

O modo de leitura do 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 a página Modelo de Objeto .

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 de suplemento do Microsoft Outlook.

Propriedades principais:

  • diagnostics: fornece informações de diagnóstico para 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 propriedade meetingSuggestions do objeto Entities, que é retornado quando os métodos getEntities ou getEntitiesByType são chamados 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.

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 a página Modelo de Objeto .

Interfaces filho:

Office.MessageCompose

O modo de composição de mensagem do 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 a página Modelo de Objeto .

Interfaces pai:

Office.MessageRead

O modo de leitura da mensagem do 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 a página Modelo de Objeto .

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 PhoneNumber que contém os números de telefone encontrados em uma mensagem de email é retornada na propriedade phoneNumbers do objeto Entities, que é retornado ao chamar o método getEntities no item selecionado.

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 da caixa de correio do usuário na qual eles são salvos.

Embora a API de suplemento do Outlook limite o acesso a essas configurações apenas para o 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, confira Obter e definir metadados de suplemento para um suplemento do Outlook.

Office.SmartAlertsEventCompletedOptions

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

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 Entidades que é retornada quando o getEntities método ou getEntitiesByType é chamado no item ativo.

Office.Time

O Time objeto é retornado como a propriedade inicial ou final de um compromisso no modo de composição.

Office.UserProfile

Informações sobre o usuário associado à caixa de correio. Isso inclui seu 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.EntityType

Especifica o tipo da entidade.

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.OWAView

Representa a exibição atual de 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.SourceProperty

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