← Back to branch summary

~ubuntu-branches/debian/sid/openchange/sid

« back to all changes in this revision

Viewing changes to apidocs/html/libmapi++/classlibmapipp_1_1message__store.html

  • Committer: Package Import Robot
  • Author(s): Jelmer Vernooij
  • Date: 2014-04-24 00:29:19 UTC
  • mfrom: (1.2.8) (4.1.6 experimental)
  • Revision ID: package-import@ubuntu.com-20140424002919-96es5uhyy3jjzgid
Tags: 1:2.1-1
* New upstream release.
 + Stop removing broken manpages, upstream on longer installs them.
* Add upstream signing key.
* Run test suite during build.
 + Add dependency on python-twisted-core for trial and python-testtools.
 + Add fix-tests patch, cherry-picked from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
apidocs/html/libmapi++/classlibmapipp_1_1message__store.html
1
 
<html>
2
 
  <head>
3
 
    <title>MAPIC++ClientLibraryBindings 2.0 API Documentation</title>
4
 
    <link href="doxygen.css" rel="stylesheet" type="text/css"/>
5
 
    <link href="apidocs.css" rel="stylesheet" type="text/css"/>
6
 
  </head>
7
 
  <body>
8
 
    <div id="website">
9
 
    <div class="header"></div>
10
 
      <div id="middle_side">
11
 
        <div id="right_side_home">
12
 
<!-- Generated by Doxygen 1.8.1.2 -->
13
 
  <div id="navrow1" class="tabs">
14
 
    <ul class="tablist">
15
 
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
16
 
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
17
 
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
18
 
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
19
 
      <li><a href="examples.html"><span>Examples</span></a></li>
20
 
    </ul>
21
 
  </div>
22
 
  <div id="navrow2" class="tabs2">
23
 
    <ul class="tablist">
24
 
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
25
 
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
26
 
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
27
 
    </ul>
28
 
  </div>
29
 
<div id="nav-path" class="navpath">
30
 
  <ul>
31
 
<li class="navelem"><a class="el" href="namespacelibmapipp.html">libmapipp</a></li><li class="navelem"><a class="el" href="classlibmapipp_1_1message__store.html">message_store</a></li>  </ul>
32
 
</div>
33
 
</div><!-- top -->
34
 
<div class="header">
35
 
  <div class="summary">
36
 
<a href="#pub-methods">Public Member Functions</a> &#124;
37
 
<a href="classlibmapipp_1_1message__store-members.html">List of all members</a>  </div>
38
 
  <div class="headertitle">
39
 
<div class="title">libmapipp::message_store Class Reference</div>  </div>
40
 
</div><!--header-->
41
 
<div class="contents">
42
 
 
43
 
<p>This class represents the Message Store in Exchange.  
44
 
 <a href="classlibmapipp_1_1message__store.html#details">More...</a></p>
45
 
 
46
 
<p><code>#include &lt;message_store.h&gt;</code></p>
47
 
<div class="dynheader">
48
 
Inheritance diagram for libmapipp::message_store:</div>
49
 
<div class="dyncontent">
50
 
 <div class="center">
51
 
  <img src="classlibmapipp_1_1message__store.png" usemap="#libmapipp::message_store_map" alt=""/>
52
 
  <map id="libmapipp::message_store_map" name="libmapipp::message_store_map">
53
 
<area href="classlibmapipp_1_1object.html" title="Base Object class." alt="libmapipp::object" shape="rect" coords="0,0,155,24"/>
54
 
</map>
55
 
 </div></div>
56
 
<table class="memberdecls">
57
 
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
58
 
Public Member Functions</h2></td></tr>
59
 
<tr class="memitem:a4c1365513e350d75cb4285a51fc9a5e5"><td class="memItemLeft" align="right" valign="top">mapi_id_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibmapipp_1_1message__store.html#a4c1365513e350d75cb4285a51fc9a5e5">get_default_folder</a> (const uint32_t id) const   throw (mapi_exception)</td></tr>
60
 
<tr class="memdesc:a4c1365513e350d75cb4285a51fc9a5e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the folder id for the specified default folder in the Message Store.  <a href="#a4c1365513e350d75cb4285a51fc9a5e5"></a><br/></td></tr>
61
 
