Attachments

Our programmatic email API supports attachments via multipart/form-data requests.

Overview

• The attachment feature is only available to users who have set up sending emails from their own domains. If your agency would like to set this up, contact us.

• Each email can have up to 10 attachments.

• Each attachment should not exceed 2MB in size.

• The cumulative size of all attachments should not exceed 10MB.

• You can find the list of supported attachment file types below.

You will receive a 413 error if the requirements above are not met.

Supported attachment file types

List of supported attachment file types

• asc

• avi

• bmp

• csv

• dgn

• docx

• dwf

• dwg

• dxf

• ent

• gif

• jpeg

• jpg

• mpeg

• mpg

• mpp

• odb

• odf

• odg

• ods

• pdf

• png

• pptx

• rtf

• sxc

• sxd

• sxi

• sxw

• tif

• tiff

• txt

• wmv

• xlsx

Sample API calls

API call with one attachment

curl --location --request POST 'https://api.postman.gov.sg/v1/transactional/email/send' \
--header 'Authorization: Bearer your_api_key' \
--form 'body="<p>Hello <b>there</b></p>"' \
--form 'recipient="[email protected]"' \
--form 'attachments=@"/your/local/path-to-file"' \
--form 'subject="Test email"'
--form 'from="[email protected]"'

API call with two attachments

curl --location --request POST 'https://api.postman.gov.sg/v1/transactional/email/send' \
--header 'Authorization: Bearer your_api_key' \
--form 'body="<p>Hello <b>there</b></p>"' \
--form 'recipient="[email protected]"' \
--form 'attachments=@"/your/local/path-to-file-1"' \
--form 'attachments=@"/your/local/path-to-file-2"' \
--form 'subject="Test email"'
--form 'from="[email protected]"'

Sample code

JavaScript

const data = new FormData();
data.append("recipient", "[email protected]");
data.append("subject", "Test email");
data.append("body", "<p>Hello <b>there</b></p>");
data.append("from", "[email protected]");
data.append("attachments", "/your/local/path-to-file-1");
data.append("attachments", "/your/local/path-to-file-2");

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.postman.gov.sg/v1/transactional/email/send");
xhr.setRequestHeader("Authorization", "Bearer your_api_key");

xhr.send(data);