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

namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Attachment() = 
        member val Content:String = null with get,set
        member val Type:String = null with get,set
        member val Filename:String = null with get,set
        member val Disposition:String = null with get,set
        member val ContentId:String = null with get,set

    [<AllowNullLiteral>]
    type AttachmentStream() = 
        member val Stream:Stream = null with get,set
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val Disposition:String = null with get,set
        member val Contentid:String = null with get,set

    [<AllowNullLiteral>]
    type SendMailRequest() = 
        ///<summary>
        ///Email address of sender. If it is not set the a default address will be used.
        ///</summary>
        [<ApiMember(Description="Email address of sender. If it is not set the a default address will be used.")>]
        member val FromAddress:String = null with get,set

        ///<summary>
        ///List of recipient email addresses
        ///</summary>
        [<ApiMember(Description="List of recipient email addresses", IsRequired=true)>]
        member val Recipients:IEnumerable<String> = null with get,set

        ///<summary>
        ///Email subject
        ///</summary>
        [<ApiMember(Description="Email subject", IsRequired=true)>]
        member val Subject:String = null with get,set

        ///<summary>
        ///Plain text body. Either this or HtmlBody is required
        ///</summary>
        [<ApiMember(Description="Plain text body. Either this or HtmlBody is required")>]
        member val Body:String = null with get,set

        ///<summary>
        ///Html body. Either this or Body is required
        ///</summary>
        [<ApiMember(Description="Html body. Either this or Body is required")>]
        member val HtmlBody:String = null with get,set

        ///<summary>
        ///Email attachments
        ///</summary>
        [<ApiMember(Description="Email attachments")>]
        member val Attachments:String[] = null with get,set

        ///<summary>
        ///Email attachments
        ///</summary>
        [<ApiMember(Description="Email attachments")>]
        member val AttachmentsObject:Attachment[] = null with get,set

        ///<summary>
        ///Attachment streams
        ///</summary>
        [<ApiMember(Description="Attachment streams")>]
        member val AttachmentStreams:AttachmentStream[] = null with get,set

        ///<summary>
        ///Template substitutions
        ///</summary>
        [<ApiMember(Description="Template substitutions")>]
        member val TemplateSubstitutions:Dictionary<String, String> = null with get,set

        ///<summary>
        ///Template Id
        ///</summary>
        [<ApiMember(Description="Template Id")>]
        member val TemplateId:String = null with get,set

        ///<summary>
        ///List of BCC email addresses
        ///</summary>
        [<ApiMember(Description="List of BCC email addresses")>]
        member val Bcc:IEnumerable<String> = null with get,set

        ///<summary>
        ///List of CC email addresses
        ///</summary>
        [<ApiMember(Description="List of CC email addresses")>]
        member val Cc:IEnumerable<String> = null with get,set

F# 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/" />