Office.Body interface

Referência

Pacote:: outlook

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

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Problema conhecido com as cores da borda da tabela HTML

Outlook no Windows: se você estiver definindo várias bordas de célula para cores diferentes em uma tabela HTML no modo Compose, as bordas de uma célula podem não refletir a cor esperada. Para o comportamento conhecido, visite o problema officeDev/office-js #1818.

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

Modo outlook aplicável: compor ou ler

Métodos

appendOnSendAsync(data, options, callback)	Acrescenta ao enviar o conteúdo especificado para o final do corpo do item, após qualquer assinatura. Para usar `appendOnSendAsync`, você deve especificar uma permissão complementar no manifesto. Os detalhes variam com o tipo de manifesto. Consulte Noções básicas sobre as permissões de suplemento do Outlook. Para saber mais sobre o append-on-send e sua configuração, consulte Implementar append-on-send em seu suplemento do Outlook. Importante: se o recurso de envio for implementado com o append-on-send, o seguinte será aplicado. Se o usuário estiver executando suplementos que implementam o recurso de envio usando `ItemSend` no manifesto, o append-on-send será executado antes da funcionalidade de envio. Se o suplemento implementar o recurso de envio e as chamadas `appendOnSendAsync` no `ItemSend` manipulador, a `appendOnSendAsync` chamada retornará um erro, pois esse cenário não terá suporte. Recomendado: chame `getTypeAsync` e passe o valor retornado para o `options.coercionType` parâmetro. Observação: para limpar dados de uma chamada anterior `appendOnSendAsync` , você pode chamá-los novamente com o `data` parâmetro definido como `null`.
appendOnSendAsync(data, callback)	Acrescenta ao enviar o conteúdo especificado para o final do corpo do item, após qualquer assinatura. Para usar `appendOnSendAsync`, você deve especificar uma permissão complementar no manifesto. Os detalhes variam com o tipo de manifesto. Consulte Noções básicas sobre as permissões de suplemento do Outlook. Para saber mais sobre o append-on-send e sua configuração, consulte Implementar append-on-send em seu suplemento do Outlook. Importante: se o recurso de envio for implementado com o append-on-send, o seguinte será aplicado. Se o usuário estiver executando suplementos que implementam o recurso de envio usando `ItemSend` no manifesto, o append-on-send será executado antes da funcionalidade de envio. Se o suplemento implementar o recurso de envio e as chamadas `appendOnSendAsync` no `ItemSend` manipulador, a `appendOnSendAsync` chamada retornará um erro, pois esse cenário não terá suporte. Recomendado: chame `getTypeAsync` e passe o valor retornado para o `options.coercionType` parâmetro. Observação: para limpar dados de uma chamada anterior `appendOnSendAsync` , você pode chamá-los novamente com o `data` parâmetro definido como `null`.
getAsync(coercionType, options, callback)	Retorna o corpo atual em um formato especificado. Esse método retorna todo o corpo atual no formato especificado por `coercionType`.
getAsync(coercionType, callback)	Retorna o corpo atual em um formato especificado. Esse método retorna todo o corpo atual no formato especificado por `coercionType`.
getTypeAsync(options, callback)	Obtém um valor que indica se o conteúdo está em formato HTML ou texto.
getTypeAsync(callback)	Obtém um valor que indica se o conteúdo está em formato HTML ou texto.
prependAsync(data, options, callback)	Adiciona o conteúdo especificado ao início do corpo do item.
prependAsync(data, callback)	Adiciona o conteúdo especificado ao início do corpo do item.
prependOnSendAsync(data, options, callback)	Prepara o TEXTO HTML ou simples para o início de um corpo de mensagem ou compromisso quando o item de email é enviado. Para usar `prependOnSendAsync`, você deve especificar uma permissão complementar no manifesto. Os detalhes variam com o tipo de manifesto. Para obter diretrizes, consulte Noções básicas sobre as permissões de suplemento do Outlook.
prependOnSendAsync(data, callback)	Prepara o TEXTO HTML ou simples para o início de um corpo de mensagem ou compromisso quando o item de email é enviado. Para usar `prependOnSendAsync`, você deve especificar uma permissão complementar no manifesto. Os detalhes variam com o tipo de manifesto. Para obter diretrizes, consulte Noções básicas sobre as permissões de suplemento do Outlook.
setAsync(data, options, callback)	Substitui todo o corpo com o texto especificado.
setAsync(data, callback)	Substitui todo o corpo com o texto especificado.
setSelectedDataAsync(data, options, callback)	Substitui a seleção no corpo pelo texto especificado. O método `setSelectedDataAsync` insere a cadeia de caracteres especificada no local do cursor no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor nunca esteve no corpo do item, ou se o corpo do item perdeu o destaque na interface de usuário, a cadeia de caracteres será inserida na parte superior do conteúdo do corpo. Após a inserção, o cursor é colocado no final do conteúdo inserido. Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o `id` atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo). Recomendado: chame `getTypeAsync` e passe o valor retornado para o `options.coercionType` parâmetro.
setSelectedDataAsync(data, callback)	Substitui a seleção no corpo pelo texto especificado. O método `setSelectedDataAsync` insere a cadeia de caracteres especificada no local do cursor no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor nunca esteve no corpo do item, ou se o corpo do item perdeu o destaque na interface de usuário, a cadeia de caracteres será inserida na parte superior do conteúdo do corpo. Após a inserção, o cursor é colocado no final do conteúdo inserido. Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o `id` atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo). Recomendado: chame `getTypeAsync` e passe o valor retornado para o `options.coercionType` parâmetro.
setSignatureAsync(data, options, callback)	Adiciona uma assinatura ao corpo do item se ele não tiver uma assinatura existente. Se já houver uma assinatura no corpo, substitua essa assinatura.
setSignatureAsync(data, callback)	Adiciona uma assinatura ao corpo do item se ele não tiver uma assinatura existente. Se já houver uma assinatura no corpo, substitua essa assinatura.

