Office.DelayDeliveryTime interface
Объект DelayDeliveryTime позволяет управлять датой и временем отложенной доставки сообщения.
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Используется
Методы
| get |
Получает дату и время доставки сообщения. |
| get |
Получает дату и время доставки сообщения. |
| set |
Установка даты и времени доставки сообщения. |
| set |
Установка даты и времени доставки сообщения. |
Сведения о методе
getAsync(options, callback)
Получает дату и время доставки сообщения.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<Date | 0>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Дата и время доставки сообщения возвращаются в свойстве asyncResult.value . Если для сообщения еще не указана дата доставки, 0 возвращается дата.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
getAsync(callback)
Получает дату и время доставки сообщения.
getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Date | 0>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Дата и время доставки сообщения возвращаются в свойстве asyncResult.value . Если для сообщения еще не указана дата доставки, 0 возвращается дата.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/delay-message-delivery.yaml
// This snippet gets the delivery date and time of a message.
Office.context.mailbox.item.delayDeliveryTime.getAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
return;
}
const deliveryDate = asyncResult.value;
if (deliveryDate === 0) {
console.log("Your message will be delivered immediately when you select Send.");
} else {
const date = new Date(deliveryDate);
console.log(`Message delivery date and time: ${date.toString()}`);
}
});
setAsync(datetime, options, callback)
Установка даты и времени доставки сообщения.
setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- datetime
-
Date
Будущая дата и время отправки сообщения.
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Все обнаруженные ошибки будут указаны в свойстве asyncResult.error.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно!
Если
item.delayDeliveryTime.setAsyncзадержка используется для планирования доставки сообщения, она обрабатывается на сервере. Это позволяет отправлять сообщение, даже если клиент Outlook не запущен. В классической версии Outlook для Windows сообщение не отображается в папке "Исходящие ", поэтому изменить сообщение или отменить его доставку после нажатия кнопки "Отправить" будет невозможно. Вы сможете просмотреть только сообщение из папки "Отправленные ". В Outlook в Интернете, на Mac и в новом Outlook для Windows сообщение отображается в папке "Черновики" до запланированного времени доставки. Пока сообщение находится в папке " Черновики ", его можно изменить перед отправкой. Дополнительные сведения см. в статье "Управление датой и временем доставки сообщения".Этот
setAsyncметод не поддерживается для сообщений, которые сейчас загружаются с помощью этогоloadItemByIdAsyncметода. Дополнительные сведения см. в статье "Активация надстройки Outlook для нескольких сообщений".
Ошибки:
-
InvalidFormatError- Формат указанного объекта данных не является допустимым.
setAsync(datetime, callback)
Установка даты и времени доставки сообщения.
setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- datetime
-
Date
Будущая дата и время отправки сообщения.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Все обнаруженные ошибки будут указаны в свойстве asyncResult.error.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно!
Если
item.delayDeliveryTime.setAsyncзадержка используется для планирования доставки сообщения, она обрабатывается на сервере. Это позволяет отправлять сообщение, даже если клиент Outlook не запущен. В классической версии Outlook для Windows сообщение не отображается в папке "Исходящие ", поэтому изменить сообщение или отменить его доставку после нажатия кнопки "Отправить" будет невозможно. Вы сможете просмотреть только сообщение из папки "Отправленные ". В Outlook в Интернете, на Mac и в новом Outlook для Windows сообщение отображается в папке "Черновики" до запланированного времени доставки. Пока сообщение находится в папке " Черновики ", его можно изменить перед отправкой. Дополнительные сведения см. в статье "Управление датой и временем доставки сообщения".Этот
setAsyncметод не поддерживается для сообщений, которые сейчас загружаются с помощью этогоloadItemByIdAsyncметода. Дополнительные сведения см. в статье "Активация надстройки Outlook для нескольких сообщений".
Ошибки:
-
InvalidFormatError- Формат указанного объекта данных не является допустимым.
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/delay-message-delivery.yaml
function setDeliveryDate(minutes) {
// This snippet sets the delivery date and time of a message.
const currentTime = new Date().getTime();
const milliseconds = totalDelay * 60000;
const timeDelay = new Date(currentTime + milliseconds);
Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
return;
}
if (minutes === 1440) {
console.log(`Delayed delivery by an additional one day.`);
} else {
console.log(`Delayed delivery by an additional ${minutes} minutes.`);
}
});
}