| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Documentation</title>
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <base href="../">
- <link rel="icon" href="images/favicon.ico"/>
- <link rel="stylesheet" href="css/normalize.css">
- <link rel="stylesheet" href="css/base.css">
- <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
- <link rel="stylesheet" href="css/template.css">
- <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" />
- <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
- <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
- <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
- <script src="js/search.js"></script>
- <script defer src="js/searchIndex.js"></script>
- </head>
- <body id="top">
- <header class="phpdocumentor-header phpdocumentor-section">
- <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
- <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
- <label class="phpdocumentor-header__menu-icon" for="menu-button">
- <i class="fas fa-bars"></i>
- </label>
- <section data-search-form class="phpdocumentor-search">
- <label>
- <span class="visually-hidden">Search for</span>
- <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
- <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
- <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
- </svg>
- <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
- </label>
- </section>
- <nav class="phpdocumentor-topnav">
- <ul class="phpdocumentor-topnav__menu">
- </ul>
- </nav>
- </header>
- <main class="phpdocumentor">
- <div class="phpdocumentor-section">
- <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
- <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
- Menu
- </label>
- <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
-
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
- <h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
- </section>
-
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
- </section>
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
- </section>
- </aside>
- <div class="phpdocumentor-column -eight phpdocumentor-content">
- <ul class="phpdocumentor-breadcrumbs">
- <li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
- </ul>
- <article class="phpdocumentor-element -class">
- <h2 class="phpdocumentor-content__title">
- Zm_Account
-
-
-
- </h2>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">27</span>
- </aside>
- <p class="phpdocumentor-summary">Zm_Account is a class which allows to manage Zimbra accounts via SOAP</p>
- <section class="phpdocumentor-description"><p>You may create, modify, rename, delete and get the attributes of a Zimbra account using this class</p>
- <p>For the usage examples of all class methods check the source code of test.php</p>
- </section>
- <h3 id="toc">
- Table of Contents
- <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <dl class="phpdocumentor-table-of-contents">
- <dt class="phpdocumentor-table-of-contents__entry -property -private">
- <a href="classes/Zm-Account.html#property_auth">$auth</a>
- <span>
- : <a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a> </span>
- </dt>
- <dd>$auth</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method___construct">__construct()</a>
- <span>
- : mixed </span>
- </dt>
- <dd>Constructor</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_accountExists">accountExists()</a>
- <span>
- : bool </span>
- </dt>
- <dd>accountExists</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_addAccountAlias">addAccountAlias()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>addAccountAlias</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_createAccount">createAccount()</a>
- <span>
- : string </span>
- </dt>
- <dd>createAccount</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_deleteAccount">deleteAccount()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>deleteAccount</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_expireAccountSessions">expireAccountSessions()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>expireAccountSessions</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_fetchAccounts">fetchAccounts()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>fetchAccounts</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccount">getAccount()</a>
- <span>
- : string </span>
- </dt>
- <dd>getAccount</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountAliases">getAccountAliases()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>getAccountAliases</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountCos">getAccountCos()</a>
- <span>
- : string </span>
- </dt>
- <dd>getAccountCos</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountId">getAccountId()</a>
- <span>
- : string </span>
- </dt>
- <dd>getAccountId</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountInfo">getAccountInfo()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>getAccountInfo</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountOption">getAccountOption()</a>
- <span>
- : string </span>
- </dt>
- <dd>getAccountOption</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountOptions">getAccountOptions()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>getAccountOptions</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAccountStatus">getAccountStatus()</a>
- <span>
- : string </span>
- </dt>
- <dd>getAccountStatus</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAllAccounts">getAllAccounts()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>getAllAccounts</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getAllCos">getAllCos()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>getAllCos</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getCosId">getCosId()</a>
- <span>
- : string </span>
- </dt>
- <dd>getCosId</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getMailbox">getMailbox()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>getMailbox</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_getQuota">getQuota()</a>
- <span>
- : string </span>
- </dt>
- <dd>getQuota</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_modifyAccount">modifyAccount()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>modifyAccount</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_removeAccountAlias">removeAccountAlias()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>removeAccountAlias</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_renameAccount">renameAccount()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>renameAccount</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_setAccountCos">setAccountCos()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>setAccountCos</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_setAccountPassword">setAccountPassword()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>setAccountPassword</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/Zm-Account.html#method_setAccountStatus">setAccountStatus()</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>setAccountStatus</dd>
- </dl>
-
-
- <section class="phpdocumentor-properties">
- <h3 class="phpdocumentor-elements__header" id="properties">
- Properties
- <a href="classes/Zm-Account.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="
- phpdocumentor-element
- -property
- -private
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_auth">
- $auth
- <a href="classes/Zm-Account.html#property_auth" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">33</span>
- </aside>
- <p class="phpdocumentor-summary">$auth</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">private</span>
- <span class="phpdocumentor-signature__type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
- <span class="phpdocumentor-signature__name">$auth</span>
- </code>
- <section class="phpdocumentor-description"></section>
-
- </article>
- </section>
- <section class="phpdocumentor-methods">
- <h3 class="phpdocumentor-elements__header" id="methods">
- Methods
- <a href="classes/Zm-Account.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method___construct">
- __construct()
- <a href="classes/Zm-Account.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">39</span>
- </aside>
- <p class="phpdocumentor-summary">Constructor</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <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> </span><span class="phpdocumentor-signature__argument__name">$auth</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$auth</span>
- : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>soap authentication</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">mixed</span>
- —
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_accountExists">
- accountExists()
- <a href="classes/Zm-Account.html#method_accountExists" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">233</span>
- </aside>
- <p class="phpdocumentor-summary">accountExists</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">accountExists</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">bool</span>
- —
- <section class="phpdocumentor-description"><p>exists</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_addAccountAlias">
- addAccountAlias()
- <a href="classes/Zm-Account.html#method_addAccountAlias" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">633</span>
- </aside>
- <p class="phpdocumentor-summary">addAccountAlias</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">addAccountAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$alias</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account alias</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_createAccount">
- createAccount()
- <a href="classes/Zm-Account.html#method_createAccount" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">421</span>
- </aside>
- <p class="phpdocumentor-summary">createAccount</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">createAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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<string|int, mixed> </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>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$name</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$password</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>password</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$attrs</span>
- : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
- = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>an optional array containing the account attributes to be set</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>the new account's id</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_deleteAccount">
- deleteAccount()
- <a href="classes/Zm-Account.html#method_deleteAccount" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">582</span>
- </aside>
- <p class="phpdocumentor-summary">deleteAccount</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">deleteAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_expireAccountSessions">
- expireAccountSessions()
- <a href="classes/Zm-Account.html#method_expireAccountSessions" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">745</span>
- </aside>
- <p class="phpdocumentor-summary">expireAccountSessions</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">expireAccountSessions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_fetchAccounts">
- fetchAccounts()
- <a href="classes/Zm-Account.html#method_fetchAccounts" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">92</span>
- </aside>
- <p class="phpdocumentor-summary">fetchAccounts</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">fetchAccounts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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<string|int, mixed> </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 </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<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$ldapQuery</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>LDAP-style filter string (RFC 2254)</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$attrList</span>
- : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>names of requested attributes</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$nameDomain</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>domain name to restrict search request</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">author</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
- <section class="phpdocumentor-description"><p>Marc Lamouche <a href="mailto:marc.lamouche@ined.fr">marc.lamouche@ined.fr</a></p>
- </section>
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations for accounts as specified in $ldapQuery</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccount">
- getAccount()
- <a href="classes/Zm-Account.html#method_getAccount" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">142</span>
- </aside>
- <p class="phpdocumentor-summary">getAccount</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$name</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account name</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>account informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountAliases">
- getAccountAliases()
- <a href="classes/Zm-Account.html#method_getAccountAliases" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">621</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountAliases</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountAliases</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>aliases</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountCos">
- getAccountCos()
- <a href="classes/Zm-Account.html#method_getAccountCos" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">765</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountCos</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountCos</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$returnType</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"NAME"</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$returnType</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"NAME"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>get the COS ID or NAME</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>COS id or name</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountId">
- getAccountId()
- <a href="classes/Zm-Account.html#method_getAccountId" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">202</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountId</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$name</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account name</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>account id</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountInfo">
- getAccountInfo()
- <a href="classes/Zm-Account.html#method_getAccountInfo" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">271</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountInfo</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountOption">
- getAccountOption()
- <a href="classes/Zm-Account.html#method_getAccountOption" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">344</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountOption</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$optName</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>name of the option to get</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$multisingle</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- = <span class="phpdocumentor-signature__argument__default-value">ATTR_SINGLEVALUE</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>(ATTR_SINGLEVALUE, ATTR_MULTIVALUE)</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>option</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountOptions">
- getAccountOptions()
- <a href="classes/Zm-Account.html#method_getAccountOptions" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">380</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountOptions</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>options</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAccountStatus">
- getAccountStatus()
- <a href="classes/Zm-Account.html#method_getAccountStatus" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">714</span>
- </aside>
- <p class="phpdocumentor-summary">getAccountStatus</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAccountStatus</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>status</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- -deprecated "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAllAccounts">
- getAllAccounts()
- <a href="classes/Zm-Account.html#method_getAllAccounts" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">54</span>
- </aside>
- <p class="phpdocumentor-summary">getAllAccounts</p>
- <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAllAccounts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameDomain</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>domain id or domain name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the domain (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">deprecated</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
- <section class="phpdocumentor-description"><p>it may take a long time to complete and fail on servers with lots of accounts</p>
- <p>use fetchAccounts instead</p>
- </section>
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations for all accounts</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getAllCos">
- getAllCos()
- <a href="classes/Zm-Account.html#method_getAllCos" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">851</span>
- </aside>
- <p class="phpdocumentor-summary">getAllCos</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getAllCos</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getCosId">
- getCosId()
- <a href="classes/Zm-Account.html#method_getCosId" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">822</span>
- </aside>
- <p class="phpdocumentor-summary">getCosId</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getCosId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$name</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>the COS name</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>COS id</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getMailbox">
- getMailbox()
- <a href="classes/Zm-Account.html#method_getMailbox" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">304</span>
- </aside>
- <p class="phpdocumentor-summary">getMailbox</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getMailbox</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
-
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_getQuota">
- getQuota()
- <a href="classes/Zm-Account.html#method_getQuota" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">172</span>
- </aside>
- <p class="phpdocumentor-summary">getQuota</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">getQuota</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$name</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account name</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
- <section class="phpdocumentor-description"><p>account informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_modifyAccount">
- modifyAccount()
- <a href="classes/Zm-Account.html#method_modifyAccount" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">500</span>
- </aside>
- <p class="phpdocumentor-summary">modifyAccount</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">modifyAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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<string|int, mixed> </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$attrs</span>
- : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
- = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>an array containing the account attributes to be set</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_removeAccountAlias">
- removeAccountAlias()
- <a href="classes/Zm-Account.html#method_removeAccountAlias" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">674</span>
- </aside>
- <p class="phpdocumentor-summary">removeAccountAlias</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">removeAccountAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$alias</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account alias</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_renameAccount">
- renameAccount()
- <a href="classes/Zm-Account.html#method_renameAccount" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">542</span>
- </aside>
- <p class="phpdocumentor-summary">renameAccount</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">renameAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$newName</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>new account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setAccountCos">
- setAccountCos()
- <a href="classes/Zm-Account.html#method_setAccountCos" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">807</span>
- </aside>
- <p class="phpdocumentor-summary">setAccountCos</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setAccountCos</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$cosName</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>the COS name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setAccountPassword">
- setAccountPassword()
- <a href="classes/Zm-Account.html#method_setAccountPassword" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">457</span>
- </aside>
- <p class="phpdocumentor-summary">setAccountPassword</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setAccountPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$password</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>password</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setAccountStatus">
- setAccountStatus()
- <a href="classes/Zm-Account.html#method_setAccountStatus" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <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>
- :
- <span class="phpdocumentor-element-found-in__line">726</span>
- </aside>
- <p class="phpdocumentor-summary">setAccountStatus</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setAccountStatus</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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 </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 </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"auto"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
- <section class="phpdocumentor-description"></section>
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$idOrNameAccount</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>account id or account name</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$status</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>the status (active, maintenance, pending, locked, closed)</p>
- </section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$type</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">"auto"</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"><p>value of the account (auto, name, id)</p>
- </section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
- —
- <section class="phpdocumentor-description"><p>informations</p>
- </section>
-
- </article>
- </section>
- </article>
- <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
- <section class="phpdocumentor-search-results__dialog">
- <header class="phpdocumentor-search-results__header">
- <h2 class="phpdocumentor-search-results__title">Search results</h2>
- <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
- </header>
- <section class="phpdocumentor-search-results__body">
- <ul class="phpdocumentor-search-results__entries"></ul>
- </section>
- </section>
- </section>
- </div>
- </div>
- <a href="classes/Zm-Account.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
- </main>
- <script>
- cssVars({});
- </script>
- </body>
- </html>
|