POST api/Message/Email/Send

Request Information

URI Parameters

None.

Body Parameters

EmailMessage
NameDescriptionTypeAdditional information
SendTo

string

None.

CC

string

None.

Subject

string

None.

Body

string

None.

NonPeak

boolean

None.

SendFrom

string

None.

BCC

string

None.

Attachments

Collection of EmailAttachment

None.

Application

string

None.

Reference

string

None.

Anonymise

boolean

None.

ReplyTo

string

None.

Scheduled

date

None.

SendPlainTextEmail

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SendTo": "sample string 1",
  "CC": "sample string 2",
  "Subject": "sample string 3",
  "Body": "sample string 4",
  "NonPeak": true,
  "SendFrom": "sample string 6",
  "BCC": "sample string 7",
  "Attachments": [
    {
      "Filename": "sample string 1",
      "Content": "QEA="
    },
    {
      "Filename": "sample string 1",
      "Content": "QEA="
    }
  ],
  "Application": "sample string 8",
  "Reference": "sample string 9",
  "Anonymise": true,
  "ReplyTo": "sample string 10",
  "Scheduled": "2024-11-22T22:34:42.669047+00:00",
  "SendPlainTextEmail": true
}

text/html

Sample:
{"SendTo":"sample string 1","CC":"sample string 2","Subject":"sample string 3","Body":"sample string 4","NonPeak":true,"SendFrom":"sample string 6","BCC":"sample string 7","Attachments":[{"Filename":"sample string 1","Content":"QEA="},{"Filename":"sample string 1","Content":"QEA="}],"Application":"sample string 8","Reference":"sample string 9","Anonymise":true,"ReplyTo":"sample string 10","Scheduled":"2024-11-22T22:34:42.669047+00:00","SendPlainTextEmail":true}

application/xml, text/xml

Sample:
<EmailMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ldl.MessageBroker.Service.MailSender.Models">
  <Anonymise>true</Anonymise>
  <Application>sample string 8</Application>
  <Attachments>
    <EmailAttachment>
      <Content>QEA=</Content>
      <Filename>sample string 1</Filename>
    </EmailAttachment>
    <EmailAttachment>
      <Content>QEA=</Content>
      <Filename>sample string 1</Filename>
    </EmailAttachment>
  </Attachments>
  <BCC>sample string 7</BCC>
  <Body>sample string 4</Body>
  <CC>sample string 2</CC>
  <NonPeak>true</NonPeak>
  <Reference>sample string 9</Reference>
  <ReplyTo>sample string 10</ReplyTo>
  <Scheduled>2024-11-22T22:34:42.669047+00:00</Scheduled>
  <SendFrom>sample string 6</SendFrom>
  <SendPlainTextEmail>true</SendPlainTextEmail>
  <SendTo>sample string 1</SendTo>
  <Subject>sample string 3</Subject>
</EmailMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.