POST api/Mail/Discard

Request Information

URI Parameters

None.

Body Parameters

MailEntity
NameDescriptionTypeAdditional information
AccountName

string

None.

FromID

string

None.

CC

string

None.

BCC

string

None.

To

string

None.

Headers

string

None.

Subject

string

None.

UniqueID

string

None.

body

string

None.

bodyShrinked

string

None.

Fullbody

string

None.

ReceivedDate

date

None.

ReceivedDateString

string

None.

FromName

string

None.

HasAttachments

boolean

None.

AttachmentFileame

string

None.

AttachmentPath

string

None.

MailIndex

integer

None.

MailCount

integer

None.

ServerIsRead

boolean

None.

ClientIsRead

byte

None.

IsMetrics

boolean

None.

JobIndex

integer

None.

CaseID

string

None.

currentOrder

string

None.

SearchBy

string

None.

TimeZoneID

string

None.

MailIndexes

string

None.

Time

string

None.

EnableFileDownload

boolean

None.

EnableReply

boolean

None.

PageCount

integer

None.

actiontaken

string

None.

jobcreatedtype

string

None.

MaxMailIndex

integer

None.

ReadMailCount

integer

None.

UnReadMailCount

integer

None.

ProjectCount

integer

None.

EnableDiscard

boolean

None.

InboxCount

integer

None.

IsProjFolderRequired

boolean

None.

RT

string

None.

BodyShrink

string

None.

Title

string

None.

RequestNumber

string

None.

RequestorName

string

None.

RequestorMailId

string

None.

RequestorCCMailId

string

None.

CaseNumber

string

None.

RefNumber

string

None.

FolderID

integer

None.

FolderName

string

None.

PageIndex

integer

None.

FolderCount

integer

None.

ConversationId

string

None.

UserEmailGroupID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountName": "sample string 1",
  "FromID": "sample string 2",
  "CC": "sample string 3",
  "BCC": "sample string 4",
  "To": "sample string 5",
  "Headers": "sample string 6",
  "Subject": "sample string 7",
  "UniqueID": "sample string 8",
  "body": "sample string 9",
  "bodyShrinked": "sample string 10",
  "Fullbody": "sample string 11",
  "ReceivedDate": "2026-06-08T11:18:10.0725094+00:00",
  "ReceivedDateString": "sample string 13",
  "FromName": "sample string 14",
  "HasAttachments": true,
  "AttachmentFileame": "sample string 16",
  "AttachmentPath": "sample string 17",
  "MailIndex": 18,
  "MailCount": 19,
  "ServerIsRead": true,
  "ClientIsRead": 64,
  "IsMetrics": true,
  "JobIndex": 22,
  "CaseID": "sample string 23",
  "currentOrder": "sample string 24",
  "SearchBy": "sample string 25",
  "TimeZoneID": "sample string 26",
  "MailIndexes": "sample string 27",
  "Time": "sample string 28",
  "EnableFileDownload": true,
  "EnableReply": true,
  "PageCount": 31,
  "actiontaken": "sample string 32",
  "jobcreatedtype": "sample string 33",
  "MaxMailIndex": 34,
  "ReadMailCount": 35,
  "UnReadMailCount": 36,
  "ProjectCount": 37,
  "EnableDiscard": true,
  "InboxCount": 39,
  "IsProjFolderRequired": true,
  "RT": "sample string 41",
  "BodyShrink": "sample string 42",
  "Title": "sample string 43",
  "RequestNumber": "sample string 44",
  "RequestorName": "sample string 45",
  "RequestorMailId": "sample string 46",
  "RequestorCCMailId": "sample string 47",
  "CaseNumber": "sample string 48",
  "RefNumber": "sample string 49",
  "FolderID": 50,
  "FolderName": "sample string 51",
  "PageIndex": 52,
  "FolderCount": 53,
  "ConversationId": "sample string 54",
  "UserEmailGroupID": 55
}

application/xml, text/xml

Sample:
<MailEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIDataLayer">
  <AccountName>sample string 1</AccountName>
  <AttachmentFileame>sample string 16</AttachmentFileame>
  <AttachmentPath>sample string 17</AttachmentPath>
  <BCC>sample string 4</BCC>
  <BodyShrink>sample string 42</BodyShrink>
  <CC>sample string 3</CC>
  <CaseID>sample string 23</CaseID>
  <CaseNumber>sample string 48</CaseNumber>
  <ClientIsRead>64</ClientIsRead>
  <ConversationId>sample string 54</ConversationId>
  <EnableDiscard>true</EnableDiscard>
  <EnableFileDownload>true</EnableFileDownload>
  <EnableReply>true</EnableReply>
  <FolderCount>53</FolderCount>
  <FolderID>50</FolderID>
  <FolderName>sample string 51</FolderName>
  <FromID>sample string 2</FromID>
  <FromName>sample string 14</FromName>
  <Fullbody>sample string 11</Fullbody>
  <HasAttachments>true</HasAttachments>
  <Headers>sample string 6</Headers>
  <InboxCount>39</InboxCount>
  <IsMetrics>true</IsMetrics>
  <IsProjFolderRequired>true</IsProjFolderRequired>
  <JobIndex>22</JobIndex>
  <MailCount>19</MailCount>
  <MailIndex>18</MailIndex>
  <MailIndexes>sample string 27</MailIndexes>
  <MaxMailIndex>34</MaxMailIndex>
  <PageCount>31</PageCount>
  <PageIndex>52</PageIndex>
  <ProjectCount>37</ProjectCount>
  <RT>sample string 41</RT>
  <ReadMailCount>35</ReadMailCount>
  <ReceivedDate>2026-06-08T11:18:10.0725094+00:00</ReceivedDate>
  <ReceivedDateString>sample string 13</ReceivedDateString>
  <RefNumber>sample string 49</RefNumber>
  <RequestNumber>sample string 44</RequestNumber>
  <RequestorCCMailId>sample string 47</RequestorCCMailId>
  <RequestorMailId>sample string 46</RequestorMailId>
  <RequestorName>sample string 45</RequestorName>
  <SearchBy>sample string 25</SearchBy>
  <ServerIsRead>true</ServerIsRead>
  <Subject>sample string 7</Subject>
  <Time>sample string 28</Time>
  <TimeZoneID>sample string 26</TimeZoneID>
  <Title>sample string 43</Title>
  <To>sample string 5</To>
  <UnReadMailCount>36</UnReadMailCount>
  <UniqueID>sample string 8</UniqueID>
  <UserEmailGroupID>55</UserEmailGroupID>
  <actiontaken>sample string 32</actiontaken>
  <body>sample string 9</body>
  <bodyShrinked>sample string 10</bodyShrinked>
  <currentOrder>sample string 24</currentOrder>
  <jobcreatedtype>sample string 33</jobcreatedtype>
</MailEntity>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.