Office.MessageCompose interface
Der Nachrichtenerstellungsmodus von Office.context.mailbox.item.
Wichtig: Dies ist ein internes Outlook-Objekt, das nicht direkt über vorhandene Schnittstellen verfügbar gemacht wird. Sie sollten dies als Modus behandeln Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite Objektmodell .
Übergeordnete Schnittstellen:
- Extends
Eigenschaften
| bcc | Ruft ein -Objekt ab, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt . |
| body | Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt. |
| cc | Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab. Die |
| conversation |
Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist. Sie können für diese Eigenschaft eine ganze Zahl abrufen, wenn Ihre Mail-App in Formularen zum Lesen oder Antworten in Formularen zum Verfassen aktiviert wird. Wenn der Benutzer den Betreff der Antwortnachricht ändert, ändert sich beim Versenden die Konversations-ID für die entsprechende Nachricht, und der Wert, den Sie vorher bezogen haben, trifft nicht länger zu. Sie erhalten in einem Formular zum Verfassen für diese Eigenschaft für ein neues Element null. Wenn der Benutzer einen Betreff festlegt und das Element speichert, gibt die |
| item |
Ruft den Typ des Elements ab, das eine Instanz darstellt. Die |
| subject | Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest. Die Die |
| to | Bietet Zugriff auf die Empfänger in der Zeile An einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab. Die |
Methoden
| add |
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu. Die Anschließend können Sie den Bezeichner mit der Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen |
| add |
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu. Die Anschließend können Sie den Bezeichner mit der Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen |
| add |
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu. Die Anschließend können Sie den Bezeichner mit der Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode |
| add |
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu. Die Anschließend können Sie den Bezeichner mit der Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode |
| get |
Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück. Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den Rufen |
| get |
Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück. Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den Rufen |
| load |
Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element. Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte. Die benutzerdefinierten Eigenschaften werden als |
| remove |
Entfernt eine Anlage aus einer Nachricht oder einem Termin. Die |
| remove |
Entfernt eine Anlage aus einer Nachricht oder einem Termin. Die |
| set |
Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein. Die |
| set |
Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein. Die |
Details zur Eigenschaft
bcc
Ruft ein -Objekt ab, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht bereitstellt.
Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
bcc: Recipients;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);
function callback(asyncResult) {
const arrayOfBccRecipients = asyncResult.value;
}
// 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);
}
});
...
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);
}
});
body
Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
body: Body;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
"text",
{ asyncContext: "This is passed to the callback" },
function callback(result) {
// Do something with the result.
});
// The following is an example of the result parameter passed to the callback function.
{
"value": "TEXT of whole body (including threads below)",
"status": "succeeded",
"asyncContext": "This is passed to the callback"
}
cc
Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.
Die cc-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Cc-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
cc: Recipients;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);
function callback(asyncResult) {
const arrayOfCcRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml
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);
}
});
...
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);
}
});
conversationId
Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist.
Sie können für diese Eigenschaft eine ganze Zahl abrufen, wenn Ihre Mail-App in Formularen zum Lesen oder Antworten in Formularen zum Verfassen aktiviert wird. Wenn der Benutzer den Betreff der Antwortnachricht ändert, ändert sich beim Versenden die Konversations-ID für die entsprechende Nachricht, und der Wert, den Sie vorher bezogen haben, trifft nicht länger zu.
Sie erhalten in einem Formular zum Verfassen für diese Eigenschaft für ein neues Element null. Wenn der Benutzer einen Betreff festlegt und das Element speichert, gibt die conversationId-Eigenschaft einen Wert zurück.
conversationId: string;Eigenschaftswert
string
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml
console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);
itemType
Ruft den Typ des Elements ab, das eine Instanz darstellt.
Die itemType Eigenschaft gibt einen der Enumerationswerte zurück, der ItemType angibt, ob das Elementobjekt instance eine Nachricht oder ein Termin ist.
itemType: MailboxEnums.ItemType | string;Eigenschaftswert
Office.MailboxEnums.ItemType | string
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
case Office.MailboxEnums.ItemType.Appointment:
console.log(`Current item is an ${itemType}.`);
break;
case Office.MailboxEnums.ItemType.Message:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
subject
Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.
Die subject-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird.
Die subject-Eigenschaft gibt ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.
subject: Subject;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml
Office.context.mailbox.item.subject.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Subject: ${result.value}`);
});
...
let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set subject to ${subject}`);
});
to
Bietet Zugriff auf die Empfänger in der Zeile An einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.
Die to-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der An-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
to: Recipients;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);
function callback(asyncResult) {
const arrayOfToRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-to-message-compose.yaml
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);
}
});
...
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);
}
});
Details zur Methode
addFileAttachmentAsync(uri, attachmentName, options, callback)
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- uri
-
string
Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- options
-
Office.AsyncContextOptions & { isInline: boolean }
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. isInline: Wenn true, gibt an, dass die Anlage inline im Nachrichtentext angezeigt wird und nicht in der Anlagenliste angezeigt werden soll.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
AttachmentSizeExceeded: Die Anlage ist größer als zulässig.FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
Beispiele
function callback(result) {
if (result.error) {
console.log(result.error);
} else {
console.log("Attachment added");
}
}
function addAttachment() {
// The values in asyncContext can be accessed in the callback.
const options = { 'asyncContext': { var1: 1, var2: 2 } };
const attachmentURL = "https://contoso.com/rtm/icon.png";
Office.context.mailbox.item.addFileAttachmentAsync(attachmentURL, attachmentURL, options, callback);
}
// The following example adds an image file as an inline attachment and
// references the attachment in the message body.
Office.context.mailbox.item.addFileAttachmentAsync(
"http://i.imgur.com/WJXklif.png",
"cute_bird.png",
{
isInline: true
},
function (asyncResult) {
Office.context.mailbox.item.body.setAsync(
"<p>Here's a cute bird!</p><img src='cid:cute_bird.png'>",
{
"coercionType": "html"
},
function (asyncResult) {
// Do something here.
});
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
const attachmentUrl = $("#attachmentUrl").val();
Office.context.mailbox.item.addFileAttachmentAsync(
attachmentUrl,
getFileName(attachmentUrl),
{ "asyncContext" : { var1: 1, var2: true } },
function(result) { console.log(result); });
addFileAttachmentAsync(uri, attachmentName, callback)
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.
addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- uri
-
string
Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
AttachmentSizeExceeded: Die Anlage ist größer als zulässig.FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
addItemAttachmentAsync(itemId, attachmentName, options, callback)
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- itemId
-
any
Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- 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<string>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
Beispiele
// The following example adds an existing Outlook item as an attachment
// with the name `My Attachment`.
function callback(result) {
if (result.error) {
console.log(result.error);
} else {
console.log("Attachment added");
}
}
function addAttachment() {
// EWS ID of item to attach (shortened for readability).
const itemId = "AAMkADI1...AAA=";
// The values in asyncContext can be accessed in the callback.
const options = { 'asyncContext': { var1: 1, var2: 2 } };
Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, callback);
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
const attachmentItemId = $("#attachmentItemId").val();
Office.context.mailbox.item.addItemAttachmentAsync(
attachmentItemId,
"My attachment",
{ "asyncContext" : { var3: 3, var4: false } },
function(result) { console.log(result); });
addItemAttachmentAsync(itemId, attachmentName, callback)
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- itemId
-
any
Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
getSelectedDataAsync(coercionType, options, callback)
Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.
Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.
Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die Quelleigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, die entweder body oder subjectist.
getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;Parameter
- coercionType
-
Office.CoercionType | string
Fordert ein Format für die Daten an. Wenn Text, gibt die Methode den Nur-Text als Zeichenfolge zurück und entfernt alle vorhandenen HTML-Tags. Gibt Htmldie Methode den markierten Text zurück, unabhängig davon, ob es sich um Klartext oder HTML handelt.
- 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<any>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
Gibt zurück
void
Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// Get selected data.
Office.initialize = function () {
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, getCallback);
};
function getCallback(asyncResult) {
const text = asyncResult.value.data;
const prop = asyncResult.value.sourceProperty;
console.log("Selected text in " + prop + ": " + text);
}
getSelectedDataAsync(coercionType, callback)
Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.
Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.
Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die Quelleigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, die entweder body oder subjectist.
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;Parameter
- coercionType
-
Office.CoercionType | string
Fordert ein Format für die Daten an. Wenn Text, gibt die Methode den Nur-Text als Zeichenfolge zurück und entfernt alle vorhandenen HTML-Tags. Gibt Htmldie Methode den markierten Text zurück, unabhängig davon, ob es sich um Klartext oder HTML handelt.
- callback
-
(asyncResult: Office.AsyncResult<any>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
Gibt zurück
void
Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const text = asyncResult.value.data;
const prop = asyncResult.value.sourceProperty;
console.log("Selected text in " + prop + ": " + text);
} else {
console.error(asyncResult.error);
}
});
loadCustomPropertiesAsync(callback, userContext)
Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte.
Die benutzerdefinierten Eigenschaften werden als CustomProperties-Objekt in der asyncResult.value-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;Parameter
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
- userContext
-
any
Optional. Entwickler können ein beliebiges Objekt bereitstellen, auf das sie in der Callbackfunktion zugreifen möchten. Der Zugriff auf dieses Objekt kann über die asyncResult.asyncContext-Eigenschaft in der Callbackfunktion erfolgen.
Gibt zurück
void
Hinweise
Weitere Informationen zu benutzerdefinierten Eigenschaften finden Sie unter Abrufen und Festlegen von Add-In-Metadaten für ein Outlook-Add-In.
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Beispiele
// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, add-in-specific code can run.
const mailbox = Office.context.mailbox;
mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
});
};
function customPropsCallback(asyncResult) {
const customProps = asyncResult.value;
const myProp = customProps.get("myProp");
customProps.set("otherProp", "value");
customProps.saveAsync(saveCallback);
}
function saveCallback(asyncResult) {
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml
Office.context.mailbox.item.loadCustomPropertiesAsync(function (result) {
if (result.status === Office.AsyncResultStatus.Succeeded) {
console.log("Loaded following custom properties:");
customProps = result.value;
const dataKey = Object.keys(customProps)[0];
const data = customProps[dataKey];
for (let propertyName in data)
{
let propertyValue = data[propertyName];
console.log(`${propertyName}: ${propertyValue}`);
}
}
else {
console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
}
});
removeAttachmentAsync(attachmentId, options, callback)
Entfernt eine Anlage aus einer Nachricht oder einem Termin.
Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- attachmentId
-
string
Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge von attachmentId beträgt 200 Zeichen in Outlook im Web und unter Windows.
- 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 Entfernen der Anlage ein Fehler auftritt, enthält die Eigenschaft asyncResult.error einen Fehlercode mit dem Grund für den Fehler.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.
Beispiele
// The following code removes an attachment with an identifier of '0'.
Office.context.mailbox.item.removeAttachmentAsync(
'0',
{ asyncContext : null },
function (asyncResult)
{
console.log(asyncResult.status);
}
);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
Office.context.mailbox.item.removeAttachmentAsync(
$("#attachmentId").val(),
{ asyncContext : null },
function(result)
{
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`${result.error.message}`);
} else {
console.log(`Attachment removed successfully.`);
}
}
);
removeAttachmentAsync(attachmentId, callback)
Entfernt eine Anlage aus einer Nachricht oder einem Termin.
Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- attachmentId
-
string
Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge von attachmentId beträgt 200 Zeichen in Outlook im Web und unter Windows.
- 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 Entfernen der Anlage ein Fehler auftritt, enthält die Eigenschaft asyncResult.error einen Fehlercode mit dem Grund für den Fehler.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.
setSelectedDataAsync(data, options, callback)
Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.
Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.
setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- data
-
string
Die einzufügenden Daten. Daten dürfen 1.000.000 Zeichen nicht überschreiten. Werden mehr als 1.000.000 Zeichen übergeben, wird eine ArgumentOutOfRange-Ausnahme ausgelöst.
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. coercionType: Bei Text wird die aktuelle Formatvorlage in Outlook im Web und auf Desktopclients angewendet. Wenn das Feld ein HTML-Editor ist, werden nur die Textdaten eingefügt, selbst wenn es sich bei den Daten um HTML-Daten handelt. Wenn html und das Feld HTML unterstützt (der Betreff nicht), wird die aktuelle Formatvorlage in Outlook im Web und die Standardformatvorlage in Outlook auf Desktopclients angewendet. Ist das Feld ein Textfeld, wird ein Fehler des Typs InvalidDataFormat zurückgegeben. Wenn coercionType nicht festgelegt wird, hängt das Ergebnis vom Feld ab: Wenn das Feld HTML ist, wird HTML verwendet. Wenn das Feld Text ist, wird Nur-Text verwendet.
- 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.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.
Beispiele
Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });
Office.context.mailbox.item.setSelectedDataAsync("Hello World!");
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/set-selected-data.yaml
Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Selected text has been updated successfully.");
} else {
console.error(asyncResult.error);
}
});
setSelectedDataAsync(data, callback)
Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.
Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.
setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- data
-
string
Die einzufügenden Daten. Daten dürfen 1.000.000 Zeichen nicht überschreiten. Werden mehr als 1.000.000 Zeichen übergeben, wird eine ArgumentOutOfRange-Ausnahme ausgelöst.
- 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.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Verfassen von Nachrichten
Fehler:
InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für