Office. Message Compose interface

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

Modo outlook aplicável: Composição de mensagens

Exemplos

Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfBccRecipients = asyncResult.value;
}

// 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 = $("#emailBcc")
  .val()
  .toString();
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 API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: Composição de mensagens

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.), os limites podem se aplicar a 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: item de leitura

Modo outlook aplicável: Composição de mensagens

Exemplos

Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfCcRecipients = asyncResult.value;
}

// 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 = $("#emailCc")
  .val()
  .toString();
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: item de leitura

Modo outlook aplicável: Composição de mensagens

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 de entrega atrasadas de uma mensagem.

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

delayDeliveryTime: DelayDeliveryTime;

Valor da propriedade

Office.DelayDeliveryTime

Comentários

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

Modo outlook aplicável: Composição de mensagens

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

from: From;

Valor da propriedade

Office.From

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

Importante: essa propriedade tem suporte no Outlook no Android e no iOS. Para obter um cenário de exemplo, consulte Implementar ativação baseada em evento em 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

Observação

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

Obtém a ID 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: item de leitura

Modo outlook aplicável: Composição de mensagens

Importante:

Para visualizar a propriedade, você deve instalar o inReplyTo Outlook no Windows Versão 2402 (Build 17317.20000) ou posterior. Em seguida, insira o programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar builds beta do Office.
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.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-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: item de leitura

Modo outlook aplicável: Composição de mensagens

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 ItemType enumeração, indicando se a instância do objeto de item é uma mensagem ou um compromisso.

itemType: MailboxEnums.ItemType | string;

Valor da propriedade

Office.MailboxEnums.ItemType | string

Comentários

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

Modo outlook aplicável: Composição de mensagens

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

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

Modo outlook aplicável: Composição de mensagens

Exemplos

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

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

...

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

...

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

...

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

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

...

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

...

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

sensitivityLabel

Obtém o objeto para obter ou definir 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 outlook aplicável: Composição de mensagens

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

Para saber mais sobre como gerenciar rótulos de confidencialidade no suplemento, consulte Gerenciar o rótulo de confidencialidade da mensagem ou compromisso no modo de composiçã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.

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

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

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

seriesId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

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

Modo outlook aplicável: Composição de mensagens

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 o SessionData de um item no modo Compose.

Importante: todo o objeto SessionData é limitado a 50.000 caracteres por suplemento.

sessionData: SessionData;

Valor da propriedade

Office.SessionData

Comentários

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

Modo outlook aplicável: Composição de mensagens

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: item de leitura

Modo outlook aplicável: Composição de mensagens

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.), os limites podem se aplicar a 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: item de leitura

Modo outlook aplicável: Composição de mensagens

Exemplos

Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

function callback(asyncResult) {
    const arrayOfToRecipients = asyncResult.value;
}

// 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 = $("#emailTo")
  .val()
  .toString();
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);
  }
});

Detalhes do método

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.

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

Importante: em builds recentes do Outlook 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, você pode tentar usar a API introduzida com o addFileAttachmentFromBase64 conjunto de requisitos 1.8.

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 desejam acessar na função de retorno de chamada. isInline: se for true, indica que o anexo será mostrado embutido no corpo da mensagem e não deve 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 será fornecido na propriedade asyncResult.value. Se houver falha ao carregar 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 outlook aplicável: Composição de mensagens

Erros:

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

Exemplos

function callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

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

    const attachmentURL = "https://contoso.com/rtm/icon.png";
    Office.context.mailbox.item.addFileAttachmentAsync(attachmentURL, attachmentURL, options, callback);
}

// The following example adds an image file as an inline attachment and
// references the attachment in the message body.
Office.context.mailbox.item.addFileAttachmentAsync(
    "http://i.imgur.com/WJXklif.png",
    "cute_bird.png",
    {
        isInline: true
    },
    function (asyncResult) {
        Office.context.mailbox.item.body.setAsync(
            "<p>Here's a cute bird!</p><img src='cid:cute_bird.png'>",
            {
                "coercionType": "html"
            },
            function (asyncResult) {
                // Do something here.
            });
    });

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

const attachmentUrl = $("#attachmentUrl").val();
Office.context.mailbox.item.addFileAttachmentAsync(
    attachmentUrl,
    getFileName(attachmentUrl),
    { "asyncContext" : { var1: 1, var2: true } },
    function(result) { console.log(result); });

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.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessã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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Erros:

