Loading...

REST API - GET Email Message Preview

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="&#xA; &#x41C;&#x43E;&#x451; &#x441;&#x443;&#x434;&#x43D;&#x43E; &#x43D;&#x430; &#x432;&#x43E;&#x437;&#x434;&#x443;&#x448;&#x43D;&#x43E;&#x439; &#x443;&#x433;&#x440;&#x435;&#x439; - 964509071 &#xA;&#xA;" id="?at=56&amp;ec=1&amp;si=Q1ZTVFVCX1YxCexampleMjA0MTQ6MDowCi1vZiAwCi1hdCAwCi1jbiAtMQotZXMgbm9uZQpDVlNUVUJfVjEK&amp;fg=Y2QyZjM2Zjc0MjQ4ZDJkMGJjNGMxODYwYThhMzU1ZGFkMmY2ZGZiM2EzOTNkNmFjZDEyNDNmZjQwODJlZTJiNw&amp;ag=MTQ1N2VhZTktZGFiMi00MGQ0LWFlMmQtY2Q1Zjg1MDk0OTdj&amp;subclientId=379&amp;appId=379&amp;pv=MTI&amp;cn=MTk5NDIwNDE0&amp;sik=-1&amp;sin=Message.msg" body="&#xA;&#xA;&#xA;&lt;html&gt;&#xA;&#xA;&#xA;&lt;head&gt;&#xA;&#xA;&#xA;&lt;meta http-equiv=&quot;content-type&quot; content=&quot;text/html; charset=UTF-8&quot; /&gt;&#xA;&#xA;&#xA;&lt;title&gt;tmp_558777725052830321&lt;/title&gt;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&lt;style type=&quot;text/css&quot;&gt;&#xA;&#xA;&#xA;&lt;!-- &#xA;&#xA;&#xA;p { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;h1 { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;h2 { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;h3 { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;h4 { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;h5 { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;h6 { margin-top: 0pt; margin-bottom: 0pt}&#xA;&#xA;&#xA;/* In certain situations, Netscape collapses vertical margins which results in unreadable tables. */&#xA;&#xA;&#xA;/* Forcing padding into the &lt;p&gt; tag prevents the collapse. */&#xA;&#xA;&#xA;td p { padding-top: 1pt; padding-bottom: 1pt}&#xA;&#xA;&#xA;th p { padding-top: 1pt; padding-bottom: 1pt}&#xA;&#xA;&#xA;.Default{&#xA;&#xA;&#xA; font-family: &apos;Arial&apos;;&#xA;&#xA;&#xA;}&#xA;&#xA;&#xA;.Default__Char{&#xA;&#xA;&#xA; font-family: &apos;Arial&apos;;&#xA;&#xA;&#xA;}&#xA;&#xA;&#xA;oody{&#xA;&#xA;&#xA; margin-top: 72pt; margin-bottom: 72pt; margin-left: 90pt; margin-right: 90pt;&#xA;&#xA;&#xA;}&#xA;&#xA;&#xA; --&gt;&#xA;&#xA;&#xA;&lt;/style&gt;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&lt;/head&gt;&#xA;&#xA;&#xA;&lt;body&gt;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Sender: VeDancey@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Subject: &#x41C;&#x43E;&#x451; &#xA;&#xA;&#xA;&#x441;&#x443;&#x434;&#x43D;&#x43E; &#x43D;&#x430; &#x432;&#x43E;&#x437;&#x434;&#x443;&#x448;&#x43D;&#x43E;&#x439; &#x43F;&#x43E;&#x434;&#x443;&#x448;&#x43A;&#x435; &#x43F;&#x43E;&#x43B;&#x43D;&#x43E; &#x443;&#x433;&#x440;&#x435;&#x439; &#xA;&#xA;&#xA;- 964509071&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Message-Id: &#xA;&#xA;&#xA;&amp;lt;9f90bf79-f143-4ffa-9d61-45d60080a2a9@EDEXCH10.Testexch.mycompany.com&amp;gt;&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: JoWade@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: MaDowall@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: QuEasterfield@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: SaNott@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: VEastwood@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: DRalles@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: BBeckith@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&lt;p class=&quot;Default&quot; style=&quot; margin-left: 0pt; margin-right: 0pt; text-indent: 0pt;&#xA;&#xA;&#xA;&quot;&gt;&lt;span class=&quot;Default__Char&quot; style=&quot; font-size: 10pt;&quot;&gt;Recipient: Recipient: CaBains@testexch.mycompany.com&lt;/span&gt;&lt;/p&gt;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;&lt;/body&gt;&#xA;&#xA;&#xA;&lt;/html&gt;&#xA;&#xA;&#xA;&#xA;&#xA;&#xA;" 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&#xA;&#xA;" smtpAddress="EDEXCH10Journal2@testexch.mycompany.com" />
  <attachments downloadLink="RestServlet/Recall?at=56&amp;ec=1&amp;si=Q1ZTVFVCX1YxCi1hZiAxOTk0MjA0MTQ6MDowCi1vZiAwCi1hdCAwCi1jbiAtMQotZXMgbm9uZQpDVlNUVUJfVjEK&amp;fg=Y2QyZjM2Zjc0MjQ4ZDJkMGJjNGMxOexamplezU1ZGFkMmY2ZGZiM2EzOTNkNmFjZDEyNDNmZjQwODJlZTJiNw&amp;ag=MTQ1N2VhZTktZGFiMi00MGQ0LWFlMmQtY2Q1Zjg1MDk0OTdj&amp;subclientId=379&amp;appId=379&amp;pv=MTI&amp;cn=MTk5NDIwNDE0&amp;sik=0&amp;sin=&#x41C;&#x43E;&#x451; &#x441;&#x443;&#x434;&#x43D;&#x43E; &#x43D;&#x430;&#x441;&#x443;&#x434;&#x43D;&#x43E; &#x43D;&#x430; &#x432;&#x43E;&#x437;&#x434;&#x443;&#x448;&#x43D;&#x43E;&#x439; &#x43F;&#x43E;&#x434;&#x443;&#x448;&#x43A;&#x435; &#x43F;&#x43E;&#x43B;&#x43D;&#x43E; &#x443;&#x433;&#x440;&#x435;&#x439; - 964509071.msg" ciPreviewLink="previewService?docId=cd2f36f74248d2d0bc4c1860a8a355dad2f6dfb3a393d6acd1243ff4082ee2b7&amp;attId=970685277&amp;parentId=&amp;cloudId=&amp;at=56&amp;ec=1&amp;si=Q1ZTVFVCX1YxCi1hZiAxOTk0MjA0MTQ6MDowCi1vZiAwCi1hdCAwCi1jbiAtMQotZXMgbm9uZQpDVlNUVUJfVjEK&amp;fg=Y2QyZjM2Zjc0MjQ4ZexampleMxODYwYThhMzU1ZGFkMmY2ZGZiM2EzOTNkNmFjZDEyNDNmZjQwODJlZTJiNw&amp;ag=MTQ1N2VhZTktZGFiMi00MGQ0LWFlMmQtY2Q1Zjg1MDk0OTdj&amp;subclientId=379&amp;appId=379&amp;pv=MTI&amp;cn=MTk5NDIwNDE0" />
  <from displayName="&#xA;Microsoft Outlook&#xA;&#xA;" 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>

Last modified: 3/1/2018 4:57:03 PM