Office.AppointmentRead interface

Возвращает вложения элемента в виде массива.

attachments: AttachmentDetails[];

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

Комментарии

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

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

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

Примеры

// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";

if (item.attachments.length > 0) {
    for (let i = 0 ; i < item.attachments.length ; i++) {
        const attachment = item.attachments[i];
        outputString += "<BR>" + i + ". Name: ";
        outputString += attachment.name;
        outputString += "<BR>ID: " + attachment.id;
        outputString += "<BR>contentType: " + attachment.contentType;
        outputString += "<BR>size: " + attachment.size;
        outputString += "<BR>attachmentType: " + attachment.attachmentType;
        outputString += "<BR>isInline: " + attachment.isInline;
    }
}

console.log(outputString);

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

const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);

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

body: 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;

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

Комментарии

[ Набор 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: 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: 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 представляет собой объект, выраженный Date в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в локальные значения даты и времени клиента.

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

end: 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

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

Возвращает расположения встречи.

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

enhancedLocation: EnhancedLocation;

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

Комментарии

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

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

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

Примеры

// 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: boolean;

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

Комментарии

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

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

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

Примеры

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

Возвращает класс элементов веб-служб Exchange выбранной встречи.

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

itemClass: 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}`);

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

itemId: 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 возвращает одно из значений ItemType перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.

itemType: 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: string;

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

Комментарии

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

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

Примеры

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

// 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}`);

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

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

normalizedSubject: 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;

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

Комментарии

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

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

Применимый режим 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 = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// 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(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
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
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

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

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

• Windows: 500 участников

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

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

optionalAttendees: 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: 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 для повторяющихся встреч или запросов собраний, если элемент является рядом или экземпляром ряда. null возвращается для отдельных встреч и запросов на собрания для отдельных встреч.

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

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

recurrence: 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 возвращает массив, содержащий объект EmailAddressDetails для каждого обязательного участника собрания. Максимальное число возвращенных участников зависит от клиента Outlook.

• Windows: 500 участников

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

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

requiredAttendees: EmailAddressDetails[];

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

Комментарии

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

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

Примеры

// 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: MailboxEnums.AppointmentSensitivityType;

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

Комментарии

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

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

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

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

Примеры

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

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

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

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

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

seriesId: 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 представляет собой объект, выраженный Date в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в локальные дату и время клиента.

start: 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

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

Возвращает описание, отображающееся в поле темы элемента.

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

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

subject: 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: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

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

Комментарии

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

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

Применимый режим 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: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

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

Комментарии

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

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

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

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

displayReplyAllForm(formData: string | ReplyFormData): void;

Параметры

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

Комментарии

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

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

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

Важно!

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.

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

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

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

Примеры

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// 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>.");

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

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

Параметры

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

Комментарии

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

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

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

Важно!

• В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 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));
});

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

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

Параметры

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

Комментарии

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

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

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

Важно!

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

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

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

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

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

displayReplyForm(formData: string | ReplyFormData): void;

Параметры

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

Комментарии

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

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

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

Важно!

• В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 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>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "https://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

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

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

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

Параметры

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

Комментарии

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

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

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

Важно!

• В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 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));
});

...

// The async version is only available starting with 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 image and an item attachment.<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  (asyncResult) => {
    console.log(JSON.stringify(asyncResult));
  }
);

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

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

Параметры

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

Комментарии

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

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

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

Важно!

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

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

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

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

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

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

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

Параметры

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

Комментарии

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

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

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

Ошибки:

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

• 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 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);
}

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

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

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

Параметры

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

Комментарии

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

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

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

Ошибки:

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

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

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

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

getEntities(): Entities;

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

Комментарии

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

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

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

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

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

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

Параметры

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

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

Комментарии

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

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

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

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

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

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

Параметры

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

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

Комментарии

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

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

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

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

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): 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: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

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

Комментарии

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

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

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

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

getRegExMatches(): any;

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

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

Комментарии

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

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

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

Важно!

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

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

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

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

Примеры

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

// 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: string): string[];

Параметры

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

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

Комментарии

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

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

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

Важно!

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

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

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

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

Примеры

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

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

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

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

getSelectedEntities(): Entities;

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

Комментарии

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

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

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

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

getSelectedRegExMatches(): 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 элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, такого как .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примеры

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;

// 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.");
}

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

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

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

Параметры

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

Комментарии

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

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

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

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

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

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

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): 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}`);
});

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

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

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

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): 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: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

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

Комментарии

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

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

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

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

Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.

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

Параметры

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

Комментарии

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

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

Применимый режим 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.");
});