digitaluapi

<back to all web services

SendMailRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/sendmailSends an email
SendMailRequest Parameters:
NameParameterData TypeRequiredDescription
FromAddressbodystringNoEmail address of sender. If it is not set the a default address will be used.
RecipientsbodyIEnumerable<string>YesList of recipient email addresses
SubjectbodystringYesEmail subject
BodybodystringNoPlain text body. Either this or HtmlBody is required
HtmlBodybodystringNoHtml body. Either this or Body is required
Attachmentsbodystring[]NoEmail attachments
AttachmentsObjectbodyAttachment[]NoEmail attachments
AttachmentStreamsbodyAttachmentStream[]NoAttachment streams
TemplateSubstitutionsbodyDictionary<string, string>NoTemplate substitutions
TemplateIdbodystringNoTemplate Id
BccbodyIEnumerable<string>NoList of BCC email addresses
CcbodyIEnumerable<string>NoList of CC email addresses
Attachment Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
TypeformstringNo
FilenameformstringNo
DispositionformstringNo
ContentIdformstringNo
AttachmentStream Parameters:
NameParameterData TypeRequiredDescription
StreamformStreamNo
NameformstringNo
TypeformstringNo
DispositionformstringNo
ContentidformstringNo

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