Office.Recipients interface

Fügt einen Liste der Empfänger den vorhandenen Empfängern für einen Termin oder eine Nachricht hinzu.

addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Die Empfänger, die der Empfängerliste hinzugefügt werden sollen. Das Empfängerarray kann Zeichenfolgen von SMTP-E-Mail-Adressen, EmailUser-Objekten oder EmailAddressDetails-Objekten enthalten.

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 vom Typ Office.AsyncResultaufgerufen. Wenn beim Hinzufügen der Empfänger ein Fehler auftritt, enthält die asyncResult.error-Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Mit der addAsync -Methode können Sie maximal 100 Empfänger zu einem E-Mail-Element in Outlook im Web, unter Windows (neu und klassisch), auf Mac (klassische Benutzeroberfläche), unter Android und unter iOS hinzufügen. Beachten Sie jedoch Folgendes:

In Outlook im Web, unter Windows (neu und klassisch) und unter Mac (klassische Benutzeroberfläche) können Maximal 500 Empfänger in einem Zielfeld enthalten sein. Wenn Sie einem E-Mail-Element mehr als 100 Empfänger hinzufügen müssen, können Sie wiederholt anrufen addAsync , aber beachten Sie die Empfängergrenze des Felds.
In Outlook für Android und unter iOS wird die addAsync Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Es gibt keine Empfängerbeschränkung, wenn Sie in Outlook für Mac (neue Benutzeroberfläche) aufrufen addAsync .

Fehler:

NumberOfRecipientsExceeded : Die Anzahl der Empfänger hat 100 Einträge überschritten.

Beispiele

// The following example creates an array of EmailUser objects
// and adds them to the To recipients of the message.
const newRecipients = [
    {
        "displayName": "Allie Bellew",
        "emailAddress": "allieb@contoso.com"
    },
    {
        "displayName": "Alex Darrow",
        "emailAddress": "alexd@contoso.com"
    }
];

Office.context.mailbox.item.to.addAsync(newRecipients, function(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Recipients added");
    }
});

Fügt einen Liste der Empfänger den vorhandenen Empfängern für einen Termin oder eine Nachricht hinzu.

addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Die Empfänger, die der Empfängerliste hinzugefügt werden sollen. Das Empfängerarray kann Zeichenfolgen von SMTP-E-Mail-Adressen, EmailUser-Objekten oder EmailAddressDetails-Objekten enthalten.

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn beim Hinzufügen der Empfänger ein Fehler auftritt, enthält die asyncResult.error-Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Mit der addAsync -Methode können Sie maximal 100 Empfänger zu einem E-Mail-Element in Outlook im Web, unter Windows (neu und klassisch), auf Mac (klassische Benutzeroberfläche), unter Android und unter iOS hinzufügen. Beachten Sie jedoch Folgendes:

In Outlook im Web, unter Windows (neu und klassisch) und unter Mac (klassische Benutzeroberfläche) können Maximal 500 Empfänger in einem Zielfeld enthalten sein. Wenn Sie einem E-Mail-Element mehr als 100 Empfänger hinzufügen müssen, können Sie wiederholt anrufen addAsync , aber beachten Sie die Empfängergrenze des Felds.
In Outlook für Android und unter iOS wird die addAsync Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Es gibt keine Empfängerbeschränkung, wenn Sie in Outlook für Mac (neue Benutzeroberfläche) aufrufen addAsync .

Fehler:

NumberOfRecipientsExceeded : Die Anzahl der Empfänger hat 100 Einträge überschritten.

Ruft eine Empfängerliste für einen Termin oder eine Nachricht ab.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => 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<Office.EmailAddressDetails[]>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Die asyncResult.value -Eigenschaft des Ergebnisses ist ein Array von EmailAddressDetails-Objekten .

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Wichtig:

Die maximale Anzahl von Empfängern, die von dieser Methode zurückgegeben werden, variiert je nach Outlook-Client.

Windows (neu und klassisch), Webbrowser, Mac (klassische Benutzeroberfläche): 500 Empfänger
Android, iOS: 100 Empfänger
Mac (neue Benutzeroberfläche): Keine Beschränkung

Im klassischen Outlook unter Windows ist der Terminplaner in das Objekt eingeschlossen, das von der getAsync -Methode zurückgegeben wird, wenn Sie einen neuen Termin erstellen oder einen vorhandenen bearbeiten. In Outlook im Web und neuen Outlook unter Windows ist der Organisator nur im zurückgegebenen Objekt enthalten, wenn Sie einen vorhandenen Termin bearbeiten.

