Edit

Share via

Office.AttachmentDetailsCompose interface

  • Reference
Package:
outlook

Represents an attachment on an item. Compose mode only.

An array of AttachmentDetailsCompose objects is returned by the getAttachmentsAsync method.

Remarks

[ API set: Mailbox 1.8 ]

Minimum permission level: read item

Applicable Outlook mode: Compose

Properties

attachmentType

Gets a value that indicates the attachment's type.
id

Gets the index of the attachment.
isInline

Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.
name

Gets the name of the attachment.
size

Gets the size of the attachment in bytes.
url

Gets the url of the attachment if its type is MailboxEnums.AttachmentType.Cloud.

Property Details

attachmentType

Gets a value that indicates the attachment's type.

attachmentType: MailboxEnums.AttachmentType | string;

Property Value

Office.MailboxEnums.AttachmentType | string

Remarks

Important:

  • In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using drag-and-drop or the Attach Item option is of type Office.MailboxEnums.AttachmentType.File. The file name extension is returned in the name property. However, a message or appointment that's attached using the Forward as Attachment option is of type Office.MailboxEnums.AttachmentType.Item. In this case, an extension isn't returned in the name property.

  • In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, Attach File, or Forward as Attachment is of type Office.MailboxEnums.AttachmentType.Item. A file name extension isn't returned in the name property.

  • In Outlook on Mac, a message or appointment that's attached using drag-and-drop, Attach Item, or Forward as Attachment is of type Office.MailboxEnums.AttachmentType.File. The file name extension is returned in the name property.

id

Gets the index of the attachment.

id: string;

Property Value

string

isInline

Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.

isInline: boolean;

Property Value

boolean

name

Gets the name of the attachment.

name: string;

Property Value

string

Remarks

Important:

  • An attachment of type Office.MailboxEnums.AttachmentType.Item doesn't return a file name extension in the name property.

  • In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using drag-and-drop or the Attach Item option is of type Office.MailboxEnums.AttachmentType.File. The file name extension is returned in the name property. However, a message or appointment that's attached using the Forward as Attachment option is of type Office.MailboxEnums.AttachmentType.Item. In this case, an extension isn't returned in the name property.

  • In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, Attach File, or Forward as Attachment is of type Office.MailboxEnums.AttachmentType.Item. A file name extension isn't returned in the name property.

  • In Outlook on Mac, a message or appointment that's attached using drag-and-drop, Attach Item, or Forward as Attachment is of type Office.MailboxEnums.AttachmentType.File. The file name extension is returned in the name property.

size

Gets the size of the attachment in bytes.

size: number;

Property Value

number

url

Gets the url of the attachment if its type is MailboxEnums.AttachmentType.Cloud.

url?: string;

Property Value

string