Office.AppointmentRead interface

Pacote:

outlook

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:

• ItemRead

• Compromisso

Extends

Office.Appointment

Propriedades

attachments	Obtém os anexos do item como uma matriz.
body	Obtém um objeto que fornece métodos para manipular o corpo de um item.
categories	Obtém um objeto que fornece métodos para gerenciar as categorias do item.
dateTimeCreated	Obtém a data e a hora em que um item foi criado.
dateTimeModified	Obtém a data e a hora em que um item foi alterado pela última vez.
end	Obtém a data e a hora que o compromisso deve terminar. A end propriedade é um Date objeto expresso como um valor de data e hora do UTC (Tempo Universal Coordenado). Você pode usar o convertToLocalClientTime método para converter o valor da end propriedade na data e hora local do cliente. Ao usar o método Time.setAsync para definir a hora de término, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor.
enhancedLocation	Obtém os locais de um compromisso. A enhancedLocation propriedade retorna um objeto EnhancedLocation que permite que você obtenha o conjunto de locais (cada um representado por um objeto LocationDetails ) associado ao compromisso.
isAllDayEvent	Retorna um valor booliano que indica se o evento é o dia todo.
itemClass	Obtém a classe de item do Exchange Web Services do compromisso selecionado. Retorna IPM.Appointment para compromissos não recorrentes e IPM.Appointment.Occurrence para compromissos recorrentes.
itemId	Obtém o identificador de item do Exchange Web Services para o item atual. A propriedade itemId não está disponível no modo de redação. Se for obrigatório o identificador de um item, pode ser usado o método saveAsync para salvar o item no servidor, o que retornará o identificador do item no parâmetro asyncResult.value na função de retorno de chamada. Observação: o identificador retornado pela itemId propriedade é o mesmo que o identificador de item do Exchange Web Services. A propriedade itemId não é idêntica à ID de Entrada do Outlook ou a ID usada pela API REST do Outlook. Antes de fazer chamadas de API REST usando esse valor, ela deve ser convertida usando Office.context.mailbox.convertToRestId. Para obter mais detalhes, confira Usar as APIs REST do Outlook de um suplemento do Outlook.
itemType	Obtém o tipo de item que representa uma instância. A itemType propriedade retorna um dos valores de ItemType enumeração, indicando se a instância do objeto de item é uma mensagem ou um compromisso.
location	Obtém o local de um compromisso. A propriedade location retorna uma cadeia de caracteres que contém o local do compromisso.
normalizedSubject	Obtém o assunto de um item, com todos os prefixos removidos (incluindo RE: e FWD:). A normalizedSubject propriedade obtém o assunto do item, com quaisquer prefixos padrão (como RE: e FW:) que são adicionados por programas de email. Para obter o assunto do item com os prefixos intactos, use a propriedade subject.
notificationMessages	Obtém as mensagens de notificação de um item.
optionalAttendees	Fornece acesso aos participantes opcionais de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual. A optionalAttendees propriedade retorna uma matriz que contém um objeto EmailAddressDetails para cada participante opcional na reunião. O número máximo de participantes retornados varia de acordo com o cliente do Outlook. Windows: 500 participantes Android, interface do usuário clássica do Mac, iOS: 100 participantes Nova interface do usuário do Mac, navegador da Web: sem limite
organizer	Obtém as propriedades de email do organizador da reunião.
recurrence	Obtém o padrão de recorrência de um compromisso. Obtém o padrão de recorrência de uma solicitação de reunião. A recurrence propriedade retorna um objeto Recorrência para compromissos recorrentes ou solicitações de reuniões se um item for uma série ou uma instância em uma série. null é retornado para compromissos únicos e solicitações de reunião de compromissos únicos. Observação: as solicitações de reunião têm um itemClass valor de IPM.Schedule.Meeting.Request. Observação: se o objeto de recorrência for nulo, isso indica que o objeto é um único compromisso ou uma solicitação de reunião de um único compromisso e NÃO uma parte de uma série.
requiredAttendees	Fornece acesso aos participantes obrigatórios de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual. A requiredAttendees propriedade retorna uma matriz que contém um objeto EmailAddressDetails para cada participante necessário para a reunião. O número máximo de participantes retornados varia de acordo com o cliente do Outlook. Windows: 500 participantes Android, interface do usuário clássica do Mac, iOS: 100 participantes Nova interface do usuário do Mac, navegador da Web: sem limite
sensitivity	Fornece o valor de confidencialidade do compromisso.
seriesId	Obtém a ID da série à qual uma instância pertence. Em Outlook na Web e clientes de área de trabalho, o seriesId retorna a ID dos Serviços Web do Exchange (EWS) do item pai (série) ao qual esse item pertence. No entanto, no iOS e no Android, o seriesId retorna a ID REST do item pai. Observação: o identificador retornado pela seriesId propriedade é o mesmo que o identificador de item do Exchange Web Services. A seriesId propriedade não é idêntica às IDs do Outlook usadas pela API REST do Outlook. Antes de fazer chamadas de API REST usando esse valor, ela deve ser convertida usando Office.context.mailbox.convertToRestId. Para obter mais detalhes, confira Usar as APIs REST do Outlook de um suplemento do Outlook. A seriesId propriedade retorna null para itens que não têm itens pai, como compromissos individuais, itens de série ou solicitações de reunião e retorna undefined para quaisquer outros itens que não sejam solicitações de reunião.
start	Obtém a data e a hora que o compromisso deve começar. A start propriedade é um Date objeto expresso como um valor de data e hora do UTC (Tempo Universal Coordenado). Você pode usar o convertToLocalClientTime método para converter o valor na data e hora local do cliente.
subject	Obtém a descrição que aparece no campo assunto de um item. A propriedade subject obtém ou define o assunto completo do item, conforme enviado pelo servidor de email. A propriedade subject retorna uma cadeia de caracteres. Use a normalizedSubject propriedade para obter o assunto menos todos os prefixos principais, como RE: e FW:.

