Office. Message Compose interface

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

Modo do Outlook aplicável: Message Compose

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailBcc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

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 APIs: Caixa de correio 1.13

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

Modo do Outlook aplicável: Message Compose

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"
}

cc

Fornece acesso aos destinatários na linha Cc (com cópia) de uma mensagem. O tipo de objeto e o nível de acesso dependem do modo do item atual.

A propriedade cc retorna um objeto Recipients que fornece métodos para obter ou atualizar os destinatários na linha Cc da mensagem. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac etc.), podem ser aplicados limites de quantos destinatários você pode obter ou atualizar. Consulte o objeto Destinatários para obter mais detalhes.

cc: Recipients;

Valor da propriedade

Office.Recipients

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailCc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

conversationId

Obtém um identificador da conversa de email que contém uma mensagem específica.

Você pode obter um número inteiro para esta propriedade se o aplicativo de email estiver ativado nos formulários de leitura ou nas respostas em formulários de composição. Se, posteriormente, o usuário alterar o assunto da mensagem de resposta, ao enviar a resposta, a ID da conversa daquela mensagem será alterada e o valor obtido anteriormente não mais se aplicará.

Você obtém nulo para esta propriedade para um novo item em um formulário de composição. Se o usuário definir um assunto e salvar o item, a propriedade conversationId retornará um valor.

conversationId: string;

Valor da propriedade

string

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

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

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

delayDeliveryTime

Obtém ou define a data e a hora atrasadas da entrega de uma mensagem.

A delayDeliveryTime propriedade retorna um DelayDeliveryTime objeto que fornece métodos para gerenciar a data e a hora de entrega da mensagem.

delayDeliveryTime: DelayDeliveryTime;

Valor da propriedade

Office.DelayDeliveryTime

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

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

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}

from

Obtém o endereço de email do remetente de uma mensagem.

A from propriedade retorna um From objeto que fornece um método para obter o valor from.

from: From;

Valor da propriedade

Office.From

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: esta propriedade tem suporte no Outlook no Android e no iOS. Para obter um cenário de exemplo, consulte Implementar a ativação baseada em eventos nos suplementos móveis do Outlook.

Exemplos

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

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

inReplyTo

Obtém a ID da mensagem de Internet da mensagem original que está sendo respondida pela mensagem atual.

inReplyTo: string;

Valor da propriedade

string

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

No Outlook no Windows, o inReplyTo valor é mantido em todas as respostas, independentemente das alterações feitas pelo usuário, como alterar o assunto em uma resposta.
A inReplyTo propriedade retorna null para novas mensagens e convites de reunião encaminhados por um usuário que também é o organizador da reunião.

Exemplos

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

// This snippet gets the ID of the message being replied to by the current message (PR_IN_REPLY_TO_ID).
// The API call is supported on messages being composed and isn't supported on read items.
const inReplyTo = Office.context.mailbox.item.inReplyTo;
if (inReplyTo) {
  console.log("ID of the message being replied to: " + inReplyTo);
} else {
  console.log("No InReplyTo property available for this message");
}

internetHeaders

Obtém ou define os cabeçalhos personalizados da Internet de uma mensagem.

A internetHeaders propriedade retorna um InternetHeaders objeto que fornece métodos para gerenciar os cabeçalhos da Internet na mensagem.

Para saber mais, confira Obter e definir cabeçalhos da Internet em uma mensagem em um suplemento do Outlook.

internetHeaders: InternetHeaders;

Valor da propriedade

Office.InternetHeaders

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: a API de cabeçalhos da Internet tem suporte no Outlook no Android e no iOS a partir da versão 4.2405.0. Para saber mais sobre os recursos compatíveis com o Outlook em dispositivos móveis, confira 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/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

itemType

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

A itemType propriedade retorna um dos valores de enumeração, indicando se a instância do ItemType objeto 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: ler item

Modo do Outlook aplicável: Message Compose

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;
}

notificationMessages

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

notificationMessages: NotificationMessages;

Valor da propriedade

Office.NotificationMessages

Comentários

Conjunto de APIs: Caixa de correio 1.13

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

Modo do Outlook aplicável: Message Compose

Importante: para saber mais sobre os diferentes tipos de mensagens de notificação que você pode implementar, confira Criar notificações para seu suplemento do Outlook.

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 = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

// 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(JSON.stringify(asyncResult.value));
});

...

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
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
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

...

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

sensitivityLabel

Faz com que o objeto obtenha ou defina o rótulo de confidencialidade de uma mensagem.

sensitivityLabel: SensitivityLabel;

Valor da propriedade

Office.SensitivityLabel

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: para usar o recurso de rótulo de confidencialidade em seu suplemento, você deve ter uma assinatura do Microsoft 365 E5.

Para saber mais sobre como gerenciar rótulos de confidencialidade em seu suplemento, consulte Gerenciar o rótulo de confidencialidade de sua mensagem ou compromisso no modo de redação.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

seriesId

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

No Outlook na Web, no Windows (novo e clássico) e no Mac, o seriesId retorna a ID do EWS (Serviços Web do Exchange) 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.

seriesId: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: Caixa de correio 1.11

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

Modo do Outlook aplicável: Message Compose

Importante: O identificador retornado pela seriesId propriedade é o mesmo que o identificador de item do Serviços Web do Exchange. A seriesId propriedade não é idêntica às IDs do Outlook usadas pela API REST do Outlook. Antes de fazer chamadas à API REST usando esse valor, ele deve ser convertido usando Office.context.mailbox.convertToRestId. Para obter mais detalhes, consulte 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 únicos, itens de série ou solicitações de reunião, e retorna undefined para quaisquer outros itens que não são solicitações de reunião.

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);
}

sessionData

Gerencia os SessionData de um item no modo de Composição.

Importante: em clientes Outlook que oferecem suporte à Caixa de Correio 1.15 ou anterior, todo o objeto SessionData para cada item de email é limitado a 50.000 caracteres por suplemento. Em clientes que dão suporte à Caixa de Correio 1.16 ou posterior, o limite de caracteres por suplemento é de 2.621.440 caracteres.

sessionData: SessionData;

Valor da propriedade

Office.SessionData

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

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

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

subject

Obtém ou define a descrição que aparece no campo de 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 um objeto Subject que fornece métodos para obter e definir o assunto.

subject: Subject;

Valor da propriedade

Office.Subject

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

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

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

to

Fornece acesso aos destinatários na linha Para de uma mensagem. O tipo de objeto e o nível de acesso dependem do modo do item atual.

A propriedade to retorna um objeto Recipients que fornece métodos para obter ou atualizar os destinatários na linha Para da mensagem. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac etc.), podem ser aplicados limites de quantos destinatários você pode obter ou atualizar. Consulte o objeto Destinatários para obter mais detalhes.

to: Recipients;

Valor da propriedade

Office.Recipients

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

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

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailTo") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