Detalhes do método

appendOnSendAsync(data, options, callback)

Acrescenta ao enviar o conteúdo especificado para o final do corpo do item, após qualquer assinatura.

Para usar appendOnSendAsync, você deve especificar uma permissão complementar no manifesto. Os detalhes variam com o tipo de manifesto. Consulte Noções básicas sobre as permissões de suplemento do Outlook. Para saber mais sobre o append-on-send e sua configuração, consulte Implementar append-on-send em seu suplemento do Outlook.

Importante: se o recurso de envio for implementado com o append-on-send, o seguinte será aplicado.

Se o usuário estiver executando suplementos que implementam o recurso de envio usando ItemSend no manifesto, o append-on-send será executado antes da funcionalidade de envio.
Se o suplemento implementar o recurso de envio e as chamadas appendOnSendAsync no ItemSend manipulador, a appendOnSendAsync chamada retornará um erro, pois esse cenário não terá suporte.

Recomendado: chame getTypeAsync e passe o valor retornado para o options.coercionType parâmetro.

Observação: para limpar dados de uma chamada anterior appendOnSendAsync , você pode chamá-los novamente com o data parâmetro definido como null.

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

Parâmetros

data: string

A cadeia de caracteres a ser adicionada ao final do corpo. A cadeia de caracteres é limitada a 5.000 caracteres.

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: o formato desejado para que os dados sejam acrescentados. A cadeia de caracteres no parâmetro data será convertida para este formato.

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. Quaisquer erros encontrados serão fornecidos na propriedade asyncResult.error.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.9 ]

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

Modo outlook aplicável: compose

Erros:

DataExceedsMaximumSize: o data parâmetro é maior que 5.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html , mas o corpo da mensagem está em texto simples.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/append-text-on-send.yaml

