ZimbraSoapPhp.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
  5. <meta charset="utf-8"/>
  6. <title> &raquo; \ZimbraSoapPhp
  7. </title>
  8. <meta name="author" content=""/>
  9. <meta name="description" content=""/>
  10. <link href="../css/template.css" rel="stylesheet" media="all"/>
  11. <!--[if lt IE 9]>
  12. <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
  13. <![endif]-->
  14. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
  15. <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
  16. <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
  17. <script src="../js/bootstrap.js" type="text/javascript"></script>
  18. <script src="../js/template.js" type="text/javascript"></script>
  19. <script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
  20. <link rel="shortcut icon" href="../img/favicon.ico"/>
  21. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
  22. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
  23. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
  24. </head>
  25. <body>
  26. <div class="navbar navbar-fixed-top">
  27. <div class="navbar-inner">
  28. <div class="container">
  29. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
  30. <span class="icon-bar"></span> <span class="icon-bar"></span>
  31. <span class="icon-bar"></span> </a>
  32. <a class="brand" href="../index.html">ZimbraSoapPhp</a>
  33. <div class="nav-collapse">
  34. <ul class="nav">
  35. <li class="dropdown">
  36. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  37. API Documentation <b class="caret"></b>
  38. </a>
  39. <ul class="dropdown-menu">
  40. </ul>
  41. </li>
  42. <li class="dropdown" id="charts-menu">
  43. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  44. Charts <b class="caret"></b>
  45. </a>
  46. <ul class="dropdown-menu">
  47. <li>
  48. <a href="../graph_class.html">
  49. <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
  50. </a>
  51. </li>
  52. </ul>
  53. </li>
  54. <li class="dropdown" id="reports-menu">
  55. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  56. Reports <b class="caret"></b>
  57. </a>
  58. <ul class="dropdown-menu">
  59. <li>
  60. <a href="../errors.html">
  61. <i class="icon-list-alt"></i>&#160;Errors
  62. </a>
  63. </li>
  64. <li>
  65. <a href="../markers.html">
  66. <i class="icon-list-alt"></i>&#160;Markers
  67. </a>
  68. </li>
  69. <li>
  70. <a href="../deprecated.html">
  71. <i class="icon-list-alt"></i>&#160;Deprecated
  72. </a>
  73. </li>
  74. </ul>
  75. </li>
  76. </ul>
  77. </div>
  78. </div>
  79. </div>
  80. <div class="go_to_top">
  81. <a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
  82. </div>
  83. </div>
  84. <div id="___" class="container">
  85. <noscript>
  86. <div class="alert alert-warning">
  87. Javascript is disabled; several features are only available if Javascript is enabled.
  88. </div>
  89. </noscript>
  90. <div class="row">
  91. <div class="span4">
  92. <div class="btn-group view pull-right" data-toggle="buttons-radio">
  93. <button class="btn details" title="Show descriptions and method names">
  94. <i class="icon-list"></i></button><button class="btn simple" title="Show only method names">
  95. <i class="icon-align-justify"></i>
  96. </button>
  97. </div>
  98. <ul class="side-nav nav nav-list">
  99. <li class="nav-header">
  100. <i class="icon-map-marker"></i> Packages
  101. </li>
  102. <a href="../packages/ZimbraSoapPhp.html" title="ZimbraSoapPhp">
  103. <i class="icon-th"></i> ZimbraSoapPhp
  104. </a>
  105. <ul class="nav nav-list nav-packages">
  106. </ul>
  107. </ul>
  108. </div>
  109. <div class="span8 package-contents">
  110. <ul class="breadcrumb">
  111. <li><a href="../index.html"><i class="icon-th"></i></a></li>
  112. <li>
  113. <span class="divider">\</span><a href="../packages/ZimbraSoapPhp.html">ZimbraSoapPhp</a>
  114. </li>
  115. </ul>
  116. <div class="package-indent">
  117. <h3><i class="icon-custom icon-class"></i> Classes, interfaces and traits</h3>
  118. <div id="Zm_Account" class="element ajax clickable class">
  119. <h1>Zm_Account<a href="../classes/Zm_Account.html">¶</a></h1>
  120. <p class="short_description">Zm_Account is a class which allows to manage Zimbra accounts via SOAP</p>
  121. <div class="details collapse">You may create, modify, rename, delete and get the attributes of a Zimbra account using this class
  122. For the usage examples of all class methods check the source code of test.php</div>
  123. <a href="../classes/Zm_Account.html" class="more">« More »</a>
  124. </div>
  125. <div id="Zm_Auth" class="element ajax clickable class">
  126. <h1>Zm_Auth<a href="../classes/Zm_Auth.html">¶</a></h1>
  127. <p class="short_description">Zm_Auth is a class which allows to connect to the Zimbra admin or user space via SOAP</p>
  128. <div class="details collapse">Use this class to connect and login to a Zimbra server
  129. Example:
  130. // either authenticate as admin:
  131. $auth = new Zm_Auth($zimbraServer, $zimbraAdminEmail, $zimbraAdminPassword, &quot;admin&quot;);
  132. // or authenticate as user:
  133. $auth = new Zm_Auth($zimbraServer, $userEmail, $userPassword, &quot;user&quot;);
  134. // then login
  135. $l = $auth-&gt;login();
  136. if(is_a($l, &quot;Exception&quot;)) {
  137. echo &quot;Error : cannot login to $zimbraServer\n&quot;;
  138. echo $l-&gt;getMessage().&quot;\n&quot;;
  139. exit();
  140. }</div>
  141. <a href="../classes/Zm_Auth.html" class="more">« More »</a>
  142. </div>
  143. <div id="Zm_Domain" class="element ajax clickable class">
  144. <h1>Zm_Domain<a href="../classes/Zm_Domain.html">¶</a></h1>
  145. <p class="short_description">Zm_Domain is a class which allows to manage Zimbra domains via SOAP</p>
  146. <div class="details collapse">You may create, modify, rename, delete and get the attributes of a Zimbra domain using this class
  147. For the usage examples of all class methods check the source code of test.php</div>
  148. <a href="../classes/Zm_Domain.html" class="more">« More »</a>
  149. </div>
  150. <div id="Zm_Server" class="element ajax clickable class">
  151. <h1>Zm_Server<a href="../classes/Zm_Server.html">¶</a></h1>
  152. <p class="short_description">Zm_Server is a class which allows to manage Zimbra servers via SOAP</p>
  153. <div class="details collapse">You may create, modify, rename, delete and get the attributes of a Zimbra server using this class
  154. For the usage examples of all class methods check the source code of test.php</div>
  155. <a href="../classes/Zm_Server.html" class="more">« More »</a>
  156. </div>
  157. <div id="Zm_User" class="element ajax clickable class">
  158. <h1>Zm_User<a href="../classes/Zm_User.html">¶</a></h1>
  159. <p class="short_description">Zm_User is a class which allows a Zimbra user to manage its own account via SOAP</p>
  160. <div class="details collapse">You may change password, modify and get the attributes of a Zimbra user using this class
  161. For the usage examples of all class methods check the source code of test.php</div>
  162. <a href="../classes/Zm_User.html" class="more">« More »</a>
  163. </div>
  164. </div>
  165. </div>
  166. </div>
  167. </div>
  168. <footer class="span12">
  169. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
  170. <a href="http://glyphicons.com/">Glyphicons</a>.<br/>
  171. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
  172. generated on Tue, 26 Sep 2017 11:01:05 +0200.<br/>
  173. </footer>
  174. </body>
  175. </html>