addFileAttachmentAsync(uri, attachmentName, options, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O método addFileAttachmentAsync carrega o arquivo no URI especificado e anexa-o ao item no formulário de composição.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

uri: string

O URI que fornece o local do arquivo anexado à mensagem ou compromisso. O comprimento máximo é de 2048 caracteres.

attachmentName: string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

options: Office.AsyncContextOptions & { isInline: boolean }

Um literal de objeto que contém uma ou mais das seguintes propriedades: - asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejem acessar na função de retorno de chamada. isInline : Se verdadeiro, indica que o anexo será mostrado embutido como uma imagem no corpo da mensagem e não será exibido na lista de anexos.

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

Opcional. 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 caso de êxito, o identificador do anexo é fornecido na asyncResult.value propriedade. O identificador varia dependendo do cliente Outlook. No Outlook na Web e no novo Outlook no Windows, a ID do Serviços Web do Exchange (EWS) é retornada. Se isInline estiver definido como true, uma ID de anexo temporário prefixada com addinId é inicialmente retornada enquanto o anexo é carregado no servidor. Após a conclusão do upload, o anexo recebe uma ID do EWS. Para obter detalhes, consulte as observações na seção Comentários. No Outlook no Windows (clássico) e no Mac, o índice do anexo é retornado para anexos embutidos e não embutidos. Se o carregamento do anexo falhar, uma descrição do erro será fornecida em asyncResult.error.

Retornos

void

Comentários

Conjunto de APIs: Caixa de Correio 1.1 para Outlook no Windows (clássico) e no Mac, Caixa de Correio 1.8 para Outlook na Web e novo Outlook no Windows

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

Modo do Outlook aplicável: Message Compose

Importante:

Este método não é compatível com o Outlook no iOS ou Android. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange) na id propriedade e sua isServiceAccessible propriedade é definida como true. A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
Não há suporte para imagens de bitmap (BMP) se forem adicionadas como anexos embutidos.
Em builds recentes do Outlook clássico no Windows, foi introduzido um bug que acrescenta incorretamente um Authorization: Bearer cabeçalho a essa ação (seja usando essa API ou a interface do usuário do Outlook). Para contornar esse problema, use a API introduzida com o addFileAttachmentFromBase64 conjunto de requisitos 1.8.
O URI do arquivo a ser anexado deve dar suporte ao cache em produção. O servidor que hospeda a imagem não deve retornar um Cache-Control cabeçalho que especifica no-cache, no-store, ou opções semelhantes na resposta HTTP. No entanto, quando você está desenvolvendo o suplemento e fazendo alterações em arquivos, o cache pode impedir que você veja suas alterações. É recomendável usar Cache-Control cabeçalhos durante o desenvolvimento.
Você pode usar o mesmo URI com o removeAttachmentAsync método para remover o anexo na mesma sessão.

Erros:

AttachmentSizeExceeded : o anexo é maior do que o permitido.
FileTypeNotSupported : O anexo tem uma extensão que não é permitida.
NumberOfAttachmentsExceeded : a mensagem ou o compromisso tem muitos anexos.

Exemplos

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

const attachmentUrl = (document.getElementById("attachmentUrl") as HTMLInputElement).value;
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment with ID: ${result.value}`);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O método addFileAttachmentAsync carrega o arquivo no URI especificado e anexa-o ao item no formulário de composição.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

uri: string

O URI que fornece o local do arquivo anexado à mensagem ou compromisso. O comprimento máximo é de 2048 caracteres.

attachmentName: string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

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

Opcional. 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 caso de êxito, o identificador do anexo é fornecido na asyncResult.value propriedade. O identificador varia dependendo do cliente Outlook. No Outlook na Web e no novo Outlook no Windows, a ID do Serviços Web do Exchange (EWS) é retornada. Se isInline estiver definido como true, uma ID de anexo temporário prefixada com addinId é inicialmente retornada enquanto o anexo é carregado no servidor. Após a conclusão do upload, o anexo recebe uma ID do EWS. Para obter detalhes, consulte as observações na seção Comentários. No Outlook no Windows (clássico) e no Mac, o índice do anexo é retornado para anexos embutidos e não embutidos. Se o carregamento do anexo falhar, uma descrição do erro será fornecida em asyncResult.error.

Retornos

void

Comentários

Conjunto de APIs: Caixa de Correio 1.1 para Outlook no Windows (clássico) e no Mac, Caixa de Correio 1.8 para Outlook na Web e novo Outlook no Windows

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

Modo do Outlook aplicável: Message Compose

Importante:

Este método não é compatível com o Outlook no iOS ou Android. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange) na id propriedade e sua isServiceAccessible propriedade é definida como true. A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
Não há suporte para imagens de bitmap (BMP) se forem adicionadas como anexos embutidos.
Em builds recentes do Outlook clássico no Windows, foi introduzido um bug que acrescenta incorretamente um Authorization: Bearer cabeçalho a essa ação (seja usando essa API ou a interface do usuário do Outlook). Para contornar esse problema, use a API introduzida com o addFileAttachmentFromBase64 conjunto de requisitos 1.8.
O URI do arquivo a ser anexado deve dar suporte ao cache em produção. O servidor que hospeda a imagem não deve retornar um Cache-Control cabeçalho que especifica no-cache, no-store, ou opções semelhantes na resposta HTTP. No entanto, quando você está desenvolvendo o suplemento e fazendo alterações em arquivos, o cache pode impedir que você veja suas alterações. É recomendável usar Cache-Control cabeçalhos durante o desenvolvimento.
Você pode usar o mesmo URI com o removeAttachmentAsync método para remover o anexo na mesma sessão.

Erros:

AttachmentSizeExceeded : o anexo é maior do que o permitido.
FileTypeNotSupported : O anexo tem uma extensão que não é permitida.
NumberOfAttachmentsExceeded : a mensagem ou o compromisso tem muitos anexos.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O addFileAttachmentFromBase64Async método carrega o arquivo da codificação Base64 e o anexa ao item no formulário de composição. Esse método retorna o identificador de anexo no asyncResult.value objeto.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

base64File: string

O conteúdo codificado em Base64 de uma imagem ou arquivo a ser adicionado a um email ou evento. O comprimento máximo da cadeia de caracteres codificada é de 34.865.152 caracteres. Isso corresponde a um tamanho máximo de anexo de 25 MB antes da codificação Base64.

attachmentName: string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

options: Office.AsyncContextOptions & { isInline: boolean }

Um literal de objeto que contém uma ou mais das seguintes propriedades: - asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejem acessar na função de retorno de chamada. isInline : Se verdadeiro, indica que o anexo será mostrado embutido como uma imagem no corpo da mensagem e não será exibido na lista de anexos.

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

Opcional. 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 caso de êxito, o identificador do anexo é fornecido na asyncResult.value propriedade. O identificador varia dependendo do cliente Outlook. No Outlook na Web e no novo Outlook no Windows, a ID do Serviços Web do Exchange (EWS) é retornada. Se isInline estiver definido como true, uma ID de anexo temporário prefixada com addinId é inicialmente retornada enquanto o anexo é carregado no servidor. Após a conclusão do upload, o anexo recebe uma ID do EWS. Para obter detalhes, consulte as observações na seção Comentários. No Outlook no Windows (clássico) e no Mac, o índice do anexo é retornado para anexos embutidos e não embutidos. Se o carregamento do anexo falhar, uma descrição do erro será fornecida em asyncResult.error.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A adição de um arquivo Base64 embutido a uma mensagem no modo de redação é compatível com o Outlook no Android e no iOS. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas nas mensagens no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange). A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
Se você estiver usando uma API de URL de dados (por exemplo, readAsDataURL), precisará remover o prefixo da URL de dados e enviar o restante da cadeia de caracteres para essa API. Por exemplo, se a cadeia de caracteres completa for representada por data:image/svg+xml;base64,<rest of Base64 string>, remova data:image/svg+xml;base64,.
Para adicionar uma imagem codificada em Base64 embutida ao corpo de uma mensagem ou compromisso que está sendo composto, use os métodos da API do Corpo , como prependAsync, setSignatureAsync, ou setAsync. Se você usar Office.context.mailbox.item.body.setAsync para inserir a imagem, primeiro chame Office.context.mailbox.item.body.getAsync para obter o corpo atual do item. Caso contrário, a imagem não será renderizada no corpo depois de inserida. Para obter um exemplo, consulte o exemplo Adicionar imagem codificada em Base64 embutida ao corpo da mensagem ou do compromisso (Compose) no Script Lab.

Erros:

AttachmentSizeExceeded : o anexo é maior do que o permitido.
FileTypeNotSupported : O anexo tem uma extensão que não é permitida.
NumberOfAttachmentsExceeded : a mensagem ou o compromisso tem muitos anexos.

Exemplos

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

const base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment from Base64-encoded string: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment from a Base64-encoded string with ID: ${result.value}`);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = (document.getElementById("signature") as HTMLInputElement).value + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O addFileAttachmentFromBase64Async método carrega o arquivo da codificação Base64 e o anexa ao item no formulário de composição. Esse método retorna o identificador de anexo no asyncResult.value objeto.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

