|
@@ -0,0 +1,1900 @@
|
|
|
|
|
+<!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 Kerio accounts via SOAP</p>
|
|
|
|
|
+
|
|
|
|
|
+ <section class="phpdocumentor-description"><p>You may create, modify, rename, delete and get the attributes of a Kerio 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>
|