Edit

Share via

Office.AttachmentDetails interface

Package:
outlook

Represents an attachment on an item from the server. Read mode only.

An array of AttachmentDetails objects is returned as the attachments property of an appointment or message item.

Remarks

[ API set: Mailbox 1.1 ]

Minimum permission level: read item

Applicable Outlook mode: Read

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml

const item = Office.context.mailbox.item;

if (item.attachments.length > 0) {
    for (let i = 0; i < item.attachments.length; i++) {
        const attachment = item.attachments[i];
        console.log(`${i+1}. Name: ${attachment.name}`);
        console.log(`ID: ${attachment.id}`);
        console.log(`Type: ${attachment.attachmentType}`);
        console.log(`Inline content: ${attachment.isInline}`);
        console.log(`Size: ${attachment.size}`);
    }
} else {
    console.log("This mail item doesn't contain any attachments.");
}

Properties

attachmentType

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

Gets the MIME content type of the attachment.

Warning: While the contentType value is a direct lookup of the attachment's extension, the internal mapping isn't actively maintained so this property has been deprecated. If you require specific types, grab the attachment's extension and process accordingly. For details, refer to the related blog post.
id

Gets the Exchange attachment ID of the attachment. However, if the attachment type is MailboxEnums.AttachmentType.Cloud, then a URL for the file is returned.
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.

Property Details

attachmentType

Gets a value that indicates the attachment's type.

attachmentType: MailboxEnums.AttachmentType | string;

Property Value

Office.MailboxEnums.AttachmentType | string

contentType

Warning

This API is now deprecated.

If you require specific content types, grab the attachment's extension and process accordingly.

Gets the MIME content type of the attachment.

Warning: While the contentType value is a direct lookup of the attachment's extension, the internal mapping isn't actively maintained so this property has been deprecated. If you require specific types, grab the attachment's extension and process accordingly. For details, refer to the related blog post.

contentType: string;

Property Value

string

id

Gets the Exchange attachment ID of the attachment. However, if the attachment type is MailboxEnums.AttachmentType.Cloud, then a URL for the file is returned.

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.

size

Gets the size of the attachment in bytes.

size: number;

Property Value

number