Porta Plus 2 Web Services

<back to all web services

EmailClient

The following routes are available for this service:
POST/SendEmail

To override the Content-type in your clients 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 /xml/reply/EmailClient HTTP/1.1 
Host: api-uk.activesoftswitch.com 
Content-Type: application/xml
Content-Length: length

<EmailClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Web.Dto">
  <ContentId>0</ContentId>
  <FeatureName>String</FeatureName>
  <License>String</License>
  <Bcc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Bcc>
  <Cc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Cc>
  <From xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </From>
  <Message>String</Message>
  <Subject>String</Subject>
  <To xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </To>
  <mailPriority>Normal</mailPriority>
</EmailClient>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Web.Dto">
  <EmailSent>false</EmailSent>
</EmailClientResponse>