AttachmentSizeExceeded: o anexo é maior do que o permitido.
FileTypeNotSupported: o anexo tem uma extensão que não é permitida.
NumberOfAttachmentsExceeded: a mensagem ou 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 27.892.122 caracteres (cerca de 25 MB).

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 desejam acessar na função de retorno de chamada. isInline: se verdadeiro, indica que o anexo será mostrado embutido no corpo da mensagem e não deve 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 será fornecido na propriedade asyncResult.value. Se houver falha ao carregar 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 outlook aplicável: Composição de mensagens

Importante:

Há suporte para adicionar um arquivo Base64 embutido a uma mensagem no modo de composição no Outlook no Android e no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
Se você estiver usando uma API de URL de dados (por exemplo, readAsDataURL), precisará remover o prefixo de 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,.
Se você estiver adicionando uma imagem base64 embutida ao corpo de uma mensagem ou compromisso que está sendo composta, primeiro deverá obter o corpo do item atual usando o método Office.context.mailbox.item.body.getAsync antes de inserir a imagem usando addFileAttachmentFromBase64Async. Caso contrário, a imagem não será renderizada no corpo depois de inserida. Para obter mais diretrizes, consulte Anexar um arquivo.

Erros:

AttachmentSizeExceeded: o anexo é maior do que o permitido.
FileTypeNotSupported: o anexo tem uma extensão que não é permitida.
NumberOfAttachmentsExceeded: a mensagem ou 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

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 },
    function(result) { console.log(result); });

...

// 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 = $("#signature").val() + "<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.

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 27.892.122 caracteres (cerca de 25 MB).

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Importante:

Há suporte para adicionar um arquivo Base64 embutido a uma mensagem no modo de composição no Outlook no Android e no iOS. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
Se você estiver usando uma API de URL de dados (por exemplo, readAsDataURL), precisará remover o prefixo de 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,.
Se você estiver adicionando uma imagem base64 embutida ao corpo de uma mensagem ou compromisso que está sendo composta, primeiro deverá obter o corpo do item atual usando o método Office.context.mailbox.item.body.getAsync antes de inserir a imagem usando addFileAttachmentFromBase64Async. Caso contrário, a imagem não será renderizada no corpo depois de inserida. Para obter mais diretrizes, consulte Anexar um arquivo.

Erros:

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

addHandlerAsync(eventType, handler, options, callback)

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

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

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

Parâmetros

eventType: Office.EventType | string

O evento que deve invocar o manipulador.

handler: any

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

options: Office.AsyncContextOptions

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

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Exemplos

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

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

addHandlerAsync(eventType, handler, callback)

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

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

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

Parâmetros

eventType: Office.EventType | string

O evento que deve invocar o manipulador.

handler: any

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

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 de anexo ou um código que indica qualquer erro ocorrido ao anexar o item. Você pode usar o parâmetro de opções 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 Suplemento do Office estiver em execução no Outlook na Web, o método addItemAttachmentAsync pode anexar itens que não sejam aquele 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 desejam 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 outlook aplicável: Composição de mensagens

Erros:

NumberOfAttachmentsExceeded: a mensagem ou compromisso tem muitos anexos.

Exemplos

// The following example adds an existing Outlook item as an attachment
// with the name `My Attachment`.
function callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

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

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

const attachmentItemId = $("#attachmentItemId").val();
Office.context.mailbox.item.addItemAttachmentAsync(
    attachmentItemId,
    "My attachment",
    { "asyncContext" : { var3: 3, var4: false } },
    function(result) { console.log(result); });

addItemAttachmentAsync(itemId, attachmentName, callback)

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

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

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 outlook aplicável: Composição de mensagens

Erros:

NumberOfAttachmentsExceeded: a mensagem ou 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 cliente da área de trabalho do Outlook, o close método não tem efeito em uma resposta no Painel de Leitura.

close(): void;

Retornos

void

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

Importante: em Outlook na Web, 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 que o item foi salvo pela última vez.

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

Descarte automaticamente uma mensagem que está sendo composta sem solicitar ao usuário a caixa de diálogo Salvar.
Determine quando um usuário cancela a caixa de diálogo salvar item em uma mensagem que está sendo composta.
Feche uma resposta no Painel de Leitura ou um rascunho existente de um cliente da área de trabalho do Outlook.

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)