// This snippet appends text to the end of the message or appointment's body once it's sent.
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the appendOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.appendOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be appended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

appendOnSendAsync(data, callback)

Acrescenta ao enviar o conteúdo especificado para o final do corpo do item, após qualquer assinatura.

Importante: se o recurso de envio for implementado com o append-on-send, o seguinte será aplicado.

Se o usuário estiver executando suplementos que implementam o recurso de envio usando ItemSend no manifesto, o append-on-send será executado antes da funcionalidade de envio.
Se o suplemento implementar o recurso de envio e as chamadas appendOnSendAsync no ItemSend manipulador, a appendOnSendAsync chamada retornará um erro, pois esse cenário não terá suporte.

Recomendado: chame getTypeAsync e passe o valor retornado para o options.coercionType parâmetro.

Observação: para limpar dados de uma chamada anterior appendOnSendAsync , você pode chamá-los novamente com o data parâmetro definido como null.

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

Parâmetros

data: string

A cadeia de caracteres a ser adicionada ao final do corpo. A cadeia de caracteres é limitada a 5.000 caracteres.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.9 ]

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

Modo outlook aplicável: compose

Erros:

DataExceedsMaximumSize: o data parâmetro é maior que 5.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html , mas o corpo da mensagem está em texto simples.

getAsync(coercionType, options, callback)

Retorna o corpo atual em um formato especificado.

Esse método retorna todo o corpo atual no formato especificado por coercionType.

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

Parâmetros

coercionType: Office.CoercionType | string

O formato do corpo retornado.

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. O corpo é fornecido no formato solicitado na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

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

Modo outlook aplicável: compor ou ler

Importante: ao trabalhar com corpos formatados por HTML, é importante observar que o valor retornado pelo Body.getAsync método não será necessariamente o mesmo valor que foi passado anteriormente no Body.setAsync método. O cliente pode modificar o valor passado para setAsync torná-lo renderizado com eficiência com seu mecanismo de renderização.

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

getAsync(coercionType, callback)

Retorna o corpo atual em um formato especificado.

Esse método retorna todo o corpo atual no formato especificado por coercionType.

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

Parâmetros

coercionType: Office.CoercionType | string

O formato do corpo retornado.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

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

Modo outlook aplicável: compor ou ler

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64 image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64 image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

getTypeAsync(options, callback)

Obtém um valor que indica se o conteúdo está em formato HTML ou texto.

getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => 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.CoercionType>) => 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. O tipo de conteúdo é retornado como um dos CoercionType valores na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Importante: no Outlook no Android e no iOS, esse método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. 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/20-item-body/get-body-format.yaml

// Get the mail item's body format (plain text or HTML) and log it to the console.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Body format: " + asyncResult.value);
});

getTypeAsync(callback)

Obtém um valor que indica se o conteúdo está em formato HTML ou texto.

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

Parâmetros

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

prependAsync(data, options, callback)

Adiciona o conteúdo especificado ao início do corpo do item.

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

Parâmetros

data: string

A cadeia de caracteres a ser inserida no início do corpo. A cadeia de caracteres está limitada a 1.000.000 de caracteres.

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: o formato desejado para o corpo. A cadeia de caracteres no parâmetro data será convertida para este formato.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Importante:

Depois que o conteúdo é pré-configurado, a posição do cursor depende de qual cliente o suplemento está em execução. No Outlook no Windows e na Web, a posição do cursor permanece a mesma no conteúdo pré-existente do corpo. Por exemplo, se o cursor foi posicionado no início do corpo antes da prependAsync chamada, ele aparecerá entre o conteúdo pré-configurado e o conteúdo pré-existente do corpo após a chamada. No Outlook no Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só reaparece quando o usuário seleciona algo no corpo do item de email.
Ao trabalhar com corpos formatados por HTML, é importante observar que o cliente pode modificar o valor passado para prependAsync torná-lo renderizado com eficiência com seu mecanismo de renderização. Isso significa que o valor retornado de uma chamada subsequente para o Body.getAsync método (introduzido na Caixa de Correio 1.3) não conterá necessariamente o valor exato que foi passado na chamada anterior prependAsync .
Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o id atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo).
No Outlook no Android e no iOS, esse método não tem suporte no modo Compose de Mensagem. Há suporte apenas para o modo Organizador de Compromissos. 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.

