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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Attachment:
    content: Optional[str] = None
    type: Optional[str] = None
    filename: Optional[str] = None
    disposition: Optional[str] = None
    content_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttachmentStream:
    stream: Optional[bytes] = None
    name: Optional[str] = None
    type: Optional[str] = None
    disposition: Optional[str] = None
    contentid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendMailRequest:
    # @ApiMember(Description="Email address of sender. If it is not set the a default address will be used.")
    from_address: Optional[str] = None
    """
    Email address of sender. If it is not set the a default address will be used.
    """


    # @ApiMember(Description="List of recipient email addresses", IsRequired=true)
    recipients: Optional[List[str]] = None
    """
    List of recipient email addresses
    """


    # @ApiMember(Description="Email subject", IsRequired=true)
    subject: Optional[str] = None
    """
    Email subject
    """


    # @ApiMember(Description="Plain text body. Either this or HtmlBody is required")
    body: Optional[str] = None
    """
    Plain text body. Either this or HtmlBody is required
    """


    # @ApiMember(Description="Html body. Either this or Body is required")
    html_body: Optional[str] = None
    """
    Html body. Either this or Body is required
    """


    # @ApiMember(Description="Email attachments")
    attachments: Optional[List[str]] = None
    """
    Email attachments
    """


    # @ApiMember(Description="Email attachments")
    attachments_object: Optional[List[Attachment]] = None
    """
    Email attachments
    """


    # @ApiMember(Description="Attachment streams")
    attachment_streams: Optional[List[AttachmentStream]] = None
    """
    Attachment streams
    """


    # @ApiMember(Description="Template substitutions")
    template_substitutions: Optional[Dict[str, str]] = None
    """
    Template substitutions
    """


    # @ApiMember(Description="Template Id")
    template_id: Optional[str] = None
    """
    Template Id
    """


    # @ApiMember(Description="List of BCC email addresses")
    bcc: Optional[List[str]] = None
    """
    List of BCC email addresses
    """


    # @ApiMember(Description="List of CC email addresses")
    cc: Optional[List[str]] = None
    """
    List of CC email addresses
    """

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