Zm-Auth.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  12. <link rel="stylesheet" href="css/template.css">
  13. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  14. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  15. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  16. <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
  17. <script src="js/search.js"></script>
  18. <script defer src="js/searchIndex.js"></script>
  19. </head>
  20. <body id="top">
  21. <header class="phpdocumentor-header phpdocumentor-section">
  22. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  23. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  24. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  25. <i class="fas fa-bars"></i>
  26. </label>
  27. <section data-search-form class="phpdocumentor-search">
  28. <label>
  29. <span class="visually-hidden">Search for</span>
  30. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  31. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  32. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  33. </svg>
  34. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  35. </label>
  36. </section>
  37. <nav class="phpdocumentor-topnav">
  38. <ul class="phpdocumentor-topnav__menu">
  39. </ul>
  40. </nav>
  41. </header>
  42. <main class="phpdocumentor">
  43. <div class="phpdocumentor-section">
  44. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  45. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  46. Menu
  47. </label>
  48. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  49. <section class="phpdocumentor-sidebar__category">
  50. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  51. <h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
  52. </section>
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  55. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  56. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  57. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  58. </section>
  59. <section class="phpdocumentor-sidebar__category">
  60. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  61. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  62. </section>
  63. </aside>
  64. <div class="phpdocumentor-column -eight phpdocumentor-content">
  65. <ul class="phpdocumentor-breadcrumbs">
  66. <li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
  67. </ul>
  68. <article class="phpdocumentor-element -class">
  69. <h2 class="phpdocumentor-content__title">
  70. Zm_Auth
  71. </h2>
  72. <aside class="phpdocumentor-element-found-in">
  73. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  74. :
  75. <span class="phpdocumentor-element-found-in__line">49</span>
  76. </aside>
  77. <p class="phpdocumentor-summary">Zm_Auth is a class which allows to connect to the Kerio admin or user space via SOAP</p>
  78. <section class="phpdocumentor-description"><p>Use this class to connect and login to a Kerio server</p>
  79. <p>Example:</p>
  80. <pre class="prettyprint"><code class="prettyprint">// either authenticate as admin:
  81. $auth = new Zm_Auth($kerioServer, $kerioAdminEmail, $kerioAdminPassword, &quot;admin&quot;);
  82. // or authenticate as user:
  83. $auth = new Zm_Auth($kerioServer, $userEmail, $userPassword, &quot;user&quot;);
  84. // then login
  85. $l = $auth-&gt;login();
  86. if(is_a($l, &quot;Exception&quot;)) {
  87. echo &quot;Error : cannot login to $kerioServer\n&quot;;
  88. echo $l-&gt;getMessage().&quot;\n&quot;;
  89. exit();
  90. }
  91. </code></pre>
  92. </section>
  93. <h3 id="toc">
  94. Table of Contents
  95. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  96. </h3>
  97. <dl class="phpdocumentor-table-of-contents">
  98. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  99. <a href="classes/Zm-Auth.html#property_authToken">$authToken</a>
  100. <span>
  101. &nbsp;: mixed </span>
  102. </dt>
  103. <dd></dd>
  104. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  105. <a href="classes/Zm-Auth.html#property_client">$client</a>
  106. <span>
  107. &nbsp;: <a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a> </span>
  108. </dt>
  109. <dd>$auth</dd>
  110. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  111. <a href="classes/Zm-Auth.html#property_context">$context</a>
  112. <span>
  113. &nbsp;: mixed </span>
  114. </dt>
  115. <dd></dd>
  116. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  117. <a href="classes/Zm-Auth.html#property_params">$params</a>
  118. <span>
  119. &nbsp;: mixed </span>
  120. </dt>
  121. <dd></dd>
  122. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  123. <a href="classes/Zm-Auth.html#property_retryAttempts">$retryAttempts</a>
  124. <span>
  125. &nbsp;: mixed </span>
  126. </dt>
  127. <dd></dd>
  128. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  129. <a href="classes/Zm-Auth.html#property_soapHeader">$soapHeader</a>
  130. <span>
  131. &nbsp;: mixed </span>
  132. </dt>
  133. <dd></dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  135. <a href="classes/Zm-Auth.html#method___construct">__construct()</a>
  136. <span>
  137. &nbsp;: mixed </span>
  138. </dt>
  139. <dd>Constructor</dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  141. <a href="classes/Zm-Auth.html#method_getRetryAttempts">getRetryAttempts()</a>
  142. <span>
  143. &nbsp;: int </span>
  144. </dt>
  145. <dd>getRetryAttempts</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  147. <a href="classes/Zm-Auth.html#method_login">login()</a>
  148. <span>
  149. &nbsp;: mixed </span>
  150. </dt>
  151. <dd>login</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  153. <a href="classes/Zm-Auth.html#method_setRetryAttempts">setRetryAttempts()</a>
  154. <span>
  155. &nbsp;: mixed </span>
  156. </dt>
  157. <dd>setRetryAttempts</dd>
  158. </dl>
  159. <section class="phpdocumentor-properties">
  160. <h3 class="phpdocumentor-elements__header" id="properties">
  161. Properties
  162. <a href="classes/Zm-Auth.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  163. </h3>
  164. <article
  165. class="
  166. phpdocumentor-element
  167. -property
  168. -private
  169. "
  170. >
  171. <h4 class="phpdocumentor-element__name" id="property_authToken">
  172. $authToken
  173. <a href="classes/Zm-Auth.html#property_authToken" class="headerlink"><i class="fas fa-link"></i></a>
  174. <span class="phpdocumentor-element__modifiers">
  175. </span>
  176. </h4>
  177. <aside class="phpdocumentor-element-found-in">
  178. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  179. :
  180. <span class="phpdocumentor-element-found-in__line">61</span>
  181. </aside>
  182. <code class="phpdocumentor-code phpdocumentor-signature ">
  183. <span class="phpdocumentor-signature__visibility">private</span>
  184. <span class="phpdocumentor-signature__type">mixed</span>
  185. <span class="phpdocumentor-signature__name">$authToken</span>
  186. </code>
  187. </article>
  188. <article
  189. class="
  190. phpdocumentor-element
  191. -property
  192. -private
  193. "
  194. >
  195. <h4 class="phpdocumentor-element__name" id="property_client">
  196. $client
  197. <a href="classes/Zm-Auth.html#property_client" class="headerlink"><i class="fas fa-link"></i></a>
  198. <span class="phpdocumentor-element__modifiers">
  199. </span>
  200. </h4>
  201. <aside class="phpdocumentor-element-found-in">
  202. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  203. :
  204. <span class="phpdocumentor-element-found-in__line">58</span>
  205. </aside>
  206. <p class="phpdocumentor-summary">$auth</p>
  207. <code class="phpdocumentor-code phpdocumentor-signature ">
  208. <span class="phpdocumentor-signature__visibility">private</span>
  209. <span class="phpdocumentor-signature__type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  210. <span class="phpdocumentor-signature__name">$client</span>
  211. </code>
  212. <section class="phpdocumentor-description"></section>
  213. </article>
  214. <article
  215. class="
  216. phpdocumentor-element
  217. -property
  218. -private
  219. "
  220. >
  221. <h4 class="phpdocumentor-element__name" id="property_context">
  222. $context
  223. <a href="classes/Zm-Auth.html#property_context" class="headerlink"><i class="fas fa-link"></i></a>
  224. <span class="phpdocumentor-element__modifiers">
  225. </span>
  226. </h4>
  227. <aside class="phpdocumentor-element-found-in">
  228. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  229. :
  230. <span class="phpdocumentor-element-found-in__line">62</span>
  231. </aside>
  232. <code class="phpdocumentor-code phpdocumentor-signature ">
  233. <span class="phpdocumentor-signature__visibility">private</span>
  234. <span class="phpdocumentor-signature__type">mixed</span>
  235. <span class="phpdocumentor-signature__name">$context</span>
  236. </code>
  237. </article>
  238. <article
  239. class="
  240. phpdocumentor-element
  241. -property
  242. -private
  243. "
  244. >
  245. <h4 class="phpdocumentor-element__name" id="property_params">
  246. $params
  247. <a href="classes/Zm-Auth.html#property_params" class="headerlink"><i class="fas fa-link"></i></a>
  248. <span class="phpdocumentor-element__modifiers">
  249. </span>
  250. </h4>
  251. <aside class="phpdocumentor-element-found-in">
  252. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  253. :
  254. <span class="phpdocumentor-element-found-in__line">60</span>
  255. </aside>
  256. <code class="phpdocumentor-code phpdocumentor-signature ">
  257. <span class="phpdocumentor-signature__visibility">private</span>
  258. <span class="phpdocumentor-signature__type">mixed</span>
  259. <span class="phpdocumentor-signature__name">$params</span>
  260. </code>
  261. </article>
  262. <article
  263. class="
  264. phpdocumentor-element
  265. -property
  266. -private
  267. "
  268. >
  269. <h4 class="phpdocumentor-element__name" id="property_retryAttempts">
  270. $retryAttempts
  271. <a href="classes/Zm-Auth.html#property_retryAttempts" class="headerlink"><i class="fas fa-link"></i></a>
  272. <span class="phpdocumentor-element__modifiers">
  273. </span>
  274. </h4>
  275. <aside class="phpdocumentor-element-found-in">
  276. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  277. :
  278. <span class="phpdocumentor-element-found-in__line">63</span>
  279. </aside>
  280. <code class="phpdocumentor-code phpdocumentor-signature ">
  281. <span class="phpdocumentor-signature__visibility">private</span>
  282. <span class="phpdocumentor-signature__type">mixed</span>
  283. <span class="phpdocumentor-signature__name">$retryAttempts</span>
  284. </code>
  285. </article>
  286. <article
  287. class="
  288. phpdocumentor-element
  289. -property
  290. -private
  291. "
  292. >
  293. <h4 class="phpdocumentor-element__name" id="property_soapHeader">
  294. $soapHeader
  295. <a href="classes/Zm-Auth.html#property_soapHeader" class="headerlink"><i class="fas fa-link"></i></a>
  296. <span class="phpdocumentor-element__modifiers">
  297. </span>
  298. </h4>
  299. <aside class="phpdocumentor-element-found-in">
  300. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  301. :
  302. <span class="phpdocumentor-element-found-in__line">59</span>
  303. </aside>
  304. <code class="phpdocumentor-code phpdocumentor-signature ">
  305. <span class="phpdocumentor-signature__visibility">private</span>
  306. <span class="phpdocumentor-signature__type">mixed</span>
  307. <span class="phpdocumentor-signature__name">$soapHeader</span>
  308. </code>
  309. </article>
  310. </section>
  311. <section class="phpdocumentor-methods">
  312. <h3 class="phpdocumentor-elements__header" id="methods">
  313. Methods
  314. <a href="classes/Zm-Auth.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  315. </h3>
  316. <article
  317. class="phpdocumentor-element
  318. -method
  319. -public
  320. "
  321. >
  322. <h4 class="phpdocumentor-element__name" id="method___construct">
  323. __construct()
  324. <a href="classes/Zm-Auth.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  325. </h4>
  326. <aside class="phpdocumentor-element-found-in">
  327. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  328. :
  329. <span class="phpdocumentor-element-found-in__line">73</span>
  330. </aside>
  331. <p class="phpdocumentor-summary">Constructor</p>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">public</span>
  334. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$server</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$username</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$authas</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;admin&quot;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attempts</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">3</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  335. <section class="phpdocumentor-description"></section>
  336. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  337. <dl class="phpdocumentor-argument-list">
  338. <dt class="phpdocumentor-argument-list__entry">
  339. <span class="phpdocumentor-signature__argument__name">$server</span>
  340. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  341. </dt>
  342. <dd class="phpdocumentor-argument-list__definition">
  343. <section class="phpdocumentor-description"><p>server name (example: kerio.yourdomain.com)</p>
  344. </section>
  345. </dd>
  346. <dt class="phpdocumentor-argument-list__entry">
  347. <span class="phpdocumentor-signature__argument__name">$username</span>
  348. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  349. </dt>
  350. <dd class="phpdocumentor-argument-list__definition">
  351. <section class="phpdocumentor-description"><p>admin/user account's username</p>
  352. </section>
  353. </dd>
  354. <dt class="phpdocumentor-argument-list__entry">
  355. <span class="phpdocumentor-signature__argument__name">$password</span>
  356. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  357. </dt>
  358. <dd class="phpdocumentor-argument-list__definition">
  359. <section class="phpdocumentor-description"><p>admin/user account's password</p>
  360. </section>
  361. </dd>
  362. <dt class="phpdocumentor-argument-list__entry">
  363. <span class="phpdocumentor-signature__argument__name">$authas</span>
  364. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  365. = <span class="phpdocumentor-signature__argument__default-value">&quot;admin&quot;</span> </dt>
  366. <dd class="phpdocumentor-argument-list__definition">
  367. <section class="phpdocumentor-description"><p>authenticate as admin or user (default admin)</p>
  368. </section>
  369. </dd>
  370. <dt class="phpdocumentor-argument-list__entry">
  371. <span class="phpdocumentor-signature__argument__name">$attempts</span>
  372. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  373. = <span class="phpdocumentor-signature__argument__default-value">3</span> </dt>
  374. <dd class="phpdocumentor-argument-list__definition">
  375. <section class="phpdocumentor-description"><p>how many times we retry to invoke a soapCall (default 3)</p>
  376. </section>
  377. </dd>
  378. </dl>
  379. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  380. <span class="phpdocumentor-signature__response_type">mixed</span>
  381. &mdash;
  382. <section class="phpdocumentor-description"></section>
  383. </article>
  384. <article
  385. class="phpdocumentor-element
  386. -method
  387. -public
  388. "
  389. >
  390. <h4 class="phpdocumentor-element__name" id="method_getRetryAttempts">
  391. getRetryAttempts()
  392. <a href="classes/Zm-Auth.html#method_getRetryAttempts" class="headerlink"><i class="fas fa-link"></i></a>
  393. </h4>
  394. <aside class="phpdocumentor-element-found-in">
  395. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  396. :
  397. <span class="phpdocumentor-element-found-in__line">218</span>
  398. </aside>
  399. <p class="phpdocumentor-summary">getRetryAttempts</p>
  400. <code class="phpdocumentor-code phpdocumentor-signature ">
  401. <span class="phpdocumentor-signature__visibility">public</span>
  402. <span class="phpdocumentor-signature__name">getRetryAttempts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  403. <section class="phpdocumentor-description"></section>
  404. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  405. <span class="phpdocumentor-signature__response_type">int</span>
  406. &mdash;
  407. <section class="phpdocumentor-description"><p>attempts how many times we retry to invoke a soapCall</p>
  408. </section>
  409. </article>
  410. <article
  411. class="phpdocumentor-element
  412. -method
  413. -public
  414. "
  415. >
  416. <h4 class="phpdocumentor-element__name" id="method_login">
  417. login()
  418. <a href="classes/Zm-Auth.html#method_login" class="headerlink"><i class="fas fa-link"></i></a>
  419. </h4>
  420. <aside class="phpdocumentor-element-found-in">
  421. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  422. :
  423. <span class="phpdocumentor-element-found-in__line">242</span>
  424. </aside>
  425. <p class="phpdocumentor-summary">login</p>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility">public</span>
  428. <span class="phpdocumentor-signature__name">login</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  429. <section class="phpdocumentor-description"><p>Use this method to login to a Kerio server after you create an instance of this class</p>
  430. <p>Login parameters must be specified when calling the constructor</p>
  431. </section>
  432. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  433. <span class="phpdocumentor-signature__response_type">mixed</span>
  434. &mdash;
  435. <section class="phpdocumentor-description"></section>
  436. </article>
  437. <article
  438. class="phpdocumentor-element
  439. -method
  440. -public
  441. "
  442. >
  443. <h4 class="phpdocumentor-element__name" id="method_setRetryAttempts">
  444. setRetryAttempts()
  445. <a href="classes/Zm-Auth.html#method_setRetryAttempts" class="headerlink"><i class="fas fa-link"></i></a>
  446. </h4>
  447. <aside class="phpdocumentor-element-found-in">
  448. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Auth.php"><a href="files/zm-auth.html"><abbr title="Zm/Auth.php">Auth.php</abbr></a></abbr>
  449. :
  450. <span class="phpdocumentor-element-found-in__line">228</span>
  451. </aside>
  452. <p class="phpdocumentor-summary">setRetryAttempts</p>
  453. <code class="phpdocumentor-code phpdocumentor-signature ">
  454. <span class="phpdocumentor-signature__visibility">public</span>
  455. <span class="phpdocumentor-signature__name">setRetryAttempts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attempts</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  456. <section class="phpdocumentor-description"></section>
  457. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  458. <dl class="phpdocumentor-argument-list">
  459. <dt class="phpdocumentor-argument-list__entry">
  460. <span class="phpdocumentor-signature__argument__name">$attempts</span>
  461. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  462. </dt>
  463. <dd class="phpdocumentor-argument-list__definition">
  464. <section class="phpdocumentor-description"><p>how many times we retry to invoke a soapCall
  465. the wait time between attempts is progressively increased using an exponential backoff algorithm</p>
  466. </section>
  467. </dd>
  468. </dl>
  469. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  470. <span class="phpdocumentor-signature__response_type">mixed</span>
  471. &mdash;
  472. <section class="phpdocumentor-description"></section>
  473. </article>
  474. </section>
  475. </article>
  476. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  477. <section class="phpdocumentor-search-results__dialog">
  478. <header class="phpdocumentor-search-results__header">
  479. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  480. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  481. </header>
  482. <section class="phpdocumentor-search-results__body">
  483. <ul class="phpdocumentor-search-results__entries"></ul>
  484. </section>
  485. </section>
  486. </section>
  487. </div>
  488. </div>
  489. <a href="classes/Zm-Auth.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  490. </main>
  491. <script>
  492. cssVars({});
  493. </script>
  494. </body>
  495. </html>