<tr class="inherit_header pub_methods_classlibmapipp_1_1object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlibmapipp_1_1object')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classlibmapipp_1_1object.html">libmapipp::object</a></td></tr>
62
 
<tr class="memitem:ab77b8007759aca16ddbfd831a1bdf486 inherit pub_methods_classlibmapipp_1_1object"><td class="memItemLeft" align="right" valign="top">virtual mapi_object_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibmapipp_1_1object.html#ab77b8007759aca16ddbfd831a1bdf486">data</a> ()  throw ()</td></tr>
63
 
<tr class="memdesc:ab77b8007759aca16ddbfd831a1bdf486 inherit pub_methods_classlibmapipp_1_1object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtain a reference to the mapi_object_t associated with this object.  <a href="#ab77b8007759aca16ddbfd831a1bdf486"></a><br/></td></tr>
64
 
<tr class="memitem:a376d5b9ecaee41549ca74f17da161f52 inherit pub_methods_classlibmapipp_1_1object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlibmapipp_1_1property__container.html">property_container</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibmapipp_1_1object.html#a376d5b9ecaee41549ca74f17da161f52">get_property_container</a> ()</td></tr>
65
 
<tr class="memdesc:a376d5b9ecaee41549ca74f17da161f52 inherit pub_methods_classlibmapipp_1_1object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtain a <a class="el" href="classlibmapipp_1_1property__container.html" title="A container of properties to be used with classes derived from object.">property_container</a> to be used with this object.  <a href="#a376d5b9ecaee41549ca74f17da161f52"></a><br/></td></tr>
66
 
<tr class="memitem:a329ad153c797d4d9b959e01123e08d4b inherit pub_methods_classlibmapipp_1_1object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlibmapipp_1_1session.html">session</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibmapipp_1_1object.html#a329ad153c797d4d9b959e01123e08d4b">get_session</a> ()</td></tr>
67
 
<tr class="memdesc:a329ad153c797d4d9b959e01123e08d4b inherit pub_methods_classlibmapipp_1_1object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtain the session associated with this object.  <a href="#a329ad153c797d4d9b959e01123e08d4b"></a><br/></td></tr>
68
 
<tr class="memitem:a21dee02030ae56f35c0d44b7ffc3f1b7 inherit pub_methods_classlibmapipp_1_1object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibmapipp_1_1object.html#a21dee02030ae56f35c0d44b7ffc3f1b7">object</a> (<a class="el" href="classlibmapipp_1_1session.html">session</a> &amp;mapi_session, const std::string &amp;object_type=&quot;&quot;)  throw ()</td></tr>
69
 
<tr class="memdesc:a21dee02030ae56f35c0d44b7ffc3f1b7 inherit pub_methods_classlibmapipp_1_1object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object Constructor.  <a href="#a21dee02030ae56f35c0d44b7ffc3f1b7"></a><br/></td></tr>
70
 
<tr class="memitem:a4eac18fc8a3e1c0e5e9ef30c6f0aedec inherit pub_methods_classlibmapipp_1_1object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibmapipp_1_1object.html#a4eac18fc8a3e1c0e5e9ef30c6f0aedec">~object</a> ()  throw ()</td></tr>
71
 
<tr class="memdesc:a4eac18fc8a3e1c0e5e9ef30c6f0aedec inherit pub_methods_classlibmapipp_1_1object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a4eac18fc8a3e1c0e5e9ef30c6f0aedec"></a><br/></td></tr>
72
 
</table>
73
 
<a name="details" id="details"></a><h2>Detailed Description</h2>
74
 
<div class="textblock"><p>This class represents the Message Store in Exchange. </p>
75
 
<p>The <a class="el" href="classlibmapipp_1_1message__store.html" title="This class represents the Message Store in Exchange.">message_store</a> is the grouping of message folders (which could be the users private store including mail, calendar, todo list, journal, contacts and so on) or could be the public store (e.g. shared public folders).</p>
76
 
<p>It is not possible for you, the user, to create a <a class="el" href="classlibmapipp_1_1message__store.html" title="This class represents the Message Store in Exchange.">message_store</a> object. Instead, you should retrieve the <a class="el" href="classlibmapipp_1_1message__store.html" title="This class represents the Message Store in Exchange.">message_store</a> associated with a session using <a class="el" href="classlibmapipp_1_1session.html#a31b2b92339432f1b98ccd17b15073539" title="Obtain a reference to the message_store associated with this session.">session::get_message_store()</a> </p>
77
 
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="foldertree_8cpp-example.html#_a2">foldertree.cpp</a>, and <a class="el" href="messages_8cpp-example.html#_a2">messages.cpp</a>.</dd>
78
 