Observação

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

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, 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 desejam 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 forem descartadas. Quando o parâmetro não é declarado ou é definido como false, uma caixa de diálogo salvar aparece solicitando que o usuário salve um rascunho, descarte alterações ou cancele a operação. Esse comportamento ocorre para novas mensagens e as respostas surgiram do Painel de Leitura. Se você quiser fechar uma resposta no Painel de Leitura ou em um rascunho existente, deverá 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 outlook aplicável: Composição de mensagens

Importante: o closeAsync método está em versão prévia. Ele só tem suporte no Outlook no Windows neste momento.

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 em um rascunho existente e a discardItem propriedade não está definida ou está definida como false.

closeAsync(callback)

Observação

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

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 tiver sido 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 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

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

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

Modo outlook aplicável: Composição de mensagens

Importante: o closeAsync método está em versão prévia. Ele só tem suporte no Outlook no Windows neste momento.

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 em um rascunho existente.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/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 do Outlook.

O comportamento desse método depende de qual cliente o suplemento está em execução.

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

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 desejam acessar na função de retorno de chamada.

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

Opcional. Quando o método é concluído, a função passada no 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 outlook aplicável: Composição de mensagens

Importante: esse método tem suporte no Compose de Mensagens 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 mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/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 do Outlook.

O comportamento desse método depende de qual cliente o suplemento está em execução.

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

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 outlook aplicável: Composição de mensagens

getAttachmentContentAsync(attachmentId, options, callback)

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

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

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

Parâmetros

attachmentId: string

O identificador do anexo que você deseja obter.

options: Office.AsyncContextOptions

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

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Erros:

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

Exemplos

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

// Gets the attachments of the current message or appointment in compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(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.
    result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
}

getAttachmentContentAsync(attachmentId, callback)

Obtém um anexo de uma mensagem ou compromisso e retorna-o 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.

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Erros:

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

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(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(result.error.message);
    } else {
        if (result.value.length > 0) {
            for (let i = 0; i < result.value.length; i++) {
                const attachment = result.value[i];
                console.log("ID: " + attachment.id + "\n" +
                    "Name: " + attachment.name + "\n" +
                    "Size: " + attachment.size + "\n" +
                    "isInline: " + attachment.isInline);
                switch (attachment.attachmentType) {
                    case Office.MailboxEnums.AttachmentType.Cloud:
                        console.log("Attachment type: Attachment is stored in a cloud location.");
                        break;
                    case Office.MailboxEnums.AttachmentType.File:
                        console.log("Attachment type: Attachment is a file.");
                        break;
                    case Office.MailboxEnums.AttachmentType.Item:
                        console.log("Attachment type: Attachment is an Exchange item.");
                        break;
                }
            }
        }
        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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

getComposeTypeAsync(options, callback)

Especifica o tipo de composição de mensagem e seu tipo de coerção. A mensagem pode ser nova, ou uma resposta ou encaminhamento. O tipo de coerção pode ser HTML ou texto simples.

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 desejam 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. Com ê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 enumeração CoercionType de valores para o item de mensagem.

Comentários

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

Modo outlook aplicável: Composição de mensagens

Importante: esse método tem suporte 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 mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

getComposeTypeAsync(callback)

Especifica o tipo de composição de mensagem e seu tipo de coerção. A mensagem pode ser nova, ou uma resposta ou encaminhamento. O tipo de coerção pode ser HTML ou texto simples.

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

Parâmetros

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

Retornos

void

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

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

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)

Observação

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

Obtém a posição codificada 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 desejam acessar na função de retorno de chamada.

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

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A posição codificada base64 da mensagem atual em uma conversa é retornada na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Importante: para visualizar o método, você deve instalar o getConversationIndexAsync Outlook no Windows Versão 2402 (Build 17317.20000) ou posterior. Em seguida, insira o programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar builds beta do Office.

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

getConversationIndexAsync(callback)

Observação

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

Obtém a posição codificada 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

Retornos

void

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-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)

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

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

Parâmetros

options: Office.AsyncContextOptions

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

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Exemplos

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

getInitializationContextAsync(callback)

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

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

Parâmetros

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

Retornos

void

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

getItemClassAsync(options, callback)

Observação

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

Obtém a classe de item do Exchange Web Services 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 desejam acessar na função de retorno de chamada.

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

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A classe de mensagem é retornada na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Importante:

