Office.AppointmentRead interface

Пакет:

outlook

Режим участника встречи Office.context.mailbox.item.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Вы должны рассматривать это как модус Office.context.mailbox.item. Дополнительные сведения см. в статье Модель объектов элементов Outlook.

Родительские интерфейсы:

• Чтение элемента

• Встреча

Extends

Office.Appointment

Комментарии

Используется

• Office.Mailbox: элемент

Свойства

attachments	Получает вложения элемента в виде массива.
body	Получает объект, предоставляющий методы для работы с основным текстом элемента.
categories	Получает объект, предоставляющий методы для управления категориями элемента.
dateTimeCreated	Получает дату и время создания элемента.
dateTimeModified	Получает дату и время последнего изменения элемента.
end	Получает дату и время окончания встречи. Это end свойство представляет собой объект, Date выраженный в формате даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в местную дату и время клиента. Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.
enhancedLocation	Получает места встречи. Свойство enhancedLocation возвращает объект EnhancedLocation , позволяющий получить набор расположений (каждое из которых представлено объектом LocationDetails ), связанных со встречей.
isAllDayEvent	Возвращает логическое значение, указывающее, длится ли событие весь день.
itemClass	Получает класс элементов веб-служб Exchange для выбранной встречи. Возвращает данные IPM.Appointment о повторяющихся и неповторяющихся встречах IPM.Appointment.Occurrence .
itemId	Получает идентификатор элемента веб-службы Exchange (EWS) для текущего элемента.
itemType	Получает тип элемента, который представляет экземпляр. Свойство itemTypeItemType возвращает одно из значений перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
location	Получает место встречи. Свойство location возвращает строку, содержащую сведения о месте встречи.
normalizedSubject	Получает тему элемента с удалением всех префиксов (включая RE: и FWD:). Свойство normalizedSubject получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), добавляемыми почтовыми программами. Для получения темы элемента с неизмененными префиксами используйте свойство subject.
notificationMessages	Получает сообщения уведомления для элемента.
optionalAttendees	Предоставляет доступ к необязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство optionalAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого необязательного участника собрания. Максимальное количество возвращаемых участников зависит от клиента Outlook. Windows (классическая версия — почтовый ящик 1.15 и более ранние версии): 500 участников Веб-версия, Windows (новая, классическая — почтовый ящик 1.16 и более поздние версии): 1000 получателей Android, классический пользовательский интерфейс Mac, iOS: 100 участников Новый пользовательский интерфейс Mac: не ограничен
organizer	Получает свойства электронной почты организатора собрания.
recurrence	Получает схему повторения встречи. Получает шаблон повторения приглашения на собрание. Свойство recurrence возвращает объект Recurrence для повторяющихся встреч или приглашений на собрания, если элемент является рядом или экземпляром ряда. null возвращается для отдельных встреч и приглашений на собрания отдельных встреч. Примечание. Приглашения на собрание itemClass имеют значение, равное IPM.Schedule.Meeting.Request. Примечание. Если объект повторения имеет значение null, это означает, что объект является единственной встречей или приглашением на собрание одной встречи и НЕ является частью ряда.
requiredAttendees	Предоставляет доступ к обязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство requiredAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого обязательного участника собрания. Максимальное количество возвращаемых участников зависит от клиента Outlook. Windows (классическая версия — почтовый ящик 1.15 и более ранние версии): 500 участников Веб-версия, Windows (новая, классическая — почтовый ящик 1.16 и более поздние версии): 1000 получателей Android, классический пользовательский интерфейс Mac, iOS: 100 участников Новый пользовательский интерфейс Mac: не ограничен
sensitivity	Предоставляет значение конфиденциальности встречи.
seriesId	Получает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете, в Windows (новой и классической версии) и в Mac seriesId возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (серии), к которому принадлежит этот элемент. Однако в iOS и Android код seriesId возвращает REST идентификатора родительского элемента. Примечание. Идентификатор, возвращаемый свойством seriesId , совпадает с идентификатором элемента веб-служб Exchange. Это seriesId свойство не идентично идентификаторам Outlook, используемым REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId. Дополнительные сведения см. в статье Использование Outlook REST API из надстройки Outlook. Свойство seriesId возвращает null элементы, которые не имеют родительских элементов, таких как отдельные встречи, элементы ряда или приглашения на собрания, и возвращает undefined любые другие элементы, не являющиеся приглашениями на собрания.
start	Получает дату и время начала встречи. Это start свойство представляет собой объект, Date выраженный в формате даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в местную дату и время клиента.
subject	Получает описание, отображаемое в поле темы элемента. Свойство subject получает или задает всю тему элемента для отправки с почтового сервера. Свойство subject возвращает строку. Используйте свойство normalizedSubject , чтобы получить тему за вычетом любых начальных префиксов, таких как RE: и FW:.

