|
| 1 | +### YamlMime:TSType |
| 2 | +name: Office.DecryptedMessageAttachment |
| 3 | +uid: outlook!Office.DecryptedMessageAttachment:interface |
| 4 | +package: outlook! |
| 5 | +fullName: Office.DecryptedMessageAttachment |
| 6 | +summary: Represents an attachment in a decrypted message. |
| 7 | +remarks: >- |
| 8 | + \[ [API set: Mailbox |
| 9 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 10 | + \] |
| 11 | +
|
| 12 | +
|
| 13 | + **[Minimum permission |
| 14 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 15 | + -->**: **read/write item** |
| 16 | +
|
| 17 | +
|
| 18 | + **[Applicable Outlook |
| 19 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 20 | + -->**: Message Read |
| 21 | +
|
| 22 | +
|
| 23 | + To learn how to develop an encryption add-in in Outlook, see [Create an |
| 24 | + encryption Outlook |
| 25 | + add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption)<!-- |
| 26 | + -->. |
| 27 | +
|
| 28 | +isPreview: true |
| 29 | +isDeprecated: false |
| 30 | +type: interface |
| 31 | +properties: |
| 32 | + - name: attachmentType |
| 33 | + uid: outlook!Office.DecryptedMessageAttachment#attachmentType:member |
| 34 | + package: outlook! |
| 35 | + fullName: attachmentType |
| 36 | + summary: Specifies the type of attachment. |
| 37 | + remarks: >- |
| 38 | + \[ [API set: Mailbox |
| 39 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 40 | + \] |
| 41 | +
|
| 42 | +
|
| 43 | + **[Minimum permission |
| 44 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 45 | + -->**: **read/write item** |
| 46 | +
|
| 47 | +
|
| 48 | + **[Applicable Outlook |
| 49 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 50 | + -->**: Message Read |
| 51 | +
|
| 52 | + isPreview: true |
| 53 | + isDeprecated: false |
| 54 | + syntax: |
| 55 | + content: 'attachmentType: MailboxEnums.AttachmentType;' |
| 56 | + return: |
| 57 | + type: <xref uid="outlook!Office.MailboxEnums.AttachmentType:enum" /> |
| 58 | + - name: content |
| 59 | + uid: outlook!Office.DecryptedMessageAttachment#content:member |
| 60 | + package: outlook! |
| 61 | + fullName: content |
| 62 | + summary: Specifies the Base64-encoded content of the attachment. |
| 63 | + remarks: >- |
| 64 | + \[ [API set: Mailbox |
| 65 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 66 | + \] |
| 67 | +
|
| 68 | +
|
| 69 | + **[Minimum permission |
| 70 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 71 | + -->**: **read/write item** |
| 72 | +
|
| 73 | +
|
| 74 | + **[Applicable Outlook |
| 75 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 76 | + -->**: Message Read |
| 77 | +
|
| 78 | +
|
| 79 | + **Important**: The `content` property isn't supported by attachments |
| 80 | + of type `MailboxEnums.AttachmentType.Cloud`<!-- -->. |
| 81 | +
|
| 82 | + isPreview: true |
| 83 | + isDeprecated: false |
| 84 | + syntax: |
| 85 | + content: 'content: string;' |
| 86 | + return: |
| 87 | + type: string |
| 88 | + - name: contentId |
| 89 | + uid: outlook!Office.DecryptedMessageAttachment#contentId:member |
| 90 | + package: outlook! |
| 91 | + fullName: contentId |
| 92 | + summary: >- |
| 93 | + Specifies the content identifier of an inline attachment. |
| 94 | +
|
| 95 | +
|
| 96 | + The `contentId` property must be specified if `isInline` is set to |
| 97 | + `true`<!-- -->. |
| 98 | + remarks: >- |
| 99 | + \[ [API set: Mailbox |
| 100 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 101 | + \] |
| 102 | +
|
| 103 | +
|
| 104 | + **[Minimum permission |
| 105 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 106 | + -->**: **read/write item** |
| 107 | +
|
| 108 | +
|
| 109 | + **[Applicable Outlook |
| 110 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 111 | + -->**: Message Read |
| 112 | +
|
| 113 | +
|
| 114 | + **Important**: When images are added to a message as inline |
| 115 | + attachments, they're automatically assigned a content ID. In the body of a |
| 116 | + message, the content ID of an inline attachment is specified in the `src` |
| 117 | + attribute of the `<img>` element (for example, `<img width=96 height=96 |
| 118 | + id="Picture_1" src="cid:image001.png@01DC1E6F.FC7C7410">`<!-- -->). To |
| 119 | + easily identify and provide these inline attachments during decryption, we |
| 120 | + recommend saving the content IDs of inline attachments to the message |
| 121 | + header during encryption. Call |
| 122 | + `Office.context.mailbox.item.getAttachmentsAsync` to get the content ID of |
| 123 | + an inline attachment. Then, call |
| 124 | + `Office.context.mailbox.item.internetHeaders.setAsync` to save the ID to |
| 125 | + the header of the message. |
| 126 | +
|
| 127 | + isPreview: true |
| 128 | + isDeprecated: false |
| 129 | + syntax: |
| 130 | + content: 'contentId?: string;' |
| 131 | + return: |
| 132 | + type: string |
| 133 | + - name: isInline |
| 134 | + uid: outlook!Office.DecryptedMessageAttachment#isInline:member |
| 135 | + package: outlook! |
| 136 | + fullName: isInline |
| 137 | + summary: >- |
| 138 | + If true, specifies that the decrypted attachment appears as an image in |
| 139 | + the body of the message instead of in the attachment list. If the |
| 140 | + `isInline` property isn't specified, its value is set to false. |
| 141 | + remarks: >- |
| 142 | + \[ [API set: Mailbox |
| 143 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 144 | + \] |
| 145 | +
|
| 146 | +
|
| 147 | + **[Minimum permission |
| 148 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 149 | + -->**: **read/write item** |
| 150 | +
|
| 151 | +
|
| 152 | + **[Applicable Outlook |
| 153 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 154 | + -->**: Message Read |
| 155 | +
|
| 156 | + isPreview: true |
| 157 | + isDeprecated: false |
| 158 | + syntax: |
| 159 | + content: 'isInline?: boolean;' |
| 160 | + return: |
| 161 | + type: boolean |
| 162 | + - name: name |
| 163 | + uid: outlook!Office.DecryptedMessageAttachment#name:member |
| 164 | + package: outlook! |
| 165 | + fullName: name |
| 166 | + summary: Specifies the name of the attachment. |
| 167 | + remarks: >- |
| 168 | + \[ [API set: Mailbox |
| 169 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 170 | + \] |
| 171 | +
|
| 172 | +
|
| 173 | + **[Minimum permission |
| 174 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 175 | + -->**: **read/write item** |
| 176 | +
|
| 177 | +
|
| 178 | + **[Applicable Outlook |
| 179 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 180 | + -->**: Message Read |
| 181 | +
|
| 182 | + isPreview: true |
| 183 | + isDeprecated: false |
| 184 | + syntax: |
| 185 | + content: 'name: string;' |
| 186 | + return: |
| 187 | + type: string |
| 188 | + - name: path |
| 189 | + uid: outlook!Office.DecryptedMessageAttachment#path:member |
| 190 | + package: outlook! |
| 191 | + fullName: path |
| 192 | + summary: >- |
| 193 | + Specifies the URL reference path of the attachment if its type is |
| 194 | + `MailboxEnums.AttachmentType.Cloud`<!-- -->. The `path` property must be |
| 195 | + specified for attachments of type `MailboxEnums.AttachmentType.Cloud`<!-- |
| 196 | + -->. |
| 197 | + remarks: >- |
| 198 | + \[ [API set: Mailbox |
| 199 | + preview](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) |
| 200 | + \] |
| 201 | +
|
| 202 | +
|
| 203 | + **[Minimum permission |
| 204 | + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- |
| 205 | + -->**: **read/write item** |
| 206 | +
|
| 207 | +
|
| 208 | + **[Applicable Outlook |
| 209 | + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- |
| 210 | + -->**: Message Read |
| 211 | +
|
| 212 | + isPreview: true |
| 213 | + isDeprecated: false |
| 214 | + syntax: |
| 215 | + content: 'path?: string;' |
| 216 | + return: |
| 217 | + type: string |
0 commit comments