zimbrasingle.html 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007
  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 -file">
  69. <h2 class="phpdocumentor-content__title">kerioSingle.php</h2>
  70. <h3 id="toc">
  71. Table of Contents
  72. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  73. </h3>
  74. <dl class="phpdocumentor-table-of-contents">
  75. <dt class="phpdocumentor-table-of-contents__entry -function -">
  76. <a href="namespaces/default.html#function_kerioSingleFindAll">kerioSingleFindAll()</a>
  77. <span>
  78. &nbsp;: array&lt;string|int, mixed&gt; </span>
  79. </dt>
  80. <dd>Helper function to find values of a named key in a multidimensional arrays or objects</dd>
  81. <dt class="phpdocumentor-table-of-contents__entry -function -">
  82. <a href="namespaces/default.html#function_kerioSingleCheckPassword">kerioSingleCheckPassword()</a>
  83. <span>
  84. &nbsp;: string </span>
  85. </dt>
  86. <dd>server side password check</dd>
  87. <dt class="phpdocumentor-table-of-contents__entry -function -">
  88. <a href="namespaces/default.html#function_kerioSingle_MetaData">kerioSingle_MetaData()</a>
  89. <span>
  90. &nbsp;: array&lt;string|int, mixed&gt; </span>
  91. </dt>
  92. <dd>Define module related meta data.</dd>
  93. <dt class="phpdocumentor-table-of-contents__entry -function -">
  94. <a href="namespaces/default.html#function_kerioSingle_TestConnection">kerioSingle_TestConnection()</a>
  95. <span>
  96. &nbsp;: array&lt;string|int, mixed&gt; </span>
  97. </dt>
  98. <dd>Test connection to a Kerio server with the given server parameters.</dd>
  99. <dt class="phpdocumentor-table-of-contents__entry -function -">
  100. <a href="namespaces/default.html#function_kerioSingle_ClientArea">kerioSingle_ClientArea()</a>
  101. <span>
  102. &nbsp;: array&lt;string|int, mixed&gt; </span>
  103. </dt>
  104. <dd>Client area output logic handling.</dd>
  105. <dt class="phpdocumentor-table-of-contents__entry -function -">
  106. <a href="namespaces/default.html#function_kerioSingle_UsageUpdate">kerioSingle_UsageUpdate()</a>
  107. <span>
  108. &nbsp;: mixed </span>
  109. </dt>
  110. <dd>Usage Update</dd>
  111. <dt class="phpdocumentor-table-of-contents__entry -function -">
  112. <a href="namespaces/default.html#function_kerioSingle_ChangePassword">kerioSingle_ChangePassword()</a>
  113. <span>
  114. &nbsp;: string </span>
  115. </dt>
  116. <dd>Change the password for a Kerio account.</dd>
  117. <dt class="phpdocumentor-table-of-contents__entry -function -">
  118. <a href="namespaces/default.html#function_kerioSingle_CreateAccount">kerioSingle_CreateAccount()</a>
  119. <span>
  120. &nbsp;: string </span>
  121. </dt>
  122. <dd>Provision a new instance of a Kerio account.</dd>
  123. <dt class="phpdocumentor-table-of-contents__entry -function -">
  124. <a href="namespaces/default.html#function_kerioSingle_SuspendAccount">kerioSingle_SuspendAccount()</a>
  125. <span>
  126. &nbsp;: string </span>
  127. </dt>
  128. <dd>Set a Kerio account to status locked.</dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -function -">
  130. <a href="namespaces/default.html#function_kerioSingle_UnsuspendAccount">kerioSingle_UnsuspendAccount()</a>
  131. <span>
  132. &nbsp;: string </span>
  133. </dt>
  134. <dd>Set a Kerio account to status active.</dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -function -">
  136. <a href="namespaces/default.html#function_kerioSingle_TerminateAccount">kerioSingle_TerminateAccount()</a>
  137. <span>
  138. &nbsp;: string </span>
  139. </dt>
  140. <dd>Removes a Kerio account.</dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -function -">
  142. <a href="namespaces/default.html#function_kerioSingle_ChangePackage">kerioSingle_ChangePackage()</a>
  143. <span>
  144. &nbsp;: string </span>
  145. </dt>
  146. <dd>Set a new class of service for a Kerio account.</dd>
  147. <dt class="phpdocumentor-table-of-contents__entry -function -">
  148. <a href="namespaces/default.html#function_kerioSingle_ConfigOptions">kerioSingle_ConfigOptions()</a>
  149. <span>
  150. &nbsp;: array&lt;string|int, mixed&gt; </span>
  151. </dt>
  152. <dd>Define Kerio product configuration options.</dd>
  153. <dt class="phpdocumentor-table-of-contents__entry -function -">
  154. <a href="namespaces/default.html#function_kerioSingle_ServiceSingleSignOn">kerioSingle_ServiceSingleSignOn()</a>
  155. <span>
  156. &nbsp;: array&lt;string|int, mixed&gt; </span>
  157. </dt>
  158. <dd>Perform single sign-on for a given instance of a product/service.</dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -function -">
  160. <a href="namespaces/default.html#function_kerioSingleUpdateQuota">kerioSingleUpdateQuota()</a>
  161. <span>
  162. &nbsp;: mixed </span>
  163. </dt>
  164. <dd>Perform an update of customfields to prevent downgrades.</dd>
  165. </dl>
  166. <section class="phpdocumentor-functions">
  167. <h3 class="phpdocumentor-elements__header" id="functions">
  168. Functions
  169. <a href="files/keriosingle.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
  170. </h3>
  171. <article class="phpdocumentor-element -function - ">
  172. <h4 class="phpdocumentor-element__name" id="function_kerioSingleFindAll">
  173. kerioSingleFindAll()
  174. <a href="namespaces/default.html#function_kerioSingleFindAll" class="headerlink"><i class="fas fa-link"></i></a>
  175. </h4>
  176. <aside class="phpdocumentor-element-found-in">
  177. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  178. :
  179. <span class="phpdocumentor-element-found-in__line">35</span>
  180. </aside>
  181. <p class="phpdocumentor-summary">Helper function to find values of a named key in a multidimensional arrays or objects</p>
  182. <code class="phpdocumentor-code phpdocumentor-signature ">
  183. <span class="phpdocumentor-signature__visibility"></span>
  184. <span class="phpdocumentor-signature__name">kerioSingleFindAll</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$haystack</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">$needle</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  185. <section class="phpdocumentor-description"></section>
  186. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  187. <dl class="phpdocumentor-argument-list">
  188. <dt class="phpdocumentor-argument-list__entry">
  189. <span class="phpdocumentor-signature__argument__name">$haystack</span>
  190. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  191. </dt>
  192. <dd class="phpdocumentor-argument-list__definition">
  193. <section class="phpdocumentor-description"><p>mixed data</p>
  194. </section>
  195. </dd>
  196. <dt class="phpdocumentor-argument-list__entry">
  197. <span class="phpdocumentor-signature__argument__name">$needle</span>
  198. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  199. </dt>
  200. <dd class="phpdocumentor-argument-list__definition">
  201. <section class="phpdocumentor-description"><p>key to search for values</p>
  202. </section>
  203. </dd>
  204. </dl>
  205. </article>
  206. <article class="phpdocumentor-element -function - ">
  207. <h4 class="phpdocumentor-element__name" id="function_kerioSingleCheckPassword">
  208. kerioSingleCheckPassword()
  209. <a href="namespaces/default.html#function_kerioSingleCheckPassword" class="headerlink"><i class="fas fa-link"></i></a>
  210. </h4>
  211. <aside class="phpdocumentor-element-found-in">
  212. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  213. :
  214. <span class="phpdocumentor-element-found-in__line">60</span>
  215. </aside>
  216. <p class="phpdocumentor-summary">server side password check</p>
  217. <code class="phpdocumentor-code phpdocumentor-signature ">
  218. <span class="phpdocumentor-signature__visibility"></span>
  219. <span class="phpdocumentor-signature__name">kerioSingleCheckPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pwd</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  220. <section class="phpdocumentor-description"><p>recheck the client side password check
  221. in case that the client side check has been disabled</p>
  222. </section>
  223. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  224. <dl class="phpdocumentor-argument-list">
  225. <dt class="phpdocumentor-argument-list__entry">
  226. <span class="phpdocumentor-signature__argument__name">$pwd</span>
  227. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  228. </dt>
  229. <dd class="phpdocumentor-argument-list__definition">
  230. <section class="phpdocumentor-description"><p>password</p>
  231. </section>
  232. </dd>
  233. </dl>
  234. </article>
  235. <article class="phpdocumentor-element -function - ">
  236. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_MetaData">
  237. kerioSingle_MetaData()
  238. <a href="namespaces/default.html#function_kerioSingle_MetaData" class="headerlink"><i class="fas fa-link"></i></a>
  239. </h4>
  240. <aside class="phpdocumentor-element-found-in">
  241. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  242. :
  243. <span class="phpdocumentor-element-found-in__line">93</span>
  244. </aside>
  245. <p class="phpdocumentor-summary">Define module related meta data.</p>
  246. <code class="phpdocumentor-code phpdocumentor-signature ">
  247. <span class="phpdocumentor-signature__visibility"></span>
  248. <span class="phpdocumentor-signature__name">kerioSingle_MetaData</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  249. <section class="phpdocumentor-description"><p>Values returned here are used to determine module related abilities and
  250. settings.</p>
  251. </section>
  252. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  253. Tags
  254. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  255. </h5>
  256. <dl class="phpdocumentor-tag-list">
  257. <dt class="phpdocumentor-tag-list__entry">
  258. <span class="phpdocumentor-tag__name">see</span>
  259. </dt>
  260. <dd class="phpdocumentor-tag-list__definition">
  261. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/meta-data-params/"><abbr title="https://developers.whmcs.com/provisioning-modules/meta-data-params/">https://developers.whmcs.com/provisioning-modules/meta-data-params/</abbr></a></span>
  262. <section class="phpdocumentor-description"></section>
  263. </dd>
  264. </dl>
  265. </article>
  266. <article class="phpdocumentor-element -function - ">
  267. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_TestConnection">
  268. kerioSingle_TestConnection()
  269. <a href="namespaces/default.html#function_kerioSingle_TestConnection" class="headerlink"><i class="fas fa-link"></i></a>
  270. </h4>
  271. <aside class="phpdocumentor-element-found-in">
  272. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  273. :
  274. <span class="phpdocumentor-element-found-in__line">122</span>
  275. </aside>
  276. <p class="phpdocumentor-summary">Test connection to a Kerio server with the given server parameters.</p>
  277. <code class="phpdocumentor-code phpdocumentor-signature ">
  278. <span class="phpdocumentor-signature__visibility"></span>
  279. <span class="phpdocumentor-signature__name">kerioSingle_TestConnection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  280. <section class="phpdocumentor-description"><p>Allows an admin user to verify that an API connection can be
  281. successfully made with the given configuration parameters for a
  282. server.</p>
  283. <p>When defined in a module, a Test Connection button will appear
  284. alongside the Server Type dropdown when adding or editing an
  285. existing server.</p>
  286. </section>
  287. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  288. <dl class="phpdocumentor-argument-list">
  289. <dt class="phpdocumentor-argument-list__entry">
  290. <span class="phpdocumentor-signature__argument__name">$params</span>
  291. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  292. </dt>
  293. <dd class="phpdocumentor-argument-list__definition">
  294. <section class="phpdocumentor-description"><p>common module parameters</p>
  295. </section>
  296. </dd>
  297. </dl>
  298. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  299. Tags
  300. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  301. </h5>
  302. <dl class="phpdocumentor-tag-list">
  303. <dt class="phpdocumentor-tag-list__entry">
  304. <span class="phpdocumentor-tag__name">see</span>
  305. </dt>
  306. <dd class="phpdocumentor-tag-list__definition">
  307. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  308. <section class="phpdocumentor-description"></section>
  309. </dd>
  310. </dl>
  311. </article>
  312. <article class="phpdocumentor-element -function - ">
  313. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_ClientArea">
  314. kerioSingle_ClientArea()
  315. <a href="namespaces/default.html#function_kerioSingle_ClientArea" class="headerlink"><i class="fas fa-link"></i></a>
  316. </h4>
  317. <aside class="phpdocumentor-element-found-in">
  318. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  319. :
  320. <span class="phpdocumentor-element-found-in__line">174</span>
  321. </aside>
  322. <p class="phpdocumentor-summary">Client area output logic handling.</p>
  323. <code class="phpdocumentor-code phpdocumentor-signature ">
  324. <span class="phpdocumentor-signature__visibility"></span>
  325. <span class="phpdocumentor-signature__name">kerioSingle_ClientArea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  326. <section class="phpdocumentor-description"><p>This function is used to define module specific client area output. It should
  327. return an array consisting of a template file and optional additional
  328. template variables to make available to that template.</p>
  329. <p>The template file you return can be one of two types:</p>
  330. <ul>
  331. <li>
  332. <p>tabOverviewModuleOutputTemplate - The output of the template provided here
  333. will be displayed as part of the default product/service client area
  334. product overview page.</p>
  335. </li>
  336. <li>
  337. <p>tabOverviewReplacementTemplate - Alternatively using this option allows you
  338. to entirely take control of the product/service overview page within the
  339. client area.</p>
  340. </li>
  341. </ul>
  342. <p>Whichever option you choose, extra template variables are defined in the same
  343. way. This demonstrates the use of the full replacement.</p>
  344. <p>Please Note: Using tabOverviewReplacementTemplate means you should display
  345. the standard information such as pricing and billing details in your custom
  346. template or they will not be visible to the end user.</p>
  347. </section>
  348. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  349. <dl class="phpdocumentor-argument-list">
  350. <dt class="phpdocumentor-argument-list__entry">
  351. <span class="phpdocumentor-signature__argument__name">$params</span>
  352. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  353. </dt>
  354. <dd class="phpdocumentor-argument-list__definition">
  355. <section class="phpdocumentor-description"><p>common module parameters</p>
  356. </section>
  357. </dd>
  358. </dl>
  359. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  360. Tags
  361. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  362. </h5>
  363. <dl class="phpdocumentor-tag-list">
  364. <dt class="phpdocumentor-tag-list__entry">
  365. <span class="phpdocumentor-tag__name">see</span>
  366. </dt>
  367. <dd class="phpdocumentor-tag-list__definition">
  368. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  369. <section class="phpdocumentor-description"></section>
  370. </dd>
  371. </dl>
  372. </article>
  373. <article class="phpdocumentor-element -function - ">
  374. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_UsageUpdate">
  375. kerioSingle_UsageUpdate()
  376. <a href="namespaces/default.html#function_kerioSingle_UsageUpdate" class="headerlink"><i class="fas fa-link"></i></a>
  377. </h4>
  378. <aside class="phpdocumentor-element-found-in">
  379. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  380. :
  381. <span class="phpdocumentor-element-found-in__line">222</span>
  382. </aside>
  383. <p class="phpdocumentor-summary">Usage Update</p>
  384. <code class="phpdocumentor-code phpdocumentor-signature ">
  385. <span class="phpdocumentor-signature__visibility"></span>
  386. <span class="phpdocumentor-signature__name">kerioSingle_UsageUpdate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  387. <section class="phpdocumentor-description"><p>Important: Runs daily per server not per product
  388. Run Manually: /admin/reports.php?report=disk_usage_summary&amp;action=updatestats</p>
  389. </section>
  390. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  391. <dl class="phpdocumentor-argument-list">
  392. <dt class="phpdocumentor-argument-list__entry">
  393. <span class="phpdocumentor-signature__argument__name">$params</span>
  394. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  395. </dt>
  396. <dd class="phpdocumentor-argument-list__definition">
  397. <section class="phpdocumentor-description"><p>common module parameters</p>
  398. </section>
  399. </dd>
  400. </dl>
  401. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  402. Tags
  403. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  404. </h5>
  405. <dl class="phpdocumentor-tag-list">
  406. <dt class="phpdocumentor-tag-list__entry">
  407. <span class="phpdocumentor-tag__name">see</span>
  408. </dt>
  409. <dd class="phpdocumentor-tag-list__definition">
  410. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/usage-update/"><abbr title="https://developers.whmcs.com/provisioning-modules/usage-update/">https://developers.whmcs.com/provisioning-modules/usage-update/</abbr></a></span>
  411. <section class="phpdocumentor-description"></section>
  412. </dd>
  413. </dl>
  414. </article>
  415. <article class="phpdocumentor-element -function - ">
  416. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_ChangePassword">
  417. kerioSingle_ChangePassword()
  418. <a href="namespaces/default.html#function_kerioSingle_ChangePassword" 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="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  422. :
  423. <span class="phpdocumentor-element-found-in__line">304</span>
  424. </aside>
  425. <p class="phpdocumentor-summary">Change the password for a Kerio account.</p>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility"></span>
  428. <span class="phpdocumentor-signature__name">kerioSingle_ChangePassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  429. <section class="phpdocumentor-description"><p>Called when a password change is requested. This can occur either due to a
  430. client requesting it via the client area or an admin requesting it from the
  431. admin side.</p>
  432. <p>This option is only available to client end users when the product is in an
  433. active status.</p>
  434. </section>
  435. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  436. <dl class="phpdocumentor-argument-list">
  437. <dt class="phpdocumentor-argument-list__entry">
  438. <span class="phpdocumentor-signature__argument__name">$params</span>
  439. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  440. </dt>
  441. <dd class="phpdocumentor-argument-list__definition">
  442. <section class="phpdocumentor-description"><p>common module parameters</p>
  443. </section>
  444. </dd>
  445. </dl>
  446. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  447. Tags
  448. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  449. </h5>
  450. <dl class="phpdocumentor-tag-list">
  451. <dt class="phpdocumentor-tag-list__entry">
  452. <span class="phpdocumentor-tag__name">see</span>
  453. </dt>
  454. <dd class="phpdocumentor-tag-list__definition">
  455. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  456. <section class="phpdocumentor-description"></section>
  457. </dd>
  458. </dl>
  459. </article>
  460. <article class="phpdocumentor-element -function - ">
  461. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_CreateAccount">
  462. kerioSingle_CreateAccount()
  463. <a href="namespaces/default.html#function_kerioSingle_CreateAccount" class="headerlink"><i class="fas fa-link"></i></a>
  464. </h4>
  465. <aside class="phpdocumentor-element-found-in">
  466. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  467. :
  468. <span class="phpdocumentor-element-found-in__line">352</span>
  469. </aside>
  470. <p class="phpdocumentor-summary">Provision a new instance of a Kerio account.</p>
  471. <code class="phpdocumentor-code phpdocumentor-signature ">
  472. <span class="phpdocumentor-signature__visibility"></span>
  473. <span class="phpdocumentor-signature__name">kerioSingle_CreateAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  474. <section class="phpdocumentor-description"><p>Attempt to provision a new Kerio mail account. This is
  475. called any time provisioning is requested inside of WHMCS. Depending upon the
  476. configuration, this can be any of:</p>
  477. <ul>
  478. <li>When a new order is placed</li>
  479. <li>When an invoice for a new order is paid</li>
  480. <li>Upon manual request by an admin user</li>
  481. </ul>
  482. </section>
  483. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  484. <dl class="phpdocumentor-argument-list">
  485. <dt class="phpdocumentor-argument-list__entry">
  486. <span class="phpdocumentor-signature__argument__name">$params</span>
  487. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  488. </dt>
  489. <dd class="phpdocumentor-argument-list__definition">
  490. <section class="phpdocumentor-description"><p>common module parameters</p>
  491. </section>
  492. </dd>
  493. </dl>
  494. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  495. Tags
  496. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  497. </h5>
  498. <dl class="phpdocumentor-tag-list">
  499. <dt class="phpdocumentor-tag-list__entry">
  500. <span class="phpdocumentor-tag__name">see</span>
  501. </dt>
  502. <dd class="phpdocumentor-tag-list__definition">
  503. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  504. <section class="phpdocumentor-description"></section>
  505. </dd>
  506. </dl>
  507. </article>
  508. <article class="phpdocumentor-element -function - ">
  509. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_SuspendAccount">
  510. kerioSingle_SuspendAccount()
  511. <a href="namespaces/default.html#function_kerioSingle_SuspendAccount" class="headerlink"><i class="fas fa-link"></i></a>
  512. </h4>
  513. <aside class="phpdocumentor-element-found-in">
  514. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  515. :
  516. <span class="phpdocumentor-element-found-in__line">451</span>
  517. </aside>
  518. <p class="phpdocumentor-summary">Set a Kerio account to status locked.</p>
  519. <code class="phpdocumentor-code phpdocumentor-signature ">
  520. <span class="phpdocumentor-signature__visibility"></span>
  521. <span class="phpdocumentor-signature__name">kerioSingle_SuspendAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  522. <section class="phpdocumentor-description"><p>Called when a suspension is requested. This is invoked automatically by WHMCS
  523. when a product becomes overdue on payment or can be called manually by admin
  524. user.</p>
  525. </section>
  526. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  527. <dl class="phpdocumentor-argument-list">
  528. <dt class="phpdocumentor-argument-list__entry">
  529. <span class="phpdocumentor-signature__argument__name">$params</span>
  530. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  531. </dt>
  532. <dd class="phpdocumentor-argument-list__definition">
  533. <section class="phpdocumentor-description"><p>common module parameters</p>
  534. </section>
  535. </dd>
  536. </dl>
  537. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  538. Tags
  539. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  540. </h5>
  541. <dl class="phpdocumentor-tag-list">
  542. <dt class="phpdocumentor-tag-list__entry">
  543. <span class="phpdocumentor-tag__name">see</span>
  544. </dt>
  545. <dd class="phpdocumentor-tag-list__definition">
  546. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  547. <section class="phpdocumentor-description"></section>
  548. </dd>
  549. </dl>
  550. </article>
  551. <article class="phpdocumentor-element -function - ">
  552. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_UnsuspendAccount">
  553. kerioSingle_UnsuspendAccount()
  554. <a href="namespaces/default.html#function_kerioSingle_UnsuspendAccount" class="headerlink"><i class="fas fa-link"></i></a>
  555. </h4>
  556. <aside class="phpdocumentor-element-found-in">
  557. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  558. :
  559. <span class="phpdocumentor-element-found-in__line">492</span>
  560. </aside>
  561. <p class="phpdocumentor-summary">Set a Kerio account to status active.</p>
  562. <code class="phpdocumentor-code phpdocumentor-signature ">
  563. <span class="phpdocumentor-signature__visibility"></span>
  564. <span class="phpdocumentor-signature__name">kerioSingle_UnsuspendAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  565. <section class="phpdocumentor-description"><p>Called when an un-suspension is requested. This is invoked
  566. automatically upon payment of an overdue invoice for a product, or
  567. can be called manually by admin user.</p>
  568. </section>
  569. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  570. <dl class="phpdocumentor-argument-list">
  571. <dt class="phpdocumentor-argument-list__entry">
  572. <span class="phpdocumentor-signature__argument__name">$params</span>
  573. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  574. </dt>
  575. <dd class="phpdocumentor-argument-list__definition">
  576. <section class="phpdocumentor-description"><p>common module parameters</p>
  577. </section>
  578. </dd>
  579. </dl>
  580. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  581. Tags
  582. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  583. </h5>
  584. <dl class="phpdocumentor-tag-list">
  585. <dt class="phpdocumentor-tag-list__entry">
  586. <span class="phpdocumentor-tag__name">see</span>
  587. </dt>
  588. <dd class="phpdocumentor-tag-list__definition">
  589. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  590. <section class="phpdocumentor-description"></section>
  591. </dd>
  592. </dl>
  593. </article>
  594. <article class="phpdocumentor-element -function - ">
  595. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_TerminateAccount">
  596. kerioSingle_TerminateAccount()
  597. <a href="namespaces/default.html#function_kerioSingle_TerminateAccount" class="headerlink"><i class="fas fa-link"></i></a>
  598. </h4>
  599. <aside class="phpdocumentor-element-found-in">
  600. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  601. :
  602. <span class="phpdocumentor-element-found-in__line">532</span>
  603. </aside>
  604. <p class="phpdocumentor-summary">Removes a Kerio account.</p>
  605. <code class="phpdocumentor-code phpdocumentor-signature ">
  606. <span class="phpdocumentor-signature__visibility"></span>
  607. <span class="phpdocumentor-signature__name">kerioSingle_TerminateAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  608. <section class="phpdocumentor-description"><p>Called when a termination is requested. This can be invoked automatically for
  609. overdue products if enabled, or requested manually by an admin user.</p>
  610. </section>
  611. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  612. <dl class="phpdocumentor-argument-list">
  613. <dt class="phpdocumentor-argument-list__entry">
  614. <span class="phpdocumentor-signature__argument__name">$params</span>
  615. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  616. </dt>
  617. <dd class="phpdocumentor-argument-list__definition">
  618. <section class="phpdocumentor-description"><p>common module parameters</p>
  619. </section>
  620. </dd>
  621. </dl>
  622. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  623. Tags
  624. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  625. </h5>
  626. <dl class="phpdocumentor-tag-list">
  627. <dt class="phpdocumentor-tag-list__entry">
  628. <span class="phpdocumentor-tag__name">see</span>
  629. </dt>
  630. <dd class="phpdocumentor-tag-list__definition">
  631. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  632. <section class="phpdocumentor-description"></section>
  633. </dd>
  634. </dl>
  635. </article>
  636. <article class="phpdocumentor-element -function - ">
  637. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_ChangePackage">
  638. kerioSingle_ChangePackage()
  639. <a href="namespaces/default.html#function_kerioSingle_ChangePackage" class="headerlink"><i class="fas fa-link"></i></a>
  640. </h4>
  641. <aside class="phpdocumentor-element-found-in">
  642. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  643. :
  644. <span class="phpdocumentor-element-found-in__line">590</span>
  645. </aside>
  646. <p class="phpdocumentor-summary">Set a new class of service for a Kerio account.</p>
  647. <code class="phpdocumentor-code phpdocumentor-signature ">
  648. <span class="phpdocumentor-signature__visibility"></span>
  649. <span class="phpdocumentor-signature__name">kerioSingle_ChangePackage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  650. <section class="phpdocumentor-description"><p>Called to apply a change of the class of service. It
  651. is called to provision upgrade or downgrade orders, as well as being
  652. able to be invoked manually by an admin user.</p>
  653. <p>This same function is called for upgrades and downgrades of both
  654. products and configurable options.</p>
  655. </section>
  656. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  657. <dl class="phpdocumentor-argument-list">
  658. <dt class="phpdocumentor-argument-list__entry">
  659. <span class="phpdocumentor-signature__argument__name">$params</span>
  660. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  661. </dt>
  662. <dd class="phpdocumentor-argument-list__definition">
  663. <section class="phpdocumentor-description"><p>common module parameters</p>
  664. </section>
  665. </dd>
  666. </dl>
  667. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  668. Tags
  669. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  670. </h5>
  671. <dl class="phpdocumentor-tag-list">
  672. <dt class="phpdocumentor-tag-list__entry">
  673. <span class="phpdocumentor-tag__name">see</span>
  674. </dt>
  675. <dd class="phpdocumentor-tag-list__definition">
  676. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  677. <section class="phpdocumentor-description"></section>
  678. </dd>
  679. </dl>
  680. </article>
  681. <article class="phpdocumentor-element -function - ">
  682. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_ConfigOptions">
  683. kerioSingle_ConfigOptions()
  684. <a href="namespaces/default.html#function_kerioSingle_ConfigOptions" class="headerlink"><i class="fas fa-link"></i></a>
  685. </h4>
  686. <aside class="phpdocumentor-element-found-in">
  687. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  688. :
  689. <span class="phpdocumentor-element-found-in__line">664</span>
  690. </aside>
  691. <p class="phpdocumentor-summary">Define Kerio product configuration options.</p>
  692. <code class="phpdocumentor-code phpdocumentor-signature ">
  693. <span class="phpdocumentor-signature__visibility"></span>
  694. <span class="phpdocumentor-signature__name">kerioSingle_ConfigOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  695. <section class="phpdocumentor-description"><p>Gather classes of service from the Zinbra server.
  696. Calls a function to create all necessary customfields for the order form using the selected values.</p>
  697. </section>
  698. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  699. <dl class="phpdocumentor-argument-list">
  700. <dt class="phpdocumentor-argument-list__entry">
  701. <span class="phpdocumentor-signature__argument__name">$params</span>
  702. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  703. </dt>
  704. <dd class="phpdocumentor-argument-list__definition">
  705. </dd>
  706. </dl>
  707. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  708. Tags
  709. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  710. </h5>
  711. <dl class="phpdocumentor-tag-list">
  712. <dt class="phpdocumentor-tag-list__entry">
  713. <span class="phpdocumentor-tag__name">see</span>
  714. </dt>
  715. <dd class="phpdocumentor-tag-list__definition">
  716. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/config-options/"><abbr title="https://developers.whmcs.com/provisioning-modules/config-options/">https://developers.whmcs.com/provisioning-modules/config-options/</abbr></a></span>
  717. <section class="phpdocumentor-description"></section>
  718. </dd>
  719. </dl>
  720. </article>
  721. <article class="phpdocumentor-element -function - ">
  722. <h4 class="phpdocumentor-element__name" id="function_kerioSingle_ServiceSingleSignOn">
  723. kerioSingle_ServiceSingleSignOn()
  724. <a href="namespaces/default.html#function_kerioSingle_ServiceSingleSignOn" class="headerlink"><i class="fas fa-link"></i></a>
  725. </h4>
  726. <aside class="phpdocumentor-element-found-in">
  727. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  728. :
  729. <span class="phpdocumentor-element-found-in__line">747</span>
  730. </aside>
  731. <p class="phpdocumentor-summary">Perform single sign-on for a given instance of a product/service.</p>
  732. <code class="phpdocumentor-code phpdocumentor-signature ">
  733. <span class="phpdocumentor-signature__visibility"></span>
  734. <span class="phpdocumentor-signature__name">kerioSingle_ServiceSingleSignOn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  735. <section class="phpdocumentor-description"><p>Called when single sign-on is requested for an instance of a product/service.</p>
  736. <p>When successful, returns an URL to which the user should be redirected.</p>
  737. </section>
  738. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  739. <dl class="phpdocumentor-argument-list">
  740. <dt class="phpdocumentor-argument-list__entry">
  741. <span class="phpdocumentor-signature__argument__name">$params</span>
  742. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  743. </dt>
  744. <dd class="phpdocumentor-argument-list__definition">
  745. <section class="phpdocumentor-description"><p>common module parameters</p>
  746. </section>
  747. </dd>
  748. </dl>
  749. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  750. Tags
  751. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  752. </h5>
  753. <dl class="phpdocumentor-tag-list">
  754. <dt class="phpdocumentor-tag-list__entry">
  755. <span class="phpdocumentor-tag__name">see</span>
  756. </dt>
  757. <dd class="phpdocumentor-tag-list__definition">
  758. <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
  759. <section class="phpdocumentor-description"></section>
  760. </dd>
  761. </dl>
  762. </article>
  763. <article class="phpdocumentor-element -function - ">
  764. <h4 class="phpdocumentor-element__name" id="function_kerioSingleUpdateQuota">
  765. kerioSingleUpdateQuota()
  766. <a href="namespaces/default.html#function_kerioSingleUpdateQuota" class="headerlink"><i class="fas fa-link"></i></a>
  767. </h4>
  768. <aside class="phpdocumentor-element-found-in">
  769. <abbr class="phpdocumentor-element-found-in__file" title="kerioSingle.php"><a href="files/keriosingle.html"><abbr title="kerioSingle.php">kerioSingle.php</abbr></a></abbr>
  770. :
  771. <span class="phpdocumentor-element-found-in__line">813</span>
  772. </aside>
  773. <p class="phpdocumentor-summary">Perform an update of customfields to prevent downgrades.</p>
  774. <code class="phpdocumentor-code phpdocumentor-signature ">
  775. <span class="phpdocumentor-signature__visibility"></span>
  776. <span class="phpdocumentor-signature__name">kerioSingleUpdateQuota</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  777. <section class="phpdocumentor-description"><p>Called in changePackage or createAccount functions.</p>
  778. </section>
  779. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  780. <dl class="phpdocumentor-argument-list">
  781. <dt class="phpdocumentor-argument-list__entry">
  782. <span class="phpdocumentor-signature__argument__name">$params</span>
  783. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  784. </dt>
  785. <dd class="phpdocumentor-argument-list__definition">
  786. <section class="phpdocumentor-description"><p>common module parameters</p>
  787. </section>
  788. </dd>
  789. </dl>
  790. </article>
  791. </section>
  792. </article>
  793. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  794. <section class="phpdocumentor-search-results__dialog">
  795. <header class="phpdocumentor-search-results__header">
  796. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  797. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  798. </header>
  799. <section class="phpdocumentor-search-results__body">
  800. <ul class="phpdocumentor-search-results__entries"></ul>
  801. </section>
  802. </section>
  803. </section>
  804. </div>
  805. </div>
  806. <a href="files/keriosingle.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  807. </main>
  808. <script>
  809. cssVars({});
  810. </script>
  811. </body>
  812. </html>