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
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Date | 0>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター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 パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター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
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 検出されたすべてのエラーは asyncResult.error プロパティに表示されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用される Outlook モード: Compose
重要: item.delayDeliveryTime.setAsync を使用してメッセージの配信をスケジュールする場合、遅延はサーバーで処理されます。 これにより、Outlook クライアントが実行されていない場合でもメッセージを送信できます。 従来の Outlook on Windows では、メッセージは 送信トレイ フォルダーに表示されないため、[ 送信] を選択した後にメッセージを編集したり、配信をキャンセルしたりすることはできません。
[送信済みアイテム] フォルダーからのメッセージのみを確認できます。 Outlook on the web、Mac、および新しい Outlook on Windows で、スケジュールされた配信時刻まで下書きフォルダーにメッセージが表示されます。
下書きフォルダーにある間は、メッセージを送信する前に編集できます。 詳細については、「 メッセージの配信日時を管理する」を参照してください。
エラー:
-
InvalidFormatError- 指定されたデータ オブジェクトの形式が無効です。
setAsync(datetime, callback)
メッセージの配信日時を設定します。
setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- datetime
-
Date
メッセージを送信する必要がある将来の日付と時刻。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 検出されたすべてのエラーは asyncResult.error プロパティに表示されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用される Outlook モード: Compose
重要: item.delayDeliveryTime.setAsync を使用してメッセージの配信をスケジュールする場合、遅延はサーバーで処理されます。 これにより、Outlook クライアントが実行されていない場合でもメッセージを送信できます。 従来の Outlook on Windows では、メッセージは 送信トレイ フォルダーに表示されないため、[ 送信] を選択した後にメッセージを編集したり、配信をキャンセルしたりすることはできません。
[送信済みアイテム] フォルダーからのメッセージのみを確認できます。 Outlook on the web、Mac、および新しい Outlook on Windows で、スケジュールされた配信時刻まで下書きフォルダーにメッセージが表示されます。
下書きフォルダーにある間は、メッセージを送信する前に編集できます。 詳細については、「 メッセージの配信日時を管理する」を参照してください。
エラー:
-
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.`);
}
});
}
Office Add-ins