CommunicationHub.API

<back to all web services

SendMail

The following routes are available for this service:
POST/Mail/Send
SendMail Parameters:
NameParameterData TypeRequiredDescription
DomainbodystringNo
FrombodystringNo
FromNamebodystringNo
TobodystringNo
ReceiverNamebodystringNo
CCbodystringNo
BCCbodystringNo
SubjectbodystringNo
TextbodystringNo
HTMLbodystringNo
AttachmentsbodyList<Attachment>No
ReferencebodystringNo
Attachment Parameters:
NameParameterData TypeRequiredDescription
Bytesformbyte[]No
NameformstringNo
ContentTypeformstringNo
SendResponse Parameters:
NameParameterData TypeRequiredDescription
MessageIdformstringNo
SenderformstringNo
ReceiverformstringNo
StatusformStatusNo
ErrorMessageformstringNo
ConfigurationformstringNo
RetryformboolNo
RetryCountformintNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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