Office.InternetHeaders interface

Пакет:
outlook

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

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

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

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose

Важно! 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

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose

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

Примеры

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

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

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

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

Параметры

names

string[]

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose

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

removeAsync(names, options, callback)

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

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

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

Параметры

names

string[]

Имена интернет-заголовков, которые нужно удалить.

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Важно!

Примеры

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

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

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

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

Параметры

names

string[]

Имена интернет-заголовков, которые нужно удалить.

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Важно!

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

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Важно!

Примеры

// 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 создает новый заголовок, если указанного заголовка еще не существует; в противном случае существующее значение заменяется новым значением.

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

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

Параметры

headers

Record<string, string>

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Важно!