Para visualizar o método, você deve instalar o getItemClassAsync Outlook no Windows Versão 2402 (Build 17317.20000) ou posterior. Em seguida, insira o programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar builds beta do Office.

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

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

getItemClassAsync(callback)

Observação

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

Obtém a classe de item do Exchange Web Services da mensagem selecionada.

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

Parâmetros

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

Retornos

void

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

Importante:

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

Classe item	Descrição
IPM. Nota	Novas mensagens e respostas de mensagem
IPM.Schedule.Meeting.Request	Solicitações de reunião
IPM.Schedule.Meeting.Canceled	Cancelamentos de reunião
IPM. Agendar.Meeting.Resp.Neg	Respostas para recusar solicitações de reunião
IPM. Agendar.Meeting.Resp.Pos	Respostas para aceitar solicitações de reunião
IPM. Agendar.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/99-preview-apis/get-item-class-async.yaml

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current mail item.
// 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 mail item: " + asyncResult.value);
});

getItemIdAsync(options, callback)

Obtém assíncronamente a ID de um item salvo.

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

Observação: se o suplemento chamar getItemIdAsync em um item no modo de composição (por exemplo, para obter um itemId para usar com o EWS ou a API REST), esteja ciente de que, quando o Outlook está no modo armazenado em cache, pode levar algum tempo até que o item seja sincronizado com o servidor. Até que o item seja sincronizado, o itemId não é reconhecido e usá-lo retorna um erro.

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 desejam acessar na função de retorno de chamada.

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Erros:

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

getItemIdAsync(callback)

Obtém assíncronamente a ID 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.

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

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/85-tokens-and-service-calls/item-id-compose.yaml

Office.context.mailbox.item.getItemIdAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
    } else {
        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 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á body ou subject.

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 simples como uma cadeia de caracteres, removendo todas as marcas HTML presentes. Se Html, o método retornará o texto selecionado, seja plaintext 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 desejam 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: item de leitura

Modo outlook aplicável: Composição de mensagens

Exemplos

// Get selected data.
Office.initialize = function () {
    Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, 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.

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

Parâmetros

coercionType: Office.CoercionType | string

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 API: Caixa de correio 1.8 para suporte de pasta compartilhada, Caixa de correio 1.13 para suporte de caixa de correio compartilhada ]

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

Modo outlook aplicável: Composição de mensagens

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 desejam acessar na função de retorno de chamada.

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

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

Importante: no modo Compose de Mensagem, essa API não tem suporte em Outlook na Web ou no Windows, a menos que as seguintes condições sejam atendidas.

a. Delegar acesso/pastas compartilhadas

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

b. Caixa de correio compartilhada (aplica-se apenas ao Outlook no Windows)

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

A mensagem agora está em um contexto compartilhado e suplementos que dão suporte a esses cenários compartilhados podem obter as propriedades compartilhadas do item. Depois que a mensagem é enviada, ela geralmente é encontrada na pasta Itens Enviados do remetente.

Exemplos

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

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

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

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

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

getSharedPropertiesAsync(callback)

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

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

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

Parâmetros

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

Retornos

void

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

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

Importante: no modo Compose de Mensagem, essa API não tem suporte em Outlook na Web ou no Windows, a menos que as seguintes condições sejam atendidas.

a. Delegar acesso/pastas compartilhadas

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

b. Caixa de correio compartilhada (aplica-se apenas ao Outlook no Windows)

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

Exemplos

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

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

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

isClientSignatureEnabledAsync(options, callback)

Obtém se a assinatura do cliente estiver habilitada.

Para clientes ricos em Windows e Mac, a chamada de API deve retornar true se a assinatura padrão de novas mensagens, respostas ou encaminhamentos for definida como um modelo para a conta de envio do Outlook. Para Outlook na Web, a chamada de API deve retornar true se a assinatura estiver habilitada para tipos newMailde composição , replyou forward. Se as configurações forem definidas como "(nenhuma)" em clientes ricos do Mac ou windows ou desabilitadas no Outlook na Web, a chamada de API deverá 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 desejam 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: item de leitura

Modo outlook aplicável: Composição de mensagens

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 estiver habilitada.

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: item de leitura

Modo outlook aplicável: Composição de mensagens

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

Parâmetros

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

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

userContext: any

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

Retornos

void

Comentários

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

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

Modo outlook aplicável: Composição de mensagens

Exemplos

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

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

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

function saveCallback(asyncResult) {
}

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

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

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 e em dispositivos móveis, a identificador do anexo é válido apenas durante a mesma sessão. Uma sessão acaba quando o usuário fecha o aplicativo ou se o usuário começa a compor um formulário embutido e, posteriormente, aparece o formulário para continuar em uma janela separada.

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 é de attachmentId 200 caracteres em Outlook na Web e no Windows.

options: Office.AsyncContextOptions

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

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro 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 outlook aplicável: Composição de mensagens

Erros:

InvalidAttachmentId: o identificador de anexo não existe.

Exemplos

// The following code removes an attachment with an identifier of '0'.
Office.context.mailbox.item.removeAttachmentAsync(
    '0',
    { asyncContext : null },
    function (asyncResult)
    {
        console.log(asyncResult.status);
    }
);

// 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(
    $("#attachmentId").val(),
    { asyncContext : null },
    function(result)
    {
        if (result.status !== Office.AsyncResultStatus.Succeeded) {
            console.error(`${result.error.message}`);
        } else {
            console.log(`Attachment removed successfully.`);
        }
    }
);