base64File: string

O conteúdo codificado em Base64 de uma imagem ou arquivo a ser adicionado a um email ou evento. O comprimento máximo da cadeia de caracteres codificada é de 34.865.152 caracteres. Isso corresponde a um tamanho máximo de anexo de 25 MB antes da codificação Base64.

attachmentName: string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

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

Opcional. 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 caso de êxito, o identificador do anexo é fornecido na asyncResult.value propriedade. O identificador varia dependendo do cliente Outlook. No Outlook na Web e no novo Outlook no Windows, a ID do Serviços Web do Exchange (EWS) é retornada. Se isInline estiver definido como true, uma ID de anexo temporário prefixada com addinId é inicialmente retornada enquanto o anexo é carregado no servidor. Após a conclusão do upload, o anexo recebe uma ID do EWS. Para obter detalhes, consulte as observações na seção Comentários. No Outlook no Windows (clássico) e no Mac, o índice do anexo é retornado para anexos embutidos e não embutidos. Se o carregamento do anexo falhar, uma descrição do erro será fornecida em asyncResult.error.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A adição de um arquivo Base64 embutido a uma mensagem no modo de redação é compatível com o Outlook no Android e no iOS. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas nas mensagens no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange). A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
Se você estiver usando uma API de URL de dados (por exemplo, readAsDataURL), precisará remover o prefixo da URL de dados e enviar o restante da cadeia de caracteres para essa API. Por exemplo, se a cadeia de caracteres completa for representada por data:image/svg+xml;base64,<rest of Base64 string>, remova data:image/svg+xml;base64,.
Para adicionar uma imagem codificada em Base64 embutida ao corpo de uma mensagem ou compromisso que está sendo composto, use os métodos da API do Corpo , como prependAsync, setSignatureAsync, ou setAsync. Se você usar Office.context.mailbox.item.body.setAsync para inserir a imagem, primeiro chame Office.context.mailbox.item.body.getAsync para obter o corpo atual do item. Caso contrário, a imagem não será renderizada no corpo depois de inserida. Para obter um exemplo, consulte o exemplo Adicionar imagem codificada em Base64 embutida ao corpo da mensagem ou do compromisso (Compose) no Script Lab.

Erros:

AttachmentSizeExceeded : o anexo é maior do que o permitido.
FileTypeNotSupported : O anexo tem uma extensão que não é permitida.
NumberOfAttachmentsExceeded : a mensagem ou o compromisso tem muitos anexos.

addHandlerAsync(eventType, handler, options, callback)

Adiciona um manipulador de eventos a um evento com suporte. Os eventos só estão disponíveis nos suplementos do painel de tarefas.

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 desejem 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, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: para obter uma lista de eventos com suporte em um item de email, consulte Modelo de objeto do item do Outlook.

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. Os eventos só estão disponíveis nos suplementos do painel de tarefas.

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, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: para obter uma lista de eventos com suporte em um item de email, consulte Modelo de objeto do item do Outlook.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.

O método addItemAttachmentAsync anexa o item com o identificador do Exchange especificado ao item no formulário de composição. Se você especificar uma função de retorno de chamada, o método será chamado com um parâmetro, asyncResult, que contém o identificador do anexo ou um código que indica qualquer erro ocorrido ao anexar o item. Você pode usar o parâmetro options para passar informações de estado para a função de retorno de chamada, se necessário.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

Se o seu suplemento do Office estiver em execução no Outlook na Web ou no novo Outlook no Windows, o addItemAttachmentAsync método poderá anexar itens a itens diferentes daquele que você está editando. No entanto, isso não tem suporte e não é recomendado.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

itemId: any

O identificador do Exchange do item a anexar. O comprimento máximo é de 100 caracteres.

attachmentName: string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

options: Office.AsyncContextOptions

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

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

Opcional. 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 caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao adicionar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Erros:

NumberOfAttachmentsExceeded : a mensagem ou o compromisso tem muitos anexos.

Exemplos

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.

O método addItemAttachmentAsync anexa o item com o identificador do Exchange especificado ao item no formulário de composição. Se você especificar uma função de retorno de chamada, o método será chamado com um parâmetro, asyncResult, que contém o identificador do anexo ou um código que indica qualquer erro ocorrido ao anexar o item. Você pode usar o parâmetro options para passar informações de estado para a função de retorno de chamada, se necessário.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

Se o seu suplemento do Office estiver em execução no Outlook na Web ou no novo Outlook no Windows, o addItemAttachmentAsync método poderá anexar itens a itens diferentes daquele que você está editando. No entanto, isso não tem suporte e não é recomendado.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

itemId: any

O identificador do Exchange do item a anexar. O comprimento máximo é de 100 caracteres.

attachmentName: string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

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

Opcional. 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 caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao adicionar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Erros:

NumberOfAttachmentsExceeded : a mensagem ou o compromisso tem muitos anexos.

close()

Fecha o item atual que está sendo composto.

O comportamento do método close depende do estado atual do item que está sendo redigido. Se o item tiver alterações não salvas, o cliente solicitará que o usuário salve, descarte ou feche a ação.

No Outlook no Windows (clássico) e no Mac, o close método não tem efeito sobre uma resposta no Painel de Leitura.

close(): void;

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: no Outlook na Web e no novo Outlook no Windows, se o item for um compromisso e tiver sido salvo anteriormente usando saveAsync, o usuário será solicitado a salvar, descartar ou cancelar, mesmo que nenhuma alteração tenha ocorrido desde a última vez que o item foi salvo.

Dica: use o método closeAsync em vez do close método se quiser que o suplemento:

Descartar automaticamente uma mensagem que está sendo redigida sem avisar o usuário com a caixa de diálogo salvar.
Determinar quando um usuário cancela a caixa de diálogo salvar item em uma mensagem que está sendo redigida.
Feche uma resposta no Painel de Leitura ou um rascunho existente.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

closeAsync(options, callback)

Fecha a mensagem atual que está sendo composta com a opção de descartar alterações não salvas. A mensagem que está sendo composta pode ser uma nova mensagem, uma resposta ou um rascunho existente.

closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

options: Office.AsyncContextOptions & { discardItem: boolean }

Um literal de objeto que contém uma ou mais das seguintes propriedades: - asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejem acessar na função de retorno de chamada. discardItem : Se true, a mensagem atual que está sendo composta for fechada e as alterações não salvas serão descartadas. Quando o parâmetro não é declarado ou está definido como false, uma caixa de diálogo salvar é exibida solicitando que o usuário salve um rascunho, descarte as alterações ou cancele a operação. Esse comportamento ocorre para novas mensagens e respostas exibidas no Painel de Leitura. Se quiser fechar uma resposta no Painel de Leitura ou um rascunho existente, você deve definir discardItem como true. Caso contrário, a chamada retornará um erro. Para obter mais informações sobre o erro, consulte a seção Comentários.

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

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

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

O closeAsync método só tem suporte em implementações de painel de tarefas e comando de função. Não há suporte em manipuladores baseados em eventos ou cenários de seleção múltipla de itens.
Quando o closeAsync método fecha e descarta a mensagem atual com êxito, o suplemento que o chamou deixa de ser executado.

Erros:

The operation was cancelled by the user : o usuário seleciona Cancelar na caixa de diálogo salvar e a discardItem propriedade não está definida ou está definida como false.
The operation is not supported : O closeAsync método tenta fechar uma resposta no Painel de Leitura ou um rascunho existente e a discardItem propriedade não está definida ou está definida como false.

closeAsync(callback)

Fecha a nova mensagem atual que está sendo composta.

O comportamento de uma nova mensagem que está sendo composta depende se a mensagem contém alterações não salvas. Se nenhuma alteração for feita, a mensagem será fechada sem uma caixa de diálogo salvar. Por outro lado, se a mensagem contiver alterações não salvas, uma caixa de diálogo salvar aparecerá solicitando que o usuário salve um rascunho, descarte as alterações ou cancele a operação.

closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

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

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

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

O closeAsync método só tem suporte em implementações de painel de tarefas e comando de função. Não há suporte em manipuladores baseados em eventos ou cenários de seleção múltipla de itens.
Quando o closeAsync método fecha e descarta a mensagem atual com êxito, o suplemento que o chamou deixa de ser executado.

Erros:

The operation was cancelled by the user : o usuário seleciona Cancelar na caixa de diálogo salvar.
The operation is not supported : O closeAsync método tenta fechar uma resposta no Painel de Leitura ou um rascunho existente.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close-async.yaml

// This snippet closes the current message being composed and discards any unsaved changes when the optional property, discardItem, is set to true.
// The API call works on a new message being composed, a reply, or an existing draft.
// When discardItem is set to false or isn't defined on a new message with unsaved changes, the user is prompted to save a draft, discard the changes, or cancel the close operation.
Office.context.mailbox.item.closeAsync(
  { discardItem: true },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }
  });

disableClientSignatureAsync(options, callback)

Desabilita a assinatura do cliente Outlook.

O comportamento desse método depende de qual cliente o suplemento está executando.

No Outlook na Web e no novo Outlook no Windows, a opção de assinatura para novos emails, respostas e encaminhamentos está desabilitada. Uma assinatura selecionada também será desabilitada pelo método.
No Outlook no Windows (clássico) e no Mac, a assinatura nas seções Novas mensagens e Respostas/encaminhamentos da conta de envio é definida como (nenhum).
No Outlook no Android e no iOS, a assinatura salva no dispositivo móvel é apagada.

disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => 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 desejem 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 parâmetro de retorno de chamada é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: esse método é compatível com o Message Compose no Outlook no Android e no iOS a partir da versão 4.2352.0. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, 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/work-with-client-signatures.yaml

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Desabilita a assinatura do cliente Outlook.

O comportamento desse método depende de qual cliente o suplemento está executando.

No Outlook na Web e no novo Outlook no Windows, a opção de assinatura para novos emails, respostas e encaminhamentos está desabilitada. Uma assinatura selecionada também será desabilitada pelo método.
No Outlook no Windows (clássico) e no Mac, a assinatura nas seções Novas mensagens e Respostas/encaminhamentos da conta de envio é definida como (nenhum).
No Outlook no Android e no iOS, a assinatura salva no dispositivo móvel é apagada.

disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

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

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

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: esse método é compatível com o Message Compose no Outlook no Android e no iOS a partir da versão 4.2352.0. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

getAttachmentContentAsync(attachmentId, options, callback)

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

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. No Outlook na Web e no novo Outlook no Windows, a ID do anexo temporário gerada localmente para imagens embutidas que ainda não foram carregadas no servidor tem suporte durante a sessão de redação atual.

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: - asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejem 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, asyncResult, que é 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

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

Modo do Outlook aplicável: Message Compose

Importante:

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 getAttachmentsAsync chamada e, na mesma sessão, usar esse identificador para recuperar o anexo.
A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas nas mensagens no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange). A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
No Outlook na Web e no novo Outlook no Windows, getAttachmentContentAsync não oferece suporte a anexos que foram adicionados usando a opção Carregar e compartilhar.
No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo é válido somente na mesma sessão. Uma sessão termina quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, em seguida, abre o formulário para continuar em uma janela separada.

Erros:

AttachmentTypeNotSupported : não há suporte para o tipo de anexo. Os tipos sem suporte incluem imagens incorporadas no formato Rich Text ou tipos de anexo de item diferentes de itens de email ou calendário (como um contato ou item de 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 compose mode. The getAttachmentsAsync call can only be used in compose mode.
Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

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

getAttachmentContentAsync(attachmentId, callback)

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

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

Parâmetros

attachmentId: string

O identificador do anexo que você deseja obter. No Outlook na Web e no novo Outlook no Windows, a ID do anexo temporário gerada localmente para imagens embutidas que ainda não foram carregadas no servidor tem suporte durante a sessão de redação atual.

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, asyncResult, que é 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

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

Modo do Outlook aplicável: Message Compose

Importante:

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 getAttachmentsAsync chamada e, na mesma sessão, usar esse identificador para recuperar o anexo.
A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas nas mensagens no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange). A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
No Outlook na Web e no novo Outlook no Windows, getAttachmentContentAsync não oferece suporte a anexos que foram adicionados usando a opção Carregar e compartilhar.
No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo é válido somente na mesma sessão. Uma sessão termina quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, em seguida, abre o formulário para continuar em uma janela separada.

Erros:

AttachmentTypeNotSupported : não há suporte para o tipo de anexo. Os tipos sem suporte incluem imagens incorporadas no formato Rich Text ou tipos de anexo de item diferentes de itens de email ou calendário (como um contato ou item de tarefa).
InvalidAttachmentId : o identificador de anexo não existe.

getAttachmentsAsync(options, callback)

Obtém os anexos do item como uma matriz.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => 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 desejem acessar na função de retorno de chamada.

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha. Se a chamada for bem-sucedida, uma matriz de objetos será retornada AttachmentDetailsCompose na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas nas mensagens no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange). A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
No Outlook na Web e no novo Outlook no Windows, os usuários podem selecionar a opção Carregar e compartilhar para carregar um anexo no OneDrive e incluir um link para o arquivo no item de email. No entanto, como apenas um link é incluído, getAttachmentsAsync o não retorna esse anexo.

Exemplos

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

Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

getAttachmentsAsync(callback)

