POST api/v1/MailData
Request Information
URI Parameters
None.
Body Parameters
GetMailDataParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| MailID | MailID |
None. |
|
| IncludeData | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{
"MailID": {
"ConversationID": "sample string 1",
"MessageID": "sample string 2"
},
"IncludeData": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<GetMailDataParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
<IncludeData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</IncludeData>
<MailID>
<ConversationID>sample string 1</ConversationID>
<MessageID>sample string 2</MessageID>
</MailID>
</GetMailDataParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MailData| Name | Description | Type | Additional information |
|---|---|---|---|
| IsMailArchived | boolean |
None. |
|
| IsMailSoftDeleted | boolean |
None. |
|
| MailMetadataCollection | MailMetadataCollection |
None. |
|
| SecurityGroups | Collection of SecurityGroup |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsMailArchived": true,
"IsMailSoftDeleted": true,
"MailMetadataCollection": {
"MailID": {
"ConversationID": "sample string 1",
"MessageID": "sample string 2"
},
"MailMetadataList": [
{
"Metadata": {
"ID": 1,
"Name": "sample string 2",
"Type": 10,
"SortOrder": 3,
"Mandatory": true,
"Hidden": true,
"Settings": "sample string 6"
},
"Value": "sample string 1",
"MetadataValues": [
{
"ID": 1,
"MetadataID": 2,
"Name": "sample string 3",
"SortOrder": 4
},
{
"ID": 1,
"MetadataID": 2,
"Name": "sample string 3",
"SortOrder": 4
}
]
},
{
"Metadata": {
"ID": 1,
"Name": "sample string 2",
"Type": 10,
"SortOrder": 3,
"Mandatory": true,
"Hidden": true,
"Settings": "sample string 6"
},
"Value": "sample string 1",
"MetadataValues": [
{
"ID": 1,
"MetadataID": 2,
"Name": "sample string 3",
"SortOrder": 4
},
{
"ID": 1,
"MetadataID": 2,
"Name": "sample string 3",
"SortOrder": 4
}
]
}
]
},
"SecurityGroups": [
{
"TeamID": "sample string 1",
"TeamName": "sample string 2",
"IsDomainGroup": true
},
{
"TeamID": "sample string 1",
"TeamName": "sample string 2",
"IsDomainGroup": true
}
]
}
application/xml, text/xml
Sample:
<MailData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
<IsMailArchived>true</IsMailArchived>
<IsMailSoftDeleted>true</IsMailSoftDeleted>
<MailMetadataCollection>
<MailID>
<ConversationID>sample string 1</ConversationID>
<MessageID>sample string 2</MessageID>
</MailID>
<MailMetadataList>
<MailMetadata>
<Metadata>
<Hidden>true</Hidden>
<ID>1</ID>
<Mandatory>true</Mandatory>
<Name>sample string 2</Name>
<Settings>sample string 6</Settings>
<SortOrder>3</SortOrder>
<Type>ShortText</Type>
</Metadata>
<MetadataValues>
<MetadataValue>
<ID>1</ID>
<MetadataID>2</MetadataID>
<Name>sample string 3</Name>
<SortOrder>4</SortOrder>
</MetadataValue>
<MetadataValue>
<ID>1</ID>
<MetadataID>2</MetadataID>
<Name>sample string 3</Name>
<SortOrder>4</SortOrder>
</MetadataValue>
</MetadataValues>
<Value>sample string 1</Value>
</MailMetadata>
<MailMetadata>
<Metadata>
<Hidden>true</Hidden>
<ID>1</ID>
<Mandatory>true</Mandatory>
<Name>sample string 2</Name>
<Settings>sample string 6</Settings>
<SortOrder>3</SortOrder>
<Type>ShortText</Type>
</Metadata>
<MetadataValues>
<MetadataValue>
<ID>1</ID>
<MetadataID>2</MetadataID>
<Name>sample string 3</Name>
<SortOrder>4</SortOrder>
</MetadataValue>
<MetadataValue>
<ID>1</ID>
<MetadataID>2</MetadataID>
<Name>sample string 3</Name>
<SortOrder>4</SortOrder>
</MetadataValue>
</MetadataValues>
<Value>sample string 1</Value>
</MailMetadata>
</MailMetadataList>
</MailMetadataCollection>
<SecurityGroups>
<SecurityGroup>
<IsDomainGroup>true</IsDomainGroup>
<TeamID>sample string 1</TeamID>
<TeamName>sample string 2</TeamName>
</SecurityGroup>
<SecurityGroup>
<IsDomainGroup>true</IsDomainGroup>
<TeamID>sample string 1</TeamID>
<TeamName>sample string 2</TeamName>
</SecurityGroup>
</SecurityGroups>
</MailData>