</dl></div><h2>Member Function Documentation</h2>
79
 
<a class="anchor" id="a4c1365513e350d75cb4285a51fc9a5e5"></a>
80
 
<div class="memitem">
81
 
<div class="memproto">
82
 
<table class="mlabels">
83
 
  <tr>
84
 
  <td class="mlabels-left">
85
 
      <table class="memname">
86
 
        <tr>
87
 
          <td class="memname">mapi_id_t libmapipp::message_store::get_default_folder </td>
88
 
          <td>(</td>
89
 
          <td class="paramtype">const uint32_t&#160;</td>
90
 
          <td class="paramname"><em>id</em></td><td>)</td>
91
 
          <td> const  throw (mapi_exception)</td>
92
 
        </tr>
93
 
      </table>
94
 
  </td>
95
 
  <td class="mlabels-right">
96
 
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
97
 
  </tr>
98
 
</table>
99
 
</div><div class="memdoc">
100
 
 
101
 
<p>Retrieves the folder id for the specified default folder in the Message Store. </p>
102
 
<dl class="params"><dt>Parameters</dt><dd>
103
 
  <table class="params">
104
 
    <tr><td class="paramname">id</td><td>The type of folder to search for.</td></tr>
105
 
  </table>
106
 
  </dd>
107
 
</dl>
108
 
<p>The following types of folders are supported:</p>
109
 
<ul>
110
 
<li>olFolderTopInformationStore</li>
111
 
<li>olFolderDeletedItems</li>
112
 
<li>olFolderOutbox</li>
113
 
<li>olFolderSentMail</li>
114
 
<li>olFolderInbox</li>
115
 
<li>olFolderCalendar</li>
116
 
<li>olFolderContacts</li>
117
 
<li>olFolderJournal</li>
118
 
<li>olFolderNotes</li>
119
 
<li>olFolderTasks</li>
120
 
<li>olFolderDrafts</li>
121
 
</ul>
122
 
<p>If you are trying to enumerate all folders, you should open the olFolderTopInformationStore, and then get the hierarchy container for that top level folder.</p>
123
 
<dl class="section return"><dt>Returns</dt><dd>The resulting folder id. </dd></dl>
124
 
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="attach_test_8cpp-example.html#a12">attach_test.cpp</a>, <a class="el" href="foldertree_8cpp-example.html#a7">foldertree.cpp</a>, <a class="el" href="messages_8cpp-example.html#a4">messages.cpp</a>, and <a class="el" href="test_8cpp-example.html#a11">test.cpp</a>.</dd>
125
 
</dl>
126
 
</div>
127
 
</div>
128
 
<hr/>The documentation for this class was generated from the following file:<ul>
129
 
<li>libmapi++/message_store.h</li>
130
 
</ul>
131
 
</div><!-- contents -->
132
 
</div>
133
 
<br/>
134
 
<table style="clear:both; margin: 0.5em auto; width:80%; text-align: center; background-color:#f8f8f8; border:2px solid #e0e0e0; padding:5px;">
135
 
<tr>
136
 
<td> 
137
 
  <img alt="Creative Commons License" src="CC_SomeRightsReserved.png" width="90" height="30" border="0" /><br />
138
 
  <img alt="Creative Commons Attribution icon" src="24px-Cc-by_white.svg.png" width="24" height="24" border="0" />
139
 
  <img alt="Creative Commons Share Alike icon" src="24px-Cc-sa_white.svg.png" width="24" height="24" border="0" />
140
 
</td>
141
 
<td> <i><strong class="selflink">This content</strong> is licensed under the Creative Commons<br />
142
 
Attribution ShareAlike License v. 3.0:<br />
143
 
<a href="http://creativecommons.org/licenses/by-sa/3.0/" class="external free" title="http://creativecommons.org/licenses/by-sa/3.0/" rel="nofollow">http://creativecommons.org/licenses/by-sa/3.0/</a></i>
144
 
</td></tr></table>
145
 
<br/>
146
 
</div>
147
 
</div>
148
 
</body>
149
 
</html>