{"id":31396,"date":"2018-04-21T15:47:46","date_gmt":"2018-04-21T15:47:46","guid":{"rendered":"https:\/\/ampscript.guide\/attachfile\/"},"modified":"2021-04-06T01:18:22","modified_gmt":"2021-04-06T01:18:22","slug":"attachfile","status":"publish","type":"post","link":"https:\/\/ampscript.guide\/attachfile\/","title":{"rendered":"AttachFile"},"content":{"rendered":"

AttachFile<\/h2>\n

This function attaches the specified file to the outbound message or displays a link to the file when included in a landing page. This function returns no output.<\/p>\n

Arguments<\/h3>\n

AttachFile(1,2,3,4,5,6,7,8)<\/code><\/p>\n\n\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n
Ordinal<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nString<\/td>\nTrue<\/td>\n\n

Type of location containing the file to attach. Valid values include:<\/p>\n

    \n
  • ContentBuilder<\/code><\/li>\n
  • FTP<\/code><\/li>\n
  • HTTP<\/code><\/li>\n
  • \nPortfolio<\/code> (Classic Content)<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
2<\/td>\nString<\/td>\nTrue<\/td>\n\n

Path or key of the asset to attach. Specify the following for the preceding location:<\/p>\n

    \n
  • \nContentBuilder<\/code> – Customer\/External Key of asset<\/li>\n
  • \nFTP<\/code> – Name of file in the Enhanced SFTP Import<\/code> Folder<\/li>\n
  • \nHTTP<\/code> – HTTP\/HTTPS URL of the asset<\/li>\n
  • \nPortfolio<\/code> – Customer\/External Key of asset in Classic Content<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
3<\/td>\nString<\/td>\nFalse<\/td>\n\n

Alias assigned to file when attached. If no value is specified, the name of the file is used.<\/p>\n

If you do not specify an alias for HTTP<\/code> type asset, the Content-Disposition<\/code> from the HTTP header will be used. If no Content-Disposition<\/code> is provided, a system-generated value will be returned.<\/p>\n<\/td>\n<\/tr>\n

4<\/td>\nBoolean<\/td>\nFalse<\/td>\n\n

Show link to file in the View as a Web Page<\/em> context. Default value is false<\/code>.<\/p>\n

This argument can only be used with the HTTP<\/code> location type.<\/p>\n<\/td>\n<\/tr>\n

5<\/td>\nString<\/td>\nFalse<\/td>\n\n

URL of the attachment to use in the View as a Web Page<\/em> context. Default value is false<\/code>.<\/p>\n

This argument can only be used with the HTTP<\/code> location type.<\/p>\n<\/td>\n<\/tr>\n

6<\/td>\nString<\/td>\nFalse<\/td>\n\n

Link name for file in the View as a Web Page<\/em> context.<\/p>\n

This argument can only be used with the HTTP<\/code> location type.<\/p>\n<\/td>\n<\/tr>\n

7<\/td>\nNumber<\/td>\nFalse<\/td>\n\n

Number of days the link to download the file appears in the View as a Web Page<\/em> context.<\/p>\n

This argument can only be used with the HTTP<\/code> location type.<\/p>\n<\/td>\n<\/tr>\n

8<\/td>\nBoolean<\/td>\nFalse<\/td>\n\n

When this force_attachment<\/i> indicator is true<\/code>, the [content-disposition](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Disposition) of the file is set to attachment<\/i>. When false<\/code>, the content-disposition is set to inline<\/i>. Default is false<\/code> for inline<\/i>, with some exceptions noted in the table below.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n

NOTE: Arguments 4 – 7 are unavailable in the current release of Marketing Cloud. This should be resolved in a future release.<\/p>\n<\/blockquote>\n

Files of the following MIME types can be attached to email messages in Marketing Cloud:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Extension<\/th>\nMIME Type<\/th>\nDefault Content-Disposition<\/th>\n<\/tr>\n<\/thead>\n
.csv<\/code><\/td>\ntext\/csv<\/code><\/td>\nattachment<\/code><\/td>\n<\/tr>\n
.doc<\/code><\/td>\napplication\/msword<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.docm<\/code><\/td>\napplication\/vnd.ms-word.document.macroEnabled.12<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.docx<\/code><\/td>\napplication\/vnd.openxmlformats-officedocument.wordprocessingml.document<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.gif<\/code><\/td>\nimage\/gif<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.htm<\/code><\/td>\ntext\/html<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.html<\/code><\/td>\ntext\/html<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.ics<\/code><\/td>\napplication\/ics<\/code> or text\/calendar<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.jpeg<\/code><\/td>\nimage\/jpeg<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.jpg<\/code><\/td>\nimage\/jpeg<\/code> or image\/jpg<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.mp4<\/code><\/td>\nvideo\/mp4<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.pdf<\/code><\/td>\napplication\/pdf<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.pkpass<\/code><\/td>\napplication\/vnd.apple.pkpass<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.png<\/code><\/td>\nimage\/png<\/code> or image\/x-png<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.ppt<\/code><\/td>\napplication\/vnd.ms-powerpoint<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.pptx<\/code><\/td>\napplication\/vnd.openxmlformats-officedocument.presentationml.presentation<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.rar<\/code><\/td>\napplication\/x-rar-compressed<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.rtf<\/code><\/td>\napplication\/rtf<\/code> or text\/rtf<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.tif<\/code><\/td>\nimage\/tiff<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.tiff<\/code><\/td>\nimage\/tiff<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.txt<\/code><\/td>\ntext\/plain<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.vcf<\/code><\/td>\ntext\/vcard<\/code> or text\/x-vcard<\/code><\/td>\nattachment<\/code><\/td>\n<\/tr>\n
.wav<\/code><\/td>\naudio\/wav<\/code> or audio\/x-wav<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.xls<\/code><\/td>\napplication\/vnd.ms-excel<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.xlsx<\/code><\/td>\napplication\/vnd.openxmlformats-officedocument.spreadsheetml.sheet<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.xml<\/code><\/td>\napplication\/xml<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n
.xml<\/code><\/td>\ntext\/xml<\/code><\/td>\nattachment<\/code><\/td>\n<\/tr>\n
.zip<\/code><\/td>\napplication\/x-zip-compressed<\/code> or application\/zip<\/code><\/td>\ninline<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

NOTE: Marketing Cloud Support must provision this function for use in your account. There is typically an additional charge per attachment sent. Contact your Salesforce Account Executive to complete the process.<\/p>\n

NOTE: If the specified file cannot be found at send time, the send will throw a runtime error and abort.<\/p>\n

NOTE: If you are attaching an external file and the remote server does not respond within 30 seconds, the send will be scheduled to retry 15 minutes later.<\/p>\n

NOTE: Local assets in shared Content Builder or Portfolio locations are not supported.<\/p>\n

NOTE: MIME types text\/csv<\/code>, application\/xml<\/code>, text\/xml<\/code>, text\/vcard<\/code> and text\/x-vcard<\/code> have a default content-disposition of attachment<\/code>, that cannot be overridden.<\/p>\n<\/blockquote>\n

Example 1<\/h3>\n

This example attaches a Content Builder asset by Customer\/External Key:<\/p>\n

%%[\n\nvar @customerKey, @fileAlias\nset @customerKey = \"LoyaltyMembersCB\"\nset @fileAlias = \"LoyaltyMembers_ContentBuilder.zip\"\n\nAttachFile(\"ContentBuilder\", @customerKey, @fileAlias)\n\n]%%<\/code><\/pre>\n
Example 2<\/h3>\n
This example attaches a file from the Marketing Cloud Import<\/code> folder:<\/p>\n
%%[\n\nvar @fileName, @fileAlias\nset @fileName = \"LoyaltyMembers.zip\"\nset @fileAlias = \"LoyaltyMembers_FTP.zip\"\n\nAttachFile(\"FTP\", @fileName, @fileAlias)\n\n]%%<\/code><\/pre>\n
Example 3<\/h3>\n
This example attaches a file from an external website via HTTP\/HTTPS:<\/p>\n
%%[\n\nvar @fileName, @fileAlias\nset @fileName = \"https:\/\/limedash.com\/drop\/LoyaltyMembers.zip\"\nset @fileAlias = \"LoyaltyMembers.zip\"\n\nAttachFile(\"HTTP\", @fileName, @fileAlias)\n\n]%%<\/code><\/pre>\n
Example 4<\/h3>\n
This example attaches a file from the Portfolio asset by Customer\/External Key:<\/p>\n
%%[\n\nvar @externalKey, @fileAlias\nset @externalKey = \"LoyaltyMembers\"\nset @fileAlias = \"LoyaltyMembers_Portfolio.zip\"\n\nAttachFile(\"Portfolio\", @externalKey, @fileAlias)\n\n]%%\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
AttachFile This function attaches the specified file to the outbound message or displays a link to the file when included in a landing page. This function returns no output. Arguments AttachFile(1,2,3,4,5,6,7,8) Ordinal Type Required Description 1 String True Type of location containing the file to attach. Valid values include: ContentBuilder FTP HTTP Portfolio (Classic Content) […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"yoast_head":"\nThe AMPscript Guide - AttachFile<\/title>\n<meta name=\"robots\" content=\"index, follow\" \/>\n<meta name=\"googlebot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta name=\"bingbot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/ampscript.guide\/attachfile\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"The AMPscript Guide - AttachFile\" \/>\n<meta property=\"og:description\" content=\"AttachFile This function attaches the specified file to the outbound message or displays a link to the file when included in a landing page. This function returns no output. Arguments AttachFile(1,2,3,4,5,6,7,8) Ordinal Type Required Description 1 String True Type of location containing the file to attach. Valid values include: ContentBuilder FTP HTTP Portfolio (Classic Content) […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ampscript.guide\/attachfile\/\" \/>\n<meta property=\"og:site_name\" content=\"The AMPscript Guide\" \/>\n<meta property=\"article:published_time\" content=\"2018-04-21T15:47:46+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-04-06T01:18:22+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ampscript.guide\/#website\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"The AMPscript Guide\",\"description\":\"The Definitive Scripting Manual for Salesforce Marketing Cloud\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/ampscript.guide\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/attachfile\/#webpage\",\"url\":\"https:\/\/ampscript.guide\/attachfile\/\",\"name\":\"The AMPscript Guide - AttachFile\",\"isPartOf\":{\"@id\":\"https:\/\/ampscript.guide\/#website\"},\"datePublished\":\"2018-04-21T15:47:46+00:00\",\"dateModified\":\"2021-04-06T01:18:22+00:00\",\"author\":{\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\"},\"breadcrumb\":{\"@id\":\"https:\/\/ampscript.guide\/attachfile\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ampscript.guide\/attachfile\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ampscript.guide\/attachfile\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"Home\"}},{\"@type\":\"ListItem\",\"position\":2,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/attachfile\/\",\"url\":\"https:\/\/ampscript.guide\/attachfile\/\",\"name\":\"AttachFile\"}}]},{\"@type\":[\"Person\"],\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\",\"name\":\"dev\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","_links":{"self":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31396"}],"collection":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/comments?post=31396"}],"version-history":[{"count":0,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31396\/revisions"}],"wp:attachment":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/media?parent=31396"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/categories?post=31396"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/tags?post=31396"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}