Office.InternetHeaders interface

Ссылка

Пакет:: outlook

Объект InternetHeaders представляет пользовательские заголовки Интернета, которые сохраняются после того, как элемент сообщения покинет Exchange и преобразуется в сообщение MIME.

Заголовки Интернета хранятся в виде строковых пар "ключ—значение" для каждого элемента.

Примечание. Этот объект предназначен для установки и получения пользовательских заголовков в элементе сообщения. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.

Важно! API заголовков в Интернете поддерживается в Outlook для Android и iOS, начиная с версии 4.2405.0. Дополнительные сведения о функциях, поддерживаемых в Outlook на мобильных устройствах, см. в статье Api JavaScript Outlook, поддерживаемые в Outlook на мобильных устройствах.

Рекомендуемые методики:

В настоящее время заголовки Интернета являются конечным ресурсом в почтовом ящике пользователя. Когда квота исчерпана, вы не сможете создавать в этом почтовом ящике дополнительные заголовки в Интернете, что может привести к непредвиденному поведению клиентов, которые полагаются на эту функцию.

При создании заголовков в Интернете в надстройке используйте следующие рекомендации.

Создайте минимальное необходимое количество заголовков. Квота заголовков зависит от общего размера заголовков, применяемых к сообщению. В Exchange Online ограничение заголовка ограничено 256 КБ, а в локальной среде Exchange ограничение определяется администратором вашей организации. Дополнительные сведения об ограничениях заголовков см. в разделах Ограничения сообщений Exchange Online и Ограничения сообщений Exchange Server.
Присвойте заголовкам имена, чтобы вы могли повторно использовать и обновлять их значения позже. Таким образом, избегайте именования заголовков переменным образом (например, на основе введенных пользователем данных или метки времени).

Методы

getAsync(names, options, callback)	Учитывая массив имен заголовков в Интернете, этот метод возвращает запись, содержащую эти заголовки интернета и их значения. Если надстройка запрашивает заголовок, который недоступен, этот заголовок не будет возвращен в результатах. Примечание. Этот метод предназначен для возврата значений настраиваемых заголовков, заданных с помощью `setAsync` метода .
getAsync(names, callback)	Учитывая массив имен заголовков в Интернете, этот метод возвращает запись, содержащую эти заголовки интернета и их значения. Если надстройка запрашивает заголовок, который недоступен, этот заголовок не будет возвращен в результатах. Примечание. Этот метод предназначен для возврата значений настраиваемых заголовков, заданных с помощью `setAsync` метода .
removeAsync(names, options, callback)	Учитывая массив имен заголовков в Интернете, этот метод удаляет указанные заголовки из коллекции заголовков Интернета. Примечание. Этот метод предназначен для удаления пользовательских заголовков, заданных с помощью `setAsync` метода .
removeAsync(names, callback)	Учитывая массив имен заголовков в Интернете, этот метод удаляет указанные заголовки из коллекции заголовков Интернета. Примечание. Этот метод предназначен для удаления пользовательских заголовков, заданных с помощью `setAsync` метода .
setAsync(headers, options, callback)	Задает указанные заголовки Интернета в указанные значения. Метод `setAsync` создает новый заголовок, если указанный заголовок еще не существует; в противном случае существующее значение заменяется новым значением. Примечание. Этот метод предназначен для задания значений пользовательских заголовков.
setAsync(headers, callback)	Задает указанные заголовки Интернета в указанные значения. Метод `setAsync` создает новый заголовок, если указанный заголовок еще не существует; в противном случае существующее значение заменяется новым значением. Примечание. Этот метод предназначен для задания значений пользовательских заголовков.

Сведения о методе

getAsync(names, options, callback)

Учитывая массив имен заголовков в Интернете, этот метод возвращает запись, содержащую эти заголовки интернета и их значения. Если надстройка запрашивает заголовок, который недоступен, этот заголовок не будет возвращен в результатах.

