Office.InternetHeaders interface

Referência

Pacote:: outlook

O InternetHeaders objeto representa cabeçalhos personalizados da Internet que são preservados depois que o item da mensagem deixa o Exchange e é convertido em uma mensagem MIME.

Os cabeçalhos da Internet são armazenados como pares de chave de cadeia de caracteres por item.

Observação: este objeto destina-se a definir e obter seus cabeçalhos personalizados em um item de mensagem. Para saber mais, confira Obter e definir cabeçalhos da Internet em uma mensagem em um suplemento do Outlook.

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

Importante: a API de cabeçalhos da Internet tem suporte no Outlook no Android e no iOS a partir da versão 4.2405.0. Para saber mais sobre os recursos com suporte no Outlook em dispositivos móveis, confira APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Práticas recomendadas

Atualmente, os cabeçalhos da Internet são um recurso finito na caixa de correio de um usuário. Quando a cota estiver esgotada, você não poderá criar mais cabeçalhos de Internet nessa caixa de correio, o que pode resultar em um comportamento inesperado de clientes que dependem disso para funcionar.

Aplique as diretrizes a seguir ao criar cabeçalhos da Internet no suplemento.

Create o número mínimo de cabeçalhos necessários. A cota de cabeçalho é baseada no tamanho total dos cabeçalhos aplicados a uma mensagem. Em Exchange Online, o limite de cabeçalho é limitado a 256 KB, enquanto em um ambiente local do Exchange, o limite é determinado pelo administrador da sua organização. Para obter mais informações sobre limites de cabeçalho, consulte Exchange Online limites de mensagem e Exchange Server limites de mensagem.
Nomeie cabeçalhos para que você possa reutilizar e atualizar seus valores posteriormente. Como tal, evite nomear cabeçalhos de maneira variável (por exemplo, com base na entrada do usuário, carimbo de data/hora etc.).

Métodos

getAsync(names, options, callback)	Dada uma matriz de nomes de cabeçalho da Internet, esse método retorna um registro que contém esses cabeçalhos de Internet e seus valores. Se o suplemento solicitar um cabeçalho que não esteja disponível, esse cabeçalho não será retornado nos resultados. Observação: esse método destina-se a retornar os valores dos cabeçalhos personalizados definidos usando o `setAsync` método.
getAsync(names, callback)	Dada uma matriz de nomes de cabeçalho da Internet, esse método retorna um registro que contém esses cabeçalhos de Internet e seus valores. Se o suplemento solicitar um cabeçalho que não esteja disponível, esse cabeçalho não será retornado nos resultados. Observação: esse método destina-se a retornar os valores dos cabeçalhos personalizados definidos usando o `setAsync` método.
removeAsync(names, options, callback)	Dada uma matriz de nomes de cabeçalho da Internet, esse método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet. Observação: este método destina-se a remover os cabeçalhos personalizados definidos usando o `setAsync` método.
removeAsync(names, callback)	Dada uma matriz de nomes de cabeçalho da Internet, esse método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet. Observação: este método destina-se a remover os cabeçalhos personalizados definidos usando o `setAsync` método.
setAsync(headers, options, callback)	Define os cabeçalhos de Internet especificados para os valores especificados. O `setAsync` método cria um novo cabeçalho se o cabeçalho especificado ainda não existir; caso contrário, o valor existente será substituído pelo novo valor. Observação: esse método destina-se a definir os valores de seus cabeçalhos personalizados.
setAsync(headers, callback)	Define os cabeçalhos de Internet especificados para os valores especificados. O `setAsync` método cria um novo cabeçalho se o cabeçalho especificado ainda não existir; caso contrário, o valor existente será substituído pelo novo valor. Observação: esse método destina-se a definir os valores de seus cabeçalhos personalizados.

Detalhes do método

getAsync(names, options, callback)

Dada uma matriz de nomes de cabeçalho da Internet, esse método retorna um registro que contém esses cabeçalhos de Internet e seus valores. Se o suplemento solicitar um cabeçalho que não esteja disponível, esse cabeçalho não será retornado nos resultados.

Observação: esse método destina-se a retornar os valores dos cabeçalhos personalizados definidos usando o setAsync método.

getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;

Parâmetros

names: string[]