Métodos

addHandlerAsync(eventType, handler, options, callback)	Adiciona um manipulador de eventos a um evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.
addHandlerAsync(eventType, handler, callback)	Adiciona um manipulador de eventos a um evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.
displayReplyAllForm(formData)	Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes do compromisso selecionado.
displayReplyAllFormAsync(formData, options, callback)	Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes do compromisso selecionado. Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna. Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyAllFormAsync gera uma exceção. Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada. Observação: esse método não tem suporte no Outlook no iOS ou android.
displayReplyAllFormAsync(formData, callback)	Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes do compromisso selecionado. Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna. Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyAllFormAsync gera uma exceção. Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada. Observação: esse método não tem suporte no Outlook no iOS ou android.
displayReplyForm(formData)	Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.
displayReplyFormAsync(formData, options, callback)	Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado. Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna. Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyFormAsync gera uma exceção. Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada. Observação: esse método não tem suporte no Outlook no iOS ou android.
displayReplyFormAsync(formData, callback)	Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado. Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna. Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyFormAsync gera uma exceção. Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada. Observação: esse método não tem suporte no Outlook no iOS ou android.
getAttachmentContentAsync(attachmentId, options, callback)	Obtém um anexo de uma mensagem ou compromisso e retorna-o como um AttachmentContent objeto. O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como prática recomendada, você deve obter o identificador do anexo de uma chamada item.anexos e, na mesma sessão, usar esse identificador para recuperar o anexo. No Outlook na Web e em dispositivos móveis, a identificador do anexo é válido apenas durante a mesma sessão. Uma sessão acaba quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, posteriormente, aparece o formulário para continuar em uma janela separada.
getAttachmentContentAsync(attachmentId, callback)	Obtém um anexo de uma mensagem ou compromisso e retorna-o como um AttachmentContent objeto. O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como prática recomendada, você deve obter o identificador do anexo de uma chamada item.anexos e, na mesma sessão, usar esse identificador para recuperar o anexo. No Outlook na Web e em dispositivos móveis, a identificador do anexo é válido apenas durante a mesma sessão. Uma sessão acaba quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, posteriormente, aparece o formulário para continuar em uma janela separada.
getEntities()	Obtém as entidades encontradas no corpo do item selecionado.
getEntitiesByType(entityType)	Obtém uma matriz de todas as entidades do tipo de entidade especificado encontradas no corpo do item selecionado.
getFilteredEntitiesByName(name)	Retorna entidades conhecidas no item selecionado que passa o filtro nomeado definido em um arquivo de manifesto XML.
getInitializationContextAsync(options, callback)	Obtém dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
getInitializationContextAsync(callback)	Obtém dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
getRegExMatches()	Retorna valores de cadeia de caracteres no item selecionado que correspondem às expressões regulares definidas em um arquivo de manifesto XML.
getRegExMatchesByName(name)	Retorna valores de cadeia de caracteres no item selecionado que correspondem à expressão regular nomeada definida em um arquivo de manifesto XML.
getSelectedEntities()	Obtém as entidades encontradas em uma correspondência realçada que um usuário selecionou. As correspondências realçadas aplicam-se aos suplementos contextuais.
getSelectedRegExMatches()	Retorna valores de cadeia de caracteres em uma correspondência realçada que correspondem às expressões regulares definidas em um arquivo de manifesto XML. As correspondências realçadas aplicam-se aos suplementos contextuais.
getSharedPropertiesAsync(options, callback)	Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. Para obter mais informações sobre como usar essa API, consulte Habilitar pastas compartilhadas e cenários de caixa de correio compartilhada em um suplemento do Outlook.
getSharedPropertiesAsync(callback)	Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. Para obter mais informações sobre como usar essa API, consulte Habilitar pastas compartilhadas e cenários de caixa de correio compartilhada em um suplemento do Outlook.
loadCustomPropertiesAsync(callback, userContext)	Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado. As propriedades personalizadas são armazenadas como pares de valor-chave por aplicativo, por item. Esse método retorna um objeto CustomProperties no retorno de chamada, que fornece métodos para acessar as propriedades personalizadas específicas do item atual e do suplemento atual. As propriedades personalizadas não são criptografadas no item, portanto, isso não deve ser usado como armazenamento seguro. As propriedades personalizadas são fornecidas como um objeto CustomProperties na propriedade asyncResult.value. Esse objeto pode ser usado para obter, definir, salvar e remover propriedades personalizadas do item de email.
removeHandlerAsync(eventType, options, callback)	Remove um manipulador de eventos para um tipo de evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.
removeHandlerAsync(eventType, callback)	Remove um manipulador de eventos para um tipo de evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.

