Transactional Emails using APIs

Messages

SendMessage

Description

The method allows the sending of a message to multiple recipients, the message content is passed as input in HTML or plain text. The message may also include attachments and embedded images.

HTTP Method

POST

URL

https://send.mailup.com/API/v2.0/messages/sendmessage

Reference

Click here to learn more about request parameters

The method takes as input the document JSON or XML that has the structure MessageDTO defined in the tables below.

MessageDTO
Parameter	Type	Description
Subject	String	the subject of the message
Html	HtmlDTO	the HTML part of the message
Text	String	the plain text part of the message
From	EmailAddressDTO	the sender
To	List<EmailAddressDTO>	the list of recipients in To header
Cc	List<EmailAddressDTO>	the list of recipients in Cc header
Bcc	List<EmailAddressDTO>	the list of recipients in Bcc
ReplyTo	String	The Reply-To header value
CharSet	String	The charset of the message body
ExtendedHeaders	List<NameValueDTO>	List of extended headers (only configured SMTP custom headers will be sent)
Attachments	List<MessagePartDTO>	List of attachments
EmbeddedImages	List<MessagePartDTO>	list of embedded images
XSmtpAPI	XSmtpAPIDTO	the X-SMTPAPI header value, used for custom aggregations and configurations
User	SmtpUserDTO	the SMTP+ user credentials

HtmlDTO
Parameter	Type	Description
DocType	String	The DOCTYPE directive
Head	String	The head content
Body	String	The body content
BodyTag	String	the body tag, default is "< body>"

EmailAddressDTO
Parameter	Type	Description
Name	String	the name
Email	String	the email address

NameValueDTO
Parameter	Type	Description
N	String	the name of the parameter
V	String	the value of the parameter

MessagePartDTO
Parameter	Type	Description
Filename	String	the file name
ContentId	String	the Content-Id value
Body	Array of Byte	the array of byte of the content

XSmtpAPIDTO
Parameter	Type	Description
CampaignName	String	The name used for the aggregated campaign
CampaignCode	String	The campaign code which determines the aggregation
Header	Boolean	Add or not the MailUp header to the message
Footer	Boolean	Add or not the MailUp footer to the message
ClickTracking	Boolean	Use the click tracking
ViewTracking	Boolean	Use the view tracking
Priority	Integer	Set the priority of the message (1 high - 5 low )
Schedule	DateTime	Schedule date and time of the message
DynamicFields	List<NameValueDTO>	List of merge tags and dynamic field of the recipient
CampaignReport	String	Name of the aggregated campaign report
SkipDynamicFields	Boolean	skip merge tags evaluation

SmtpUserDTO
Parameter	Type	Description
Username	String	the username
Password	String	the password

Click here to learn more about response parameters

SendResponseDTO
Parameter	Type	Description
Status	String	the status of the response can be "done" or "error"
Code	String	the result code (see the Error Code table)
Message	String	the result message

JSON request (example)

Click here to expand...

{
 "Html":
 {
 "DocType":null,
 "Head":null,
 "Body":"<div>Hello Mr. [firstname] [lastname] !!!</div><br><img width=\\"600\\" height=\\"397\\" src=\\"cid:img001\\">",
 "BodyTag":"<body>"
 },
 "Text":"Hello world!!!",
 "Subject":"Hello friend!",
 "From":{"Name":"Test User","Email":"test@mailup.it"},
 "To":[{"Name":"Massimo","Email":"info@mailup.it"}],
 "Cc":[],
 "Bcc":[],
 "ReplyTo":null,
 "CharSet":"utf-8",
 "ExtendedHeaders":null,
 "Attachments":null,
 "EmbeddedImages":
 [
 {
 "Filename":"Image.jpg",
 "ContentId":"img001",
 "Body":"..."
 }
 ],
 "XSmtpAPI":
 {
 "CampaignName":"Test Campaign",
 "CampaignCode":"1001",
 "Header":null,
 "Footer":null,
 "ClickTracking":null,
 "ViewTracking":null,
 "Priority":null,
 "Schedule":null,
 "DynamicFields":[{"N":"firstname","V":"Mario"},{"N":"lastname","V":"Rossi"}],
 "CampaignReport":null,
 "SkipDynamicFields":null
 },
 "User":{"Username":"sNNNNN_NN","Secret":"..."}
}

JSON response (example)

"Status":"done",
 "Code":"0",
 "Message":"Ok"
}

SendTemplate