Chat now with support
Chat with Support

Archive Manager 5.9.6 - RESTful API Service Guide

Common rules Advanced searches Alert service global setting Alert service policies Alert service queries Attachments Authentication (login) Configurations Contacts Delegations Exported searches Folders Groups Logins Login domains Mailboxes Mailstores Messages
.../v1/messages/schema.{format} .../v1/messages.{format} .../v1/messages/{messageId}.{format} .../v1/messages/{messageId}/html.{format} .../v1/messages/{messageId}/plaintext.{format} .../v1/messages/{messageId}/raw.{format} .../v1/messages/{messageId}/rtf.{format} .../v1/messages/{checksum}/bodyhtml .../v1/messages/{checksum}/eml .../v1/messages/{checksum}/sendmail.{format} .../v1/messages/{checksum}/web.{format} .../v1/messages/searchresults/schema.{format} .../v1/messages/rtfImage/{fileName} .../v1/messages/web/schema.{format} .../v1/messages/web.{format} .../v1/messages/{checksumOrId}/accesshistories.{format} .../v1/messages/{checksumOrId}/availabletags.{format} .../v1/messages/{checksumOrId}/comments.{format} .../v1/messages/{checksumOrId}/journalreports.{format} .../v1/messages/{checksumOrId}/tags.{format} .../v1/messages/{checksumOrId}/tags/{tagId}.{format}
Message comments Message folders Message tags Message types Organizational units Product Retention change logs Retention holds Retention message logs Retention policies Retention runs Retention run policies Retention schedule Retention settings Security roles Server Tags

JSON response sample

[
{
"id": 1,
"attachments": 0,
"toDisplay": "Administrator",
"fromDisplay": "Administrator",
"subject": "test2",
"bodyFormat": 2,
"bodyCodePage": 20127,
"dateSent": "2015-04-08T21:08:37",
"dateReceived": "2015-04-08T21:08:38.307",
"importance": 1,
"sensitivity": 0,
"size": 2480,
"checkSum": "41b0616d-7fea-873c-8891-30386f31b462",
"messageClass": "IPM.Note"
},
{
"id": 2,
"attachments": 0,
"toDisplay": "Administrator",
"fromDisplay": "Administrator",
"subject": "test1",
"bodyFormat": 2,
"bodyCodePage": 20127,
"dateSent": "2015-04-08T21:08:27",
"dateReceived": "2015-04-08T21:08:34.993",
"importance": 1,
"sensitivity": 0,
"size": 2488,
"checkSum": "42d3e176-076f-9fbd-bb55-20baf5734a8c",
"messageClass": "IPM.Note"
}
]

POST

Creates a message and associates it to a folder and the mailbox that the folder belongs to.

* 
NOTE: This API only supports for creating a single message and linking the message to a single mailbox.

JSON request sample

{
"partType": "Email",
"partId": "1",
"isReference": false,
"purportedCheckSum": "d07f8e21-a441-30fc-df76-138f64b7f8ee",
"id": 1,
"from": {
"address": "test10@test.com",
"displayName": "test10"
},
"to": [
{
"address": "test1@test.com",
"displayName": "test1"
},
{
"address": "test2@test.com",
"displayName": "test2"
},
{
"address": "test3@test.com",
"displayName": "test3"
}
],
"cc": [
{
"address": "test4@test.com",
"displayName": "test4"
},
{
"address": "test5@test.com",
"displayName": "test5"
},
{
"address": "test6@test.com",
"displayName": "test6"
}
],
"bcc": [
{
"address": "test7@test.com",
"displayName": "test7"
},
{
"address": "test8@test.com",
"displayName": "test8"
},
{
"address": "test9@test.com",
"displayName": "test9"
}
],
"bodyCodePage": 1001,
"bodyFormat": "HTML",
"dateReceived": "9999-12-30T23:59:59.9999999Z",
"dateSent": "0001-01-02T00:00:00Z",
"evId": "Likely always empty because no one likes EV",
"header": "Super Header!",
"importance": 1,
"journalReport": "This is the report from the journal!",
"key": "Keys to the kingdom",
"messageClass": "IPM.Note",
"messageTypeId": 1,
"originalMessageId": "OriginalMessageID",
"purportedComplianceCheckSum": "d07f8e21-a441-30fc-df76-138f64b7f8ee",
"sensitivity": 5,
"size": 43,
"subject": "Subject is really long!!!!!!!!!!",
"threadIndex": "XYZThreadIndex",
"threadTopic": "XyZThreadToppiicc",
"version": "1.0 or maybe 2",
"body": {
"partType": "DataStream",
"partId": "1.1",
"isReference": false,
"purportedCheckSum": "d07f8e21-a441-30fc-df76-138f64b7f8ee",
"dsPartType": "Body",
"dataLength": 17,
"bytes": [
"UmVhbGx5IGxvbmcgYm9keSE="
]
},
"attachments": [
{
"partType": "Attachment",
"partId": "1",
"isReference": false,
"purportedCheckSum": "d07f8e21-a441-30fc-df76-138f64b7f8ee",
"charset": "UTF-8",
"contentDescription": "VWXYZ",
"contentDisposition": "RSTU",
"contentId": "NOPQ",
"contentLocation": "KLM",
"contentSubType": "HIJ",
"contentTransEncoding": "EFG",
"contentType": "ABC",
"fileName": "file.ext",
"name": "Names",
"rtfPosition": 0,
"size": 26,
"visible": true,
"streamType": 1,
"data": {
"partType": "DataStream",
"partId": "1.1",
"isReference": false,
"dsPartType": "AttachData",
"dataLength": 26,
"bytes": [
"QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo="
]
}
}
],
"sourceProperties": {
"partType": "DataStream",
"partId": "1.3",
"isReference": false,
"purportedCheckSum": "d07f8e21-a441-30fc-df76-138f64b7f8ee",
"dsPartType": "SourceProps",
"dataLength": 58,
"bytes": [
"VGhlIHNvdXJjZSBwcm9wZXJ0aWVzIHNob3VsZCBiZSBiZXR0ZXIgYnV0IHRoZXkgYXJlIG5vdC4uLg=="
]
}
}

.../v1/folders/{folderId}/messages/count.{format}

Supported HTTP method

GET

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating