Office.DelayDeliveryTime interface

メッセージの配信日時を取得します。

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;

パラメーター

戻り値

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: 読み取り項目

適用される Outlook モード: Compose

メッセージの配信日時を取得します。

getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;

パラメーター

戻り値

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: 読み取り項目

適用される 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: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: 項目の読み取り/書き込み

適用される Outlook モード: Compose

重要: item.delayDeliveryTime.setAsync を使用してメッセージの配信をスケジュールする場合、遅延はサーバーで処理されます。 これにより、Outlook クライアントが実行されていない場合でもメッセージを送信できます。 従来の Outlook on Windows では、メッセージは 送信トレイ フォルダーに表示されないため、[ 送信] を選択した後にメッセージを編集したり、配信をキャンセルしたりすることはできません。 [送信済みアイテム] フォルダーからのメッセージのみを確認できます。 Outlook on the web、Mac、および新しい Outlook on Windows で、スケジュールされた配信時刻まで下書きフォルダーにメッセージが表示されます。 下書きフォルダーにある間は、メッセージを送信する前に編集できます。 詳細については、「 メッセージの配信日時を管理する」を参照してください。

エラー:

• InvalidFormatError - 指定されたデータ オブジェクトの形式が無効です。

メッセージの配信日時を設定します。

setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: 項目の読み取り/書き込み

適用される 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.`);
    }
  });
}