Obtém os anexos do item como uma matriz.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parâmetros

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha. Se a chamada for bem-sucedida, uma matriz de objetos será retornada AttachmentDetailsCompose na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A partir de 30 de março de 2026, após a conclusão da chamada para addFileAttachmentAsync ou addFileAttachmentFromBase64Async com isInline definido para true , as imagens embutidas nas mensagens no Outlook na Web e no novo Outlook no Windows recebem localmente uma ID de anexo temporário enquanto são carregadas no servidor. Uma ID de anexo temporário é prefixada com addinId. Depois que as imagens são carregadas no servidor, elas recebem uma ID do EWS (Serviços Web do Exchange). A ID de anexo temporário só tem suporte durante a sessão de redação atual. Para obter mais informações sobre as alterações na forma como as imagens embutidas são tratadas, consulte Alterações nas IDs de anexo para imagens embutidas nos suplementos do Outlook.
No Outlook na Web e no novo Outlook no Windows, os usuários podem selecionar a opção Carregar e compartilhar para carregar um anexo no OneDrive e incluir um link para o arquivo no item de email. No entanto, como apenas um link é incluído, getAttachmentsAsync o não retorna esse anexo.

getComposeTypeAsync(options, callback)

Especifica o tipo de redação da mensagem e seu tipo de coerção. A mensagem pode ser nova, uma resposta ou encaminhamento. O tipo de coerção pode ser HTML ou texto sem formatação.

getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => 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 desejem acessar na função de retorno de chamada.

callback: (asyncResult: Office.AsyncResult<any>) => 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 caso de êxito, a asyncResult.value propriedade contém um objeto com o tipo de composição e o tipo de coerção do item.

Retornos

void

Um objeto com ComposeType valores de enumeração e CoercionType para o item de mensagem.

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: este método é suportado no Outlook no Android e no iOS a partir da versão 4.2352.0. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

getComposeTypeAsync(callback)

Especifica o tipo de redação da mensagem e seu tipo de coerção. A mensagem pode ser nova, uma resposta ou encaminhamento. O tipo de coerção pode ser HTML ou texto sem formatação.

getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parâmetros

callback: (asyncResult: Office.AsyncResult<any>) => 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 caso de êxito, a asyncResult.value propriedade contém um objeto com o tipo de composição e o tipo de coerção do item.

Retornos

void

Um objeto com ComposeType valores de enumeração e CoercionType para o item de mensagem.

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: este método é suportado no Outlook no Android e no iOS a partir da versão 4.2352.0. Para obter mais informações sobre APIs com suporte no Outlook para dispositivos móveis, 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/work-with-client-signatures.yaml

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

getConversationIndexAsync(options, callback)

Obtém a posição codificada em Base64 da mensagem atual em um thread de conversa.

getConversationIndexAsync(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 desejem 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, asyncResult, que é um Office.AsyncResult objeto. A posição codificada em Base64 da mensagem atual em uma conversa é retornada asyncResult.value na propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Dica: você pode usar o índice de conversa para localizar uma mensagem em uma conversa encadeada. Em seguida, use seu conteúdo para fornecer contexto para a mensagem atual que está sendo composta.

getConversationIndexAsync(callback)

Obtém a posição codificada em Base64 da mensagem atual em um thread de conversa.

getConversationIndexAsync(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, asyncResult, que é um Office.AsyncResult objeto. A posição codificada em Base64 da mensagem atual em uma conversa é retornada asyncResult.value na propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Dica: você pode usar o índice de conversa para localizar uma mensagem em uma conversa encadeada. Em seguida, use seu conteúdo para fornecer contexto para a mensagem atual que está sendo composta.

Exemplos

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

// This snippet returns the Base64-encoded position of the current message in a conversation thread (PR_CONVERSATION_INDEX).
// The API call is supported on a message being composed and isn't supported on read items or appointments.
Office.context.mailbox.item.getConversationIndexAsync((result) => {
   if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(result.error.message);
      return;
   }
   
   const conversationIndex = result.value;
   if (conversationIndex) {
      console.log("Position in the conversation thread: " + conversationIndex);
   } else {
      console.log("The current message doesn't belong to a conversation thread.");
   }
});

getInitializationContextAsync(options, callback)

Recebe 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 desejem 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 caso de ê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

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

Modo do Outlook aplicável: Message Compose

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)

Recebe 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 caso de ê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

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

Modo do Outlook aplicável: Message Compose

getItemClassAsync(options, callback)

Obtém a classe de item Serviços Web do Exchange da mensagem selecionada.

getItemClassAsync(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 desejem 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, asyncResult, que é um Office.AsyncResult objeto. A classe de mensagem é retornada asyncResult.value na propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A tabela a seguir lista as classes de mensagem padrão.

Classe de item	Descrição
IPM. Observação	Novas mensagens e respostas a mensagens
IPM.Schedule.Meeting.Request	Solicitações de reunião
IPM.Schedule.Meeting.Canceled	Cancelamentos de reunião
IPM. Schedule.Meeting.Resp.Neg	Respostas para recusar solicitações de reunião
IPM. Schedule.Meeting.Resp.Pos	Respostas para aceitar solicitações de reunião
IPM. Schedule.Meeting.Resp.Tent	Respostas para aceitar provisoriamente solicitações de reunião

getItemClassAsync(callback)

Obtém a classe de item Serviços Web do Exchange da mensagem selecionada.

getItemClassAsync(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, asyncResult, que é um Office.AsyncResult objeto. A classe de mensagem é retornada asyncResult.value na propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A tabela a seguir lista as classes de mensagem padrão.

Classe de item	Descrição
IPM. Observação	Novas mensagens e respostas a mensagens
IPM.Schedule.Meeting.Request	Solicitações de reunião
IPM.Schedule.Meeting.Canceled	Cancelamentos de reunião
IPM. Schedule.Meeting.Resp.Neg	Respostas para recusar solicitações de reunião
IPM. Schedule.Meeting.Resp.Pos	Respostas para aceitar solicitações de reunião
IPM. Schedule.Meeting.Resp.Tent	Respostas para aceitar provisoriamente solicitações de reunião

Exemplos

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

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current message.
// The API call is only supported on a message being composed.
Office.context.mailbox.item.getItemClassAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Item class of the current message: " + asyncResult.value);
});

getItemIdAsync(options, callback)

Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange) de um item salvo.

Quando invocado, esse método retorna a ID do item por meio da função de retorno de chamada.

getItemIdAsync(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 desejem 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. A ID do item EWS do item é retornada na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A ID do item retornada não é idêntica à ID de Entrada do Outlook ou à ID usada pela API REST do Outlook. Antes de fazer chamadas à API REST usando esse valor, ele deve ser convertido usando Office.context.mailbox.convertToRestId.
Se o suplemento chamar getItemIdAsync (por exemplo, para obter uma ID de item para usar com o EWS ou a API REST), lembre-se de que, quando o Outlook está no modo de cache, pode levar algum tempo até que o item seja sincronizado com o servidor. Até que o item seja sincronizado, a ID do item não será reconhecida e usá-la retornará um erro.

Erros:

ItemNotSaved : a ID não pode ser recuperada até que o item seja salvo.

getItemIdAsync(callback)

Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange) de um item salvo.

Quando invocado, esse método retorna a ID do item por meio da função de retorno de chamada.

