Office.InternetHeaders interface
O InternetHeaders objeto representa cabeçalhos de Internet personalizados que são preservados após o item de mensagem sair do Exchange e ser convertido numa mensagem MIME.
Os cabeçalhos da Internet são armazenados como pares chave-valor de cadeia numa base por item.
Nota: este objeto destina-se a definir e obter os cabeçalhos personalizados num item de mensagem. Para saber mais, consulte Obter e definir cabeçalhos da Internet numa mensagem num suplemento do Outlook.
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose
Importante: a API de cabeçalhos da Internet é suportada no Outlook no Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas 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 utilizador. Quando a quota está esgotada, não pode criar mais cabeçalhos de Internet nessa caixa de correio, o que pode resultar num comportamento inesperado dos clientes que dependem disto para funcionar.
Aplique as seguintes diretrizes quando criar cabeçalhos de Internet no seu suplemento.
Crie o número mínimo de cabeçalhos necessário. A quota de cabeçalho baseia-se no tamanho total dos cabeçalhos aplicados a uma mensagem. No Exchange Online, o limite de cabeçalhos está limitado a 256 KB, enquanto num ambiente do Exchange no local, o limite é determinado pelo administrador da sua organização. Para obter mais informações sobre os limites de cabeçalho, veja Exchange Online limites de mensagens e Exchange Server limites de mensagens.
Cabeçalhos de nomes para que possa reutilizar e atualizar os respetivos valores mais tarde. Como tal, evite atribuir nomes a cabeçalhos de forma variável (por exemplo, com base na entrada do utilizador ou num carimbo de data/hora).
Métodos
| get |
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método devolve um registo que contém esses cabeçalhos de Internet e os respetivos valores. Se o suplemento pedir um cabeçalho que não esteja disponível, esse cabeçalho não será devolvido nos resultados.
Nota: este método destina-se a devolver os valores dos cabeçalhos personalizados que definiu com o |
| get |
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método devolve um registo que contém esses cabeçalhos de Internet e os respetivos valores. Se o suplemento pedir um cabeçalho que não esteja disponível, esse cabeçalho não será devolvido nos resultados.
Nota: este método destina-se a devolver os valores dos cabeçalhos personalizados que definiu com o |
| remove |
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet.
Nota: este método destina-se a remover os cabeçalhos personalizados que definiu com o |
| remove |
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet.
Nota: este método destina-se a remover os cabeçalhos personalizados que definiu com o |
| set |
Define os cabeçalhos de Internet especificados para os valores especificados. O Nota: este método destina-se a definir os valores dos cabeçalhos personalizados. |
| set |
Define os cabeçalhos de Internet especificados para os valores especificados. O Nota: este método destina-se a definir os valores dos cabeçalhos personalizados. |
Detalhes do método
getAsync(names, options, callback)
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método devolve um registo que contém esses cabeçalhos de Internet e os respetivos valores. Se o suplemento pedir um cabeçalho que não esteja disponível, esse cabeçalho não será devolvido nos resultados.
Nota: este método destina-se a devolver os valores dos cabeçalhos personalizados que definiu com 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 devolvidos.
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro,asyncResult , do tipo Office.AsyncResult. Os pares chave-valor da cadeia de carateres dos cabeçalhos da Internet são devolvidos 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: ler item
Modo Outlook aplicável: Compose
Importante: a API de cabeçalhos da Internet é suportada no Outlook no Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.getAsync(
["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
function (asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Selected headers: " + JSON.stringify(asyncResult.value));
} else {
console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
}
}
);
getAsync(names, callback)
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método devolve um registo que contém esses cabeçalhos de Internet e os respetivos valores. Se o suplemento pedir um cabeçalho que não esteja disponível, esse cabeçalho não será devolvido nos resultados.
Nota: este método destina-se a devolver os valores dos cabeçalhos personalizados que definiu com 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 devolvidos.
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro,asyncResult , do tipo Office.AsyncResult. Os pares chave-valor da cadeia de carateres dos cabeçalhos da Internet são devolvidos 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: ler item
Modo Outlook aplicável: Compose
Importante: a API de cabeçalhos da Internet é suportada no Outlook no Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
removeAsync(names, options, callback)
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet.
Nota: este método destina-se a remover os cabeçalhos personalizados que definiu com 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 programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro,asyncResult , do 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/escrita
Modo Outlook aplicável: Compose
Importante: a API de cabeçalhos da Internet é suportada no Outlook no Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.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)
Tendo em conta uma matriz de nomes de cabeçalhos da Internet, este método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet.
Nota: este método destina-se a remover os cabeçalhos personalizados que definiu com 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
Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro,asyncResult , do 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/escrita
Modo Outlook aplicável: Compose
Importante: a API de cabeçalhos da Internet é suportada no Outlook no Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
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 é substituído pelo novo valor.
Nota: este método destina-se a definir os valores dos 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 definir. Este deve ser um objeto de registo, sendo as respetivas chaves nomes e valores de cabeçalho da Internet as cadeias de valor de cabeçalho correspondentes.
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro,asyncResult , do 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/escrita
Modo Outlook aplicável: Compose
Importante:
A API de cabeçalhos da Internet é suportada no Outlook para Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
A quota de cabeçalho baseia-se no tamanho total dos cabeçalhos aplicados a uma mensagem. No Exchange Online, o limite de cabeçalhos está limitado a 256 KB, enquanto num ambiente do Exchange no local, o limite é determinado pelo administrador da sua organização. Para obter mais informações sobre os limites de cabeçalho, veja Exchange Online limites de mensagens e Exchange Server limites 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.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 é substituído pelo novo valor.
Nota: este método destina-se a definir os valores dos cabeçalhos personalizados.
setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parâmetros
- headers
-
Record<string, string>
Os nomes e os valores correspondentes dos cabeçalhos a definir. Este deve ser um objeto de registo, sendo as respetivas chaves nomes e valores de cabeçalho da Internet as cadeias de valor de cabeçalho correspondentes.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro,asyncResult , do 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/escrita
Modo Outlook aplicável: Compose
Importante:
A API de cabeçalhos da Internet é suportada no Outlook para Android e no iOS a partir da Versão 4.2405.0. Para saber mais sobre as funcionalidades suportadas no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
A quota de cabeçalho baseia-se no tamanho total dos cabeçalhos aplicados a uma mensagem. No Exchange Online, o limite de cabeçalhos está limitado a 256 KB, enquanto num ambiente do Exchange no local, o limite é determinado pelo administrador da sua organização. Para obter mais informações sobre os limites de cabeçalho, veja Exchange Online limites de mensagens e Exchange Server limites de mensagens.