Detalhes da propriedade

attachments

Obtém os anexos do item como uma matriz.

attachments: AttachmentDetails[];

Valor da propriedade

Office.AttachmentDetails[]

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Observação: determinados tipos de arquivos são bloqueados pelo Outlook devido a possíveis problemas de segurança e, portanto, não são retornados. Para obter mais informações, confira Anexos bloqueados no Outlook.

Exemplos

// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";

if (item.attachments.length > 0) {
    for (let i = 0 ; i < item.attachments.length ; i++) {
        const attachment = item.attachments[i];
        outputString += "<BR>" + i + ". Name: ";
        outputString += attachment.name;
        outputString += "<BR>ID: " + attachment.id;
        outputString += "<BR>contentType: " + attachment.contentType;
        outputString += "<BR>size: " + attachment.size;
        outputString += "<BR>attachmentType: " + attachment.attachmentType;
        outputString += "<BR>isInline: " + attachment.isInline;
    }
}

console.log(outputString);

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml

const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);

body

Obtém um objeto que fornece métodos para manipular o corpo de um item.

body: Body;

Valor da propriedade

Office.Body

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

categories

Obtém um objeto que fornece métodos para gerenciar as categorias do item.

categories: Categories;

Valor da propriedade

Office.Categories

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

dateTimeCreated

Obtém a data e a hora em que um item foi criado.

dateTimeCreated: Date;

Valor da propriedade

Date

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

Obtém a data e a hora em que um item foi alterado pela última vez.

dateTimeModified: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante: essa propriedade não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

end

Obtém a data e a hora que o compromisso deve terminar.

A end propriedade é um Date objeto expresso como um valor de data e hora do UTC (Tempo Universal Coordenado). Você pode usar o convertToLocalClientTime método para converter o valor da end propriedade na data e hora local do cliente.

Ao usar o método Time.setAsync para definir a hora de término, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor.

end: Date;

Valor da propriedade

Date

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml

console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);

enhancedLocation

Obtém os locais de um compromisso.

A enhancedLocation propriedade retorna um objeto EnhancedLocation que permite que você obtenha o conjunto de locais (cada um representado por um objeto LocationDetails ) associado ao compromisso.

enhancedLocation: EnhancedLocation;

Valor da propriedade

Office.EnhancedLocation

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

isAllDayEvent

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna um valor booliano que indica se o evento é o dia todo.

isAllDayEvent: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

const isAllDayEvent = Office.context.mailbox.item.isAllDayEvent;
console.log("Is this an all-day event? " + isAllDayEvent);

itemClass

Obtém a classe de item do Exchange Web Services do compromisso selecionado.

Retorna IPM.Appointment para compromissos não recorrentes e IPM.Appointment.Occurrence para compromissos recorrentes.

itemClass: string;

Valor da propriedade

string

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante: você pode criar classes personalizadas que estendem uma classe de item padrão. Por exemplo, IPM.Appointment.Contoso.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Obtém o identificador de item do Exchange Web Services para o item atual.

A propriedade itemId não está disponível no modo de redação. Se for obrigatório o identificador de um item, pode ser usado o método saveAsync para salvar o item no servidor, o que retornará o identificador do item no parâmetro asyncResult.value na função de retorno de chamada.

Observação: o identificador retornado pela itemId propriedade é o mesmo que o identificador de item do Exchange Web Services. A propriedade itemId não é idêntica à ID de Entrada do Outlook ou a ID usada pela API REST do Outlook. Antes de fazer chamadas de API REST usando esse valor, ela deve ser convertida usando Office.context.mailbox.convertToRestId. Para obter mais detalhes, confira Usar as APIs REST do Outlook de um suplemento do Outlook.

itemId: string;

Valor da propriedade

string

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

itemType

Obtém o tipo de item que representa uma instância.

A itemType propriedade retorna um dos valores de ItemType enumeração, indicando se a instância do objeto de item é uma mensagem ou um compromisso.

itemType: MailboxEnums.ItemType | string;

Valor da propriedade

Office.MailboxEnums.ItemType | string

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

location

Obtém o local de um compromisso.

A propriedade location retorna uma cadeia de caracteres que contém o local do compromisso.

location: string;

Valor da propriedade

string

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

const location = Office.context.mailbox.item.location;
console.log("location: " + location);

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

Obtém o assunto de um item, com todos os prefixos removidos (incluindo RE: e FWD:).

A normalizedSubject propriedade obtém o assunto do item, com quaisquer prefixos padrão (como RE: e FW:) que são adicionados por programas de email. Para obter o assunto do item com os prefixos intactos, use a propriedade subject.

normalizedSubject: string;

Valor da propriedade

string

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

notificationMessages

Obtém as mensagens de notificação de um item.

notificationMessages: NotificationMessages;

Valor da propriedade