Методы

addHandlerAsync(eventType, handler, options, callback)	Добавляет обработчик для поддерживаемого события. События доступны только в надстройках области задач.
addHandlerAsync(eventType, handler, callback)	Добавляет обработчик для поддерживаемого события. События доступны только в надстройках области задач.
displayReplyAllForm(formData)	Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.
displayReplyAllFormAsync(formData, options, callback)	Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.
displayReplyAllFormAsync(formData, callback)	Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.
displayReplyForm(formData)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
displayReplyFormAsync(formData, options, callback)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
displayReplyFormAsync(formData, callback)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
getAttachmentContentAsync(attachmentId, options, callback)	Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.
getAttachmentContentAsync(attachmentId, callback)	Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.
getEntities()	Получает сущности, обнаруженные в теле выбранного элемента. Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
getEntitiesByType(entityType)	Получает массив всех сущностей указанного типа, обнаруженных в теле выбранного элемента. Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
getFilteredEntitiesByName(name)	Возвращает известные сущности в выбранном элементе, которые проходят именованный фильтр, определенный в файле манифеста только для надстроек. Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
getInitializationContextAsync(options, callback)	Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения.
getInitializationContextAsync(callback)	Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения.
getRegExMatches()	Возвращает строковые значения в выбранном элементе, соответствующие регулярным выражениям, определенным в файле манифеста, предназначенном только для надстроек.
getRegExMatchesByName(name)	Возвращает строковые значения в выбранном элементе, соответствующие именованному регулярному выражению, определенному в файле манифеста только для надстроек.
getSelectedEntities()	Возвращает сущности, найденные в выделенном совпадении, выбранном пользователем. Выделенные совпадения применяются к контекстным надстройкам. Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
getSelectedRegExMatches()	Возвращает строковые значения в выделенном совпадении, соответствующие регулярным выражениям, определенным в файле манифеста только для надстроек. Выделенные совпадения применяются к контекстным надстройкам.
getSharedPropertiesAsync(options, callback)	Получает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".
getSharedPropertiesAsync(callback)	Получает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".
loadCustomPropertiesAsync(callback, userContext)	Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Настраиваемые свойства хранятся в виде пар "ключ-значение" для каждого приложения и элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к настраиваемым свойствам, относящимся к текущему элементу и текущей надстройке. Пользовательские свойства элемента не зашифрованы, поэтому его не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта CustomProperties в свойстве asyncResult.value. Этот объект можно использовать для получения, настройки, сохранения и удаления настраиваемых свойств элемента почты.
removeHandlerAsync(eventType, options, callback)	Удаляет обработчиков для поддерживаемого типа события. События доступны только в надстройках области задач.
removeHandlerAsync(eventType, callback)	Удаляет обработчиков для поддерживаемого типа события. События доступны только в надстройках области задач.

Сведения о свойстве

attachments

Получает вложения элемента в виде массива.

attachments: AttachmentDetails[];

Значение свойства

Office.AttachmentDetails[]

Комментарии

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

Применимый режим Outlook: Участник встречи

Важно!

• Outlook блокирует определенные типы файлов из-за потенциальных проблем с безопасностью, поэтому они не возвращаются. Дополнительные сведения см. в статье Блокировка вложений в Outlook.

• Вложения, добавленные с помощью параметра "Отправка и общий доступ", не возвращаются.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml

const item = Office.context.mailbox.item;

if (item.attachments.length > 0) {
    for (let i = 0; i < item.attachments.length; i++) {
        const attachment = item.attachments[i];
        console.log(`${i+1}. Name: ${attachment.name}`);
        console.log(`ID: ${attachment.id}`);
        console.log(`Type: ${attachment.attachmentType}`);
        console.log(`Inline content: ${attachment.isInline}`);
        console.log(`Size: ${attachment.size}`);
    }
} else {
    console.log("This mail item doesn't contain any attachments.");
}

