Office.InternetHeaders interface
El InternetHeaders objeto representa encabezados de Internet personalizados que se conservan después de que el elemento de mensaje salga de Exchange y se convierta en un mensaje MIME.
Los encabezados de Internet se almacenan como pares clave-valor de cadena por elemento.
Nota: Este objeto está pensado para que establezca y obtenga los encabezados personalizados en un elemento de mensaje. Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Redacción
Importante: La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Prácticas recomendadas:
Actualmente, los encabezados de Internet son un recurso finito en el buzón de un usuario. Cuando se agota la cuota, no se pueden crear más encabezados de Internet en ese buzón, lo que puede dar lugar a un comportamiento inesperado de los clientes que dependen de esto para funcionar.
Aplique las siguientes directrices al crear encabezados de Internet en el complemento.
Create el número mínimo de encabezados necesarios. La cuota de encabezado se basa en el tamaño total de los encabezados aplicados a un mensaje. En Exchange Online, el límite de encabezado se limita a 256 KB, mientras que en un entorno local de Exchange, el límite lo determina el administrador de la organización. Para obtener más información sobre los límites de encabezado, consulte Exchange Online límites de mensajes y Exchange Server límites de mensajes.
Asigne un nombre a los encabezados para que pueda reutilizar y actualizar sus valores más adelante. Por lo tanto, evite asignar nombres a los encabezados de forma variable (por ejemplo, en función de la entrada del usuario o una marca de tiempo).
Métodos
| get |
Dada una matriz de nombres de encabezado de Internet, este método devuelve un registro que contiene esos encabezados de Internet y sus valores. Si el complemento solicita un encabezado que no está disponible, ese encabezado no se devolverá en los resultados. Nota: Este método está diseñado para devolver los valores de los encabezados personalizados establecidos mediante el |
| get |
Dada una matriz de nombres de encabezado de Internet, este método devuelve un registro que contiene esos encabezados de Internet y sus valores. Si el complemento solicita un encabezado que no está disponible, ese encabezado no se devolverá en los resultados. Nota: Este método está diseñado para devolver los valores de los encabezados personalizados establecidos mediante el |
| remove |
Dado una matriz de nombres de encabezado de Internet, este método quita los encabezados especificados de la colección de encabezados de Internet. Nota: Este método está diseñado para quitar los encabezados personalizados establecidos mediante el |
| remove |
Dado una matriz de nombres de encabezado de Internet, este método quita los encabezados especificados de la colección de encabezados de Internet. Nota: Este método está diseñado para quitar los encabezados personalizados establecidos mediante el |
| set |
Establece los encabezados de Internet especificados en los valores especificados. El Nota: Este método está diseñado para establecer los valores de los encabezados personalizados. |
| set |
Establece los encabezados de Internet especificados en los valores especificados. El Nota: Este método está diseñado para establecer los valores de los encabezados personalizados. |
Detalles del método
getAsync(names, options, callback)
Dada una matriz de nombres de encabezado de Internet, este método devuelve un registro que contiene esos encabezados de Internet y sus valores. Si el complemento solicita un encabezado que no está disponible, ese encabezado no se devolverá en los resultados.
Nota: Este método está diseñado para devolver los valores de los encabezados personalizados establecidos mediante el setAsync método .
getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;Parámetros
- names
-
string[]
Los nombres de los encabezados de Internet que se van a devolver.
- options
- Office.AsyncContextOptions
Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. Los pares clave-valor de cadena de encabezados de Internet se devuelven en la asyncResult.value propiedad . Los errores detectados se proporcionan en la asyncResult.error propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Redacción
Importante: La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Ejemplos
// 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)
Dada una matriz de nombres de encabezado de Internet, este método devuelve un registro que contiene esos encabezados de Internet y sus valores. Si el complemento solicita un encabezado que no está disponible, ese encabezado no se devolverá en los resultados.
Nota: Este método está diseñado para devolver los valores de los encabezados personalizados establecidos mediante el setAsync método .
getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;Parámetros
- names
-
string[]
Los nombres de los encabezados de Internet que se van a devolver.
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. Los pares clave-valor de cadena de encabezados de Internet se devuelven en la asyncResult.value propiedad . Los errores detectados se proporcionan en la asyncResult.error propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Redacción
Importante: La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
removeAsync(names, options, callback)
Dado una matriz de nombres de encabezado de Internet, este método quita los encabezados especificados de la colección de encabezados de Internet.
Nota: Este método está diseñado para quitar los encabezados personalizados establecidos mediante el setAsync método .
removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- names
-
string[]
Los nombres de los encabezados de Internet que se van a quitar.
- options
- Office.AsyncContextOptions
Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. Los errores detectados se proporcionan en la asyncResult.error propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Redacción
Importante: La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Ejemplos
// 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)
Dado una matriz de nombres de encabezado de Internet, este método quita los encabezados especificados de la colección de encabezados de Internet.
Nota: Este método está diseñado para quitar los encabezados personalizados establecidos mediante el setAsync método .
removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- names
-
string[]
Los nombres de los encabezados de Internet que se van a quitar.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. Los errores detectados se proporcionan en la asyncResult.error propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Redacción
Importante: La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
setAsync(headers, options, callback)
Establece los encabezados de Internet especificados en los valores especificados.
El setAsync método crea un nuevo encabezado si el encabezado especificado aún no existe; de lo contrario, el valor existente se reemplaza por el nuevo valor.
Nota: Este método está diseñado para establecer los valores de los encabezados personalizados.
setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- headers
-
Record<string, string>
Los nombres y los valores correspondientes de los encabezados que se van a establecer. Debe ser un objeto de registro con sus claves como nombres de encabezado de Internet y valores como cadenas de valor de encabezado correspondientes.
- options
- Office.AsyncContextOptions
Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. Los errores detectados se proporcionan en la asyncResult.error propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Redacción
Importante:
La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
La cuota de encabezado se basa en el tamaño total de los encabezados aplicados a un mensaje. En Exchange Online, el límite de encabezado se limita a 256 KB, mientras que en un entorno local de Exchange, el límite lo determina el administrador de la organización. Para obtener más información sobre los límites de encabezado, consulte Exchange Online límites de mensajes y Exchange Server límites de mensajes.
Ejemplos
// 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)
Establece los encabezados de Internet especificados en los valores especificados.
El setAsync método crea un nuevo encabezado si el encabezado especificado aún no existe; de lo contrario, el valor existente se reemplaza por el nuevo valor.
Nota: Este método está diseñado para establecer los valores de los encabezados personalizados.
setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- headers
-
Record<string, string>
Los nombres y los valores correspondientes de los encabezados que se van a establecer. Debe ser un objeto de registro con sus claves como nombres de encabezado de Internet y valores como cadenas de valor de encabezado correspondientes.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. Los errores detectados se proporcionan en la asyncResult.error propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Redacción
Importante:
La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
La cuota de encabezado se basa en el tamaño total de los encabezados aplicados a un mensaje. En Exchange Online, el límite de encabezado se limita a 256 KB, mientras que en un entorno local de Exchange, el límite lo determina el administrador de la organización. Para obtener más información sobre los límites de encabezado, consulte Exchange Online límites de mensajes y Exchange Server límites de mensajes.