Converse agora com nosso suporte
Chat com o suporte

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

Supported HTTP method

.../v1/messages.{format}

GET | POST

GET

Retrieves a list of HTML body of messages. If no query parameters are specified, the current login ID is applied.

Parameters:

•
queryId: A Base64 encoded value in the Response Header “X-QueryId”. It can be used to re-attach to a search result table or reissue a search result. Can be null when a search ID is specified.
•
searchId: A GUID instance. Can be null when a query ID is specified.
•
query
•
sort
•
offset
•
limit
•
fields
•
forceRefresh: Force-refresh search results without cache. Default value is False.

Query parameters:

•
searchAllEmails
•
mailboxType
•
mailboxIds
•
folderId
•
includeSubFolders
•
True: Include sub folders.
•
False: Not include sub folders.
•
excludeCCAndBCC
•
ftsQuery
•
ftsScope: For example, ftsScope:Subject|Body.
•
None: Do not perform full text search.
•
Subject: Search message subjects.
•
Body: Search message bodies.
•
Attachments: Search attachment content.
•
AllMessage: Search message subjects and bodies.
•
All: Search everything.
•
to: Supports for multiple values (email address or display name), for example, to:Jen@email.com;Andy@email.com. Supports to exclude a person, for example, to:!Jen@email.com;!Andy@email.com
•
from: Supports for multiple values (email address or display name), for example, to:Jen@email.com;Andy@email.com. Supports to exclude a person, for example, to:!Jen@email.com;!Andy@email.com
•
toOrFrom: Supports for multiple values (email address or display name), for example, to:Jen@email.com;Andy@email.com. Supports to exclude a person, for example, to:!Jen@email.com;!Andy@email.com
•
dateType
•
dateMin
•
dateMax
•
dateProcessedMin
•
dateProcessedMax
•
dateModifiedMin
•
dateModifiedMax
•
hasAttachment
•
True: The message has attachment.
•
False: The message does not have attachment.
•
attachmentName
•
attachmentType: Separate multiple types by semicolon, for example, txt;pdf;docx. Use the symbol "!" to exclude a file type, for example, !txt;!pdf, this will search for messages that do not have TXT or PDF attachment(s).
•
attachmentSizeMin
•
attachmentSizeMax
•
attachmentChecksum
•
tagName: Separate multiple tags by semicolon, for example, tagName:Food;Fruit. Use the symbol "!" to exclude a tag, for example, tagName:!Food;!Fruit.
•
federated
•
True: Search all instances.
•
False: Search local instances.
•
instanceIds
•
loginId
•
impersonate
•
messageType
•
messageClass

Sortable fields:

•
messageDate
•
subject
•
toDisplay
•
fromDisplay
•
importance
•
0: IMPORTANCE_LOW
•
1: IMPORTANCE_NORMAL
•
2: IMPORTANCE_HIGH
•
sensitivity
•
messageTypeID
•
size
•
read
•
messageClass
•
dateModified
•
attachments
* 
TIP: For example, to search all emails,
.../v1/messages.json?query=searchallemails:true

to search emails by query ID,
.../v1/messages.json?queryid=S0VZOkxPQ0FMOjE7YTYwYjkzM2M1NmE0MGQ0OGIwNGQzY2Y5MmUxMzA2OTF8MjAxNTA4MTQwNjAzMzFaXzE3ZQ==

to search emails by Full Text Search,
.../v1/messages.json?query=ftsquery:Software,ftsscope:All

JSON response sample

{
"items": [
{
"id": 3,
"attachments": 1,
"toDisplay": "Administrator",
"fromDisplay": "Administrator",
"subject": "message with attachment",
"messageDate": "2015-07-30T03:47:29.417",
"importance": 1,
"sensitivity": 0,
"size": 1737,
"checkSum": "f903283e-2bd3-2a9a-281e-b2c7f782472f",
"messageClass": "IPM.Note",
"read": true,
"messageTypeId": 1
},
{
"id": 1,
"attachments": 0,
"toDisplay": "Administrator",
"fromDisplay": "Administrator",
"subject": "111",
"messageDate": "2015-07-24T03:11:35.167",
"importance": 1,
"sensitivity": 0,
"size": 1103,
"checkSum": "59939e7e-6893-6c6c-2ed1-22ac6319c96e",
"messageClass": "IPM.Note",
"read": true,
"messageTypeId": 1
},
{
"id": 2,
"attachments": 1,
"toDisplay": "Administrator",
"fromDisplay": "Administrator",
"subject": "111",
"messageDate": "2015-07-24T03:11:34.823",
"importance": 1,
"sensitivity": 0,
"size": 1687,
"checkSum": "5fa510a8-d4fa-65df-ac97-3ce9e42fdb54",
"messageClass": "IPM.Note",
"read": false,
"messageTypeId": 1
}
]
}

POST

Creates a message and associates it with the current login ID.

Documentos relacionados

The document was helpful.

Selecione a classificação

I easily found the information I needed.

Selecione a classificação