POST api/Mail/Send

Send e-mail

Request Information

URI Parameters

None.

Body Parameters

WorkPoint.Core.Models.Actions.SendMailAction
NameDescriptionTypeAdditional information
To

Collection of Object

None.

CC

Collection of Object

None.

BCC

Collection of Object

None.

ToUserField

string

None.

CCUserField

string

None.

BCCUserField

string

None.

Subject

string

None.

Body

string

None.

TemplateId

integer

None.

Attachments

Collection of WorkPoint.Core.Models.Actions.SendMailAction+MailAttachmentQuery

None.

Id

globally unique identifier

None.

Title

string

None.

Order

integer

None.

Active

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "To": [
    {},
    {}
  ],
  "CC": [
    {},
    {}
  ],
  "BCC": [
    {},
    {}
  ],
  "ToUserField": "sample string 1",
  "CCUserField": "sample string 2",
  "BCCUserField": "sample string 3",
  "Subject": "sample string 4",
  "Body": "sample string 5",
  "TemplateId": 6,
  "Attachments": [
    {
      "WebRelativeListUrl": "sample string 1",
      "CAML": "sample string 2"
    },
    {
      "WebRelativeListUrl": "sample string 1",
      "CAML": "sample string 2"
    }
  ],
  "Id": "dd814fe5-9716-4a6a-b3fa-26883540be89",
  "Title": "sample string 8",
  "Order": 9,
  "Active": true
}

application/xml, text/xml

Sample:
<SendMailAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.Actions">
  <ActionWasSuccessful>true</ActionWasSuccessful>
  <Active>true</Active>
  <CallbackUrl>sample string 13</CallbackUrl>
  <Id>dd814fe5-9716-4a6a-b3fa-26883540be89</Id>
  <Order>9</Order>
  <ReturnValue>sample string 11</ReturnValue>
  <Title>sample string 8</Title>
  <Attachments>
    <SendMailAction.MailAttachmentQuery />
    <SendMailAction.MailAttachmentQuery />
  </Attachments>
  <BCC xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </BCC>
  <BCCUserField>sample string 3</BCCUserField>
  <Body>sample string 5</Body>
  <CC xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </CC>
  <CCUserField>sample string 2</CCUserField>
  <Subject>sample string 4</Subject>
  <TemplateId>6</TemplateId>
  <To xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </To>
  <ToUserField>sample string 1</ToUserField>
</SendMailAction>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.