Recomendado: chame getTypeAsync, em seguida, passe o valor retornado para o options.coercionType parâmetro.

Erros:

DataExceedsMaximumSize: o parâmetro de dados é maior que 1.000.000 caracteres.

Exemplos

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

/* This snippet adds text to the beginning of the message or appointment's body. 
  
  When prepending a link in HTML markup to the body, you can disable the online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.
*/
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" prepended to the body.`);
  });
});

prependAsync(data, callback)

Adiciona o conteúdo especificado ao início do corpo do item.

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

Parâmetros

data: string

A cadeia de caracteres a ser inserida no início do corpo. A cadeia de caracteres está limitada a 1.000.000 de caracteres.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Importante:

Depois que o conteúdo é pré-configurado, a posição do cursor depende de qual cliente o suplemento está em execução. No Outlook no Windows e na Web, a posição do cursor permanece a mesma no conteúdo pré-existente do corpo. Por exemplo, se o cursor foi posicionado no início do corpo antes da prependAsync chamada, ele aparecerá entre o conteúdo pré-configurado e o conteúdo pré-existente do corpo após a chamada. No Outlook no Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só reaparece quando o usuário seleciona algo no corpo do item de email.
Ao trabalhar com corpos formatados por HTML, é importante observar que o cliente pode modificar o valor passado para prependAsync torná-lo renderizado com eficiência com seu mecanismo de renderização. Isso significa que o valor retornado de uma chamada subsequente para o Body.getAsync método (introduzido na Caixa de Correio 1.3) não conterá necessariamente o valor exato que foi passado na chamada anterior prependAsync .
Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o id atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo).
No Outlook no Android e no iOS, esse método não tem suporte no modo Compose de Mensagem. Há suporte apenas para o modo Organizador de Compromissos. 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.

Recomendado: chame getTypeAsync, em seguida, passe o valor retornado para o options.coercionType parâmetro.

Erros:

DataExceedsMaximumSize: o parâmetro de dados é maior que 1.000.000 caracteres.

prependOnSendAsync(data, options, callback)

Prepara o TEXTO HTML ou simples para o início de um corpo de mensagem ou compromisso quando o item de email é enviado.

Para usar prependOnSendAsync, você deve especificar uma permissão complementar no manifesto. Os detalhes variam com o tipo de manifesto. Para obter diretrizes, consulte Noções básicas sobre as permissões de suplemento do Outlook.

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

Parâmetros

data: string

A cadeia de caracteres a ser pré-acrescentada ao início da mensagem ou do corpo da nomeação. A cadeia de caracteres é limitada a 5.000 caracteres.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Qualquer objeto que possa ser acessado na função de retorno de chamada. coercionType: o formato desejado para o corpo. A cadeia de caracteres no data parâmetro é convertida nesse formato.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Recomendado: chame getTypeAsync, em seguida, passe seu valor retornado para o options.coercionType parâmetro.

Importante: ao implementar prependOnSendAsync, tenha o seguinte em mente.

Em um suplemento alertas inteligentes, o recurso prepend-on-send é executado primeiro.
Uma nova linha é adicionada após o conteúdo pré-acrescentado.
Se vários suplementos ativos chamarem prependOnSendAsync, a ordem do conteúdo inserido dependerá da ordem na qual o suplemento é executado. O conteúdo do suplemento de última execução aparece acima do conteúdo previamente pré-configurado.
Se o suplemento tentar inserir HTML em um corpo de texto simples, o conteúdo não será pré-acrescentado. Por outro lado, o texto simples será inserido em um corpo HTML.

Erros:

DataExceedsMaximumSize: o data parâmetro excede 5.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html, mas o corpo do item está em formato de texto simples.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/prepend-text-on-send.yaml

// This snippet prepends text to the beginning of the message or appointment's body once it's sent.
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be prepended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

prependOnSendAsync(data, callback)

Prepara o TEXTO HTML ou simples para o início de um corpo de mensagem ou compromisso quando o item de email é enviado.

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

Parâmetros

data: string

A cadeia de caracteres a ser pré-acrescentada ao início da mensagem ou do corpo da nomeação. A cadeia de caracteres é limitada a 5.000 caracteres.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Recomendado: chame getTypeAsync, em seguida, passe seu valor retornado para o options.coercionType parâmetro.

Importante: ao implementar prependOnSendAsync, tenha o seguinte em mente.

Em um suplemento alertas inteligentes, o recurso prepend-on-send é executado primeiro.
Uma nova linha é adicionada após o conteúdo pré-acrescentado.
Se vários suplementos ativos chamarem prependOnSendAsync, a ordem do conteúdo inserido dependerá da ordem na qual o suplemento é executado. O conteúdo do suplemento de última execução aparece acima do conteúdo previamente pré-configurado.
Se o suplemento tentar inserir HTML em um corpo de texto simples, o conteúdo não será pré-acrescentado. Por outro lado, o texto simples será inserido em um corpo HTML.

Erros:

DataExceedsMaximumSize: o data parâmetro excede 5.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html, mas o corpo do item está em formato de texto simples.

setAsync(data, options, callback)

Substitui todo o corpo com o texto especificado.

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

Parâmetros

data: string

A cadeia de caracteres que substituirá o corpo existente. A cadeia de caracteres está limitada a 1.000.000 de caracteres.

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: o formato desejado para o corpo. A cadeia de caracteres no parâmetro data será convertida para este formato.

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. Quaisquer erros encontrados serão fornecidos na propriedade asyncResult.error.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

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

Modo outlook aplicável: compose

Importante:

Depois que o corpo é substituído pelo conteúdo especificado, a posição do cursor depende de qual cliente o suplemento está em execução. No Outlook no Windows, o cursor aparece no início do corpo do item de email, enquanto em Outlook na Web, o cursor aparece no final do corpo do item de email. No Outlook no Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só reaparece quando o usuário seleciona algo no corpo do item de email.
Ao trabalhar com corpos formatados por HTML, é importante observar que o valor retornado pelo Body.getAsync método não será necessariamente o mesmo valor que foi passado anteriormente no Body.setAsync método. O cliente pode modificar o valor passado para setAsync torná-lo renderizado com eficiência com seu mecanismo de renderização.
Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o id atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo).
No Outlook no Windows e no Mac, o usuário do suplemento não é capaz de reverter essa ação com o comando Desfazer.
No Outlook no Android e no iOS, esse método não tem suporte no modo Compose de Mensagem. Há suporte apenas para o modo Organizador de Compromissos. 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.

Recomendado: chame getTypeAsync, em seguida, passe o valor retornado para o options.coercionType parâmetro.

Erros:

DataExceedsMaximumSize: o parâmetro de dados é maior que 1.000.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html e o corpo da mensagem está em texto sem formatação.

Exemplos

// When including links in HTML markup, you can disable online link preview
// by setting the id attribute on the anchor (<a>) to "LPNoLP".
Office.context.mailbox.item.body.setAsync(
    '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>',
    {coercionType: Office.CoercionType.Html},
    callback);
Office.context.mailbox.item.body.setAsync(
    "<b>(replaces all body, including threads you are replying to that may be on the bottom)</b>",
    { coercionType: "html", asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Process the result.
});

