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

"use strict";
export class Attachment {
    /** @param {{Content?:string,Type?:string,Filename?:string,Disposition?:string,ContentId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Content;
    /** @type {string} */
    Type;
    /** @type {string} */
    Filename;
    /** @type {string} */
    Disposition;
    /** @type {string} */
    ContentId;
}
export class AttachmentStream {
    /** @param {{Stream?:string,Name?:string,Type?:string,Disposition?:string,Contentid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Stream;
    /** @type {string} */
    Name;
    /** @type {string} */
    Type;
    /** @type {string} */
    Disposition;
    /** @type {string} */
    Contentid;
}
export class SendMailRequest {
    /** @param {{FromAddress?:string,Recipients?:string[],Subject?:string,Body?:string,HtmlBody?:string,Attachments?:string[],AttachmentsObject?:Attachment[],AttachmentStreams?:AttachmentStream[],TemplateSubstitutions?:{ [index:string]: string; },TemplateId?:string,Bcc?:string[],Cc?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Email address of sender. If it is not set the a default address will be used. */
    FromAddress;
    /**
     * @type {string[]}
     * @description List of recipient email addresses */
    Recipients;
    /**
     * @type {string}
     * @description Email subject */
    Subject;
    /**
     * @type {string}
     * @description Plain text body. Either this or HtmlBody is required */
    Body;
    /**
     * @type {string}
     * @description Html body. Either this or Body is required */
    HtmlBody;
    /**
     * @type {string[]}
     * @description Email attachments */
    Attachments;
    /**
     * @type {Attachment[]}
     * @description Email attachments */
    AttachmentsObject;
    /**
     * @type {AttachmentStream[]}
     * @description Attachment streams */
    AttachmentStreams;
    /**
     * @type {{ [index:string]: string; }}
     * @description Template substitutions */
    TemplateSubstitutions;
    /**
     * @type {string}
     * @description Template Id */
    TemplateId;
    /**
     * @type {string[]}
     * @description List of BCC email addresses */
    Bcc;
    /**
     * @type {string[]}
     * @description List of CC email addresses */
    Cc;
}

JavaScript 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/" />