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


export class Attachment
{
    public Content: string;
    public Type: string;
    public Filename: string;
    public Disposition: string;
    public ContentId: string;

    public constructor(init?: Partial<Attachment>) { (Object as any).assign(this, init); }
}

export class AttachmentStream
{
    public Stream: string;
    public Name: string;
    public Type: string;
    public Disposition: string;
    public Contentid: string;

    public constructor(init?: Partial<AttachmentStream>) { (Object as any).assign(this, init); }
}

export class SendMailRequest
{
    /** @description 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.")
    public FromAddress: string;

    /** @description List of recipient email addresses */
    // @ApiMember(Description="List of recipient email addresses", IsRequired=true)
    public Recipients: string[];

    /** @description Email subject */
    // @ApiMember(Description="Email subject", IsRequired=true)
    public Subject: string;

    /** @description Plain text body. Either this or HtmlBody is required */
    // @ApiMember(Description="Plain text body. Either this or HtmlBody is required")
    public Body: string;

    /** @description Html body. Either this or Body is required */
    // @ApiMember(Description="Html body. Either this or Body is required")
    public HtmlBody: string;

    /** @description Email attachments */
    // @ApiMember(Description="Email attachments")
    public Attachments: string[];

    /** @description Email attachments */
    // @ApiMember(Description="Email attachments")
    public AttachmentsObject: Attachment[];

    /** @description Attachment streams */
    // @ApiMember(Description="Attachment streams")
    public AttachmentStreams: AttachmentStream[];

    /** @description Template substitutions */
    // @ApiMember(Description="Template substitutions")
    public TemplateSubstitutions: { [index:string]: string; };

    /** @description Template Id */
    // @ApiMember(Description="Template Id")
    public TemplateId: string;

    /** @description List of BCC email addresses */
    // @ApiMember(Description="List of BCC email addresses")
    public Bcc: string[];

    /** @description List of CC email addresses */
    // @ApiMember(Description="List of CC email addresses")
    public Cc: string[];

    public constructor(init?: Partial<SendMailRequest>) { (Object as any).assign(this, init); }
}

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