body

Получает объект, предоставляющий методы для работы с основным текстом элемента.

body: Body;

Значение свойства

Office.Body

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Примеры

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    Office.CoercionType.Text,
    { asyncContext: "This is passed to the callback" },
    (result) => {
        // Do something with the result.
    }
);

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including message threads that appear below the current body)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

categories

Получает объект, предоставляющий методы для управления категориями элемента.

categories: Categories;

Значение свойства

Office.Categories

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

dateTimeCreated

Получает дату и время создания элемента.

dateTimeCreated: Date;

Значение свойства

Date

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

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

dateTimeModified: Date;

Значение свойства

Date

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Это свойство не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

end

Получает дату и время окончания встречи.

Это end свойство представляет собой объект, Date выраженный в формате даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в местную дату и время клиента.

Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.

end: Date;

Значение свойства

Date

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml

const time = Office.context.mailbox.item.end;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);

enhancedLocation

Получает места встречи.

Свойство enhancedLocation возвращает объект EnhancedLocation , позволяющий получить набор расположений (каждое из которых представлено объектом LocationDetails ), связанных со встречей.

enhancedLocation: EnhancedLocation;

Значение свойства

Office.EnhancedLocation

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Для управления расположениями встреч в клиентах Outlook, которые не поддерживают набор требований к почтовому ящику 1.8, используйте свойство location . Рекомендации по выбору правильного API расположения для вашего сценария см. в статье Получение или настройка расположения при создании назначения.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

isAllDayEvent

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает логическое значение, указывающее, длится ли событие весь день.

isAllDayEvent: boolean;

Значение свойства

boolean

Комментарии

Набор API: предварительный просмотр почтового ящика

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

Применимый режим Outlook: Участник встречи

Примеры

const isAllDayEvent = Office.context.mailbox.item.isAllDayEvent;
console.log("Is this an all-day event? " + isAllDayEvent);

itemClass

Получает класс элементов веб-служб Exchange для выбранной встречи.

Возвращает данные IPM.Appointment о повторяющихся и неповторяющихся встречах IPM.Appointment.Occurrence .

itemClass: string;

Значение свойства

string

Комментарии

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

Применимый режим Outlook: Участник встречи

Важно: Вы можете создавать пользовательские классы, расширяющие класс элемента по умолчанию. Например, IPM.Appointment.Contoso.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Получает идентификатор элемента веб-службы Exchange (EWS) для текущего элемента.

itemId: string;

Значение свойства

string

Комментарии

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

Применимый режим Outlook: Участник встречи

Важно!

• Свойство itemId недоступно в режиме создания. Если требуется идентификатор элемента, метод Office.context.mailbox.item.saveAsync можно использовать для сохранения товара в магазине, который вернет идентификатор товара в параметре asyncResult.value функции обратного вызова. Если элемент уже сохранен, можно вызвать Office.context.mailbox.item.getItemIdAsync метод вместо этого.

• Возвращаемый идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.

Примеры

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

itemType

Получает тип элемента, который представляет экземпляр.

Свойство itemTypeItemType возвращает одно из значений перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.

itemType: MailboxEnums.ItemType | string;

Значение свойства

Office.MailboxEnums.ItemType | string

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

location

Получает место встречи.

Свойство location возвращает строку, содержащую сведения о месте встречи.

location: string;

Значение свойства

string

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Свойство было добавлено enhancedLocation в набор требований к почтовому ящику 1.8. Используйте свойство enhancedLocation для более точного определения мест встреч и управления ими, особенно если необходимо определить тип расположения. Рекомендации по выбору правильного API расположения для вашего сценария см. в статье Получение или настройка расположения при создании назначения.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

Получает тему элемента с удалением всех префиксов (включая RE: и FWD:).

Свойство normalizedSubject получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), добавляемыми почтовыми программами. Для получения темы элемента с неизмененными префиксами используйте свойство subject.

normalizedSubject: string;

Значение свойства

string

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

notificationMessages

Получает сообщения уведомления для элемента.

notificationMessages: NotificationMessages;

Значение свойства

Office.NotificationMessages

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• Дополнительные сведения о различных типах уведомлений, которые можно реализовать, см. в статье "Создание уведомлений для надстройки Outlook".