Os nomes dos cabeçalhos da Internet a serem retornados.

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<Record<string, string>>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultdo tipo Office.AsyncResult. Os pares de valores de chave de cadeia de caracteres de cabeçalhos da Internet são retornados na asyncResult.value propriedade. Todos os erros encontrados são fornecidos na asyncResult.error propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

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

getAsync(names, callback)

Observação: esse método destina-se a retornar os valores dos cabeçalhos personalizados definidos usando o setAsync método.

getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;

Parâmetros

names: string[]

Os nomes dos cabeçalhos da Internet a serem retornados.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

removeAsync(names, options, callback)

Dada uma matriz de nomes de cabeçalho da Internet, esse método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet.

Observação: este método destina-se a remover os cabeçalhos personalizados definidos usando o setAsync método.

removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

names: string[]

Os nomes dos cabeçalhos da Internet a serem removidos.

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, , asyncResultdo tipo Office.AsyncResult. Todos os erros encontrados são fornecidos na asyncResult.error propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

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.removeAsync(
  ["best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully removed selected headers");
    } else {
      console.log("Error removing selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(names, callback)

Dada uma matriz de nomes de cabeçalho da Internet, esse método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet.

Observação: este método destina-se a remover os cabeçalhos personalizados definidos usando o setAsync método.

removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

names: string[]

Os nomes dos cabeçalhos da Internet a serem removidos.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

setAsync(headers, options, callback)

Define os cabeçalhos de Internet especificados para os valores especificados.

O setAsync método cria um novo cabeçalho se o cabeçalho especificado ainda não existir; caso contrário, o valor existente será substituído pelo novo valor.

Observação: esse método destina-se a definir os valores de seus cabeçalhos personalizados.

setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

headers: Record<string, string>

Os nomes e os valores correspondentes dos cabeçalhos a serem definidos. Este deve ser um objeto de registro com suas chaves sendo nomes e valores de cabeçalho da Internet sendo as cadeias de caracteres de valor de cabeçalho correspondentes.

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

Importante:

A API de cabeçalhos da Internet tem suporte no Outlook no Android e no iOS a partir da versão 4.2405.0. Para saber mais sobre os recursos com suporte no Outlook em dispositivos móveis, confira APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
A cota de cabeçalho é baseada no tamanho total dos cabeçalhos aplicados a uma mensagem. Em Exchange Online, o limite de cabeçalho é limitado a 256 KB, enquanto em um ambiente local do Exchange, o limite é determinado pelo administrador da sua organização. Para obter mais informações sobre limites de cabeçalho, consulte Exchange Online limites de mensagem e Exchange Server limites de mensagem.

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.setAsync(
  { "preferred-fruit": "orange", "preferred-vegetable": "broccoli", "best-vegetable": "spinach" },
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully set headers");
    } else {
      console.log("Error setting headers: " + JSON.stringify(asyncResult.error));
    }
  }

);

setAsync(headers, callback)

Define os cabeçalhos de Internet especificados para os valores especificados.

O setAsync método cria um novo cabeçalho se o cabeçalho especificado ainda não existir; caso contrário, o valor existente será substituído pelo novo valor.

Observação: esse método destina-se a definir os valores de seus cabeçalhos personalizados.

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

Parâmetros

headers: Record<string, string>

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose

Importante:

A API de cabeçalhos da Internet tem suporte no Outlook no Android e no iOS a partir da versão 4.2405.0. Para saber mais sobre os recursos com suporte no Outlook em dispositivos móveis, confira APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.
A cota de cabeçalho é baseada no tamanho total dos cabeçalhos aplicados a uma mensagem. Em Exchange Online, o limite de cabeçalho é limitado a 256 KB, enquanto em um ambiente local do Exchange, o limite é determinado pelo administrador da sua organização. Para obter mais informações sobre limites de cabeçalho, consulte Exchange Online limites de mensagem e Exchange Server limites de mensagem.

Compartilhar via

Office.InternetHeaders interface

Comentários

Métodos

Detalhes do método

getAsync(names, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

getAsync(names, callback)

Parâmetros

Retornos

Comentários

removeAsync(names, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

removeAsync(names, callback)

Parâmetros

Retornos

Comentários

setAsync(headers, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setAsync(headers, callback)

Parâmetros

Retornos

Comentários

Recursos adicionais