Office.DelayDeliveryTime interface

Obtient la date et l’heure de remise d’un message.

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

Paramètres

options: Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . La date et l’heure de remise d’un message sont retournées dans la asyncResult.value propriété . Si une date de remise n’a pas encore été définie sur un message, 0 est retourné à la place.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Obtient la date et l’heure de remise d’un message.

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

Paramètres

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . La date et l’heure de remise d’un message sont retournées dans la asyncResult.value propriété . Si une date de remise n’a pas encore été définie sur un message, 0 est retourné à la place.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Exemples

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

Définit la date et l’heure de remise d’un message.

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

Paramètres

datetime: Date

Date et heure futures auxquelles le message doit être envoyé.

options: Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . Les erreurs rencontrées seront indiquées dans la propriété asyncResult.error.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Composer

Important : Lorsque item.delayDeliveryTime.setAsync est utilisé pour planifier la remise d’un message, le délai est traité sur le serveur. Cela permet d’envoyer le message même si le client Outlook n’est pas en cours d’exécution. Toutefois, pour cette raison, le message n’apparaît pas dans le dossier Boîte d’envoi . Vous ne pourrez donc pas modifier le message ou annuler sa remise après avoir sélectionné Envoyer. Vous ne pourrez consulter le mesasge à partir du dossier Éléments envoyés qu’une fois le message envoyé envoyé. Pour plus d’informations, consultez Gérer la date et l’heure de remise d’un message.

Erreurs :

InvalidFormatError - Le format de l’objet de données spécifié n’est pas valide.

Définit la date et l’heure de remise d’un message.

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

Paramètres

datetime: Date

Date et heure futures auxquelles le message doit être envoyé.

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . Les erreurs rencontrées seront indiquées dans la propriété asyncResult.error.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Composer

Important : Lorsque item.delayDeliveryTime.setAsync est utilisé pour planifier la remise d’un message, le délai est traité sur le serveur. Cela permet d’envoyer le message même si le client Outlook n’est pas en cours d’exécution. Toutefois, pour cette raison, le message n’apparaît pas dans le dossier Boîte d’envoi . Vous ne pourrez donc pas modifier le message ou annuler sa remise après avoir sélectionné Envoyer. Vous ne pourrez consulter le mesasge à partir du dossier Éléments envoyés qu’une fois le message envoyé envoyé. Pour plus d’informations, consultez Gérer la date et l’heure de remise d’un message.

Erreurs :

InvalidFormatError - Le format de l’objet de données spécifié n’est pas valide.

Exemples

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

Remarques

Méthodes

Détails de la méthode

getAsync(options, callback)

Paramètres

Retours

Remarques

getAsync(callback)

Paramètres

Retours

Remarques

Exemples

setAsync(datetime, options, callback)

Paramètres

Retours

Remarques

setAsync(datetime, callback)

Paramètres

Retours

Remarques

Exemples

Commentaires

Ressources supplémentaires