EXPMail (0.4)

Download OpenAPI specification:Download

A simple endpoint to send email messages

sending

Sending out an email

Send out an email

Request Body schema: application/json

Object defining the email message to be sent

subject	string Subject of the email
html	string String containing the HTML content of the email. Takes precedence over `htmlurl` if provided. If both `html` and `text` or `texturl` are provided, or the `noconversion` config key is not provided, will create a multi-part MIME message.
htmlurl	string String containing the URL to a file containing the HTML content of the email. Ignored if `html` if provided. If both `htmlurl` and `text` or `texturl` are provided, or the `noconversion` config key is not provided, will create a multi-part MIME message.
text	string String containing the plain text content of the email. Takes precedence over `texturl` if provided. If both `text` and `html` or `htmlurl` are provided, will create a multi-part MIME message.
texturl	string String containing the URL to a file containing the plain text content of the email. Ignored if `text` is provided. If both `texturl` and `html` or `htmlurl` are provided, will create a multi-part MIME message.
	object `Recipient` object to be used as "From:" address for the email
required	Array of objects (Recipient) Array of `Recipient` objects to be used as "To:" addresses for the email
	Array of objects (Recipient) Array of `Recipient` objects to be used as "CC:" addresses for the email
	Array of objects (Recipient) Array of `Recipient` objects to be used as "BCC:" addresses for the email
	Array of objects (Attachment) Array of `Attachment` objects to be attached to the email
	Array of objects (Placeholder) Array of `Placeholder` objects. Any occurrences of `{PLACEHOLDER_NAME}` (`name` in all caps enclosed with curly brackets) in the email's HTML or plain text will be replaced by `value`.
	Array of objects (Config) Array of `Config` objects to change the default behaviour
key required	string API key to authenticate request with

Responses

Request samples

Payload

Content type

application/json


{"subject": "string",
"html": "string",
"htmlurl": "string",
"text": "string",
"texturl": "string",
"sender": 
{"email": "user@example.com",
"name": "string"
},
"recipients": 
[
{"email": "user@example.com",
"name": "string"
}
],
"ccs": 
[
{"email": "user@example.com",
"name": "string"
}
],
"bccs": 
[
{"email": "user@example.com",
"name": "string"
}
],
"attachments": 
[
{"url": "string",
"filename": "string",
"cid": "string"
}
],
"placeholders": 
[
{"name": "string",
"value": "string"
}
],
"config": 
[
{"key": "string"
}
],
"key": "string"
}

Response samples

Content type

application/json


{"status": "string",
"error": "string"
}