• Это свойство не поддерживается в Outlook для Android и в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }
  console.log(JSON.stringify(asyncResult.value));
});

...

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

...

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

optionalAttendees

Предоставляет доступ к необязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента.

Свойство optionalAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого необязательного участника собрания. Максимальное количество возвращаемых участников зависит от клиента Outlook.

• Windows (классическая версия — почтовый ящик 1.15 и более ранние версии): 500 участников

• Веб-версия, Windows (новая, классическая — почтовый ящик 1.16 и более поздние версии): 1000 получателей

• Android, классический пользовательский интерфейс Mac, iOS: 100 участников

• Новый пользовательский интерфейс Mac: не ограничен

optionalAttendees: EmailAddressDetails[];

Значение свойства

Office.EmailAddressDetails[]

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-optional-attendees-appointment-attendee.yaml

const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;
console.log("Optional attendees:");
for (let i = 0; i < apptOptionalAttendees.length; i++) {
  console.log(
    apptOptionalAttendees[i].displayName +
      " (" +
      apptOptionalAttendees[i].emailAddress +
      ") - response: " +
      apptOptionalAttendees[i].appointmentResponse
  );
}

organizer

Получает свойства электронной почты организатора собрания.

organizer: EmailAddressDetails;

Значение свойства

Office.EmailAddressDetails

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-attendee.yaml

const apptOrganizer = Office.context.mailbox.item.organizer;
console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");

recurrence

Получает схему повторения встречи. Получает шаблон повторения приглашения на собрание.

Свойство recurrence возвращает объект Recurrence для повторяющихся встреч или приглашений на собрания, если элемент является рядом или экземпляром ряда. null возвращается для отдельных встреч и приглашений на собрания отдельных встреч.

Примечание. Приглашения на собрание itemClass имеют значение, равное IPM.Schedule.Meeting.Request.

Примечание. Если объект повторения имеет значение null, это означает, что объект является единственной встречей или приглашением на собрание одной встречи и НЕ является частью ряда.

recurrence: Recurrence;

Значение свойства

Office.Recurrence

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml

const recurrence = Office.context.mailbox.item.recurrence;

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

requiredAttendees

Предоставляет доступ к обязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента.

Свойство requiredAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого обязательного участника собрания. Максимальное количество возвращаемых участников зависит от клиента Outlook.

• Windows (классическая версия — почтовый ящик 1.15 и более ранние версии): 500 участников

• Веб-версия, Windows (новая, классическая — почтовый ящик 1.16 и более поздние версии): 1000 получателей

• Android, классический пользовательский интерфейс Mac, iOS: 100 участников

• Новый пользовательский интерфейс Mac: не ограничен

requiredAttendees: EmailAddressDetails[];

Значение свойства

Office.EmailAddressDetails[]

Комментарии

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

Применимый режим Outlook: Участник встречи

Важно! В Outlook в Интернете и в Windows (новой и классической) организатор встреч включен в объект, возвращаемый свойствомrequiredAttendees.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-required-attendees-appointment-attendee.yaml

const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("Required attendees:");
for (let i = 0; i < apptRequiredAttendees.length; i++) {
  console.log(
    apptRequiredAttendees[i].displayName +
      " (" +
      apptRequiredAttendees[i].emailAddress +
      ") - response: " +
      apptRequiredAttendees[i].appointmentResponse
  );
}

sensitivity

Предоставляет значение конфиденциальности встречи.

sensitivity: MailboxEnums.AppointmentSensitivityType;

Значение свойства

Office.MailboxEnums.AppointmentSensitivityType

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Outlook в Интернете, новый Outlook для Windows и Outlook для Mac поддерживают только уровни конфиденциальности "Обычный" и "Закрытый".

Примеры

const sensitivity = Office.context.mailbox.item.sensitivity;
console.log("Sensitivity: " + sensitivity);

seriesId

Получает идентификатор ряда, к которому принадлежит экземпляр.

В Outlook в Интернете, в Windows (новой и классической версии) и в Mac seriesId возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (серии), к которому принадлежит этот элемент. Однако в iOS и Android код seriesId возвращает REST идентификатора родительского элемента.

Примечание. Идентификатор, возвращаемый свойством seriesId , совпадает с идентификатором элемента веб-служб Exchange. Это seriesId свойство не идентично идентификаторам Outlook, используемым REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId. Дополнительные сведения см. в статье Использование Outlook REST API из надстройки Outlook.

