Secure Message Center (SMC) API
API change historyGET MESSAGE SUMMARIES WITH METADATA
This method is used to retrieve message summaries of all messages with metadata within a specified folder. A session key must be submitted via the X-Session-Key header. Include the LastMessageIdReceived request body parameter to specify the last message ID received to receive summaries only for messages created since the ID reference. A successful transaction will receive a 200 status code.
Try itRequest
Request URL
Request headers
-
(optional)string
-
(optional)stringMedia type of the body sent to the API.
Request body
Get message summaries request data
{
"FolderId": 0,
"LastMessageIdReceived": 0
}
{
"description": "Get message summaries request data",
"required": [
"FolderId"
],
"type": "object",
"properties": {
"FolderId": {
"format": "int32",
"description": "The ID of the Inbox folder to search (primary Inbox folder ID = 1)",
"type": "integer"
},
"LastMessageIdReceived": {
"format": "int32",
"description": "Used to specify the last message ID received to receive summaries only for messages created since the ID reference.",
"type": "integer"
}
}
}
Responses
200 OK
Ok
Representations
{
"Summaries": [
{
"FirstRecipient": "string",
"AttachmentCount": 0,
"InlineAttachmentCount": 0,
"Attachments": [
{
"AttachmentId": 0,
"FileName": "string",
"ContentId": "string",
"SecurityEnvelope": {
"Checksum": "string",
"HashAlgorithm": "string",
"Status": 0,
"StatusDescription": "string"
},
"Size": {
"StdString": "string"
},
"Tracking": {
"Recipients": [
{
"ChecksumValidated": 0,
"Delivered": true,
"DeliveredDate": "string",
"Downloaded": true,
"DownloadedDate": "string",
"Email": "string"
}
]
}
}
],
"createTimeString": "string",
"ExpirationDate": "string",
"FolderId": 0,
"MessageId": 0,
"MessageSize": 0,
"Read": true,
"SecurityEnvelope": {
"Checksum": "string",
"HashAlgorithm": "string",
"Status": 0,
"StatusDescription": "string"
},
"MessageStatus": 0,
"Tracking": [
{
"DateOpened": "string",
"Email": "string",
"MessageStatusDescription": "string",
"MessageStatusId": 0,
"ReceiverField": "string"
}
],
"SenderAddress": "string",
"Subject": "string"
}
]
}
{
"description": "Message summary with metadata collection data",
"required": [
"Summaries"
],
"type": "object",
"properties": {
"Summaries": {
"description": "A message summaries structure containing the message summary data with metadata for each message",
"type": "array",
"items": {
"description": "Message summary with metadata",
"required": [
"FirstRecipient",
"AttachmentCount",
"InlineAttachmentCount",
"Attachments",
"createTimeString",
"ExpirationDate",
"FolderId",
"MessageId",
"MessageSize",
"Read",
"SecurityEnvelope",
"MessageStatus",
"Tracking",
"SenderAddress",
"Subject"
],
"type": "object",
"properties": {
"FirstRecipient": {
"description": "First To recipient of the message",
"type": "string"
},
"AttachmentCount": {
"format": "int32",
"description": "The number of attachments sent with the message",
"type": "integer"
},
"InlineAttachmentCount": {
"format": "int32",
"description": "The number of inline attachments sent with the message",
"type": "integer"
},
"Attachments": {
"description": "A complex type containing the Attachment Structure, the Security Envelope Structure, and the Tracking Structure per attachment",
"type": "array",
"items": {
"description": "Attachment metadata",
"required": [
"AttachmentId",
"FileName",
"SecurityEnvelope",
"Size",
"Tracking"
],
"type": "object",
"properties": {
"AttachmentId": {
"format": "int32",
"description": "Attachment unique identifier",
"type": "integer"
},
"FileName": {
"description": "Attachment filename",
"type": "string"
},
"ContentId": {
"description": "ContentId for inline attachment",
"type": "string"
},
"SecurityEnvelope": {
"description": "Attachment security envelope structure",
"required": [
"Checksum",
"HashAlgorithm",
"Status",
"StatusDescription"
],
"type": "object",
"properties": {
"Checksum": {
"description": "Used to verify the integrity of the message, it is returned for reference only",
"type": "string"
},
"HashAlgorithm": {
"description": "Used to generate the Checksum. If not present, assume MD5",
"type": "string"
},
"Status": {
"format": "int32",
"description": "Numeric indicator of the validation status",
"type": "integer"
},
"StatusDescription": {
"description": "Status represented as string description",
"type": "string"
}
}
},
"Size": {
"type": "object",
"properties": {
"StdString": {
"type": "string"
}
},
"description": "Attachment size"
},
"Tracking": {
"description": "Attachment tracking structure",
"required": [
"Recipients"
],
"type": "object",
"properties": {
"Recipients": {
"description": "Attachment tracking recipient data collection",
"type": "array",
"items": {
"description": "Attachment tracking recipient data",
"required": [
"ChecksumValidated",
"Delivered",
"DeliveredDate",
"Downloaded",
"DownloadedDate",
"Email"
],
"type": "object",
"properties": {
"ChecksumValidated": {
"format": "int32",
"description": "0(Invalid), 1(Valid), or 2(NotApplied)",
"enum": [
0,
1,
2
],
"type": "integer"
},
"Delivered": {
"description": "Indicates whether or not the message has been delivered",
"type": "boolean"
},
"DeliveredDate": {
"description": "The date/time string that the message was delivered\r\nNote: If year = 1900, then there is no DateOpened associated with the current message status.",
"type": "string"
},
"Downloaded": {
"description": "Indicates whether or not the attachment has been downloaded",
"type": "boolean"
},
"DownloadedDate": {
"description": "The date/time string that the message was delivered.\r\nNote: If year = 1900, then there is no DateOpened associated with the current message status.",
"type": "string"
},
"Email": {
"description": "The email address of the recipient",
"type": "string"
}
}
}
}
}
}
}
}
},
"createTimeString": {
"description": "Date/time the message was created",
"type": "string"
},
"ExpirationDate": {
"description": "Date/time string for message expiration",
"type": "string"
},
"FolderId": {
"format": "int32",
"description": "Unique folder identifier",
"type": "integer"
},
"MessageId": {
"format": "int32",
"description": "Unique message identifier",
"type": "integer"
},
"MessageSize": {
"format": "int64",
"description": "Size in bytes of message",
"type": "integer"
},
"Read": {
"description": "Indicates whether or not the message was opened",
"type": "boolean"
},
"SecurityEnvelope": {
"description": "A SecurityEnvelope complex type",
"required": [
"Checksum",
"HashAlgorithm",
"Status",
"StatusDescription"
],
"type": "object",
"properties": {
"Checksum": {
"description": "Used to verify the integrity of the message, it is returned for reference only",
"type": "string"
},
"HashAlgorithm": {
"description": "Used to generate the Checksum. If not present, assume MD5",
"type": "string"
},
"Status": {
"format": "int32",
"description": "Numeric indicator of the validation status",
"type": "integer"
},
"StatusDescription": {
"description": "Status represented as string description",
"type": "string"
}
}
},
"MessageStatus": {
"format": "int32",
"description": "Integer referring to status of message.\r\nSender-Only Status Types:\r\n[-8(DirectMessageFailed), -7(PendingUpload), -6(PendingLicense), -5(Pending), -4(Restricted), -3(Deleted), -2(Retracted), -1(Draft), 0(EditMode)]\r\nSender/Recipient Status Types:\r\n[1(NoticeInQueue), 2(NoticeSent)]\r\nPer Recipient (not per message) Status Types:\r\n[3(UnRead), 4(Read)]\r\nPush Status Types:\r\n[5(SentSafeTls), 6(NoticeError), 7(Pop3Delivered), 8(PushedZip), 10(PushedPdf)]\r\nSecureForms Status Types:\r\n[11(DistributionRequestProcessed), 12(DistributionRequestFailed)]\r\nDataBridge Status Types:\r\n[13(WorkflowDestinationEnroute), 14(WorkflowDestinationDelivered), 15(WorkflowDestinationUnreachable)]\r\nDataMotion Direct Status Types:\r\n[16(DirectMessageQueued), 17(DirectMessageSent), 18(DirectMessageDispatched), 19(DirectMessageProcessed)]",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
-8,
-7,
-6,
-5,
-4,
-3,
-2,
-1
],
"type": "integer"
},
"Tracking": {
"description": "A Tracking complex type",
"type": "array",
"items": {
"description": "Message tracking recipient data",
"required": [
"DateOpened",
"Email",
"MessageStatusDescription",
"MessageStatusId",
"ReceiverField"
],
"type": "object",
"properties": {
"DateOpened": {
"description": "The date/time string that the message was opened.\r\nNote: If year = 1900, then there is no DateOpened associated with the current message status.",
"type": "string"
},
"Email": {
"description": "The email address of the recipient",
"type": "string"
},
"MessageStatusDescription": {
"description": "Status represented as string description",
"type": "string"
},
"MessageStatusId": {
"format": "int32",
"description": "Numeric indicator of the status of the individual recipient",
"type": "integer"
},
"ReceiverField": {
"description": "Indicates whether this recipient was the TO, CC, or BCC of the message",
"type": "string"
}
}
}
},
"SenderAddress": {
"description": "Sender's email address",
"type": "string"
},
"Subject": {
"description": "Subject of the message",
"type": "string"
}
}
}
}
}
}
400 Bad Request
The GetMessageSummariesRequestData model is required in the request body.
Representations
401 Unauthorized
The X-Session-Key header is missing. || Bad session key. || Session key expired. || User is not authorized to use the Web Service API. || FolderId [FolderId] not found. || An error has occurred at [DateTime] please check the server logs for details.
Representations
Code samples
@ECHO OFF
curl -v -X POST "https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata"
-H "X-Session-Key: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("X-Session-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("X-Session-Key", "");
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-Session-Key","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-Session-Key"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Session-Key' => '',
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'X-Session-Key': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.datamotion.com')
conn.request("POST", "/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'X-Session-Key': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.datamotion.com')
conn.request("POST", "/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://api.datamotion.com/SecureMail-Sandbox/Message/GetMessageSummariesWithMetadata')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['X-Session-Key'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body