getItemIdAsync(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. A ID do item EWS do item é retornada na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

A ID do item retornada não é idêntica à ID de Entrada do Outlook ou à ID usada pela API REST do Outlook. Antes de fazer chamadas à API REST usando esse valor, ele deve ser convertido usando Office.context.mailbox.convertToRestId.
Se o suplemento chamar getItemIdAsync (por exemplo, para obter uma ID de item para usar com o EWS ou a API REST), lembre-se de que, quando o Outlook está no modo de cache, pode levar algum tempo até que o item seja sincronizado com o servidor. Até que o item seja sincronizado, a ID do item não será reconhecida e usá-la retornará um erro.

Erros:

ItemNotSaved : a ID não pode ser recuperada até que o item seja salvo.

Exemplos

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

Office.context.mailbox.item.getItemIdAsync((result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
        return;
    }

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

getSelectedDataAsync(coercionType, options, callback)

Retorna de forma assíncrona os dados selecionados do assunto ou do corpo de uma mensagem.

Se não houver nenhuma seleção, mas o cursor estiver no corpo ou no assunto, o método retornará uma cadeia de caracteres vazia para os dados selecionados. Se um campo que não seja o corpo ou o assunto estiver selecionado, o método retorna o erro InvalidSelection.

Para acessar os dados selecionados da função de retorno de chamada, chame asyncResult.value.data. Para acessar a propriedade de origem da qual a seleção vem, chame asyncResult.value.sourceProperty, que será ou subjectbody.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parâmetros

coercionType: Office.CoercionType | string

Solicita um formato para os dados. Se Text, o método retornará o texto sem formatação como uma cadeia de caracteres, removendo todas as marcas HTML presentes. Se Html, o método retornará o texto selecionado, seja ele texto simples ou HTML.

options: Office.AsyncContextOptions

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

callback: (asyncResult: Office.AsyncResult<any>) => 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.

Retornos

void

Os dados selecionados como uma cadeia de caracteres com formato determinado por coercionType.

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

// Get selected data.
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, { option1: "option1"}, getCallback);

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log(`Selected text in ${prop}: ${text}`);
}

getSelectedDataAsync(coercionType, callback)

Retorna de forma assíncrona os dados selecionados do assunto ou do corpo de uma mensagem.

Se não houver nenhuma seleção, mas o cursor estiver no corpo ou no assunto, o método retornará uma cadeia de caracteres vazia para os dados selecionados. Se um campo que não seja o corpo ou o assunto estiver selecionado, o método retorna o erro InvalidSelection.

Para acessar os dados selecionados da função de retorno de chamada, chame asyncResult.value.data. Para acessar a propriedade de origem da qual a seleção vem, chame asyncResult.value.sourceProperty, que será ou subjectbody.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parâmetros

coercionType: Office.CoercionType | string

Solicita um formato para os dados. Se Text, o método retornará o texto sem formatação como uma cadeia de caracteres, removendo todas as marcas HTML presentes. Se Html, o método retornará o texto selecionado, seja ele texto simples ou HTML.

callback: (asyncResult: Office.AsyncResult<any>) => 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.

Retornos

void

Os dados selecionados como uma cadeia de caracteres com formato determinado por coercionType.

Comentários

Conjunto de APIs: Caixa de Correio 1.8 para suporte a pastas compartilhadas, Caixa de Correio 1.13 para suporte a caixas de correio compartilhadas

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

Modo do Outlook aplicável: Message Compose

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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 desejem 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, asyncResult, que é um Office.AsyncResult objeto. A asyncResult.value propriedade fornece as propriedades do item compartilhado.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Observação: este método não é compatível com o Outlook no iOS ou no Android.

Importante: no modo Message Compose, essa API não é compatível com o Outlook na Web ou no Windows (novo e clássico), a menos que as condições a seguir sejam atendidas.

a. Acesso delegado/Pastas compartilhadas

O proprietário da caixa de correio inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um encaminhamento.
Eles salvam a mensagem e a movem de sua própria pasta Rascunhos para uma pasta compartilhada com o representante.
O delegado abre o rascunho da pasta compartilhada e continua compondo.

b. Caixa de correio compartilhada aberta no mesmo painel que a caixa de correio principal do usuário (Web, Windows clássico) ou caixa de correio compartilhada que não foi promovida a conta completa (novo Windows)

O usuário da caixa de correio compartilhada inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um encaminhamento.
Eles salvam a mensagem e a movem de sua própria pasta Rascunhos para uma pasta na caixa de correio compartilhada.
Outro usuário da caixa de correio compartilhada abre o rascunho da caixa de correio compartilhada e continua redigindo.

Depois que essas condições forem atendidas, a mensagem ficará disponível em um contexto compartilhado e os suplementos que dão suporte a esses cenários compartilhados poderão obter as propriedades compartilhadas do item. Depois que a mensagem é enviada, ela geralmente é encontrada na pasta Itens Enviados da caixa de correio pessoal do remetente.

O getSharedPropertiesAsync método tem suporte nas seguintes plataformas sem condições adicionais.

Outlook na Web quando a caixa de correio compartilhada for aberta em uma guia ou janela separada usando a opção Abrir outra caixa de correio.
Novo Outlook no Windows quando a caixa de correio compartilhada é promovida a uma conta completa.

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, asyncResult, que é um Office.AsyncResult objeto. A asyncResult.value propriedade fornece as propriedades do item compartilhado.

Retornos

void

Comentários

Conjunto de APIs: Caixa de Correio 1.8 para suporte a pastas compartilhadas, Caixa de Correio 1.13 para suporte a caixas de correio compartilhadas

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

Modo do Outlook aplicável: Message Compose

Observação: este método não é compatível com o Outlook no iOS ou no Android.

Importante: no modo Message Compose, essa API não é compatível com o Outlook na Web ou no Windows (novo e clássico), a menos que as condições a seguir sejam atendidas.

a. Acesso delegado/Pastas compartilhadas

O proprietário da caixa de correio inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um encaminhamento.
Eles salvam a mensagem e a movem de sua própria pasta Rascunhos para uma pasta compartilhada com o representante.
O delegado abre o rascunho da pasta compartilhada e continua compondo.

b. Caixa de correio compartilhada aberta no mesmo painel que a caixa de correio principal do usuário (Web, Windows clássico) ou caixa de correio compartilhada que não foi promovida a conta completa (novo Windows)

O usuário da caixa de correio compartilhada inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um encaminhamento.
Eles salvam a mensagem e a movem de sua própria pasta Rascunhos para uma pasta na caixa de correio compartilhada.
Outro usuário da caixa de correio compartilhada abre o rascunho da caixa de correio compartilhada e continua redigindo.

Depois que essas condições forem atendidas, a mensagem ficará disponível em um contexto compartilhado e os suplementos que dão suporte a esses cenários compartilhados poderão obter as propriedades compartilhadas do item. Depois que a mensagem é enviada, ela geralmente é encontrada na pasta Itens Enviados da caixa de correio pessoal do remetente.

O getSharedPropertiesAsync método tem suporte nas seguintes plataformas sem condições adicionais.

Outlook na Web quando a caixa de correio compartilhada for aberta em uma guia ou janela separada usando a opção Abrir outra caixa de correio.
Novo Outlook no Windows quando a caixa de correio compartilhada é promovida a uma conta completa.

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

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

isClientSignatureEnabledAsync(options, callback)

Obtém se a assinatura do cliente está habilitada.