Свойство seriesId возвращает null элементы, которые не имеют родительских элементов, таких как отдельные встречи, элементы ряда или приглашения на собрания, и возвращает undefined любые другие элементы, не являющиеся приглашениями на собрания.

seriesId: string;

Значение свойства

string

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

start

Получает дату и время начала встречи.

Это start свойство представляет собой объект, Date выраженный в формате даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в местную дату и время клиента.

start: Date;

Значение свойства

Date

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml

const time = Office.context.mailbox.item.start;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);

subject

Получает описание, отображаемое в поле темы элемента.

Свойство subject получает или задает всю тему элемента для отправки с почтового сервера.

Свойство subject возвращает строку. Используйте свойство normalizedSubject , чтобы получить тему за вычетом любых начальных префиксов, таких как RE: и FW:.

subject: string;

Значение свойства

string

Комментарии

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-subject-read.yaml

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

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

addHandlerAsync(eventType, handler, options, callback)

Добавляет обработчик для поддерживаемого события. События доступны только в надстройках области задач.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType

Office.EventType | string

Событие, которое должно вызвать обработчик.

handler

any

Функция для обработки события. Функция должна принимать один параметр, представляющий собой объектный литерал. Свойство type параметра будет соответствовать параметру, eventType переданному в addHandlerAsync.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Список событий, поддерживаемых для элемента почты, см. в статье Объектная модель элемента Outlook.

Примеры

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Добавляет обработчик для поддерживаемого события. События доступны только в надстройках области задач.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType

Office.EventType | string

Событие, которое должно вызвать обработчик.

handler

any

Функция для обработки события. Функция должна принимать один параметр, представляющий собой объектный литерал. Свойство type параметра будет соответствовать параметру, eventType переданному в addHandlerAsync.

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Список событий, поддерживаемых для элемента почты, см. в статье Объектная модель элемента Outlook.

displayReplyAllForm(formData)

Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.

displayReplyAllForm(formData: string | ReplyFormData): void;

Параметры

formData

string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.

• Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllForm возвращает исключение.

• Если в параметре formData.attachments указано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// Create the reply with attachments.
Office.context.mailbox.item.displayReplyAllForm({
  htmlBody:
    "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
  attachments: [base64Attachment, fileAttachment, itemAttachment],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created a reply-all form with attachments.");
  }
});

displayReplyAllFormAsync(formData, options, callback)

Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData

string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.

• Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllFormAsync возвращает исключение.

• Если в параметре formData.attachments указано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// The async version was introduced in requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyAllFormAsync(
  {
    htmlBody:
      "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
    attachments: [base64Attachment, fileAttachment, itemAttachment]
  },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${asyncResult.error.message}`);
      return;
    }

    console.log("Created a reply-all form with attachments.");
  }
);

displayReplyAllFormAsync(formData, callback)

Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData

string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.

• Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllFormAsync возвращает исключение.

• Если в параметре formData.attachments указано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

displayReplyForm(formData)

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

displayReplyForm(formData: string | ReplyFormData): void;

Параметры

formData

string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.

• Если любой строковый параметр превышает указанные для него ограничения, displayReplyForm возвращает исключение.

• Если в параметре formData.attachments указано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// Create the reply with attachments.
Office.context.mailbox.item.displayReplyForm({
  htmlBody:
    "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
  attachments: [base64Attachment, fileAttachment, itemAttachment],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created a reply with attachments.");
  }
});

displayReplyFormAsync(formData, options, callback)

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

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData

string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.

• Если любой строковый параметр превышает указанные для него ограничения, displayReplyFormAsync возвращает исключение.

• Если в параметре formData.attachments указано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// The async version was introduced in requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody:
      "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
    attachments: [base64Attachment, fileAttachment, itemAttachment]
  },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${asyncResult.error.message}`);
      return;
    }

    console.log("Created reply with attachments.");
  }
);

displayReplyFormAsync(formData, callback)

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

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData

string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.

• Если любой строковый параметр превышает указанные для него ограничения, displayReplyFormAsync возвращает исключение.

• Если в параметре formData.attachments указано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

getAttachmentContentAsync(attachmentId, options, callback)

Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Параметры

attachmentId

string

Идентификатор вложения, которое нужно получить.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать этот идентификатор для извлечения вложения.