// The following is an example of the result parameter passed to the callback function.
{
    "value":null,
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64 image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64 image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

setAsync(data, callback)

Substitui todo o corpo com o texto especificado.

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

Parâmetros

data: string

A cadeia de caracteres que substituirá o corpo existente. A cadeia de caracteres está limitada a 1.000.000 de caracteres.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

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

Modo outlook aplicável: compose

Importante:

Depois que o corpo é substituído pelo conteúdo especificado, a posição do cursor depende de qual cliente o suplemento está em execução. No Outlook no Windows, o cursor aparece no início do corpo do item de email, enquanto em Outlook na Web, o cursor aparece no final do corpo do item de email. No Outlook no Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só reaparece quando o usuário seleciona algo no corpo do item de email.
Ao trabalhar com corpos formatados por HTML, é importante observar que o valor retornado pelo Body.getAsync método não será necessariamente o mesmo valor que foi passado anteriormente no Body.setAsync método. O cliente pode modificar o valor passado para setAsync torná-lo renderizado com eficiência com seu mecanismo de renderização.
Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o id atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo).
No Outlook no Windows e no Mac, o usuário do suplemento não é capaz de reverter essa ação com o comando Desfazer.
No Outlook no Android e no iOS, esse método não tem suporte no modo Compose de Mensagem. Há suporte apenas para o modo Organizador de Compromissos. 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.

Recomendado: chame getTypeAsync, em seguida, passe o valor retornado para o options.coercionType parâmetro.

Erros:

DataExceedsMaximumSize: o parâmetro de dados é maior que 1.000.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html e o corpo da mensagem está em texto sem formatação.

setSelectedDataAsync(data, options, callback)

Substitui a seleção no corpo pelo texto especificado.

O método setSelectedDataAsync insere a cadeia de caracteres especificada no local do cursor no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor nunca esteve no corpo do item, ou se o corpo do item perdeu o destaque na interface de usuário, a cadeia de caracteres será inserida na parte superior do conteúdo do corpo. Após a inserção, o cursor é colocado no final do conteúdo inserido.

Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o id atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo).

Recomendado: chame getTypeAsync e passe o valor retornado para o options.coercionType parâmetro.

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

Parâmetros

data: string

A cadeia de caracteres que substituirá o corpo existente. A cadeia de caracteres está limitada a 1.000.000 de caracteres.

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: o formato desejado para o corpo. A cadeia de caracteres no parâmetro data será convertida para este formato.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Erros:

DataExceedsMaximumSize: o data parâmetro é maior que 1.000.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html e o corpo da mensagem está em texto sem formatação.

Exemplos

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

/* This snippet replaces selected text in a message or appointment's body with specified text.
  
  If you want to use a link in HTML markup as a value of the setSelectedDataAsync call's data parameter, you can disable online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.
*/
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.setSelectedDataAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`Replaced selected text with "${text}".`);
  });
});

setSelectedDataAsync(data, callback)

Substitui a seleção no corpo pelo texto especificado.

Ao incluir links na marcação HTML, você pode desabilitar a visualização de link online definindo o id atributo na âncora (><a) como "LPNoLP" (consulte a seção Exemplos para um exemplo).

Recomendado: chame getTypeAsync e passe o valor retornado para o options.coercionType parâmetro.

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

Parâmetros

data: string

A cadeia de caracteres que substituirá o corpo existente. A cadeia de caracteres está limitada a 1.000.000 de caracteres.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Erros:

DataExceedsMaximumSize: o data parâmetro é maior que 1.000.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html e o corpo da mensagem está em texto sem formatação.

setSignatureAsync(data, options, callback)

Adiciona uma assinatura ao corpo do item se ele não tiver uma assinatura existente. Se já houver uma assinatura no corpo, substitua essa assinatura.

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

Parâmetros

data: string

