POST /{mydomain}/messages.mime
Posts a message in MIME format. Note: you will need to build a MIME string yourself. Use a MIME library for your programming language to do this. Pass the resulting MIME string as message parameter.
| Parameter | Description |
|---|
| to | Email address of the recipient(s). Example: "Bob <bob@host.com>". You can use commas to separate multiple recipients. Make sure to include all To, Cc and Bcc recipients of the message. |
| message | MIME string of the message. Make sure to use multipart/form-data to send this as a file upload. |
| o:tag | Tag string. See Tagging for more information. |
| o:deliverytime | Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future. |
| o:dkim | Enables/disabled DKIM signatures on per-message basis. Pass yes or no |
| o:testmode | Enables sending in test mode. Pass yes if needed. See Sending in Test Mode |
| o:tracking | Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no. |
| o:tracking-clicks | Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly. |
| o:tracking-opens | Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no. |
| h:X-My-Header | h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address. |
| v:my-var | v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information. |
Servers
- https://api.mailgun.net
- https://api.eu.mailgun.net
Path parameters
| Name |
Type |
Required |
Description |
mydomain |
String |
Yes |
|
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded"
|
Request body fields
| Name |
Type |
Required |
Description |
o:dkim |
String |
No |
|
inline |
String |
No |
|
o:tracking |
String |
No |
|
o:require-tls |
String |
No |
|
h:X-My-Header |
String |
No |
|
subject |
String |
No |
|
v:my-var |
String |
No |
|
attachment |
String |
No |
|
from |
String |
No |
|
o:deliverytime |
String |
No |
|
to |
String |
No |
|
html |
String |
No |
|
text |
String |
No |
|
o:tracking-clicks |
String |
No |
|
bcc |
String |
No |
|
o:skip-verification |
String |
No |
|
o:tag |
String |
No |
|
o:testmode |
String |
No |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.