• В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения, getAttachmentContentAsync добавленные с помощью параметра "Отправка и общий доступ".

• В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, а затем открывает форму, чтобы продолжить в отдельном окне.

Ошибки:

• AttachmentTypeNotSupported : тип вложения не поддерживается. К неподдерживаемым типам относятся встроенные изображения в формате RTF или вложения элементов, отличные от элементов электронной почты или календаря (таких как контакт или задача).

• InvalidAttachmentId : идентификатор вложения не существует.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in read mode. The item.attachments call can only be used in read mode.
const item = Office.context.mailbox.item;
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

for (let i = 0; i < attachments.length; i++) {
  // Log the attachment type and its contents to the console.
  item.getAttachmentContentAsync(attachments[i].id, handleAttachmentsCallback);
}

getAttachmentContentAsync(attachmentId, callback)

Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Параметры

attachmentId

string

Идентификатор вложения, которое нужно получить.

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать этот идентификатор для извлечения вложения.

• В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения, getAttachmentContentAsync добавленные с помощью параметра "Отправка и общий доступ".

• В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, а затем открывает форму, чтобы продолжить в отдельном окне.

Ошибки:

• AttachmentTypeNotSupported : тип вложения не поддерживается. К неподдерживаемым типам относятся встроенные изображения в формате RTF или вложения элементов, отличные от элементов электронной почты или календаря (таких как контакт или задача).

• InvalidAttachmentId : идентификатор вложения не существует.

getEntities()

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

Получает сущности, обнаруженные в теле выбранного элемента.

Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

getEntities(): Entities;

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

Office.Entities

Комментарии

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

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

Применимый режим Outlook: Участник встречи

getEntitiesByType(entityType)

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

Получает массив всех сущностей указанного типа, обнаруженных в теле выбранного элемента.

Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Параметры

entityType

Office.MailboxEnums.EntityType | string

Одно из EntityType значений перечисления.

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

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Если значение, переданное в entityType, не является допустимым членом перечисления EntityType, метод возвращает значение NULL. Если в теле элемента отсутствуют сущности указанного типа, метод возвращает пустой массив. В противном случае тип объектов в возвращаемом массиве зависит от типа сущности, запрошенной в параметре entityType.

Комментарии

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

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

Применимый режим Outlook: Участник встречи

getFilteredEntitiesByName(name)

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

Возвращает известные сущности в выбранном элементе, которые проходят именованный фильтр, определенный в файле манифеста только для надстроек.

Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Параметры

name

string

Имя элемента правила ItemHasKnownEntity, определяющее соответствующий фильтр.

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

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Сущности, соответствующие регулярному выражению, определенному в элементе ItemHasKnownEntity правила в файле манифеста надстройки, с указанным FilterName значением элемента. Если в манифесте нет ItemHasKnownEntity элемента со значением FilterName элемента, соответствующим параметру name , метод возвращает null. name Если параметр соответствует элементу ItemHasKnownEntity в манифесте, но в текущем элементе нет соответствующих сущностей, метод возвращает пустой массив.

Комментарии

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

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

Применимый режим Outlook: Участник встречи

getInitializationContextAsync(options, callback)

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

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

options

Office.AsyncContextOptions

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

callback

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

После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult. При успешном выполнении данные контекста инициализации предоставляются в виде строки (или пустой строки, если контекста инициализации нет) в свойстве asyncResult.value .

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Примеры

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

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

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

Параметры

callback

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

После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult. При успешном выполнении данные контекста инициализации предоставляются в виде строки (или пустой строки, если контекста инициализации нет) в свойстве asyncResult.value .

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

getRegExMatches()

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

getRegExMatches(): any;

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

any

Объект, содержащий массив строк, соответствующих регулярным выражениям, определенным в файле манифеста надстройки. Имя каждого массива равно соответствующему значению атрибута RegExName правила сопоставления ItemHasRegularExpressionMatch . Для ItemHasRegularExpressionMatch правила строка должна находиться в свойстве элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• Контекстно-зависимые надстройки Outlook на основе сущностей теперь упразднены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

• Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается единым манифестом для Microsoft 365.

• Если задано ItemHasRegularExpressionMatch правило для свойства текста элемента, регулярное выражение должно дополнительно фильтровать текст и не должно пытаться вернуть все тело элемента. Использование регулярных выражений, .* например для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

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