Die getAsync -Methode gibt nur Empfänger zurück, die vom Outlook-Client aufgelöst wurden. Ein aufgelöster Empfänger weist die folgenden Merkmale auf.

Wenn der Empfänger über einen gespeicherten Eintrag im Adressbuch des Absenders verfügt, löst Outlook die E-Mail-Adresse in den gespeicherten Anzeigenamen des Empfängers auf.
Vor dem Namen oder der E-Mail-Adresse des Empfängers wird ein Symbol für eine Teams-Besprechung status angezeigt.
Hinter dem Namen oder der E-Mail-Adresse des Empfängers wird ein Semikolon angezeigt.
Der Name oder die E-Mail-Adresse des Empfängers wird unterstrichen oder in ein Feld eingeschlossen.

Um eine E-Mail-Adresse aufzulösen, nachdem sie einem E-Mail-Element hinzugefügt wurde, muss der Absender die TAB-TASTE verwenden oder einen vorgeschlagenen Kontakt oder eine E-Mail-Adresse aus der Liste der automatischen Vervollständigung auswählen.

Wenn ein Benutzer in Outlook im Web und unter Windows (neu und klassisch) eine neue Nachricht erstellt, indem er den E-Mail-Adresslink eines Kontakts Karte aktiviert, gibt der Anruf des Add-Ins Recipients.getAsync die E-Mail-Adresse des Kontakts in der displayName -Eigenschaft des zugeordneten EmailAddressDetails-Objekts anstelle des gespeicherten Namens des Kontakts zurück. Weitere Informationen finden Sie unter Zugehöriges GitHub-Problem.

Wenn Sie beim Verfassen eines E-Mail-Elements zu einem Absenderkonto wechseln, das sich in einer anderen Domäne als dem des zuvor ausgewählten Absenderkontos befindet, wird der Wert der recipientType Eigenschaft für vorhandene Empfänger nicht aktualisiert und basiert weiterhin auf der Domäne des zuvor ausgewählten Kontos. Um nach dem Wechsel des Kontos die richtigen Empfängertypen zu erhalten, müssen Sie zuerst die vorhandenen Empfänger entfernen und sie dann wieder dem E-Mail-Element hinzufügen.

Ruft eine Empfängerliste für einen Termin oder eine Nachricht ab.

getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;

Parameter

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

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Die asyncResult.value -Eigenschaft des Ergebnisses ist ein Array von EmailAddressDetails-Objekten .

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Wichtig:

Die maximale Anzahl von Empfängern, die von dieser Methode zurückgegeben werden, variiert je nach Outlook-Client.

Windows (neu und klassisch), Webbrowser, Mac (klassische Benutzeroberfläche): 500 Empfänger
Android, iOS: 100 Empfänger
Mac (neue Benutzeroberfläche): Keine Beschränkung

Die getAsync -Methode gibt nur Empfänger zurück, die vom Outlook-Client aufgelöst wurden. Ein aufgelöster Empfänger weist die folgenden Merkmale auf.

Wenn der Empfänger über einen gespeicherten Eintrag im Adressbuch des Absenders verfügt, löst Outlook die E-Mail-Adresse in den gespeicherten Anzeigenamen des Empfängers auf.
Vor dem Namen oder der E-Mail-Adresse des Empfängers wird ein Symbol für eine Teams-Besprechung status angezeigt.
Hinter dem Namen oder der E-Mail-Adresse des Empfängers wird ein Semikolon angezeigt.
Der Name oder die E-Mail-Adresse des Empfängers wird unterstrichen oder in ein Feld eingeschlossen.

Um eine E-Mail-Adresse aufzulösen, nachdem sie einem E-Mail-Element hinzugefügt wurde, muss der Absender die TAB-TASTE verwenden oder einen vorgeschlagenen Kontakt oder eine E-Mail-Adresse aus der Liste der automatischen Vervollständigung auswählen.

Wenn ein Benutzer in Outlook im Web und unter Windows (neu und klassisch) eine neue Nachricht erstellt, indem er den E-Mail-Adresslink eines Kontakts Karte aktiviert, gibt der Anruf des Add-Ins Recipients.getAsync die E-Mail-Adresse des Kontakts in der displayName -Eigenschaft des zugeordneten EmailAddressDetails-Objekts anstelle des gespeicherten Namens des Kontakts zurück. Weitere Informationen finden Sie unter Zugehöriges GitHub-Problem.

