Zm-Account.html 100 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900
  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_Account
  71. </h2>
  72. <aside class="phpdocumentor-element-found-in">
  73. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  74. :
  75. <span class="phpdocumentor-element-found-in__line">27</span>
  76. </aside>
  77. <p class="phpdocumentor-summary">Zm_Account is a class which allows to manage Kerio accounts via SOAP</p>
  78. <section class="phpdocumentor-description"><p>You may create, modify, rename, delete and get the attributes of a Kerio account using this class</p>
  79. <p>For the usage examples of all class methods check the source code of test.php</p>
  80. </section>
  81. <h3 id="toc">
  82. Table of Contents
  83. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  84. </h3>
  85. <dl class="phpdocumentor-table-of-contents">
  86. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  87. <a href="classes/Zm-Account.html#property_auth">$auth</a>
  88. <span>
  89. &nbsp;: <a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a> </span>
  90. </dt>
  91. <dd>$auth</dd>
  92. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  93. <a href="classes/Zm-Account.html#method___construct">__construct()</a>
  94. <span>
  95. &nbsp;: mixed </span>
  96. </dt>
  97. <dd>Constructor</dd>
  98. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  99. <a href="classes/Zm-Account.html#method_accountExists">accountExists()</a>
  100. <span>
  101. &nbsp;: bool </span>
  102. </dt>
  103. <dd>accountExists</dd>
  104. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  105. <a href="classes/Zm-Account.html#method_addAccountAlias">addAccountAlias()</a>
  106. <span>
  107. &nbsp;: array&lt;string|int, mixed&gt; </span>
  108. </dt>
  109. <dd>addAccountAlias</dd>
  110. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  111. <a href="classes/Zm-Account.html#method_createAccount">createAccount()</a>
  112. <span>
  113. &nbsp;: string </span>
  114. </dt>
  115. <dd>createAccount</dd>
  116. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  117. <a href="classes/Zm-Account.html#method_deleteAccount">deleteAccount()</a>
  118. <span>
  119. &nbsp;: array&lt;string|int, mixed&gt; </span>
  120. </dt>
  121. <dd>deleteAccount</dd>
  122. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  123. <a href="classes/Zm-Account.html#method_expireAccountSessions">expireAccountSessions()</a>
  124. <span>
  125. &nbsp;: array&lt;string|int, mixed&gt; </span>
  126. </dt>
  127. <dd>expireAccountSessions</dd>
  128. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  129. <a href="classes/Zm-Account.html#method_fetchAccounts">fetchAccounts()</a>
  130. <span>
  131. &nbsp;: array&lt;string|int, mixed&gt; </span>
  132. </dt>
  133. <dd>fetchAccounts</dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  135. <a href="classes/Zm-Account.html#method_getAccount">getAccount()</a>
  136. <span>
  137. &nbsp;: string </span>
  138. </dt>
  139. <dd>getAccount</dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  141. <a href="classes/Zm-Account.html#method_getAccountAliases">getAccountAliases()</a>
  142. <span>
  143. &nbsp;: array&lt;string|int, mixed&gt; </span>
  144. </dt>
  145. <dd>getAccountAliases</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  147. <a href="classes/Zm-Account.html#method_getAccountCos">getAccountCos()</a>
  148. <span>
  149. &nbsp;: string </span>
  150. </dt>
  151. <dd>getAccountCos</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  153. <a href="classes/Zm-Account.html#method_getAccountId">getAccountId()</a>
  154. <span>
  155. &nbsp;: string </span>
  156. </dt>
  157. <dd>getAccountId</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  159. <a href="classes/Zm-Account.html#method_getAccountInfo">getAccountInfo()</a>
  160. <span>
  161. &nbsp;: array&lt;string|int, mixed&gt; </span>
  162. </dt>
  163. <dd>getAccountInfo</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  165. <a href="classes/Zm-Account.html#method_getAccountOption">getAccountOption()</a>
  166. <span>
  167. &nbsp;: string </span>
  168. </dt>
  169. <dd>getAccountOption</dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  171. <a href="classes/Zm-Account.html#method_getAccountOptions">getAccountOptions()</a>
  172. <span>
  173. &nbsp;: array&lt;string|int, mixed&gt; </span>
  174. </dt>
  175. <dd>getAccountOptions</dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  177. <a href="classes/Zm-Account.html#method_getAccountStatus">getAccountStatus()</a>
  178. <span>
  179. &nbsp;: string </span>
  180. </dt>
  181. <dd>getAccountStatus</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  183. <a href="classes/Zm-Account.html#method_getAllAccounts">getAllAccounts()</a>
  184. <span>
  185. &nbsp;: array&lt;string|int, mixed&gt; </span>
  186. </dt>
  187. <dd>getAllAccounts</dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  189. <a href="classes/Zm-Account.html#method_getAllCos">getAllCos()</a>
  190. <span>
  191. &nbsp;: array&lt;string|int, mixed&gt; </span>
  192. </dt>
  193. <dd>getAllCos</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  195. <a href="classes/Zm-Account.html#method_getCosId">getCosId()</a>
  196. <span>
  197. &nbsp;: string </span>
  198. </dt>
  199. <dd>getCosId</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  201. <a href="classes/Zm-Account.html#method_getMailbox">getMailbox()</a>
  202. <span>
  203. &nbsp;: array&lt;string|int, mixed&gt; </span>
  204. </dt>
  205. <dd>getMailbox</dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  207. <a href="classes/Zm-Account.html#method_getQuota">getQuota()</a>
  208. <span>
  209. &nbsp;: string </span>
  210. </dt>
  211. <dd>getQuota</dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  213. <a href="classes/Zm-Account.html#method_modifyAccount">modifyAccount()</a>
  214. <span>
  215. &nbsp;: array&lt;string|int, mixed&gt; </span>
  216. </dt>
  217. <dd>modifyAccount</dd>
  218. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  219. <a href="classes/Zm-Account.html#method_removeAccountAlias">removeAccountAlias()</a>
  220. <span>
  221. &nbsp;: array&lt;string|int, mixed&gt; </span>
  222. </dt>
  223. <dd>removeAccountAlias</dd>
  224. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  225. <a href="classes/Zm-Account.html#method_renameAccount">renameAccount()</a>
  226. <span>
  227. &nbsp;: array&lt;string|int, mixed&gt; </span>
  228. </dt>
  229. <dd>renameAccount</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  231. <a href="classes/Zm-Account.html#method_setAccountCos">setAccountCos()</a>
  232. <span>
  233. &nbsp;: array&lt;string|int, mixed&gt; </span>
  234. </dt>
  235. <dd>setAccountCos</dd>
  236. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  237. <a href="classes/Zm-Account.html#method_setAccountPassword">setAccountPassword()</a>
  238. <span>
  239. &nbsp;: array&lt;string|int, mixed&gt; </span>
  240. </dt>
  241. <dd>setAccountPassword</dd>
  242. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  243. <a href="classes/Zm-Account.html#method_setAccountStatus">setAccountStatus()</a>
  244. <span>
  245. &nbsp;: array&lt;string|int, mixed&gt; </span>
  246. </dt>
  247. <dd>setAccountStatus</dd>
  248. </dl>
  249. <section class="phpdocumentor-properties">
  250. <h3 class="phpdocumentor-elements__header" id="properties">
  251. Properties
  252. <a href="classes/Zm-Account.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  253. </h3>
  254. <article
  255. class="
  256. phpdocumentor-element
  257. -property
  258. -private
  259. "
  260. >
  261. <h4 class="phpdocumentor-element__name" id="property_auth">
  262. $auth
  263. <a href="classes/Zm-Account.html#property_auth" class="headerlink"><i class="fas fa-link"></i></a>
  264. <span class="phpdocumentor-element__modifiers">
  265. </span>
  266. </h4>
  267. <aside class="phpdocumentor-element-found-in">
  268. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  269. :
  270. <span class="phpdocumentor-element-found-in__line">33</span>
  271. </aside>
  272. <p class="phpdocumentor-summary">$auth</p>
  273. <code class="phpdocumentor-code phpdocumentor-signature ">
  274. <span class="phpdocumentor-signature__visibility">private</span>
  275. <span class="phpdocumentor-signature__type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  276. <span class="phpdocumentor-signature__name">$auth</span>
  277. </code>
  278. <section class="phpdocumentor-description"></section>
  279. </article>
  280. </section>
  281. <section class="phpdocumentor-methods">
  282. <h3 class="phpdocumentor-elements__header" id="methods">
  283. Methods
  284. <a href="classes/Zm-Account.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  285. </h3>
  286. <article
  287. class="phpdocumentor-element
  288. -method
  289. -public
  290. "
  291. >
  292. <h4 class="phpdocumentor-element__name" id="method___construct">
  293. __construct()
  294. <a href="classes/Zm-Account.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  295. </h4>
  296. <aside class="phpdocumentor-element-found-in">
  297. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  298. :
  299. <span class="phpdocumentor-element-found-in__line">39</span>
  300. </aside>
  301. <p class="phpdocumentor-summary">Constructor</p>
  302. <code class="phpdocumentor-code phpdocumentor-signature ">
  303. <span class="phpdocumentor-signature__visibility">public</span>
  304. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$auth</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  305. <section class="phpdocumentor-description"></section>
  306. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  307. <dl class="phpdocumentor-argument-list">
  308. <dt class="phpdocumentor-argument-list__entry">
  309. <span class="phpdocumentor-signature__argument__name">$auth</span>
  310. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  311. </dt>
  312. <dd class="phpdocumentor-argument-list__definition">
  313. <section class="phpdocumentor-description"><p>soap authentication</p>
  314. </section>
  315. </dd>
  316. </dl>
  317. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  318. <span class="phpdocumentor-signature__response_type">mixed</span>
  319. &mdash;
  320. <section class="phpdocumentor-description"></section>
  321. </article>
  322. <article
  323. class="phpdocumentor-element
  324. -method
  325. -public
  326. "
  327. >
  328. <h4 class="phpdocumentor-element__name" id="method_accountExists">
  329. accountExists()
  330. <a href="classes/Zm-Account.html#method_accountExists" class="headerlink"><i class="fas fa-link"></i></a>
  331. </h4>
  332. <aside class="phpdocumentor-element-found-in">
  333. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  334. :
  335. <span class="phpdocumentor-element-found-in__line">233</span>
  336. </aside>
  337. <p class="phpdocumentor-summary">accountExists</p>
  338. <code class="phpdocumentor-code phpdocumentor-signature ">
  339. <span class="phpdocumentor-signature__visibility">public</span>
  340. <span class="phpdocumentor-signature__name">accountExists</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  341. <section class="phpdocumentor-description"></section>
  342. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  343. <dl class="phpdocumentor-argument-list">
  344. <dt class="phpdocumentor-argument-list__entry">
  345. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  346. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  347. </dt>
  348. <dd class="phpdocumentor-argument-list__definition">
  349. <section class="phpdocumentor-description"><p>account id or account name</p>
  350. </section>
  351. </dd>
  352. <dt class="phpdocumentor-argument-list__entry">
  353. <span class="phpdocumentor-signature__argument__name">$type</span>
  354. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  355. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  356. <dd class="phpdocumentor-argument-list__definition">
  357. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  358. </section>
  359. </dd>
  360. </dl>
  361. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  362. <span class="phpdocumentor-signature__response_type">bool</span>
  363. &mdash;
  364. <section class="phpdocumentor-description"><p>exists</p>
  365. </section>
  366. </article>
  367. <article
  368. class="phpdocumentor-element
  369. -method
  370. -public
  371. "
  372. >
  373. <h4 class="phpdocumentor-element__name" id="method_addAccountAlias">
  374. addAccountAlias()
  375. <a href="classes/Zm-Account.html#method_addAccountAlias" class="headerlink"><i class="fas fa-link"></i></a>
  376. </h4>
  377. <aside class="phpdocumentor-element-found-in">
  378. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  379. :
  380. <span class="phpdocumentor-element-found-in__line">633</span>
  381. </aside>
  382. <p class="phpdocumentor-summary">addAccountAlias</p>
  383. <code class="phpdocumentor-code phpdocumentor-signature ">
  384. <span class="phpdocumentor-signature__visibility">public</span>
  385. <span class="phpdocumentor-signature__name">addAccountAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$alias</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  386. <section class="phpdocumentor-description"></section>
  387. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  388. <dl class="phpdocumentor-argument-list">
  389. <dt class="phpdocumentor-argument-list__entry">
  390. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  391. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  392. </dt>
  393. <dd class="phpdocumentor-argument-list__definition">
  394. <section class="phpdocumentor-description"><p>account id or account name</p>
  395. </section>
  396. </dd>
  397. <dt class="phpdocumentor-argument-list__entry">
  398. <span class="phpdocumentor-signature__argument__name">$alias</span>
  399. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  400. </dt>
  401. <dd class="phpdocumentor-argument-list__definition">
  402. <section class="phpdocumentor-description"><p>account alias</p>
  403. </section>
  404. </dd>
  405. <dt class="phpdocumentor-argument-list__entry">
  406. <span class="phpdocumentor-signature__argument__name">$type</span>
  407. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  408. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  409. <dd class="phpdocumentor-argument-list__definition">
  410. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  411. </section>
  412. </dd>
  413. </dl>
  414. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  415. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  416. &mdash;
  417. <section class="phpdocumentor-description"><p>informations</p>
  418. </section>
  419. </article>
  420. <article
  421. class="phpdocumentor-element
  422. -method
  423. -public
  424. "
  425. >
  426. <h4 class="phpdocumentor-element__name" id="method_createAccount">
  427. createAccount()
  428. <a href="classes/Zm-Account.html#method_createAccount" class="headerlink"><i class="fas fa-link"></i></a>
  429. </h4>
  430. <aside class="phpdocumentor-element-found-in">
  431. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  432. :
  433. <span class="phpdocumentor-element-found-in__line">421</span>
  434. </aside>
  435. <p class="phpdocumentor-summary">createAccount</p>
  436. <code class="phpdocumentor-code phpdocumentor-signature ">
  437. <span class="phpdocumentor-signature__visibility">public</span>
  438. <span class="phpdocumentor-signature__name">createAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</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">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attrs</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  439. <section class="phpdocumentor-description"></section>
  440. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  441. <dl class="phpdocumentor-argument-list">
  442. <dt class="phpdocumentor-argument-list__entry">
  443. <span class="phpdocumentor-signature__argument__name">$name</span>
  444. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  445. </dt>
  446. <dd class="phpdocumentor-argument-list__definition">
  447. <section class="phpdocumentor-description"><p>account name</p>
  448. </section>
  449. </dd>
  450. <dt class="phpdocumentor-argument-list__entry">
  451. <span class="phpdocumentor-signature__argument__name">$password</span>
  452. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  453. </dt>
  454. <dd class="phpdocumentor-argument-list__definition">
  455. <section class="phpdocumentor-description"><p>password</p>
  456. </section>
  457. </dd>
  458. <dt class="phpdocumentor-argument-list__entry">
  459. <span class="phpdocumentor-signature__argument__name">$attrs</span>
  460. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  461. = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
  462. <dd class="phpdocumentor-argument-list__definition">
  463. <section class="phpdocumentor-description"><p>an optional array containing the account attributes to be set</p>
  464. </section>
  465. </dd>
  466. </dl>
  467. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  468. <span class="phpdocumentor-signature__response_type">string</span>
  469. &mdash;
  470. <section class="phpdocumentor-description"><p>the new account's id</p>
  471. </section>
  472. </article>
  473. <article
  474. class="phpdocumentor-element
  475. -method
  476. -public
  477. "
  478. >
  479. <h4 class="phpdocumentor-element__name" id="method_deleteAccount">
  480. deleteAccount()
  481. <a href="classes/Zm-Account.html#method_deleteAccount" class="headerlink"><i class="fas fa-link"></i></a>
  482. </h4>
  483. <aside class="phpdocumentor-element-found-in">
  484. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  485. :
  486. <span class="phpdocumentor-element-found-in__line">582</span>
  487. </aside>
  488. <p class="phpdocumentor-summary">deleteAccount</p>
  489. <code class="phpdocumentor-code phpdocumentor-signature ">
  490. <span class="phpdocumentor-signature__visibility">public</span>
  491. <span class="phpdocumentor-signature__name">deleteAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  492. <section class="phpdocumentor-description"></section>
  493. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  494. <dl class="phpdocumentor-argument-list">
  495. <dt class="phpdocumentor-argument-list__entry">
  496. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  497. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  498. </dt>
  499. <dd class="phpdocumentor-argument-list__definition">
  500. <section class="phpdocumentor-description"><p>account id or account name</p>
  501. </section>
  502. </dd>
  503. <dt class="phpdocumentor-argument-list__entry">
  504. <span class="phpdocumentor-signature__argument__name">$type</span>
  505. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  506. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  507. <dd class="phpdocumentor-argument-list__definition">
  508. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  509. </section>
  510. </dd>
  511. </dl>
  512. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  513. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  514. &mdash;
  515. <section class="phpdocumentor-description"><p>informations</p>
  516. </section>
  517. </article>
  518. <article
  519. class="phpdocumentor-element
  520. -method
  521. -public
  522. "
  523. >
  524. <h4 class="phpdocumentor-element__name" id="method_expireAccountSessions">
  525. expireAccountSessions()
  526. <a href="classes/Zm-Account.html#method_expireAccountSessions" class="headerlink"><i class="fas fa-link"></i></a>
  527. </h4>
  528. <aside class="phpdocumentor-element-found-in">
  529. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  530. :
  531. <span class="phpdocumentor-element-found-in__line">745</span>
  532. </aside>
  533. <p class="phpdocumentor-summary">expireAccountSessions</p>
  534. <code class="phpdocumentor-code phpdocumentor-signature ">
  535. <span class="phpdocumentor-signature__visibility">public</span>
  536. <span class="phpdocumentor-signature__name">expireAccountSessions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  537. <section class="phpdocumentor-description"></section>
  538. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  539. <dl class="phpdocumentor-argument-list">
  540. <dt class="phpdocumentor-argument-list__entry">
  541. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  542. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  543. </dt>
  544. <dd class="phpdocumentor-argument-list__definition">
  545. <section class="phpdocumentor-description"><p>account id or account name</p>
  546. </section>
  547. </dd>
  548. <dt class="phpdocumentor-argument-list__entry">
  549. <span class="phpdocumentor-signature__argument__name">$type</span>
  550. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  551. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  552. <dd class="phpdocumentor-argument-list__definition">
  553. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  554. </section>
  555. </dd>
  556. </dl>
  557. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  558. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  559. &mdash;
  560. <section class="phpdocumentor-description"><p>informations</p>
  561. </section>
  562. </article>
  563. <article
  564. class="phpdocumentor-element
  565. -method
  566. -public
  567. "
  568. >
  569. <h4 class="phpdocumentor-element__name" id="method_fetchAccounts">
  570. fetchAccounts()
  571. <a href="classes/Zm-Account.html#method_fetchAccounts" class="headerlink"><i class="fas fa-link"></i></a>
  572. </h4>
  573. <aside class="phpdocumentor-element-found-in">
  574. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  575. :
  576. <span class="phpdocumentor-element-found-in__line">92</span>
  577. </aside>
  578. <p class="phpdocumentor-summary">fetchAccounts</p>
  579. <code class="phpdocumentor-code phpdocumentor-signature ">
  580. <span class="phpdocumentor-signature__visibility">public</span>
  581. <span class="phpdocumentor-signature__name">fetchAccounts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ldapQuery</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attrList</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">$nameDomain</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  582. <section class="phpdocumentor-description"></section>
  583. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  584. <dl class="phpdocumentor-argument-list">
  585. <dt class="phpdocumentor-argument-list__entry">
  586. <span class="phpdocumentor-signature__argument__name">$ldapQuery</span>
  587. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  588. </dt>
  589. <dd class="phpdocumentor-argument-list__definition">
  590. <section class="phpdocumentor-description"><p>LDAP-style filter string (RFC 2254)</p>
  591. </section>
  592. </dd>
  593. <dt class="phpdocumentor-argument-list__entry">
  594. <span class="phpdocumentor-signature__argument__name">$attrList</span>
  595. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  596. </dt>
  597. <dd class="phpdocumentor-argument-list__definition">
  598. <section class="phpdocumentor-description"><p>names of requested attributes</p>
  599. </section>
  600. </dd>
  601. <dt class="phpdocumentor-argument-list__entry">
  602. <span class="phpdocumentor-signature__argument__name">$nameDomain</span>
  603. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  604. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  605. <dd class="phpdocumentor-argument-list__definition">
  606. <section class="phpdocumentor-description"><p>domain name to restrict search request</p>
  607. </section>
  608. </dd>
  609. </dl>
  610. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  611. Tags
  612. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  613. </h5>
  614. <dl class="phpdocumentor-tag-list">
  615. <dt class="phpdocumentor-tag-list__entry">
  616. <span class="phpdocumentor-tag__name">author</span>
  617. </dt>
  618. <dd class="phpdocumentor-tag-list__definition">
  619. <section class="phpdocumentor-description"><p>Marc Lamouche <a href="mailto:marc.lamouche@ined.fr">marc.lamouche@ined.fr</a></p>
  620. </section>
  621. </dd>
  622. </dl>
  623. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  624. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  625. &mdash;
  626. <section class="phpdocumentor-description"><p>informations for accounts as specified in $ldapQuery</p>
  627. </section>
  628. </article>
  629. <article
  630. class="phpdocumentor-element
  631. -method
  632. -public
  633. "
  634. >
  635. <h4 class="phpdocumentor-element__name" id="method_getAccount">
  636. getAccount()
  637. <a href="classes/Zm-Account.html#method_getAccount" class="headerlink"><i class="fas fa-link"></i></a>
  638. </h4>
  639. <aside class="phpdocumentor-element-found-in">
  640. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  641. :
  642. <span class="phpdocumentor-element-found-in__line">142</span>
  643. </aside>
  644. <p class="phpdocumentor-summary">getAccount</p>
  645. <code class="phpdocumentor-code phpdocumentor-signature ">
  646. <span class="phpdocumentor-signature__visibility">public</span>
  647. <span class="phpdocumentor-signature__name">getAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  648. <section class="phpdocumentor-description"></section>
  649. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  650. <dl class="phpdocumentor-argument-list">
  651. <dt class="phpdocumentor-argument-list__entry">
  652. <span class="phpdocumentor-signature__argument__name">$name</span>
  653. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  654. </dt>
  655. <dd class="phpdocumentor-argument-list__definition">
  656. <section class="phpdocumentor-description"><p>account name</p>
  657. </section>
  658. </dd>
  659. </dl>
  660. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  661. <span class="phpdocumentor-signature__response_type">string</span>
  662. &mdash;
  663. <section class="phpdocumentor-description"><p>account informations</p>
  664. </section>
  665. </article>
  666. <article
  667. class="phpdocumentor-element
  668. -method
  669. -public
  670. "
  671. >
  672. <h4 class="phpdocumentor-element__name" id="method_getAccountAliases">
  673. getAccountAliases()
  674. <a href="classes/Zm-Account.html#method_getAccountAliases" class="headerlink"><i class="fas fa-link"></i></a>
  675. </h4>
  676. <aside class="phpdocumentor-element-found-in">
  677. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  678. :
  679. <span class="phpdocumentor-element-found-in__line">621</span>
  680. </aside>
  681. <p class="phpdocumentor-summary">getAccountAliases</p>
  682. <code class="phpdocumentor-code phpdocumentor-signature ">
  683. <span class="phpdocumentor-signature__visibility">public</span>
  684. <span class="phpdocumentor-signature__name">getAccountAliases</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  685. <section class="phpdocumentor-description"></section>
  686. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  687. <dl class="phpdocumentor-argument-list">
  688. <dt class="phpdocumentor-argument-list__entry">
  689. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  690. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  691. </dt>
  692. <dd class="phpdocumentor-argument-list__definition">
  693. <section class="phpdocumentor-description"><p>account id or account name</p>
  694. </section>
  695. </dd>
  696. <dt class="phpdocumentor-argument-list__entry">
  697. <span class="phpdocumentor-signature__argument__name">$type</span>
  698. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  699. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  700. <dd class="phpdocumentor-argument-list__definition">
  701. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  702. </section>
  703. </dd>
  704. </dl>
  705. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  706. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  707. &mdash;
  708. <section class="phpdocumentor-description"><p>aliases</p>
  709. </section>
  710. </article>
  711. <article
  712. class="phpdocumentor-element
  713. -method
  714. -public
  715. "
  716. >
  717. <h4 class="phpdocumentor-element__name" id="method_getAccountCos">
  718. getAccountCos()
  719. <a href="classes/Zm-Account.html#method_getAccountCos" class="headerlink"><i class="fas fa-link"></i></a>
  720. </h4>
  721. <aside class="phpdocumentor-element-found-in">
  722. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  723. :
  724. <span class="phpdocumentor-element-found-in__line">765</span>
  725. </aside>
  726. <p class="phpdocumentor-summary">getAccountCos</p>
  727. <code class="phpdocumentor-code phpdocumentor-signature ">
  728. <span class="phpdocumentor-signature__visibility">public</span>
  729. <span class="phpdocumentor-signature__name">getAccountCos</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$returnType</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;NAME&quot;</span><span> ]</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  730. <section class="phpdocumentor-description"></section>
  731. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  732. <dl class="phpdocumentor-argument-list">
  733. <dt class="phpdocumentor-argument-list__entry">
  734. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  735. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  736. </dt>
  737. <dd class="phpdocumentor-argument-list__definition">
  738. <section class="phpdocumentor-description"><p>account id or account name</p>
  739. </section>
  740. </dd>
  741. <dt class="phpdocumentor-argument-list__entry">
  742. <span class="phpdocumentor-signature__argument__name">$returnType</span>
  743. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  744. = <span class="phpdocumentor-signature__argument__default-value">&quot;NAME&quot;</span> </dt>
  745. <dd class="phpdocumentor-argument-list__definition">
  746. <section class="phpdocumentor-description"><p>get the COS ID or NAME</p>
  747. </section>
  748. </dd>
  749. <dt class="phpdocumentor-argument-list__entry">
  750. <span class="phpdocumentor-signature__argument__name">$type</span>
  751. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  752. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  753. <dd class="phpdocumentor-argument-list__definition">
  754. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  755. </section>
  756. </dd>
  757. </dl>
  758. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  759. <span class="phpdocumentor-signature__response_type">string</span>
  760. &mdash;
  761. <section class="phpdocumentor-description"><p>COS id or name</p>
  762. </section>
  763. </article>
  764. <article
  765. class="phpdocumentor-element
  766. -method
  767. -public
  768. "
  769. >
  770. <h4 class="phpdocumentor-element__name" id="method_getAccountId">
  771. getAccountId()
  772. <a href="classes/Zm-Account.html#method_getAccountId" class="headerlink"><i class="fas fa-link"></i></a>
  773. </h4>
  774. <aside class="phpdocumentor-element-found-in">
  775. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  776. :
  777. <span class="phpdocumentor-element-found-in__line">202</span>
  778. </aside>
  779. <p class="phpdocumentor-summary">getAccountId</p>
  780. <code class="phpdocumentor-code phpdocumentor-signature ">
  781. <span class="phpdocumentor-signature__visibility">public</span>
  782. <span class="phpdocumentor-signature__name">getAccountId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  783. <section class="phpdocumentor-description"></section>
  784. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  785. <dl class="phpdocumentor-argument-list">
  786. <dt class="phpdocumentor-argument-list__entry">
  787. <span class="phpdocumentor-signature__argument__name">$name</span>
  788. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  789. </dt>
  790. <dd class="phpdocumentor-argument-list__definition">
  791. <section class="phpdocumentor-description"><p>account name</p>
  792. </section>
  793. </dd>
  794. </dl>
  795. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  796. <span class="phpdocumentor-signature__response_type">string</span>
  797. &mdash;
  798. <section class="phpdocumentor-description"><p>account id</p>
  799. </section>
  800. </article>
  801. <article
  802. class="phpdocumentor-element
  803. -method
  804. -public
  805. "
  806. >
  807. <h4 class="phpdocumentor-element__name" id="method_getAccountInfo">
  808. getAccountInfo()
  809. <a href="classes/Zm-Account.html#method_getAccountInfo" class="headerlink"><i class="fas fa-link"></i></a>
  810. </h4>
  811. <aside class="phpdocumentor-element-found-in">
  812. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  813. :
  814. <span class="phpdocumentor-element-found-in__line">271</span>
  815. </aside>
  816. <p class="phpdocumentor-summary">getAccountInfo</p>
  817. <code class="phpdocumentor-code phpdocumentor-signature ">
  818. <span class="phpdocumentor-signature__visibility">public</span>
  819. <span class="phpdocumentor-signature__name">getAccountInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  820. <section class="phpdocumentor-description"></section>
  821. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  822. <dl class="phpdocumentor-argument-list">
  823. <dt class="phpdocumentor-argument-list__entry">
  824. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  825. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  826. </dt>
  827. <dd class="phpdocumentor-argument-list__definition">
  828. <section class="phpdocumentor-description"><p>account id or account name</p>
  829. </section>
  830. </dd>
  831. <dt class="phpdocumentor-argument-list__entry">
  832. <span class="phpdocumentor-signature__argument__name">$type</span>
  833. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  834. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  835. <dd class="phpdocumentor-argument-list__definition">
  836. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  837. </section>
  838. </dd>
  839. </dl>
  840. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  841. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  842. &mdash;
  843. <section class="phpdocumentor-description"><p>informations</p>
  844. </section>
  845. </article>
  846. <article
  847. class="phpdocumentor-element
  848. -method
  849. -public
  850. "
  851. >
  852. <h4 class="phpdocumentor-element__name" id="method_getAccountOption">
  853. getAccountOption()
  854. <a href="classes/Zm-Account.html#method_getAccountOption" class="headerlink"><i class="fas fa-link"></i></a>
  855. </h4>
  856. <aside class="phpdocumentor-element-found-in">
  857. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  858. :
  859. <span class="phpdocumentor-element-found-in__line">344</span>
  860. </aside>
  861. <p class="phpdocumentor-summary">getAccountOption</p>
  862. <code class="phpdocumentor-code phpdocumentor-signature ">
  863. <span class="phpdocumentor-signature__visibility">public</span>
  864. <span class="phpdocumentor-signature__name">getAccountOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$optName</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">$multisingle</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">ATTR_SINGLEVALUE</span><span> ]</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  865. <section class="phpdocumentor-description"></section>
  866. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  867. <dl class="phpdocumentor-argument-list">
  868. <dt class="phpdocumentor-argument-list__entry">
  869. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  870. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  871. </dt>
  872. <dd class="phpdocumentor-argument-list__definition">
  873. <section class="phpdocumentor-description"><p>account id or account name</p>
  874. </section>
  875. </dd>
  876. <dt class="phpdocumentor-argument-list__entry">
  877. <span class="phpdocumentor-signature__argument__name">$optName</span>
  878. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  879. </dt>
  880. <dd class="phpdocumentor-argument-list__definition">
  881. <section class="phpdocumentor-description"><p>name of the option to get</p>
  882. </section>
  883. </dd>
  884. <dt class="phpdocumentor-argument-list__entry">
  885. <span class="phpdocumentor-signature__argument__name">$multisingle</span>
  886. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  887. = <span class="phpdocumentor-signature__argument__default-value">ATTR_SINGLEVALUE</span> </dt>
  888. <dd class="phpdocumentor-argument-list__definition">
  889. <section class="phpdocumentor-description"><p>(ATTR_SINGLEVALUE, ATTR_MULTIVALUE)</p>
  890. </section>
  891. </dd>
  892. <dt class="phpdocumentor-argument-list__entry">
  893. <span class="phpdocumentor-signature__argument__name">$type</span>
  894. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  895. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  896. <dd class="phpdocumentor-argument-list__definition">
  897. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  898. </section>
  899. </dd>
  900. </dl>
  901. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  902. <span class="phpdocumentor-signature__response_type">string</span>
  903. &mdash;
  904. <section class="phpdocumentor-description"><p>option</p>
  905. </section>
  906. </article>
  907. <article
  908. class="phpdocumentor-element
  909. -method
  910. -public
  911. "
  912. >
  913. <h4 class="phpdocumentor-element__name" id="method_getAccountOptions">
  914. getAccountOptions()
  915. <a href="classes/Zm-Account.html#method_getAccountOptions" class="headerlink"><i class="fas fa-link"></i></a>
  916. </h4>
  917. <aside class="phpdocumentor-element-found-in">
  918. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  919. :
  920. <span class="phpdocumentor-element-found-in__line">380</span>
  921. </aside>
  922. <p class="phpdocumentor-summary">getAccountOptions</p>
  923. <code class="phpdocumentor-code phpdocumentor-signature ">
  924. <span class="phpdocumentor-signature__visibility">public</span>
  925. <span class="phpdocumentor-signature__name">getAccountOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  926. <section class="phpdocumentor-description"></section>
  927. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  928. <dl class="phpdocumentor-argument-list">
  929. <dt class="phpdocumentor-argument-list__entry">
  930. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  931. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  932. </dt>
  933. <dd class="phpdocumentor-argument-list__definition">
  934. <section class="phpdocumentor-description"><p>account id or account name</p>
  935. </section>
  936. </dd>
  937. <dt class="phpdocumentor-argument-list__entry">
  938. <span class="phpdocumentor-signature__argument__name">$type</span>
  939. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  940. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  941. <dd class="phpdocumentor-argument-list__definition">
  942. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  943. </section>
  944. </dd>
  945. </dl>
  946. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  947. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  948. &mdash;
  949. <section class="phpdocumentor-description"><p>options</p>
  950. </section>
  951. </article>
  952. <article
  953. class="phpdocumentor-element
  954. -method
  955. -public
  956. "
  957. >
  958. <h4 class="phpdocumentor-element__name" id="method_getAccountStatus">
  959. getAccountStatus()
  960. <a href="classes/Zm-Account.html#method_getAccountStatus" class="headerlink"><i class="fas fa-link"></i></a>
  961. </h4>
  962. <aside class="phpdocumentor-element-found-in">
  963. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  964. :
  965. <span class="phpdocumentor-element-found-in__line">714</span>
  966. </aside>
  967. <p class="phpdocumentor-summary">getAccountStatus</p>
  968. <code class="phpdocumentor-code phpdocumentor-signature ">
  969. <span class="phpdocumentor-signature__visibility">public</span>
  970. <span class="phpdocumentor-signature__name">getAccountStatus</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  971. <section class="phpdocumentor-description"></section>
  972. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  973. <dl class="phpdocumentor-argument-list">
  974. <dt class="phpdocumentor-argument-list__entry">
  975. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  976. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  977. </dt>
  978. <dd class="phpdocumentor-argument-list__definition">
  979. <section class="phpdocumentor-description"><p>account id or account name</p>
  980. </section>
  981. </dd>
  982. <dt class="phpdocumentor-argument-list__entry">
  983. <span class="phpdocumentor-signature__argument__name">$type</span>
  984. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  985. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  986. <dd class="phpdocumentor-argument-list__definition">
  987. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  988. </section>
  989. </dd>
  990. </dl>
  991. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  992. <span class="phpdocumentor-signature__response_type">string</span>
  993. &mdash;
  994. <section class="phpdocumentor-description"><p>status</p>
  995. </section>
  996. </article>
  997. <article
  998. class="phpdocumentor-element
  999. -method
  1000. -public
  1001. -deprecated "
  1002. >
  1003. <h4 class="phpdocumentor-element__name" id="method_getAllAccounts">
  1004. getAllAccounts()
  1005. <a href="classes/Zm-Account.html#method_getAllAccounts" class="headerlink"><i class="fas fa-link"></i></a>
  1006. </h4>
  1007. <aside class="phpdocumentor-element-found-in">
  1008. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1009. :
  1010. <span class="phpdocumentor-element-found-in__line">54</span>
  1011. </aside>
  1012. <p class="phpdocumentor-summary">getAllAccounts</p>
  1013. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1014. <span class="phpdocumentor-signature__visibility">public</span>
  1015. <span class="phpdocumentor-signature__name">getAllAccounts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameDomain</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1016. <section class="phpdocumentor-description"></section>
  1017. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1018. <dl class="phpdocumentor-argument-list">
  1019. <dt class="phpdocumentor-argument-list__entry">
  1020. <span class="phpdocumentor-signature__argument__name">$idOrNameDomain</span>
  1021. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1022. </dt>
  1023. <dd class="phpdocumentor-argument-list__definition">
  1024. <section class="phpdocumentor-description"><p>domain id or domain name</p>
  1025. </section>
  1026. </dd>
  1027. <dt class="phpdocumentor-argument-list__entry">
  1028. <span class="phpdocumentor-signature__argument__name">$type</span>
  1029. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1030. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1031. <dd class="phpdocumentor-argument-list__definition">
  1032. <section class="phpdocumentor-description"><p>value of the domain (auto, name, id)</p>
  1033. </section>
  1034. </dd>
  1035. </dl>
  1036. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1037. Tags
  1038. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1039. </h5>
  1040. <dl class="phpdocumentor-tag-list">
  1041. <dt class="phpdocumentor-tag-list__entry">
  1042. <span class="phpdocumentor-tag__name">deprecated</span>
  1043. </dt>
  1044. <dd class="phpdocumentor-tag-list__definition">
  1045. <section class="phpdocumentor-description"><p>it may take a long time to complete and fail on servers with lots of accounts</p>
  1046. <p>use fetchAccounts instead</p>
  1047. </section>
  1048. </dd>
  1049. </dl>
  1050. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1051. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1052. &mdash;
  1053. <section class="phpdocumentor-description"><p>informations for all accounts</p>
  1054. </section>
  1055. </article>
  1056. <article
  1057. class="phpdocumentor-element
  1058. -method
  1059. -public
  1060. "
  1061. >
  1062. <h4 class="phpdocumentor-element__name" id="method_getAllCos">
  1063. getAllCos()
  1064. <a href="classes/Zm-Account.html#method_getAllCos" class="headerlink"><i class="fas fa-link"></i></a>
  1065. </h4>
  1066. <aside class="phpdocumentor-element-found-in">
  1067. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1068. :
  1069. <span class="phpdocumentor-element-found-in__line">851</span>
  1070. </aside>
  1071. <p class="phpdocumentor-summary">getAllCos</p>
  1072. <code class="phpdocumentor-code phpdocumentor-signature ">
  1073. <span class="phpdocumentor-signature__visibility">public</span>
  1074. <span class="phpdocumentor-signature__name">getAllCos</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1075. <section class="phpdocumentor-description"></section>
  1076. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1077. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1078. &mdash;
  1079. <section class="phpdocumentor-description"><p>informations</p>
  1080. </section>
  1081. </article>
  1082. <article
  1083. class="phpdocumentor-element
  1084. -method
  1085. -public
  1086. "
  1087. >
  1088. <h4 class="phpdocumentor-element__name" id="method_getCosId">
  1089. getCosId()
  1090. <a href="classes/Zm-Account.html#method_getCosId" class="headerlink"><i class="fas fa-link"></i></a>
  1091. </h4>
  1092. <aside class="phpdocumentor-element-found-in">
  1093. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1094. :
  1095. <span class="phpdocumentor-element-found-in__line">822</span>
  1096. </aside>
  1097. <p class="phpdocumentor-summary">getCosId</p>
  1098. <code class="phpdocumentor-code phpdocumentor-signature ">
  1099. <span class="phpdocumentor-signature__visibility">public</span>
  1100. <span class="phpdocumentor-signature__name">getCosId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1101. <section class="phpdocumentor-description"></section>
  1102. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1103. <dl class="phpdocumentor-argument-list">
  1104. <dt class="phpdocumentor-argument-list__entry">
  1105. <span class="phpdocumentor-signature__argument__name">$name</span>
  1106. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1107. </dt>
  1108. <dd class="phpdocumentor-argument-list__definition">
  1109. <section class="phpdocumentor-description"><p>the COS name</p>
  1110. </section>
  1111. </dd>
  1112. </dl>
  1113. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1114. <span class="phpdocumentor-signature__response_type">string</span>
  1115. &mdash;
  1116. <section class="phpdocumentor-description"><p>COS id</p>
  1117. </section>
  1118. </article>
  1119. <article
  1120. class="phpdocumentor-element
  1121. -method
  1122. -public
  1123. "
  1124. >
  1125. <h4 class="phpdocumentor-element__name" id="method_getMailbox">
  1126. getMailbox()
  1127. <a href="classes/Zm-Account.html#method_getMailbox" class="headerlink"><i class="fas fa-link"></i></a>
  1128. </h4>
  1129. <aside class="phpdocumentor-element-found-in">
  1130. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1131. :
  1132. <span class="phpdocumentor-element-found-in__line">304</span>
  1133. </aside>
  1134. <p class="phpdocumentor-summary">getMailbox</p>
  1135. <code class="phpdocumentor-code phpdocumentor-signature ">
  1136. <span class="phpdocumentor-signature__visibility">public</span>
  1137. <span class="phpdocumentor-signature__name">getMailbox</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1138. <section class="phpdocumentor-description"></section>
  1139. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1140. <dl class="phpdocumentor-argument-list">
  1141. <dt class="phpdocumentor-argument-list__entry">
  1142. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1143. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1144. </dt>
  1145. <dd class="phpdocumentor-argument-list__definition">
  1146. <section class="phpdocumentor-description"><p>account id or account name</p>
  1147. </section>
  1148. </dd>
  1149. <dt class="phpdocumentor-argument-list__entry">
  1150. <span class="phpdocumentor-signature__argument__name">$type</span>
  1151. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1152. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1153. <dd class="phpdocumentor-argument-list__definition">
  1154. </dd>
  1155. </dl>
  1156. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1157. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1158. &mdash;
  1159. <section class="phpdocumentor-description"><p>informations</p>
  1160. </section>
  1161. </article>
  1162. <article
  1163. class="phpdocumentor-element
  1164. -method
  1165. -public
  1166. "
  1167. >
  1168. <h4 class="phpdocumentor-element__name" id="method_getQuota">
  1169. getQuota()
  1170. <a href="classes/Zm-Account.html#method_getQuota" class="headerlink"><i class="fas fa-link"></i></a>
  1171. </h4>
  1172. <aside class="phpdocumentor-element-found-in">
  1173. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1174. :
  1175. <span class="phpdocumentor-element-found-in__line">172</span>
  1176. </aside>
  1177. <p class="phpdocumentor-summary">getQuota</p>
  1178. <code class="phpdocumentor-code phpdocumentor-signature ">
  1179. <span class="phpdocumentor-signature__visibility">public</span>
  1180. <span class="phpdocumentor-signature__name">getQuota</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1181. <section class="phpdocumentor-description"></section>
  1182. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1183. <dl class="phpdocumentor-argument-list">
  1184. <dt class="phpdocumentor-argument-list__entry">
  1185. <span class="phpdocumentor-signature__argument__name">$name</span>
  1186. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1187. </dt>
  1188. <dd class="phpdocumentor-argument-list__definition">
  1189. <section class="phpdocumentor-description"><p>account name</p>
  1190. </section>
  1191. </dd>
  1192. </dl>
  1193. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1194. <span class="phpdocumentor-signature__response_type">string</span>
  1195. &mdash;
  1196. <section class="phpdocumentor-description"><p>account informations</p>
  1197. </section>
  1198. </article>
  1199. <article
  1200. class="phpdocumentor-element
  1201. -method
  1202. -public
  1203. "
  1204. >
  1205. <h4 class="phpdocumentor-element__name" id="method_modifyAccount">
  1206. modifyAccount()
  1207. <a href="classes/Zm-Account.html#method_modifyAccount" class="headerlink"><i class="fas fa-link"></i></a>
  1208. </h4>
  1209. <aside class="phpdocumentor-element-found-in">
  1210. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1211. :
  1212. <span class="phpdocumentor-element-found-in__line">500</span>
  1213. </aside>
  1214. <p class="phpdocumentor-summary">modifyAccount</p>
  1215. <code class="phpdocumentor-code phpdocumentor-signature ">
  1216. <span class="phpdocumentor-signature__visibility">public</span>
  1217. <span class="phpdocumentor-signature__name">modifyAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attrs</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1218. <section class="phpdocumentor-description"></section>
  1219. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1220. <dl class="phpdocumentor-argument-list">
  1221. <dt class="phpdocumentor-argument-list__entry">
  1222. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1223. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1224. </dt>
  1225. <dd class="phpdocumentor-argument-list__definition">
  1226. <section class="phpdocumentor-description"><p>account id or account name</p>
  1227. </section>
  1228. </dd>
  1229. <dt class="phpdocumentor-argument-list__entry">
  1230. <span class="phpdocumentor-signature__argument__name">$attrs</span>
  1231. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1232. = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
  1233. <dd class="phpdocumentor-argument-list__definition">
  1234. <section class="phpdocumentor-description"><p>an array containing the account attributes to be set</p>
  1235. </section>
  1236. </dd>
  1237. <dt class="phpdocumentor-argument-list__entry">
  1238. <span class="phpdocumentor-signature__argument__name">$type</span>
  1239. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1240. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1241. <dd class="phpdocumentor-argument-list__definition">
  1242. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  1243. </section>
  1244. </dd>
  1245. </dl>
  1246. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1247. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1248. &mdash;
  1249. <section class="phpdocumentor-description"><p>informations</p>
  1250. </section>
  1251. </article>
  1252. <article
  1253. class="phpdocumentor-element
  1254. -method
  1255. -public
  1256. "
  1257. >
  1258. <h4 class="phpdocumentor-element__name" id="method_removeAccountAlias">
  1259. removeAccountAlias()
  1260. <a href="classes/Zm-Account.html#method_removeAccountAlias" class="headerlink"><i class="fas fa-link"></i></a>
  1261. </h4>
  1262. <aside class="phpdocumentor-element-found-in">
  1263. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1264. :
  1265. <span class="phpdocumentor-element-found-in__line">674</span>
  1266. </aside>
  1267. <p class="phpdocumentor-summary">removeAccountAlias</p>
  1268. <code class="phpdocumentor-code phpdocumentor-signature ">
  1269. <span class="phpdocumentor-signature__visibility">public</span>
  1270. <span class="phpdocumentor-signature__name">removeAccountAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$alias</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1271. <section class="phpdocumentor-description"></section>
  1272. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1273. <dl class="phpdocumentor-argument-list">
  1274. <dt class="phpdocumentor-argument-list__entry">
  1275. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1276. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1277. </dt>
  1278. <dd class="phpdocumentor-argument-list__definition">
  1279. <section class="phpdocumentor-description"><p>account id or account name</p>
  1280. </section>
  1281. </dd>
  1282. <dt class="phpdocumentor-argument-list__entry">
  1283. <span class="phpdocumentor-signature__argument__name">$alias</span>
  1284. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1285. </dt>
  1286. <dd class="phpdocumentor-argument-list__definition">
  1287. <section class="phpdocumentor-description"><p>account alias</p>
  1288. </section>
  1289. </dd>
  1290. <dt class="phpdocumentor-argument-list__entry">
  1291. <span class="phpdocumentor-signature__argument__name">$type</span>
  1292. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1293. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1294. <dd class="phpdocumentor-argument-list__definition">
  1295. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  1296. </section>
  1297. </dd>
  1298. </dl>
  1299. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1300. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1301. &mdash;
  1302. <section class="phpdocumentor-description"><p>informations</p>
  1303. </section>
  1304. </article>
  1305. <article
  1306. class="phpdocumentor-element
  1307. -method
  1308. -public
  1309. "
  1310. >
  1311. <h4 class="phpdocumentor-element__name" id="method_renameAccount">
  1312. renameAccount()
  1313. <a href="classes/Zm-Account.html#method_renameAccount" class="headerlink"><i class="fas fa-link"></i></a>
  1314. </h4>
  1315. <aside class="phpdocumentor-element-found-in">
  1316. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1317. :
  1318. <span class="phpdocumentor-element-found-in__line">542</span>
  1319. </aside>
  1320. <p class="phpdocumentor-summary">renameAccount</p>
  1321. <code class="phpdocumentor-code phpdocumentor-signature ">
  1322. <span class="phpdocumentor-signature__visibility">public</span>
  1323. <span class="phpdocumentor-signature__name">renameAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$newName</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1324. <section class="phpdocumentor-description"></section>
  1325. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1326. <dl class="phpdocumentor-argument-list">
  1327. <dt class="phpdocumentor-argument-list__entry">
  1328. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1329. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1330. </dt>
  1331. <dd class="phpdocumentor-argument-list__definition">
  1332. <section class="phpdocumentor-description"><p>account id or account name</p>
  1333. </section>
  1334. </dd>
  1335. <dt class="phpdocumentor-argument-list__entry">
  1336. <span class="phpdocumentor-signature__argument__name">$newName</span>
  1337. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1338. </dt>
  1339. <dd class="phpdocumentor-argument-list__definition">
  1340. <section class="phpdocumentor-description"><p>new account name</p>
  1341. </section>
  1342. </dd>
  1343. <dt class="phpdocumentor-argument-list__entry">
  1344. <span class="phpdocumentor-signature__argument__name">$type</span>
  1345. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1346. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1347. <dd class="phpdocumentor-argument-list__definition">
  1348. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  1349. </section>
  1350. </dd>
  1351. </dl>
  1352. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1353. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1354. &mdash;
  1355. <section class="phpdocumentor-description"><p>informations</p>
  1356. </section>
  1357. </article>
  1358. <article
  1359. class="phpdocumentor-element
  1360. -method
  1361. -public
  1362. "
  1363. >
  1364. <h4 class="phpdocumentor-element__name" id="method_setAccountCos">
  1365. setAccountCos()
  1366. <a href="classes/Zm-Account.html#method_setAccountCos" class="headerlink"><i class="fas fa-link"></i></a>
  1367. </h4>
  1368. <aside class="phpdocumentor-element-found-in">
  1369. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1370. :
  1371. <span class="phpdocumentor-element-found-in__line">807</span>
  1372. </aside>
  1373. <p class="phpdocumentor-summary">setAccountCos</p>
  1374. <code class="phpdocumentor-code phpdocumentor-signature ">
  1375. <span class="phpdocumentor-signature__visibility">public</span>
  1376. <span class="phpdocumentor-signature__name">setAccountCos</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$cosName</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1377. <section class="phpdocumentor-description"></section>
  1378. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1379. <dl class="phpdocumentor-argument-list">
  1380. <dt class="phpdocumentor-argument-list__entry">
  1381. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1382. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1383. </dt>
  1384. <dd class="phpdocumentor-argument-list__definition">
  1385. <section class="phpdocumentor-description"><p>account id or account name</p>
  1386. </section>
  1387. </dd>
  1388. <dt class="phpdocumentor-argument-list__entry">
  1389. <span class="phpdocumentor-signature__argument__name">$cosName</span>
  1390. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1391. </dt>
  1392. <dd class="phpdocumentor-argument-list__definition">
  1393. <section class="phpdocumentor-description"><p>the COS name</p>
  1394. </section>
  1395. </dd>
  1396. <dt class="phpdocumentor-argument-list__entry">
  1397. <span class="phpdocumentor-signature__argument__name">$type</span>
  1398. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1399. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1400. <dd class="phpdocumentor-argument-list__definition">
  1401. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  1402. </section>
  1403. </dd>
  1404. </dl>
  1405. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1406. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1407. &mdash;
  1408. <section class="phpdocumentor-description"><p>informations</p>
  1409. </section>
  1410. </article>
  1411. <article
  1412. class="phpdocumentor-element
  1413. -method
  1414. -public
  1415. "
  1416. >
  1417. <h4 class="phpdocumentor-element__name" id="method_setAccountPassword">
  1418. setAccountPassword()
  1419. <a href="classes/Zm-Account.html#method_setAccountPassword" class="headerlink"><i class="fas fa-link"></i></a>
  1420. </h4>
  1421. <aside class="phpdocumentor-element-found-in">
  1422. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1423. :
  1424. <span class="phpdocumentor-element-found-in__line">457</span>
  1425. </aside>
  1426. <p class="phpdocumentor-summary">setAccountPassword</p>
  1427. <code class="phpdocumentor-code phpdocumentor-signature ">
  1428. <span class="phpdocumentor-signature__visibility">public</span>
  1429. <span class="phpdocumentor-signature__name">setAccountPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1430. <section class="phpdocumentor-description"></section>
  1431. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1432. <dl class="phpdocumentor-argument-list">
  1433. <dt class="phpdocumentor-argument-list__entry">
  1434. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1435. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1436. </dt>
  1437. <dd class="phpdocumentor-argument-list__definition">
  1438. <section class="phpdocumentor-description"><p>account id or account name</p>
  1439. </section>
  1440. </dd>
  1441. <dt class="phpdocumentor-argument-list__entry">
  1442. <span class="phpdocumentor-signature__argument__name">$password</span>
  1443. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1444. </dt>
  1445. <dd class="phpdocumentor-argument-list__definition">
  1446. <section class="phpdocumentor-description"><p>password</p>
  1447. </section>
  1448. </dd>
  1449. <dt class="phpdocumentor-argument-list__entry">
  1450. <span class="phpdocumentor-signature__argument__name">$type</span>
  1451. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1452. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1453. <dd class="phpdocumentor-argument-list__definition">
  1454. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  1455. </section>
  1456. </dd>
  1457. </dl>
  1458. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1459. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1460. &mdash;
  1461. <section class="phpdocumentor-description"><p>informations</p>
  1462. </section>
  1463. </article>
  1464. <article
  1465. class="phpdocumentor-element
  1466. -method
  1467. -public
  1468. "
  1469. >
  1470. <h4 class="phpdocumentor-element__name" id="method_setAccountStatus">
  1471. setAccountStatus()
  1472. <a href="classes/Zm-Account.html#method_setAccountStatus" class="headerlink"><i class="fas fa-link"></i></a>
  1473. </h4>
  1474. <aside class="phpdocumentor-element-found-in">
  1475. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Account.php"><a href="files/zm-account.html"><abbr title="Zm/Account.php">Account.php</abbr></a></abbr>
  1476. :
  1477. <span class="phpdocumentor-element-found-in__line">726</span>
  1478. </aside>
  1479. <p class="phpdocumentor-summary">setAccountStatus</p>
  1480. <code class="phpdocumentor-code phpdocumentor-signature ">
  1481. <span class="phpdocumentor-signature__visibility">public</span>
  1482. <span class="phpdocumentor-signature__name">setAccountStatus</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameAccount</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">$status</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">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1483. <section class="phpdocumentor-description"></section>
  1484. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1485. <dl class="phpdocumentor-argument-list">
  1486. <dt class="phpdocumentor-argument-list__entry">
  1487. <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
  1488. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1489. </dt>
  1490. <dd class="phpdocumentor-argument-list__definition">
  1491. <section class="phpdocumentor-description"><p>account id or account name</p>
  1492. </section>
  1493. </dd>
  1494. <dt class="phpdocumentor-argument-list__entry">
  1495. <span class="phpdocumentor-signature__argument__name">$status</span>
  1496. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1497. </dt>
  1498. <dd class="phpdocumentor-argument-list__definition">
  1499. <section class="phpdocumentor-description"><p>the status (active, maintenance, pending, locked, closed)</p>
  1500. </section>
  1501. </dd>
  1502. <dt class="phpdocumentor-argument-list__entry">
  1503. <span class="phpdocumentor-signature__argument__name">$type</span>
  1504. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1505. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  1506. <dd class="phpdocumentor-argument-list__definition">
  1507. <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
  1508. </section>
  1509. </dd>
  1510. </dl>
  1511. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1512. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1513. &mdash;
  1514. <section class="phpdocumentor-description"><p>informations</p>
  1515. </section>
  1516. </article>
  1517. </section>
  1518. </article>
  1519. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1520. <section class="phpdocumentor-search-results__dialog">
  1521. <header class="phpdocumentor-search-results__header">
  1522. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1523. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1524. </header>
  1525. <section class="phpdocumentor-search-results__body">
  1526. <ul class="phpdocumentor-search-results__entries"></ul>
  1527. </section>
  1528. </section>
  1529. </section>
  1530. </div>
  1531. </div>
  1532. <a href="classes/Zm-Account.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1533. </main>
  1534. <script>
  1535. cssVars({});
  1536. </script>
  1537. </body>
  1538. </html>