This operation returns the metadata and message body for an email message.
Request
Syntax
GET <webservice>/Email/message/Preview?docId={docId}&appId={appId}&guid={guid} 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 |
guid |
The globally unique identifier for the email mailbox. If the guid is not known, use the POST Email Message API to retrieve it from the mbguid 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. |
DM2ContentIndexing_EmailAppPreview |
subject |
The subject line of the email message. |
DM2ContentIndexing_EmailAppPreview |
id |
DM2ContentIndexing_EmailAppPreview |
|
content |
The content of the email message. |
DM2ContentIndexing_EmailAppPreview |
sentReceivedTime |
DM2ContentIndexing_EmailAppPreview |
|
displayName |
The name of the person carbon copied on the email. |
cc |
smtpAddress |
The SMTP address of the person carbon copied on the email. |
cc |
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/Preview?docId=52ddbca8da18668e80fexample3cd5a60cc778730ea7ad9e5b2a20f3eb602c0d4&appId=379 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<DM2ContentIndexing_EmailAppPreview subject="
 Моё судно на воздушной угрей - 964509071 

" id="?at=56&ec=1&si=Q1ZTVFVCX1YxCexampleMjA0MTQ6MDowCi1vZiAwCi1hdCAwCi1jbiAtMQotZXMgbm9uZQpDVlNUVUJfVjEK&fg=Y2QyZjM2Zjc0MjQ4ZDJkMGJjNGMxODYwYThhMzU1ZGFkMmY2ZGZiM2EzOTNkNmFjZDEyNDNmZjQwODJlZTJiNw&ag=MTQ1N2VhZTktZGFiMi00MGQ0LWFlMmQtY2Q1Zjg1MDk0OTdj&subclientId=379&appId=379&pv=MTI&cn=MTk5NDIwNDE0&sik=-1&sin=Message.msg" body="


<html>


<head>


<meta http-equiv="content-type" content="text/html; charset=UTF-8" />


<title>tmp_558777725052830321</title>





<style type="text/css">


<!-- 


p { margin-top: 0pt; margin-bottom: 0pt}


h1 { margin-top: 0pt; margin-bottom: 0pt}


h2 { margin-top: 0pt; margin-bottom: 0pt}


h3 { margin-top: 0pt; margin-bottom: 0pt}


h4 { margin-top: 0pt; margin-bottom: 0pt}


h5 { margin-top: 0pt; margin-bottom: 0pt}


h6 { margin-top: 0pt; margin-bottom: 0pt}


/* In certain situations, Netscape collapses vertical margins which results in unreadable tables. */


/* Forcing padding into the <p> tag prevents the collapse. */


td p { padding-top: 1pt; padding-bottom: 1pt}


th p { padding-top: 1pt; padding-bottom: 1pt}


.Default{


 font-family: 'Arial';


}


.Default__Char{


 font-family: 'Arial';


}


oody{


 margin-top: 72pt; margin-bottom: 72pt; margin-left: 90pt; margin-right: 90pt;


}


 -->


</style>





</head>


<body>





<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Sender: VeDancey@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Subject: Моё 


судно на воздушной подушке полно угрей 


- 964509071</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Message-Id: 


&lt;9f90bf79-f143-4ffa-9d61-45d60080a2a9@EDEXCH10.Testexch.mycompany.com&gt;</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: JoWade@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: MaDowall@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: QuEasterfield@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: SaNott@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: VEastwood@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: DRalles@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: BBeckith@testexch.mycompany.com</span></p>


<p class="Default" style=" margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;


"><span class="Default__Char" style=" font-size: 10pt;">Recipient: Recipient: CaBains@testexch.mycompany.com</span></p>
































</body>


</html>





" sentReceivedTime="">
<cc displayName="Van Eastwood" smtpAddress="MaDearne@testexch.mycompany.com" /> <cc displayName="Daniela Ralles" smtpAddress="RaVanNess@testexch.mycompany.com" /> <cc displayName="Becky Beckith" smtpAddress="ViBickersteth@testexch.mycompany.com" /> <cc displayName="CandaCe Bains

" smtpAddress="EDEXCH10Journal2@testexch.mycompany.com" /> <attachments downloadLink="RestServlet/Recall?at=56&ec=1&si=Q1ZTVFVCX1YxCi1hZiAxOTk0MjA0MTQ6MDowCi1vZiAwCi1hdCAwCi1jbiAtMQotZXMgbm9uZQpDVlNUVUJfVjEK&fg=Y2QyZjM2Zjc0MjQ4ZDJkMGJjNGMxOexamplezU1ZGFkMmY2ZGZiM2EzOTNkNmFjZDEyNDNmZjQwODJlZTJiNw&ag=MTQ1N2VhZTktZGFiMi00MGQ0LWFlMmQtY2Q1Zjg1MDk0OTdj&subclientId=379&appId=379&pv=MTI&cn=MTk5NDIwNDE0&sik=0&sin=Моё судно насудно на воздушной подушке полно угрей - 964509071.msg" ciPreviewLink="previewService?docId=cd2f36f74248d2d0bc4c1860a8a355dad2f6dfb3a393d6acd1243ff4082ee2b7&attId=970685277&parentId=&cloudId=&at=56&ec=1&si=Q1ZTVFVCX1YxCi1hZiAxOTk0MjA0MTQ6MDowCi1vZiAwCi1hdCAwCi1jbiAtMQotZXMgbm9uZQpDVlNUVUJfVjEK&fg=Y2QyZjM2Zjc0MjQ4ZexampleMxODYwYThhMzU1ZGFkMmY2ZGZiM2EzOTNkNmFjZDEyNDNmZjQwODJlZTJiNw&ag=MTQ1N2VhZTktZGFiMi00MGQ0LWFlMmQtY2Q1Zjg1MDk0OTdj&subclientId=379&appId=379&pv=MTI&cn=MTk5NDIwNDE0" /> <from displayName="
Microsoft Outlook

" smtpAddress="/O=FIRSTORGINAZATION/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=MICROSOFTEXCHANGE3exampleAE4615BBC36AB6CE41109E" /> <to displayName="Joane Wade" smtpAddress="ViLhuyd@testexch.mycompany.com" /> <to displayName="Marva Dowall" smtpAddress="MaDeare@testexch.mycompany.com" /> <to displayName="Quiana Easterfield" smtpAddress="RuDarville@testexch.mycompany.com" /> <to displayName="Sammie Nott" smtpAddress="VEastwood@testexch.mycompany.com" />
</DM2ContentIndexing_EmailAppPreview>