Office.NotificationMessages

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

optionalAttendees

Fornece acesso aos participantes opcionais de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual.

A optionalAttendees propriedade retorna uma matriz que contém um objeto EmailAddressDetails para cada participante opcional na reunião. O número máximo de participantes retornados varia de acordo com o cliente do Outlook.

• Windows: 500 participantes

• Android, interface do usuário clássica do Mac, iOS: 100 participantes

• Nova interface do usuário do Mac, navegador da Web: sem limite

optionalAttendees: EmailAddressDetails[];

Valor da propriedade

Office.EmailAddressDetails[]

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-optional-attendees-appointment-attendee.yaml

const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;
console.log("Optional attendees:");
for (let i = 0; i < apptOptionalAttendees.length; i++) {
  console.log(
    apptOptionalAttendees[i].displayName +
      " (" +
      apptOptionalAttendees[i].emailAddress +
      ") - response: " +
      apptOptionalAttendees[i].appointmentResponse
  );
}

organizer

Obtém as propriedades de email do organizador da reunião.

organizer: EmailAddressDetails;

Valor da propriedade

Office.EmailAddressDetails

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-attendee.yaml

const apptOrganizer = Office.context.mailbox.item.organizer;
console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");

recurrence

Obtém o padrão de recorrência de um compromisso. Obtém o padrão de recorrência de uma solicitação de reunião.

A recurrence propriedade retorna um objeto Recorrência para compromissos recorrentes ou solicitações de reuniões se um item for uma série ou uma instância em uma série. null é retornado para compromissos únicos e solicitações de reunião de compromissos únicos.

Observação: as solicitações de reunião têm um itemClass valor de IPM.Schedule.Meeting.Request.

Observação: se o objeto de recorrência for nulo, isso indica que o objeto é um único compromisso ou uma solicitação de reunião de um único compromisso e NÃO uma parte de uma série.

recurrence: Recurrence;

Valor da propriedade

Office.Recurrence

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml

const recurrence = Office.context.mailbox.item.recurrence;

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

requiredAttendees

Fornece acesso aos participantes obrigatórios de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual.

A requiredAttendees propriedade retorna uma matriz que contém um objeto EmailAddressDetails para cada participante necessário para a reunião. O número máximo de participantes retornados varia de acordo com o cliente do Outlook.

• Windows: 500 participantes

• Android, interface do usuário clássica do Mac, iOS: 100 participantes

• Nova interface do usuário do Mac, navegador da Web: sem limite

requiredAttendees: EmailAddressDetails[];

Valor da propriedade

Office.EmailAddressDetails[]

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-required-attendees-appointment-attendee.yaml

const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("Required attendees:");
for (let i = 0; i < apptRequiredAttendees.length; i++) {
  console.log(
    apptRequiredAttendees[i].displayName +
      " (" +
      apptRequiredAttendees[i].emailAddress +
      ") - response: " +
      apptRequiredAttendees[i].appointmentResponse
  );
}

sensitivity

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Fornece o valor de confidencialidade do compromisso.

sensitivity: MailboxEnums.AppointmentSensitivityType;

Valor da propriedade

Office.MailboxEnums.AppointmentSensitivityType

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante: o Outlook no Mac, Outlook na Web e o novo Outlook no Windows (versão prévia) só dão suporte a níveis de confidencialidade normais e privados.

Exemplos

const sensitivity = Office.context.mailbox.item.sensitivity;
console.log("Sensitivity: " + sensitivity);

seriesId

Obtém a ID da série à qual uma instância pertence.

Em Outlook na Web e clientes de área de trabalho, o seriesId retorna a ID dos Serviços Web do Exchange (EWS) do item pai (série) ao qual esse item pertence. No entanto, no iOS e no Android, o seriesId retorna a ID REST do item pai.

Observação: o identificador retornado pela seriesId propriedade é o mesmo que o identificador de item do Exchange Web Services. A seriesId propriedade não é idêntica às IDs do Outlook usadas pela API REST do Outlook. Antes de fazer chamadas de API REST usando esse valor, ela deve ser convertida usando Office.context.mailbox.convertToRestId. Para obter mais detalhes, confira Usar as APIs REST do Outlook de um suplemento do Outlook.

A seriesId propriedade retorna null para itens que não têm itens pai, como compromissos individuais, itens de série ou solicitações de reunião e retorna undefined para quaisquer outros itens que não sejam solicitações de reunião.

seriesId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

start

Obtém a data e a hora que o compromisso deve começar.

A start propriedade é um Date objeto expresso como um valor de data e hora do UTC (Tempo Universal Coordenado). Você pode usar o convertToLocalClientTime método para converter o valor na data e hora local do cliente.

start: Date;

Valor da propriedade

Date

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml

console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);

subject

Obtém a descrição que aparece no campo assunto de um item.

A propriedade subject obtém ou define o assunto completo do item, conforme enviado pelo servidor de email.

A propriedade subject retorna uma cadeia de caracteres. Use a normalizedSubject propriedade para obter o assunto menos todos os prefixos principais, como RE: e FW:.

subject: string;

Valor da propriedade

string