A cadeia de caracteres que representa a assinatura a ser definida no corpo do email. Essa cadeia de caracteres é limitada a 30.000 caracteres.

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: o formato para o qual a assinatura deve ser definida. Se Texto, o método define a assinatura como texto sem formatação, removendo todas as marcas HTML presentes. Se Html, o método define a assinatura como HTML.

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

[ Conjunto de API: Caixa de correio 1.10 ]

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

Modo outlook aplicável: compose

Importante:

Em Outlook na Web, setSignatureAsync só funciona em mensagens.
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 um cenário de exemplo, consulte Implementar ativação baseada em evento em suplementos móveis do Outlook. Para saber mais sobre APIs com suporte no Outlook mobile, confira APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
O comportamento de setSignatureAsync difere se você chamá-lo no manipulador de eventos de um suplemento que implementa o recurso de ativação baseado em evento usando LaunchEvent no manifesto. Quando o usuário compõe um novo item (incluindo resposta ou encaminhamento), a assinatura é definida, mas não modifica o formulário. Isso significa que, se o usuário fechar o formulário sem fazer outras edições, ele não será solicitado a salvar alterações.

Erros:

DataExceedsMaximumSize: o data parâmetro é maior que 30.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html e o corpo da mensagem está em texto sem formatação.

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

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

...

// Set the signature for the current item.
const signature = $("#signature").val();
console.log(`Setting signature to "${signature}".`);
Office.context.mailbox.item.body.setSignatureAsync(signature, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("setSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

setSignatureAsync(data, callback)

Adiciona uma assinatura ao corpo do item se ele não tiver uma assinatura existente. Se já houver uma assinatura no corpo, substitua essa assinatura.

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

Parâmetros

data: string

A cadeia de caracteres que representa a assinatura a ser definida no corpo do email. Essa cadeia de caracteres é limitada a 30.000 caracteres.

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

[ Conjunto de API: Caixa de correio 1.10 ]

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

Modo outlook aplicável: compose

Importante:

Em Outlook na Web, setSignatureAsync só funciona em mensagens.
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 um cenário de exemplo, consulte Implementar ativação baseada em evento em suplementos móveis do Outlook. Para saber mais sobre APIs com suporte no Outlook mobile, confira APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
O comportamento de setSignatureAsync difere se você chamá-lo no manipulador de eventos de um suplemento que implementa o recurso de ativação baseado em evento usando LaunchEvent no manifesto. Quando o usuário compõe um novo item (incluindo resposta ou encaminhamento), a assinatura é definida, mas não modifica o formulário. Isso significa que, se o usuário fechar o formulário sem fazer outras edições, ele não será solicitado a salvar alterações.

Erros:

DataExceedsMaximumSize: o data parâmetro é maior que 30.000 caracteres.
InvalidFormatError: o options.coercionType parâmetro é definido como Office.CoercionType.Html e o corpo da mensagem está em texto sem formatação.

Office.Body interface

Comentários

Métodos

Detalhes do método

appendOnSendAsync(data, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

appendOnSendAsync(data, callback)

Parâmetros

Retornos

Comentários

getAsync(coercionType, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

getAsync(coercionType, callback)

Parâmetros

Retornos

Comentários

Exemplos

getTypeAsync(options, callback)

Parâmetros

Retornos

Comentários

Exemplos

getTypeAsync(callback)

Parâmetros

Retornos

Comentários

prependAsync(data, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

prependAsync(data, callback)

Parâmetros

Retornos

Comentários

prependOnSendAsync(data, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

prependOnSendAsync(data, callback)

Parâmetros

Retornos

Comentários

setAsync(data, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setAsync(data, callback)

Parâmetros

Retornos

Comentários

setSelectedDataAsync(data, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setSelectedDataAsync(data, callback)

Parâmetros

Retornos

Comentários

setSignatureAsync(data, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setSignatureAsync(data, callback)

Parâmetros

Retornos

Comentários

Comentários

Recursos adicionais