No Outlook no Windows (clássico) e no Mac, a chamada à API retorna true se a assinatura padrão para novas mensagens, respostas ou encaminhamentos está definida como um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, a chamada à API retorna true se a assinatura estiver habilitada para os tiposnewMail de composição , replyou forward. Se as configurações forem definidas como "(nenhum)" no Outlook no Windows (clássico) ou no Mac, ou desabilitadas no Outlook na Web ou no novo Outlook no Windows, a chamada de API retornará false.

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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 desejem acessar na função de retorno de chamada.

callback: (asyncResult: Office.AsyncResult<boolean>) => 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.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Exemplos

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

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

isClientSignatureEnabledAsync(callback)

Obtém se a assinatura do cliente está habilitada.

No Outlook no Windows (clássico) e no Mac, a chamada à API retorna true se a assinatura padrão para novas mensagens, respostas ou encaminhamentos está definida como um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, a chamada à API retorna true se a assinatura estiver habilitada para os tiposnewMail de composição , replyou forward. Se as configurações forem definidas como "(nenhum)" no Outlook no Windows (clássico) ou no Mac, ou desabilitadas no Outlook na Web ou no novo Outlook no Windows, a chamada de API retornará false.

isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parâmetros

callback: (asyncResult: Office.AsyncResult<boolean>) => 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.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

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 chave-valor por aplicativo e 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

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

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

Modo do Outlook aplicável: Message Compose

Exemplos

// 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((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Remove um anexo de uma mensagem ou de um compromisso.

O método removeAttachmentAsync remove o anexo com o identificador especificado do item. Como prática recomendada, deve-se usar o identificador do anexo para remover um anexo somente se o mesmo aplicativo de email tiver adicionado esse anexo na mesma sessão. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo é válido somente na mesma sessão. Uma sessão termina quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, em seguida, abre o formulário para continuar em uma janela separada.

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

Parâmetros

attachmentId: string

O identificador do anexo a remover. O comprimento máximo da cadeia de caracteres do é de attachmentId 200 caracteres no Outlook na Web e no Windows (novo e clássico).

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: - asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejem 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 do tipo Office.AsyncResult. Se a remoção do anexo falhar, a propriedade asyncResult.error conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: O removeAttachmentAsync método não remove anexos embutidos de um item de email. Para remover um anexo embutido, primeiro obtenha o corpo do item e, em seguida, remova todas as referências do anexo de seu conteúdo. Use as APIs Office.Body para obter e definir o corpo de um item.

Erros:

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/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  (document.getElementById("attachmentId") as HTMLInputElement).value,
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }
    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Remove um anexo de uma mensagem ou de um compromisso.

O método removeAttachmentAsync remove o anexo com o identificador especificado do item. Como prática recomendada, deve-se usar o identificador do anexo para remover um anexo somente se o mesmo aplicativo de email tiver adicionado esse anexo na mesma sessão. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo é válido somente na mesma sessão. Uma sessão termina quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, em seguida, abre o formulário para continuar em uma janela separada.

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

Parâmetros

attachmentId: string

O identificador do anexo a remover. O comprimento máximo da cadeia de caracteres do é de attachmentId 200 caracteres no Outlook na Web e no Windows (novo e clássico).

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 do tipo Office.AsyncResult. Se a remoção do anexo falhar, a propriedade asyncResult.error conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: O removeAttachmentAsync método não remove anexos embutidos de um item de email. Para remover um anexo embutido, primeiro obtenha o corpo do item e, em seguida, remova todas as referências do anexo de seu conteúdo. Use as APIs Office.Body para obter e definir o corpo de um item.

Erros:

InvalidAttachmentId : o identificador de anexo não existe.

removeHandlerAsync(eventType, options, callback)

Remove um manipulador de eventos para um tipo de evento com suporte. Os eventos só estão disponíveis nos suplementos do painel de tarefas.

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 desejem 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, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: para obter uma lista de eventos com suporte em um item de email, consulte Modelo de objeto do item do Outlook.

removeHandlerAsync(eventType, callback)

Remove um manipulador de eventos para um tipo de evento com suporte. Os eventos só estão disponíveis nos suplementos do painel de tarefas.

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, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante: para obter uma lista de eventos com suporte em um item de email, consulte Modelo de objeto do item do Outlook.

Exemplos

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.ItemChanged, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});

saveAsync(options, callback)

Salva de forma assíncrona a mensagem atual como um rascunho.