Comentários

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-subject-read.yaml

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

Detalhes do método

addHandlerAsync(eventType, handler, options, callback)

Adiciona um manipulador de eventos a um evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve invocar o manipulador.

handler

any

A função para manipular o evento. A função deve aceitar um parâmetro exclusivo, que é um objeto literal. A type propriedade no parâmetro corresponderá ao eventType parâmetro passado para addHandlerAsync.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Adiciona um manipulador de eventos a um evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve invocar o manipulador.

handler

any

A função para manipular o evento. A função deve aceitar um parâmetro exclusivo, que é um objeto literal. A type propriedade no parâmetro corresponderá ao eventType parâmetro passado para addHandlerAsync.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

displayReplyAllForm(formData)

Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes do compromisso selecionado.

displayReplyAllForm(formData: string | ReplyFormData): void;

Parâmetros

formData

string | Office.ReplyFormData

Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta. A cadeia de caracteres é limitada a 32 KB OU um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de retorno de chamada.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna.

• Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyForm gera uma exceção.

• Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada.

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

displayReplyAllFormAsync(formData, options, callback)

Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes do compromisso selecionado.

Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna.

Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyAllFormAsync gera uma exceção.

Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada.

Observação: esse método não tem suporte no Outlook no iOS ou android.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

formData

string | Office.ReplyFormData

Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta. A cadeia de caracteres é limitada a 32 KB OU um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de retorno de chamada.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.9 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

displayReplyAllFormAsync(formData, callback)

Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes do compromisso selecionado.

Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna.

Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyAllFormAsync gera uma exceção.

Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada.

Observação: esse método não tem suporte no Outlook no iOS ou android.

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

formData

string | Office.ReplyFormData

Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta. A cadeia de caracteres é limitada a 32 KB OU um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.9 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

displayReplyForm(formData)

Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.

displayReplyForm(formData: string | ReplyFormData): void;

Parâmetros

formData

string | Office.ReplyFormData

Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta. A cadeia de caracteres é limitada a 32 KB OU um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de retorno de chamada.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna.

• Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyForm gera uma exceção.

• Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada.

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// The following code passes a string to the `displayReplyForm` method.
Office.context.mailbox.item.displayReplyForm('hello there');
Office.context.mailbox.item.displayReplyForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  options: { asyncContext: null },
  callback: function(result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Action failed with message ${result.error.message}`);
    }
  }
});

displayReplyFormAsync(formData, options, callback)

Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.

Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna.

Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyFormAsync gera uma exceção.

Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada.

Observação: esse método não tem suporte no Outlook no iOS ou android.

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

formData

string | Office.ReplyFormData

Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta. A cadeia de caracteres é limitada a 32 KB OU um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de retorno de chamada.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.9 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// The async version is only available starting with requirement set 1.9,
// and provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  function(asyncResult) {
    console.log(JSON.stringify(asyncResult));
  }
);

displayReplyFormAsync(formData, callback)

Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.

Em Outlook na Web, o formulário de resposta é exibido como um formulário pop-out na exibição de 3 colunas e um formulário pop-up na exibição de 2 colunas ou 1 coluna.

Se qualquer dos parâmetros da cadeia de caracteres exceder seu limite, displayReplyFormAsync gera uma exceção.

Quando os anexos são especificados no parâmetro, o formData.attachments Outlook tenta baixar todos os anexos e anexá-los ao formulário de resposta. Se a adição de anexos falhar, será exibido um erro na interface de usuário do formulário. Se isso não for possível, nenhuma mensagem de erro será apresentada.

Observação: esse método não tem suporte no Outlook no iOS ou android.

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

formData

string | Office.ReplyFormData

Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta. A cadeia de caracteres é limitada a 32 KB OU um objeto ReplyFormData que contém dados de corpo ou anexo e uma função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.9 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

getAttachmentContentAsync(attachmentId, options, callback)

Obtém um anexo de uma mensagem ou compromisso e retorna-o como um AttachmentContent objeto.

O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como prática recomendada, você deve obter o identificador do anexo de uma chamada item.anexos e, na mesma sessão, usar esse identificador para recuperar o anexo. No Outlook na Web e em dispositivos móveis, a identificador do anexo é válido apenas durante a mesma sessão. Uma sessão acaba quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, posteriormente, aparece o formulário para continuar em uma janela separada.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parâmetros

attachmentId

string

O identificador do anexo que você deseja obter.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Erros:

• AttachmentTypeNotSupported: não há suporte para o tipo de anexo. Tipos sem suporte incluem imagens inseridas no Formato de Texto Rico ou tipos de anexo de item que não sejam itens de email ou calendário (como um item de contato ou tarefa).

• InvalidAttachmentId: o identificador de anexo não existe.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in read mode.
// The item.attachments call can only be used in read mode.
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

for (let i = 0; i < attachments.length; i++) {
  // Log the attachment type and its contents to the console.
  item.getAttachmentContentAsync(attachments[i].id, handleAttachmentsCallback);
}

getAttachmentContentAsync(attachmentId, callback)

Obtém um anexo de uma mensagem ou compromisso e retorna-o como um AttachmentContent objeto.

O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como prática recomendada, você deve obter o identificador do anexo de uma chamada item.anexos e, na mesma sessão, usar esse identificador para recuperar o anexo. No Outlook na Web e em dispositivos móveis, a identificador do anexo é válido apenas durante a mesma sessão. Uma sessão acaba quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, posteriormente, aparece o formulário para continuar em uma janela separada.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parâmetros

attachmentId

string

O identificador do anexo que você deseja obter.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Erros:

• AttachmentTypeNotSupported: não há suporte para o tipo de anexo. Tipos sem suporte incluem imagens inseridas no Formato de Texto Rico ou tipos de anexo de item que não sejam itens de email ou calendário (como um item de contato ou tarefa).

• InvalidAttachmentId: o identificador de anexo não existe.

getEntities()

Obtém as entidades encontradas no corpo do item selecionado.

getEntities(): Entities;

Retornos

Office.Entities

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade, incluindo o getEntities método, serão desativados no segundo trimestre de 2024. O trabalho para aposentar esse método começará em maio e continuará até o final de junho. Após junho, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais do Outlook baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml

const entities = Office.context.mailbox.item.getEntities();
let entityTypesFound = 0;
if (entities.addresses.length > 0) {
    console.warn("physical addresses: ");
    console.log(entities.addresses);
    entityTypesFound++;
}
if (entities.contacts.length > 0) {
    console.warn("contacts: ");
    entities.contacts.forEach(function (contact) { console.log(contact.personName); })
    entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
    console.warn("email addresses: ");
    console.log(entities.emailAddresses);
    entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
    console.warn("meetings suggestions: ");
    entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
    entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
    console.warn("phone numbers: ");
    entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
    entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
    console.warn("task suggestions: ");
    entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
    entityTypesFound++;
}
if (entities.urls.length > 0) {
    console.warn("URLs: ");
    console.log(entities.urls);
    entityTypesFound++;
}
if (entityTypesFound == 0)
{
    console.log("No entities found on this item.");
}

getEntitiesByType(entityType)

Obtém uma matriz de todas as entidades do tipo de entidade especificado encontradas no corpo do item selecionado.

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parâmetros

entityType

Office.MailboxEnums.EntityType | string

Um dos valores de EntityType enumeração.

Embora o nível de permissão mínimo para usar esse método seja restrito, alguns tipos de entidade exigem o acesso do item de leitura , conforme especificado na tabela a seguir.

Valor do entityType	Tipo de objetos na matriz retornada	Nível de permissão exigido
Endereço	Cadeia de caracteres	Restricted
Contato	Contato	ReadItem
EmailAddress	Cadeia de caracteres	ReadItem
MeetingSuggestion	MeetingSuggestion	ReadItem
PhoneNumber	PhoneNumber	Restricted
TaskSuggestion	TaskSuggestion	ReadItem
URL	Cadeia de caracteres	Restricted

Retornos

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Se o valor passado em entityType não for um membro válido da enumeração EntityType, o método retorna nulo. Se nenhuma entidade do tipo especificado estiver presente no corpo do item, o método retorna uma matriz vazia. Caso contrário, o tipo de objetos na matriz retornada depende do tipo de entidade solicitado no parâmetro entityType.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade, incluindo o getEntitiesByType método, serão desativados no segundo trimestre de 2024. O trabalho para aposentar esse método começará em maio e continuará até o final de junho. Após junho, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais do Outlook baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml

console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));

getFilteredEntitiesByName(name)

Retorna entidades conhecidas no item selecionado que passa o filtro nomeado definido em um arquivo de manifesto XML.

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parâmetros

name

string

O nome do elemento de regra ItemHasKnownEntity que define o filtro a corresponder.

Retornos

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

As entidades que correspondem à expressão regular definida no ItemHasKnownEntity elemento regra no arquivo XML de manifesto com o valor do FilterName elemento especificado. Se não houver nenhum ItemHasKnownEntity elemento no manifesto com um FilterName valor de elemento que corresponda ao name parâmetro, o método retornará null. Se o name parâmetro corresponder a um ItemHasKnownEntity elemento no manifesto, mas não houver entidades no item atual que correspondam, o método retornará uma matriz vazia.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade, incluindo o getFilteredEntitiesByName método, serão desativados no segundo trimestre de 2024. O trabalho para aposentar esse método começará em maio e continuará até o final de junho. Após junho, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais do Outlook baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método é usado com o recurso de regras de ativação para suplementos do Outlook, que não é compatível com o manifesto unificado do Microsoft 365 (versão prévia).

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml

// This API would only work when you click on highlighted physical address that has the word "Way" in it.
console.log(Office.context.mailbox.item.getFilteredEntitiesByName("sampleFilterName"));

getInitializationContextAsync(options, callback)

Obtém dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Em êxito, os dados de contexto de inicialização são fornecidos como uma cadeia de caracteres (ou uma cadeia de caracteres vazia, se não houver contexto de inicialização) na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

Obtém dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Em êxito, os dados de contexto de inicialização são fornecidos como uma cadeia de caracteres (ou uma cadeia de caracteres vazia, se não houver contexto de inicialização) na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

getRegExMatches()

Retorna valores de cadeia de caracteres no item selecionado que correspondem às expressões regulares definidas em um arquivo de manifesto XML.

getRegExMatches(): any;

Retornos

any

Um objeto que contém matrizes de cadeias de caracteres que correspondem às expressões regulares definidas no arquivo XML do manifesto. O nome de cada matriz é igual ao valor correspondente do atributo RegExName da regra correspondente ItemHasRegularExpressionMatch ou do FilterName atributo da regra correspondente ItemHasKnownEntity . Para uma ItemHasRegularExpressionMatch regra, uma cadeia de caracteres correspondente deve ocorrer na propriedade do item especificado por essa regra. O tipo simples PropertyName define as propriedades compatíveis.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade serão desativados no segundo trimestre de 2024. Depois de aposentados, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método é usado com o recurso de regras de ativação para suplementos do Outlook, que não é compatível com o manifesto unificado do Microsoft 365 (versão prévia).

• Se você especificar uma ItemHasRegularExpressionMatch regra na propriedade do corpo de um item, a expressão regular deverá filtrar ainda mais o corpo e não deve tentar retornar todo o corpo do item. Usar uma expressão regular como .* para obter todo o corpo de um item nem sempre retorna os resultados esperados. Em vez disso, use o método Body.getAsync para recuperar todo o corpo.

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml

// This API would only work when you click on highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

Retorna valores de cadeia de caracteres no item selecionado que correspondem à expressão regular nomeada definida em um arquivo de manifesto XML.

getRegExMatchesByName(name: string): string[];

Parâmetros

name

string

O nome do elemento de regra ItemHasRegularExpressionMatch que define o filtro a corresponder.

Retornos

string[]

Uma matriz que contém as cadeias de caracteres que correspondem à expressão regular definida no ItemHasRegularExpressionMatch elemento de regra no arquivo XML do manifesto, com o valor do RegExName elemento especificado.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade serão desativados no segundo trimestre de 2024. Depois de aposentados, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método é usado com o recurso de regras de ativação para suplementos do Outlook, que não é compatível com o manifesto unificado do Microsoft 365 (versão prévia).

• Se você especificar uma ItemHasRegularExpressionMatch regra na propriedade do corpo de um item, a expressão regular deverá filtrar ainda mais o corpo e não deve tentar retornar todo o corpo do item. Usar uma expressão regular como .* para obter todo o corpo de um item nem sempre retorna os resultados esperados. Em vez disso, use o método Body.getAsync para recuperar todo o corpo.

• Esse método não tem suporte no Outlook no Android ou no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml

// This API would only work when you click on highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Obtém as entidades encontradas em uma correspondência realçada que um usuário selecionou. As correspondências realçadas aplicam-se aos suplementos contextuais.

getSelectedEntities(): Entities;

Retornos

Office.Entities

Comentários

[ Conjunto de API: Caixa de correio 1.6 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade, incluindo o getSelectedEntities método, serão desativados no segundo trimestre de 2024. O trabalho para aposentar esse método começará em maio e continuará até o final de junho. Após junho, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais do Outlook baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método é usado com o recurso de regras de ativação para suplementos do Outlook, que não é compatível com o manifesto unificado do Microsoft 365 (versão prévia).

• Esse método não tem suporte no Outlook no iOS ou android. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/selected.yaml

const entities = Office.context.mailbox.item.getSelectedEntities();
let entityTypesFound = 0;
if (entities.addresses.length > 0) {
    console.warn("physical addresses: ");
    console.log(entities.addresses);
    entityTypesFound++;
}
if (entities.contacts.length > 0) {
    console.warn("contacts: ");
    entities.contacts.forEach(function (contact) { console.log(contact.personName); })
    entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
    console.warn("email addresses: ");
    console.log(entities.emailAddresses);
    entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
    console.warn("meetings suggestions: ");
    entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
    entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
    console.warn("phone numbers: ");
    entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
    entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
    console.warn("task suggestions: ");
    entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
    entityTypesFound++;
}
if (entities.urls.length > 0) {
    console.warn("URLs: ");
    console.log(entities.urls);
    entityTypesFound++;
}
if (entityTypesFound == 0)
{
    console.error("Open add-in by clicking on a highlighted entity, for this API to return something useful.");
}

getSelectedRegExMatches()

Retorna valores de cadeia de caracteres em uma correspondência realçada que correspondem às expressões regulares definidas em um arquivo de manifesto XML. As correspondências realçadas aplicam-se aos suplementos contextuais.

getSelectedRegExMatches(): any;

Retornos

any

Um objeto que contém matrizes de cadeias de caracteres que correspondem às expressões regulares definidas no arquivo XML do manifesto. O nome de cada matriz é igual ao valor correspondente do atributo RegExName da regra ItemHasRegularExpressionMatch correspondente ou do atributo FilterName da regra ItemHasKnownEntity correspondente. Para uma regra ItemHasRegularExpressionMatch, uma cadeia de caracteres correspondente deve ocorrer na propriedade do item especificada por essa regra. O tipo simples PropertyName define as propriedades compatíveis.

Comentários

[ Conjunto de API: Caixa de correio 1.6 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Importante:

• Os suplementos contextuais do Outlook baseados em entidade serão desativados no segundo trimestre de 2024. Depois de aposentados, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook. Para saber mais sobre a aposentadoria de suplementos contextuais baseados em entidade, confira Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

• Esse método é usado com o recurso de regras de ativação para suplementos do Outlook, que não é compatível com o manifesto unificado do Microsoft 365 (versão prévia).

• Esse método não tem suporte no Outlook no iOS ou android. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

• Se você especificar uma ItemHasRegularExpressionMatch regra na propriedade do corpo de um item, a expressão regular deverá filtrar ainda mais o corpo e não deve tentar retornar todo o corpo do item. Usar uma expressão regular como .* para obter todo o corpo de um item nem sempre retorna os resultados esperados. Em vez disso, use o método Body.getAsync para recuperar todo o corpo.

Exemplos

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/selected.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
}
else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

getSharedPropertiesAsync(options, callback)

Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada.

Para obter mais informações sobre como usar essa API, consulte Habilitar pastas compartilhadas e cenários de caixa de correio compartilhada em um suplemento do Outlook.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A asyncResult.value propriedade fornece as propriedades do item compartilhado.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 para suporte de pasta compartilhada, Caixa de correio 1.13 para suporte de caixa de correio compartilhada ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Observação: esse método não tem suporte no Outlook no iOS ou android.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on an appointment from a shared folder.");
  return;
}

Office.context.mailbox.getCallbackTokenAsync({ isRest: true }, function(result) {
  if (result.status === Office.AsyncResultStatus.Succeeded && result.value !== "") {
    Office.context.mailbox.item.getSharedPropertiesAsync(
      {
        // Pass auth token along.
        asyncContext: result.value
      },
      function(result2) {
        let sharedProperties = result2.value;
        let delegatePermissions = sharedProperties.delegatePermissions;

        // Determine if user has the appropriate permission to do the operation.
        if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Read) != 0) {
          const ewsId = Office.context.mailbox.item.itemId;
          const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
          let rest_url =
            sharedProperties.targetRestUrl + "/v2.0/users/" + sharedProperties.targetMailbox + "/events/" + restId;

          $.ajax({
            url: rest_url,
            dataType: "json",
            headers: { Authorization: "Bearer " + result2.asyncContext }
          })
            .done(function(response) {
              console.log(response);
            })
            .fail(function(error) {
              console.error(error);
            });
        }
      }
    );
  }
});

getSharedPropertiesAsync(callback)

Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada.

Para obter mais informações sobre como usar essa API, consulte Habilitar pastas compartilhadas e cenários de caixa de correio compartilhada em um suplemento do Outlook.

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A asyncResult.value propriedade fornece as propriedades do item compartilhado.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 para suporte de pasta compartilhada, Caixa de correio 1.13 para suporte de caixa de correio compartilhada ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Observação: esse método não tem suporte no Outlook no iOS ou android.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on an item from a shared folder.");
  return;
}

Office.context.mailbox.item.getSharedPropertiesAsync(function(result) {
  console.log(result.value);
});

loadCustomPropertiesAsync(callback, userContext)

Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.

As propriedades personalizadas são armazenadas como pares de valor-chave por aplicativo, por item. Esse método retorna um objeto CustomProperties no retorno de chamada, que fornece métodos para acessar as propriedades personalizadas específicas do item atual e do suplemento atual. As propriedades personalizadas não são criptografadas no item, portanto, isso não deve ser usado como armazenamento seguro.

As propriedades personalizadas são fornecidas como um objeto CustomProperties na propriedade asyncResult.value. Esse objeto pode ser usado para obter, definir, salvar e remover propriedades personalizadas do item de email.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

userContext

any

Opcional. Os desenvolvedores podem fornecer qualquer objeto que desejarem acessar na função de retorno de chamada. Esse objeto pode ser acessado pela propriedade asyncResult.asyncContext na função de retorno de chamada.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

Exemplos

// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
        // After the DOM is loaded, add-in-specific code can run.
        const mailbox = Office.context.mailbox;
        mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
    });
};

function customPropsCallback(asyncResult) {
    const customProps = asyncResult.value;
    const myProp = customProps.get("myProp");

    customProps.set("otherProp", "value");
    customProps.saveAsync(saveCallback);
}

function saveCallback(asyncResult) {
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Loaded following custom properties:");
    customProps = result.value;
    const dataKey = Object.keys(customProps)[0];
    const data = customProps[dataKey];
    for (let propertyName in data)
    {
      let propertyValue = data[propertyName];
      console.log(`${propertyName}: ${propertyValue}`);
    }              
  }
  else {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
  }
});

removeHandlerAsync(eventType, options, callback)

Remove um manipulador de eventos para um tipo de evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve revogar o manipulador.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso

removeHandlerAsync(eventType, callback)

Remove um manipulador de eventos para um tipo de evento com suporte. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos com suporte, consulte a seção Eventos do modelo de objeto item.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve revogar o manipulador.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo Outlook aplicável: Participante de compromisso