Wenn Sie beim Verfassen eines E-Mail-Elements zu einem Absenderkonto wechseln, das sich in einer anderen Domäne als dem des zuvor ausgewählten Absenderkontos befindet, wird der Wert der recipientType Eigenschaft für vorhandene Empfänger nicht aktualisiert und basiert weiterhin auf der Domäne des zuvor ausgewählten Kontos. Um nach dem Wechsel des Kontos die richtigen Empfängertypen zu erhalten, müssen Sie zuerst die vorhandenen Empfänger entfernen und sie dann wieder dem E-Mail-Element hinzufügen.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Legt eine Empfängerliste für einen Termin oder eine Nachricht fest.

Die setAsync-Methode überschreibt die aktuelle Empfängerliste.

setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Die Empfänger, die der Empfängerliste hinzugefügt werden sollen. Das Empfängerarray kann Zeichenfolgen von SMTP-E-Mail-Adressen, EmailUser-Objekten oder EmailAddressDetails-Objekten enthalten.

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

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn beim Festlegen der Empfänger ein Fehler auftritt, enthält die asyncResult.error-Eigenschaft einen Code, der ggf. auf den Fehler hinweist, der beim Hinzufügen der Daten aufgetreten ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Mit der setAsync -Methode können Sie maximal 100 Empfänger in Outlook im Web, unter Windows (neu und klassisch), auf Mac (klassische Benutzeroberfläche), unter Android und unter iOS festlegen. Beachten Sie jedoch Folgendes:

In Outlook im Web, unter Windows (neu und klassisch) und unter Mac (klassische Benutzeroberfläche) können Maximal 500 Empfänger in einem Zielfeld enthalten sein. Wenn Sie mehr als 100 Empfänger festlegen müssen, können Sie wiederholt anrufen setAsync , beachten Sie jedoch das Empfängerlimit des Felds.
In Outlook für Android und unter iOS wird die setAsync Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Es gibt keine Empfängerbeschränkung, wenn Sie in Outlook für Mac (neue Benutzeroberfläche) aufrufen setAsync .

Fehler:

NumberOfRecipientsExceeded : Die Anzahl der Empfänger hat 100 Einträge überschritten.

Legt eine Empfängerliste für einen Termin oder eine Nachricht fest.

Die setAsync-Methode überschreibt die aktuelle Empfängerliste.

setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Die Empfänger, die der Empfängerliste hinzugefügt werden sollen. Das Empfängerarray kann Zeichenfolgen von SMTP-E-Mail-Adressen, EmailUser-Objekten oder EmailAddressDetails-Objekten enthalten.

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

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn beim Festlegen der Empfänger ein Fehler auftritt, enthält die asyncResult.error-Eigenschaft einen Code, der ggf. auf den Fehler hinweist, der beim Hinzufügen der Daten aufgetreten ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Mit der setAsync -Methode können Sie maximal 100 Empfänger in Outlook im Web, unter Windows (neu und klassisch), auf Mac (klassische Benutzeroberfläche), unter Android und unter iOS festlegen. Beachten Sie jedoch Folgendes:

In Outlook im Web, unter Windows (neu und klassisch) und unter Mac (klassische Benutzeroberfläche) können Maximal 500 Empfänger in einem Zielfeld enthalten sein. Wenn Sie mehr als 100 Empfänger festlegen müssen, können Sie wiederholt anrufen setAsync , beachten Sie jedoch das Empfängerlimit des Felds.
In Outlook für Android und unter iOS wird die setAsync Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Es gibt keine Empfängerbeschränkung, wenn Sie in Outlook für Mac (neue Benutzeroberfläche) aufrufen setAsync .

Fehler:

NumberOfRecipientsExceeded : Die Anzahl der Empfänger hat 100 Einträge überschritten.

Beispiele

// The following example creates an array of EmailUser objects and
// replaces the CC recipients of the message with the array.
const newRecipients = [
    {
        "displayName": "Allie Bellew",
        "emailAddress": "allieb@contoso.com"
    },
    {
        "displayName": "Alex Darrow",
        "emailAddress": "alexd@contoso.com"
    }
];

Office.context.mailbox.item.cc.setAsync(newRecipients, function(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Recipients overwritten");
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

const email = $("#emailBcc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailCc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailOptional")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailRequired")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailTo")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Freigeben über

Hinweise

Methoden

Details zur Methode

addAsync(recipients, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addAsync(recipients, callback)

Parameter

Gibt zurück

Hinweise

getAsync(options, callback)

Parameter

Gibt zurück

Hinweise

getAsync(callback)

Parameter

Gibt zurück

Hinweise

Beispiele

setAsync(recipients, options, callback)

Parameter

Gibt zurück

Hinweise

setAsync(recipients, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

Zusätzliche Ressourcen