getRegExMatchesByName(name: string): string[];

Параметры

name

string

Имя элемента правила ItemHasRegularExpressionMatch, определяющее соответствующий фильтр.

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

string[]

Массив, содержащий строки, соответствующие регулярному выражению, определенному в элементе ItemHasRegularExpressionMatch правила в файле манифеста надстройки, с указанным RegExName значением элемента.

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• Контекстно-зависимые надстройки Outlook на основе сущностей теперь упразднены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

• Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается единым манифестом для Microsoft 365.

• Если задано ItemHasRegularExpressionMatch правило для свойства текста элемента, регулярное выражение должно дополнительно фильтровать текст и не должно пытаться вернуть все тело элемента. Использование регулярных выражений, .* например для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

• Этот способ не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

Возвращает сущности, найденные в выделенном совпадении, выбранном пользователем. Выделенные совпадения применяются к контекстным надстройкам.

Предупреждение. Поддержка контекстно-зависимых надстроек Outlook на основе сущностей прекращена. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

getSelectedEntities(): Entities;

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

Office.Entities

Комментарии

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

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

Применимый режим Outlook: Участник встречи

getSelectedRegExMatches()

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

getSelectedRegExMatches(): any;

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

any

Объект, содержащий массив строк, соответствующих регулярным выражениям, определенным в файле манифеста надстройки. Имя каждого массива равно соответствующему RegExName значению атрибута правила сопоставления ItemHasRegularExpressionMatch . Для ItemHasRegularExpressionMatch правила строка должна находиться в свойстве элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно!

• Контекстно-зависимые надстройки Outlook на основе сущностей теперь упразднены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".

• Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается единым манифестом для Microsoft 365.

• Этот способ не поддерживается в Outlook для iOS или Android. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.

• Если задано ItemHasRegularExpressionMatch правило для свойства текста элемента, регулярное выражение должно дополнительно фильтровать текст и не должно пытаться вернуть все тело элемента. Использование регулярного выражения, например .*, для получения всего текста элемента не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
} else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

getSharedPropertiesAsync(options, callback)

Получает свойства встречи или сообщения в общей папке или общем почтовом ящике.

Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: почтовый ящик 1.8 для поддержки общих папок, почтовый ящик 1.13 для поддержки общих почтовых ящиков

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

Применимый режим Outlook: Участник встречи

Примечание. Этот метод не поддерживается в Outlook для iOS или Android.

getSharedPropertiesAsync(callback)

Получает свойства встречи или сообщения в общей папке или общем почтовом ящике.

Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: почтовый ящик 1.8 для поддержки общих папок, почтовый ящик 1.13 для поддержки общих почтовых ящиков

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

Применимый режим Outlook: Участник встречи

Примечание. Этот метод не поддерживается в Outlook для iOS или Android.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

loadCustomPropertiesAsync(callback, userContext)

Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента.

Настраиваемые свойства хранятся в виде пар "ключ-значение" для каждого приложения и элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к настраиваемым свойствам, относящимся к текущему элементу и текущей надстройке. Пользовательские свойства элемента не зашифрованы, поэтому его не следует использовать в качестве безопасного хранилища.

Настраиваемые свойства предоставляются в виде объекта CustomProperties в свойстве asyncResult.value. Этот объект можно использовать для получения, настройки, сохранения и удаления настраиваемых свойств элемента почты.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Параметры

callback

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

После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult.

userContext

any

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

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

void

Комментарии

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

Дополнительные сведения о настраиваемых свойствах см. в статье Получение и настройка метаданных надстройки для надстройки Outlook.

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

Применимый режим Outlook: Участник встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeHandlerAsync(eventType, options, callback)

Удаляет обработчиков для поддерживаемого типа события. События доступны только в надстройках области задач.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType

Office.EventType | string

Событие, которое должно отменить обработчик.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Список событий, поддерживаемых для элемента почты, см. в статье Объектная модель элемента Outlook.

removeHandlerAsync(eventType, callback)

Удаляет обработчиков для поддерживаемого типа события. События доступны только в надстройках области задач.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType

Office.EventType | string

Событие, которое должно отменить обработчик.

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Участник встречи

Важно! Список событий, поддерживаемых для элемента почты, см. в статье Объектная модель элемента Outlook.

Примеры

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.InfobarClicked, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});