removeAttachmentAsync(attachmentId, callback)

Remove um anexo de uma mensagem ou de um compromisso.

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 é de attachmentId 200 caracteres em Outlook na Web e no Windows.

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

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. Observação: os eventos só estão disponíveis com a implementação do painel de tarefas.

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

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

Parâmetros

eventType: Office.EventType | string

O evento que deve revogar o manipulador.

options: Office.AsyncContextOptions

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

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

removeHandlerAsync(eventType, callback)

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

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

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

Parâmetros

eventType: Office.EventType | string

O evento que deve revogar o manipulador.

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

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

saveAsync(options, callback)

Salva assíncronamente 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 desejam acessar na função de retorno de chamada.

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

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A ID da mensagem é retornada na asyncResult.value propriedade.

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Importante:

No Outlook na Web ou no Outlook no modo online, 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 do Outlook pode modificar o conteúdo. Isso significa que chamadas subsequentes para métodos como Body.getAsync, Body.setAsynce até mesmo saveAsync podem não resultar no mesmo conteúdo.
Se o suplemento chamar saveAsync em um item no modo de composição para obter uma ID de item a ser usada com o EWS ou a API REST, esteja ciente de que, quando o Outlook estiver no modo armazenado em cache, pode levar algum tempo até que o item seja sincronizado com o servidor. Até que o item seja sincronizado, o uso da ID do item retornará um erro.
Em Outlook na Web, a conta da caixa de correio para a 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 em sua caixa de correio pessoal e selecionar a conta de 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 de caixa de correio compartilhada em uma guia de navegador separada (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 assíncronamente a mensagem atual como um rascunho.

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

Parâmetros

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

Retornos

void

Comentários

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

Modo outlook aplicável: Composição de mensagens

Importante:

No Outlook na Web ou no Outlook no modo online, 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 do Outlook pode modificar o conteúdo. Isso significa que chamadas subsequentes para métodos como Body.getAsync, Body.setAsynce até mesmo saveAsync podem não resultar no mesmo conteúdo.
Se o suplemento chamar saveAsync em um item no modo de composição para obter uma ID de item a ser usada com o EWS ou a API REST, esteja ciente de que, quando o Outlook estiver no modo armazenado em cache, pode levar algum tempo até que o item seja sincronizado com o servidor. Até que o item seja sincronizado, o uso da ID do item retornará um erro.
Em Outlook na Web, a conta da caixa de correio para a 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 em sua caixa de correio pessoal e selecionar a conta de 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 de caixa de correio compartilhada em uma guia de navegador separada (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"
}

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 for selecionado no editor, ele substituirá o texto selecionado. Se o cursor não estiver no corpo ou no campo do 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 desejam acessar na função de retorno de chamada. coercionType: se texto, o estilo atual será aplicado em clientes de área de trabalho e Outlook na Web. Se o campo for um editor de HTML, apenas os dados de texto são inseridos, mesmo se os dados forem HTML. Se html e o campo de suporte a HTML (o assunto não o fizer), o estilo atual será aplicado em Outlook na Web e o estilo padrão será aplicado no Outlook em clientes da área de trabalho. 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 outlook aplicável: Composição de mensagens

Erros:

InvalidAttachmentId: o identificador de anexo não existe.

Exemplos

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

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

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