Примечание. Этот метод предназначен для возврата значений настраиваемых заголовков, заданных с помощью setAsync метода .

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

Параметры

names: string[]

Имена возвращаемых заголовков в Интернете.

options: Office.AsyncContextOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

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

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром ,asyncResult с типом Office.AsyncResult. В свойстве возвращаются asyncResult.value пары "ключ— значение" строковых заголовков интернета. Все возникшие ошибки предоставляются в свойстве asyncResult.error .

Возвращаемое значение

void

Примеры

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

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

Параметры

names: string[]

Имена возвращаемых заголовков в Интернете.

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

Возвращаемое значение

void

removeAsync(names, options, callback)

Учитывая массив имен заголовков в Интернете, этот метод удаляет указанные заголовки из коллекции заголовков Интернета.

Примечание. Этот метод предназначен для удаления пользовательских заголовков, заданных с помощью setAsync метода .

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

Параметры

names: string[]

Имена удаляемых заголовков в Интернете.

options: Office.AsyncContextOptions

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром ,asyncResult с типом Office.AsyncResult. Все возникшие ошибки предоставляются в свойстве asyncResult.error .

Возвращаемое значение

void

Примеры

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

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

Параметры

names: string[]

Имена удаляемых заголовков в Интернете.

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

Возвращаемое значение

void

setAsync(headers, options, callback)

Задает указанные заголовки Интернета в указанные значения.

Метод setAsync создает новый заголовок, если указанный заголовок еще не существует; в противном случае существующее значение заменяется новым значением.

Примечание. Этот метод предназначен для задания значений пользовательских заголовков.

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

Параметры

headers: Record<string, string>

Имена и соответствующие значения задается заголовков. Это должен быть объект записи, ключи которого — имена заголовков в Интернете, а значения — соответствующими строками значений заголовка.

options: Office.AsyncContextOptions

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

Возвращаемое значение

void

API заголовков в Интернете поддерживается в Outlook для Android и iOS начиная с версии 4.2405.0. Дополнительные сведения о функциях, поддерживаемых в Outlook на мобильных устройствах, см. в статье Api JavaScript Outlook, поддерживаемые в Outlook на мобильных устройствах.
Квота заголовков зависит от общего размера заголовков, применяемых к сообщению. В Exchange Online ограничение заголовка ограничено 256 КБ, а в локальной среде Exchange ограничение определяется администратором вашей организации. Дополнительные сведения об ограничениях заголовков см. в разделах Ограничения сообщений Exchange Online и Ограничения сообщений Exchange Server.

Примеры

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

Задает указанные заголовки Интернета в указанные значения.

Примечание. Этот метод предназначен для задания значений пользовательских заголовков.

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

Параметры

headers: Record<string, string>

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

Возвращаемое значение

void

API заголовков в Интернете поддерживается в Outlook для Android и iOS начиная с версии 4.2405.0. Дополнительные сведения о функциях, поддерживаемых в Outlook на мобильных устройствах, см. в статье Api JavaScript Outlook, поддерживаемые в Outlook на мобильных устройствах.
Квота заголовков зависит от общего размера заголовков, применяемых к сообщению. В Exchange Online ограничение заголовка ограничено 256 КБ, а в локальной среде Exchange ограничение определяется администратором вашей организации. Дополнительные сведения об ограничениях заголовков см. в разделах Ограничения сообщений Exchange Online и Ограничения сообщений Exchange Server.

Поделиться через

Office.InternetHeaders interface

Комментарии

Методы

Сведения о методе

getAsync(names, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

getAsync(names, callback)

Параметры

Возвращаемое значение

Комментарии

removeAsync(names, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

removeAsync(names, callback)

Параметры

Возвращаемое значение

Комментарии

setAsync(headers, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

setAsync(headers, callback)

Параметры

Возвращаемое значение

Комментарии

Дополнительные ресурсы