Office.ReplyFormData interface

Package:

outlook

A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form.

Remarks

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-with-attachments.yaml

// The async version is only available starting with requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  (asyncResult) => {
    console.log(JSON.stringify(asyncResult));
  }
);

Properties

attachments	An array of ReplyFormAttachment that are either file or item attachments.
callback	When the reply display call completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an Office.AsyncResult object.
htmlBody	A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.
options	An object literal that contains the following property:- asyncContext: Developers can provide any object they wish to access in the callback function.

Property Details

attachments

An array of ReplyFormAttachment that are either file or item attachments.

attachments?: ReplyFormAttachment[];

Property Value

Office.ReplyFormAttachment[]

callback

When the reply display call completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an Office.AsyncResult object.

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

Property Value

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

htmlBody

A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.

htmlBody?: string;

Property Value

string

options

An object literal that contains the following property:- asyncContext: Developers can provide any object they wish to access in the callback function.

options?: Office.AsyncContextOptions;

Property Value

Office.AsyncContextOptions