CommunicationHub.API

<back to all web services

ReceiveMail

The following routes are available for this service:
POST/Mail/Receive
ReceiveMail Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringNo
RecipientbodystringNo
SenderbodystringNo
FrombodystringNo
TobodystringNo
InReplyTobodystringNo
CCbodystringNo
BCCbodystringNo
SubjectbodystringNo
TextbodystringNo
HTMLbodystringNo
AttachmentCountbodyintNo

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/Receive HTTP/1.1 
Host: communicationhub.carelogic-cloud.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReceiveMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommunicationHub.APIModel">
  <AttachmentCount>0</AttachmentCount>
  <BCC>String</BCC>
  <CC>String</CC>
  <From>String</From>
  <HTML>String</HTML>
  <InReplyTo>String</InReplyTo>
  <MessageId>String</MessageId>
  <Recipient>String</Recipient>
  <Sender>String</Sender>
  <Subject>String</Subject>
  <Text>String</Text>
</ReceiveMail>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">false</boolean>