Office.MessageRead 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(
    "text",
    { asyncContext: "This is passed to the callback" },
    function 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 threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

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

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

• классическая Windows: 500 получателей

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

• Веб-браузер, новый Outlook: 20 получателей (свернутое представление), 500 получателей (развернутое представление)

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

cc: EmailAddressDetails[];

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Примеры

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

const msgCc = Office.context.mailbox.item.cc;
console.log("Message copied to:");
for (let i = 0; i < msgCc.length; i++) {
  console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
}

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

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

Это свойство имеет значение NULL для нового элемента в форме создания. Свойство conversationId вернет значение, если пользователь задаст тему и сохранит элемент.

conversationId: string;

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Примеры

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

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

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

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

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

Свойства from и sender представляют одно лицо, если сообщение не отправлено представителем. В этом случае from свойство представляет делегатор, а sender свойство представляет делегат.

Примечание. Свойство recipientTypeEmailAddressDetails объекта в свойстве from не определено.

Свойство from возвращает EmailAddressDetails объект .

from: EmailAddressDetails;

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Примеры

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

const msgFrom = Office.context.mailbox.item.from;
console.log("Message received from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");

Возвращает идентификатор интернет-сообщения для сообщения электронной почты.

Важно! В папке "ОтправленныеinternetMessageId" объект может быть еще недоступен для недавно отправленных элементов. В этом случае рассмотрите возможность использования веб-служб Exchange для получения этого свойства с сервера.

internetMessageId: string;

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Примеры

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

console.log(`Internet message ID: ${Office.context.mailbox.item.internetMessageId}`);

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

itemClass: string;

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Важно!

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

Можно создать пользовательские классы, расширяющие класс элементов по умолчанию. Например, IPM.Note.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: чтение сообщений

Примеры

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

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

Свойства from и sender представляют одно лицо, если сообщение не отправлено представителем. В этом случае from свойство представляет делегатор, а sender свойство представляет делегат.

Примечание. Свойство recipientTypeEmailAddressDetails объекта в свойстве sender не определено.

sender: EmailAddressDetails;

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Примеры

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

const msgSender = Office.context.mailbox.item.sender;
console.log("Sender: " + msgSender.displayName + " (" + msgSender.emailAddress + ")");

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

Свойство 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}`);

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

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

• классическая Windows: 500 получателей

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

• Веб-браузер, новый Outlook: 20 получателей (свернутое представление), 500 получателей (развернутое представление)

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

to: EmailAddressDetails[];

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

Комментарии

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

Применимый режим Outlook: чтение сообщений

Примеры

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

const msgTo = Office.context.mailbox.item.to;
const distributionLists = [];
const externalRecipients = [];
const internalRecipients = [];
const otherRecipients = [];
for (let i = 0; i < msgTo.length; i++) {
    switch (msgTo[i].recipientType) {
    case Office.MailboxEnums.RecipientType.DistributionList:
        distributionLists.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.ExternalUser:
        externalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.User:
        internalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.Other:
        otherRecipients.push(msgTo[i]);
    }
}

if (distributionLists.length > 0) {
    console.log("Distribution Lists:");
    distributionLists.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (externalRecipients.length > 0) {
    console.log("External Recipients:");
    externalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (internalRecipients.length > 0) {
    console.log("Internal Recipients:");
    internalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (otherRecipients.length > 0) {
    console.log("Other Recipients:");
    otherRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

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

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

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

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

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

Предупреждение. Контекстные надстройки 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: участник встречи

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

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

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

Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект 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.");
});