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 .xml suffix or ?format=xml

HTTP + XML

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

<SendMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommunicationHub.APIModel">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/CommunicationHub.APIModel.Helper">
    <d2p1:Attachment>
      <d2p1:Bytes>AA==</d2p1:Bytes>
      <d2p1:ContentType>String</d2p1:ContentType>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:Attachment>
  </Attachments>
  <BCC>String</BCC>
  <CC>String</CC>
  <Domain>String</Domain>
  <From>String</From>
  <FromName>String</FromName>
  <HTML>String</HTML>
  <ReceiverName>String</ReceiverName>
  <Reference>String</Reference>
  <Subject>String</Subject>
  <Text>String</Text>
  <To>String</To>
</SendMail>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommunicationHub.APIModel.Response">
  <Configuration>String</Configuration>
  <ErrorMessage>String</ErrorMessage>
  <MessageId>String</MessageId>
  <Receiver>String</Receiver>
  <Retry>false</Retry>
  <RetryCount>0</RetryCount>
  <Sender>String</Sender>
  <Status>accepted</Status>
</SendResponse>