CommunicationHub.API

SendMail

The following routes are available for this service:
POST	/Mail/Send

**SendMail** Parameters:
Name	Parameter	Data Type	Required
Domain	body	string	No
From	body	string	No
FromName	body	string	No
To	body	string	No
ReceiverName	body	string	No
CC	body	string	No
BCC	body	string	No
Subject	body	string	No
Text	body	string	No
HTML	body	string	No
Attachments	body	List<Attachment>	No
Reference	body	string	No

**Attachment** Parameters:
Name	Parameter	Data Type	Required
Bytes	form	byte[]	No
Name	form	string	No
ContentType	form	string	No

**SendResponse** Parameters:
Name	Parameter	Data Type	Required
MessageId	form	string	No
Sender	form	string	No
Receiver	form	string	No
Status	form	Status	No
ErrorMessage	form	string	No
Configuration	form	string	No
Retry	form	bool	No
RetryCount	form	int	No

**Status** Enum:
accepted
queued
sending
sent
failed
delivered
undelivered
receiving
received
read
pickedup
unknown

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Mail/Send HTTP/1.1 
Host: communicationhub.carelogic-cloud.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Domain: String,
	From: String,
	FromName: String,
	To: String,
	ReceiverName: String,
	CC: String,
	BCC: String,
	Subject: String,
	Text: String,
	HTML: String,
	Attachments: 
	[
		{
			Bytes: AA==,
			Name: String,
			ContentType: String
		}
	],
	Reference: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MessageId: String,
	Sender: String,
	Receiver: String,
	Status: accepted,
	ErrorMessage: String,
	Configuration: String,
	Retry: False,
	RetryCount: 0
}