digitaluapi

SendMailRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/communication/sendmail	Sends an email

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SendMailRequest
{
    /**
    * Email address of sender. If it is not set the a default address will be used.
    */
    @ApiMember(Description="Email address of sender. If it is not set the a default address will be used.")
    open var FromAddress:String? = null

    /**
    * List of recipient email addresses
    */
    @ApiMember(Description="List of recipient email addresses", IsRequired=true)
    open var Recipients:ArrayList<String>? = null

    /**
    * Email subject
    */
    @ApiMember(Description="Email subject", IsRequired=true)
    open var Subject:String? = null

    /**
    * Plain text body. Either this or HtmlBody is required
    */
    @ApiMember(Description="Plain text body. Either this or HtmlBody is required")
    open var Body:String? = null

    /**
    * Html body. Either this or Body is required
    */
    @ApiMember(Description="Html body. Either this or Body is required")
    open var HtmlBody:String? = null

    /**
    * Email attachments
    */
    @ApiMember(Description="Email attachments")
    open var Attachments:ArrayList<String>? = null

    /**
    * Email attachments
    */
    @ApiMember(Description="Email attachments")
    open var AttachmentsObject:ArrayList<Attachment>? = null

    /**
    * Attachment streams
    */
    @ApiMember(Description="Attachment streams")
    open var AttachmentStreams:ArrayList<AttachmentStream>? = null

    /**
    * Template substitutions
    */
    @ApiMember(Description="Template substitutions")
    open var TemplateSubstitutions:HashMap<String,String>? = null

    /**
    * Template Id
    */
    @ApiMember(Description="Template Id")
    open var TemplateId:String? = null

    /**
    * List of BCC email addresses
    */
    @ApiMember(Description="List of BCC email addresses")
    open var Bcc:ArrayList<String>? = null

    /**
    * List of CC email addresses
    */
    @ApiMember(Description="List of CC email addresses")
    open var Cc:ArrayList<String>? = null
}

open class Attachment
{
    open var Content:String? = null
    open var Type:String? = null
    open var Filename:String? = null
    open var Disposition:String? = null
    open var ContentId:String? = null
}

open class AttachmentStream
{
    open var Stream:InputStream? = null
    open var Name:String? = null
    open var Type:String? = null
    open var Disposition:String? = null
    open var Contentid:String? = null
}

Kotlin SendMailRequest DTOs

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 /communication/sendmail HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendMailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <AttachmentStreams>
    <AttachmentStream>
      <Contentid>String</Contentid>
      <Disposition>String</Disposition>
      <Name>String</Name>
      <Stream xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
      <Type>String</Type>
    </AttachmentStream>
  </AttachmentStreams>
  <Attachments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Attachments>
  <AttachmentsObject>
    <Attachment>
      <Content>String</Content>
      <ContentId>String</ContentId>
      <Disposition>String</Disposition>
      <Filename>String</Filename>
      <Type>String</Type>
    </Attachment>
  </AttachmentsObject>
  <Bcc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Body>String</Body>
  <Cc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <FromAddress>String</FromAddress>
  <HtmlBody>String</HtmlBody>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Subject>String</Subject>
  <TemplateId>String</TemplateId>
  <TemplateSubstitutions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </TemplateSubstitutions>
</SendMailRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />