Office.DelayDeliveryTime interface

Mit DelayDeliveryTime dem -Objekt können Sie das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht verwalten.

Hinweise

[ API-Satz: Postfach 1.13 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen

Methoden

getAsync(options, callback)

Ruft das Zustellungsdatum und die Uhrzeit einer Nachricht ab.

getAsync(callback)

Ruft das Zustellungsdatum und die Uhrzeit einer Nachricht ab.

setAsync(datetime, options, callback)

Legt das Zustellungsdatum und die Uhrzeit einer Nachricht fest.

setAsync(datetime, callback)

Legt das Zustellungsdatum und die Uhrzeit einer Nachricht fest.

Details zur Methode

getAsync(options, callback)

Ruft das Zustellungsdatum und die Uhrzeit einer Nachricht ab.

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

Parameter

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<Date | 0>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Das Zustellungsdatum und die Uhrzeit einer Nachricht werden in der asyncResult.value -Eigenschaft zurückgegeben. Wenn noch kein Zustellungsdatum für eine Nachricht festgelegt wurde, 0 wird stattdessen zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen

getAsync(callback)

Ruft das Zustellungsdatum und die Uhrzeit einer Nachricht ab.

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

Parameter

callback

(asyncResult: Office.AsyncResult<Date | 0>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Das Zustellungsdatum und die Uhrzeit einer Nachricht werden in der asyncResult.value -Eigenschaft zurückgegeben. Wenn noch kein Zustellungsdatum für eine Nachricht festgelegt wurde, 0 wird stattdessen zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen

Beispiele

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

Legt das Zustellungsdatum und die Uhrzeit einer Nachricht fest.

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

Parameter

datetime

Date

Das zukünftige Datum und die Uhrzeit, zu dem die Nachricht gesendet werden soll.

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Wenn item.delayDeliveryTime.setAsync zum Planen der Zustellung einer Nachricht verwendet wird, wird die Verzögerung auf dem Server verarbeitet. Dadurch kann die Nachricht auch dann gesendet werden, wenn der Outlook-Client nicht ausgeführt wird. Aus diesem Fall wird die Nachricht jedoch nicht im Ordner Postausgang angezeigt, sodass Sie die Nachricht nicht bearbeiten oder die Zustellung abbrechen können, nachdem Sie Senden ausgewählt haben. Sie können das Mesasge aus dem Ordner "Gesendete Elemente " erst überprüfen, nachdem die Nachricht gesendet wurde. Weitere Informationen finden Sie unter Verwalten von Zustellungsdatum und -uhrzeit einer Nachricht.

Fehler:

  • InvalidFormatError – Das Format des angegebenen Datenobjekts ist ungültig.

setAsync(datetime, callback)

Legt das Zustellungsdatum und die Uhrzeit einer Nachricht fest.

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

Parameter

datetime

Date

Das zukünftige Datum und die Uhrzeit, zu dem die Nachricht gesendet werden soll.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Wenn item.delayDeliveryTime.setAsync zum Planen der Zustellung einer Nachricht verwendet wird, wird die Verzögerung auf dem Server verarbeitet. Dadurch kann die Nachricht auch dann gesendet werden, wenn der Outlook-Client nicht ausgeführt wird. Aus diesem Fall wird die Nachricht jedoch nicht im Ordner Postausgang angezeigt, sodass Sie die Nachricht nicht bearbeiten oder die Zustellung abbrechen können, nachdem Sie Senden ausgewählt haben. Sie können das Mesasge aus dem Ordner "Gesendete Elemente " erst überprüfen, nachdem die Nachricht gesendet wurde. Weitere Informationen finden Sie unter Verwalten von Zustellungsdatum und -uhrzeit einer Nachricht.

Fehler:

  • InvalidFormatError – Das Format des angegebenen Datenobjekts ist ungültig.

Beispiele

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