saveAsync(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 desejem 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, asyncResult, que é um Office.AsyncResult objeto. A ID da mensagem EWS é retornada asyncResult.value na propriedade.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Importante:

No Outlook na Web, no novo Outlook no Windows ou no Outlook clássico no Windows no modo online (modo sem cache), o item é salvo no servidor. No Outlook no modo cache, o item é salvo no cache local.
Ao trabalhar com conteúdo formatado em HTML, é importante observar que o cliente Outlook pode modificar o conteúdo. Isso significa que chamadas subsequentes para métodos como Body.getAsync, Body.setAsynce even saveAsync podem não resultar no mesmo conteúdo.
O identificador retornado é o mesmo que o identificador de item do EWS (Serviços Web do Exchange). A ID do item retornada não é idêntica à ID de Entrada do Outlook ou à ID usada pela API REST do Outlook. Antes de fazer chamadas à API REST usando esse valor, ele deve ser convertido usando Office.context.mailbox.convertToRestId.
Se o suplemento chamar saveAsync para obter uma ID de item para usar com o EWS ou a API REST, lembre-se de que, quando o Outlook está no modo de cache, pode levar algum tempo até que o item seja realmente sincronizado com o servidor. Até que o item seja sincronizado, o uso da ID do item retornará um erro.
No Outlook na Web e no novo Outlook no Windows, a conta de caixa de correio na qual um rascunho é salvo varia quando saveAsync é chamada em uma mensagem que será enviada de uma conta de caixa de correio compartilhada. Se o remetente criar uma nova mensagem de sua caixa de correio pessoal e selecionar a conta da caixa de correio compartilhada no campo De , saveAsync salvará o rascunho na pasta Rascunhos da caixa de correio pessoal do usuário. Se o remetente abrir a conta da caixa de correio compartilhada em uma guia separada do navegador (por meio da opção Abrir outra caixa de correio , por exemplo) e criar uma nova mensagem lá, saveAsync salvará o rascunho na pasta Rascunhos da caixa de correio compartilhada.

Erros:

InvalidAttachmentId : o identificador de anexo não existe.

saveAsync(callback)

Salva de forma assíncrona a mensagem atual como um rascunho.

saveAsync(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, asyncResult, que é um Office.AsyncResult objeto. A ID da mensagem EWS é retornada asyncResult.value na propriedade.

Retornos

void

Comentários

Conjunto de APIs: Caixa de Correio 1.15

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

Modo do Outlook aplicável: Message Compose

Importante:

No Outlook na Web, no novo Outlook no Windows ou no Outlook clássico no Windows no modo online (modo sem cache), o item é salvo no servidor. No Outlook no modo cache, o item é salvo no cache local.
Ao trabalhar com conteúdo formatado em HTML, é importante observar que o cliente Outlook pode modificar o conteúdo. Isso significa que chamadas subsequentes para métodos como Body.getAsync, Body.setAsynce even saveAsync podem não resultar no mesmo conteúdo.
O identificador retornado é o mesmo que o identificador de item do EWS (Serviços Web do Exchange). A ID do item retornada não é idêntica à ID de Entrada do Outlook ou à ID usada pela API REST do Outlook. Antes de fazer chamadas à API REST usando esse valor, ele deve ser convertido usando Office.context.mailbox.convertToRestId.
Se o suplemento chamar saveAsync para obter uma ID de item para usar com o EWS ou a API REST, lembre-se de que, quando o Outlook está no modo de cache, pode levar algum tempo até que o item seja realmente sincronizado com o servidor. Até que o item seja sincronizado, o uso da ID do item retornará um erro.
No Outlook na Web e no novo Outlook no Windows, a conta de caixa de correio na qual um rascunho é salvo varia quando saveAsync é chamada em uma mensagem que será enviada de uma conta de caixa de correio compartilhada. Se o remetente criar uma nova mensagem de sua caixa de correio pessoal e selecionar a conta da caixa de correio compartilhada no campo De , saveAsync salvará o rascunho na pasta Rascunhos da caixa de correio pessoal do usuário. Se o remetente abrir a conta da caixa de correio compartilhada em uma guia separada do navegador (por meio da opção Abrir outra caixa de correio , por exemplo) e criar uma nova mensagem lá, saveAsync salvará o rascunho na pasta Rascunhos da caixa de correio compartilhada.

Erros:

InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

sendAsync(options, callback)

Envia a mensagem que está sendo redigida.

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

Parâmetros

options: Office.AsyncContextOptions

Um literal de objeto que contém a asyncContext propriedade. Use a asyncContext propriedade para especificar qualquer objeto que você deseja 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, asyncResult. O asyncResult parâmetro é um Office.AsyncResult objeto.

Retornos

void

Comentários

Nível mínimo de permissão: caixa de correio de leitura/gravação

Modo do Outlook aplicável: Message Compose

Importante:

O sendAsync método só tem suporte em implementações de painel de tarefas e comando de função. Não há suporte em manipuladores baseados em eventos ou cenários de seleção múltipla de itens.
Em uma implementação de comando de função, o valor retornado pode asyncResult.status não refletir se o compromisso que está sendo composto foi enviado com êxito. Isso ocorre porque o sendAsync método é uma API assíncrona e eventos fora do controle do suplemento (por exemplo, eventos manipulados por um suplemento Alertas inteligentes instalado separadamente) podem impedir que o item seja enviado. Como você não pode confiar no status retornado para asyncResult.status executar determinadas operações, você só deve chamar o método event.completed na função de retorno de chamada. A event.completed chamada sinaliza que o suplemento concluiu o processamento. Além dessa chamada, não há garantia de que outro código na função de retorno de chamada seja executado. É recomendável processar outras operações antes de chamar sendAsync.
Em uma implementação de painel de tarefas, não há garantia de que qualquer código incluído para ser executado quando asyncResult.status for Office.AsyncResultStatus.Success processado. Isso ocorre porque o item pode já ter sido enviado e o suplemento concluiu o processamento. É recomendável processar outras operações antes de chamar sendAsync.
Não há garantia de execução de nenhum código incluído após a sendAsync chamada, pois o suplemento conclui o processamento após a sendAsync chamada.
O sendAsync método está disponível para visualização no Outlook no Mac a partir da versão 16.105 (build 25121117). Para testar esse recurso, ingresse no programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar as builds beta do Office.

sendAsync(callback)

Envia a mensagem que está sendo redigida.

sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

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, asyncResult. O asyncResult parâmetro é um Office.AsyncResult objeto.

Retornos

void

Comentários

Conjunto de APIs: Caixa de Correio 1.15

Nível mínimo de permissão: caixa de correio de leitura/gravação

Modo do Outlook aplicável: Message Compose

Importante:

O sendAsync método só tem suporte em implementações de painel de tarefas e comando de função. Não há suporte em manipuladores baseados em eventos ou cenários de seleção múltipla de itens.
Em uma implementação de comando de função, o valor retornado pode asyncResult.status não refletir se o compromisso que está sendo composto foi enviado com êxito. Isso ocorre porque o sendAsync método é uma API assíncrona e eventos fora do controle do suplemento (por exemplo, eventos manipulados por um suplemento Alertas inteligentes instalado separadamente) podem impedir que o item seja enviado. Como você não pode confiar no status retornado para asyncResult.status executar determinadas operações, você só deve chamar o método event.completed na função de retorno de chamada. A event.completed chamada sinaliza que o suplemento concluiu o processamento. Além dessa chamada, não há garantia de que outro código na função de retorno de chamada seja executado. É recomendável processar outras operações antes de chamar sendAsync.
Em uma implementação de painel de tarefas, não há garantia de que qualquer código incluído para ser executado quando asyncResult.status for Office.AsyncResultStatus.Success processado. Isso ocorre porque o item pode já ter sido enviado e o suplemento concluiu o processamento. É recomendável processar outras operações antes de chamar sendAsync.
Não há garantia de execução de nenhum código incluído após a sendAsync chamada, pois o suplemento conclui o processamento após a sendAsync chamada.
O sendAsync método está disponível para visualização no Outlook no Mac a partir da versão 16.105 (build 25121117). Para testar esse recurso, ingresse no programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar as builds beta do Office.

Exemplos

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

// This snippet sends the current message or appointment being composed.
Office.context.mailbox.item.sendAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }
});

setSelectedDataAsync(data, options, callback)

Insere de forma assíncrona os dados no corpo ou no assunto de uma mensagem.

O setSelectedDataAsync método insere a cadeia de caracteres especificada no local do cursor no assunto ou no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor não estiver no campo corpo ou assunto, um erro será retornado. Após a inserção, o cursor é colocado no final do conteúdo inserido.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

data: string

Os dados a serem inseridos. Os dados não devem exceder 1.000.000 de caracteres. Se forem passados mais de 1.000.000 de caracteres, ocorrerá uma exceção ArgumentOutOfRange.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: - asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejem acessar na função de retorno de chamada. coercionType : se for texto, o estilo atual será aplicado no Outlook na Web, no Windows (novo e clássico) e no Mac. Se o campo for um editor de HTML, apenas os dados de texto são inseridos, mesmo se os dados forem HTML. Se os dados forem HTML e o campo for compatível com HTML (o assunto não), o estilo atual será aplicado no Outlook na Web e no novo Outlook no Windows. O estilo padrão é aplicado no Outlook no Windows (clássico) e no Mac. Se o campo for um campo de texto, retorna um erro InvalidDataFormat. Se coercionType não estiver definido, o resultado depende do campo: se o campo for HTML, HTML será usado; se o campo for texto, texto sem formatação será usado.

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 do tipo Office.AsyncResult.

Retornos

void

Comentários

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

Modo do Outlook aplicável: Message Compose

Erros:

InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

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

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Insere de forma assíncrona os dados no corpo ou no assunto de uma mensagem.

O setSelectedDataAsync método insere a cadeia de caracteres especificada no local do cursor no assunto ou no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor não estiver no campo corpo ou assunto, um erro será retornado. Após a inserção, o cursor é colocado no final do conteúdo inserido.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

data: string

Os dados a serem inseridos. Os dados não devem exceder 1.000.000 de caracteres. Se forem passados mais de 1.000.000 de caracteres, ocorrerá uma exceção ArgumentOutOfRange.

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 do tipo Office.AsyncResult.

Retornos

void

Comentários