This operation returns the metadata for an email message.
Request
Syntax
GET <webservice>/Email/message?docId={docId}&appId={appId}&clId={clientId} HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
docId |
The document ID for the email message. If the document is not known, use the POST Email Message API to retrieve it from the id parameter. |
Yes |
|
appId |
The subclient ID for the email message. If the subclient is not known, use the POST Email Message API to retrieve it from the subclientID parameter. |
Yes |
|
clId |
The client ID for the email message. If the client is not known, use the POST Email Message API to retrieve it from the clientID parameter. |
Yes |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Name |
Description |
Elements |
|---|---|---|
|
subclientId |
The system-generated ID assigned to the subclient. |
emails |
|
clientId |
The system-generated ID assigned to the client. |
emails |
|
sizeKb |
The size of the email message in kilobytes. |
emails |
|
importance |
The importance assigned to the email. Valid values are:
|
emails |
|
subject |
The subject line of the email message. |
emails |
|
commcellNum |
emails |
|
|
sentReceivedTime |
emails |
|
|
archFileOffset |
emails |
|
|
itemPathBase64encoded |
emails |
|
|
appType |
Valid value is 137. |
emails |
|
archFileId |
emails |
|
|
id |
The system-generated ID assigned to the email message. |
emails |
|
name |
The name of any files attached to the email message. |
attachments |
|
displayName |
The name of the person who sent the email. |
from |
|
smtpAddress |
The SMTP address of the person who sent the email. |
from |
|
displayName |
The name of the person who received the email. |
to |
|
smtpAddress |
The SMTP address of the person who received the email. |
to |
Examples
Sample Request
GET <webservice>/Email/message?docId=52ddbca8da18668e80fexample3cd5a60cc778730ea7ad9e5b2a20f3eb602c0d4&appId=291 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
XML
<DM2ContentIndexing_EmailSearchResp total_records="1"> <emails subclientId="291" clientId="71" sizeKb="95188" importance="1" subject="Rich Text with message type as attachment" commcellNum="219838458" sentReceivedTime="1484040624" archFileOffset="44879" itemPathBase64encoded="XE1CXHs2Nzc3MUYwNFg0NUY4WDQyQUVYODVGRVgyMzhFNUI5QThFRkF9XEluYm94VGVzdFw1MmRkYmNhOGRhMTg2NjhlODBmOWJiYTgxM2NkNWE2MGNjNzc4NzMwZWE3YWQ5ZTViMmEyMGYzZWI2MDJjMGQ0" appType="137" archFileId="9402" id="52ddbca8da18668e80fexample3cd5a60cc778730ea7ad9e5b2a20f3eb602c0d4"> <attachments name="Ohayou gozaimasu. おはようございます。 - 440737099 _ sample sentence. 日本は素晴らしい国です。 - 874193295" /> <from displayName="admin" smtpAddress="TEST2010ADMINBB6" /> <to displayName="jsmith" smtpAddress="jsmith@testexch.mycompany.com" /> </emails>
</DM2ContentIndexing_EmailSearchResp>
JSON
{ "total_records": 1, "emails": [{ "subclientId": 291, "clientId": 71, "sizeKb": 95188, "importance": 1, "subject": "Rich Text with message type as attachment", "commcellNum": 219838458, "sentReceivedTime": "1484040624", "archFileOffset": 44879, "appType": 137, "archFileId": 9402, "id": "52ddbca8da18668e80fexample3cd5a60cc778730ea7ad9e5b2a20f3eb602c0d4", "attachments": [{ "name": "Ohayou gozaimasu. \u304a\u306f\u3088\u3046\u3054\u3056\u3044\u307e\u3059\u3002 - 440737099 _ sample sentence. \u65e5\u672c\u306f\u7d20\u6674\u3089\u3057\u3044\u56fd\u3067\u3059\u3002 - 874193295" }], "from": [{ "displayName": "admin", "smtpAddress": "TEST2010ADMINBB6" }], "to": [{ "displayName": "jsmith", "smtpAddress": "jsmith@testexch.mycompany.com" }] }]
}