Difference between revisions of "AppSuite:User management"

(Marked deprecated flags)
(42 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">createuser</h2></div></div></div><p><strong class="userinput"><code>createuser</code></strong> is the tool to create new users in a given context. The displayname must be unique in one context.</p><div
+
 
class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left"> -h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left"> --environment</td><td align="left">Show infoabout commandline environment</td></tr><tr><td align="left"> --nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left"> --extendedoptions </td><td align="left">Set this if you want to see all options, use this instead of help option</td></tr><tr><td align="left"> --csv-import &lt;CSV file&gt; </td><td align="left"> Full path to CSV file with
+
== createuser ==
user data to import. This option makes mandatory options obsolete, except credential options (if needed). </td></tr><tr><td align="left"> -c,--contextid &lt;integer&gt;</td><td align="left">The id
+
 
of the context</td></tr><tr><td align="left"> -u,--username &lt;string&gt;</td><td align="left">Username of the user</td></tr><tr><td align="left"> -d,--displayname &lt;string&gt;</td><td
+
'''<code>createuser</code>''' is the tool to create new users in a given context. The displayname must be unique in one context.
align="left">Display name of the user</td></tr><tr><td align="left"> -g,--givenname &lt;string&gt;</td><td align="left">Given name for the user</td></tr><tr><td align="left"> -s,--surname
+
 
&lt;string&gt;</td><td align="left">Surname of the user</td></tr><tr><td align="left"> -p,--password &lt;string&gt;</td><td align="left">Password for the user </td></tr><tr><td align="left">
+
 
-e,--email &lt;string&gt;</td><td align="left">Primary mail address </td></tr><tr><td align="left"> -l,--language &lt;lang&gt;</td><td align="left">Language for the user (de_DE,en_US,
+
=== Parameters ===
fr_FR)</td></tr><tr><td align="left"> -t,--timezone &lt;timezone&gt;</td><td align="left">Timezone of the user (Europe/Berlin)</td></tr><tr><td align="left"> -x,--department &lt;string&gt;</td><td
+
 
align="left">Department of the user </td></tr><tr><td align="left"> -z,--company &lt;string&gt;</td><td align="left">Company of the user </td></tr><tr><td align="left"> -a,--aliases
+
{| border="1"
&lt;string&gt;</td><td align="left">E-Mail aliases of the user, separated by ","</td></tr><tr><td align="left">--access-combination-name &lt;access-combination-name&gt;</td><td align="left">Access
+
|-
combination name</td></tr><tr><td align="left">--addguipreferences &lt;addguipreferences&gt;</td><td align="left">Add a GUI setting (key=value)</td></tr></table></div><p>For the GUI
+
| -h,--help
preferences please also see <a class="ulink" href="http://www.open-xchange.com/wiki/index.php?title=Gui_path">http://www.open-xchange.com/wiki/index.php?title=Gui_path</a> </p><div
+
|Prints a help text
class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">--csv-import &lt;CSV file&gt;</h4></div></div></div><p>Full path to CSV file with user data to
+
|-
import. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.</p><p>With this option you can specify a csv file
+
| --environment
 +
|Show infoabout commandline environment
 +
|-
 +
| --nonl
 +
|Remove all newlines (\n) from output
 +
|-
 +
| --responsetimeout &lt;integer&gt;
 +
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
 +
|-
 +
| --extendedoptions  
 +
|Set this if you want to see all options, use this instead of help option
 +
|-
 +
|csv-import &lt;CSV file&gt;  
 +
| Full path to CSV file with user data to import. This option makes mandatory options obsolete, except credential options (if needed).  
 +
|-
 +
| -c,--contextid &lt;integer&gt;
 +
|The id of the context
 +
|-
 +
| -u,--username &lt;string&gt;
 +
|Username of the user
 +
|-
 +
| -d,--displayname &lt;string&gt;
 +
|Display name of the user
 +
|-
 +
| -g,--givenname &lt;string&gt;
 +
|Given name for the user
 +
|-
 +
| -s,--surname &lt;string&gt;
 +
|Surname of the user
 +
|-
 +
| -p,--password &lt;string&gt;
 +
|Password for the user  
 +
|-
 +
| -e,--email &lt;string&gt;
 +
|Primary mail address  
 +
|-
 +
| -l,--language &lt;lang&gt;
 +
|Language for the user (de_DE,en_US,fr_FR)
 +
|-
 +
| -t,--timezone &lt;timezone&gt;
 +
|Timezone of the user (Europe/Berlin)
 +
|-
 +
| -x,--department &lt;string&gt;
 +
|Department of the user  
 +
|-
 +
| -z,--company &lt;string&gt;
 +
|Company of the user  
 +
|-
 +
| -a,--aliases &lt;string&gt;
 +
|E-Mail aliases of the user, separated by ","
 +
|-
 +
| --access-combination-name &lt;access-combination-name&gt;
 +
|Access combination name
 +
|-
 +
| --addguipreferences &lt;addguipreferences&gt;
 +
|Add a GUI setting (key=value)
 +
|}
 +
For the GUI preferences please also see [http://oxpedia.org/wiki/index.php?title=Gui_path]
 +
 
 +
 
 +
==== --csv-import <CSV file> ====
 +
 
 +
Full path to CSV file with user data to
 +
import. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.
 +
 
 +
 
 +
With this option you can specify a csv file
 
(a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix
 
(a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix
"--".</p><p>This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to
+
"--".
be created, containing the whole data.</p><p>Note that the credentials of the masteradmin in the createcontext call must be given on the command line with the -A and -P options nevertheless - if
+
 
 +
 
 +
This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to
 +
be created, containing the whole data.
 +
 
 +
 
 +
Note that the credentials of the masteradmin in the createcontext call must be given on the command line with the -A and -P options nevertheless - if
 
authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this
 
authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this
 
different behavior is that different contexts have different credentials for the admin user, so they must be set in every line of the csv file. Opposed to this the credentials of the masteradmin
 
different behavior is that different contexts have different credentials for the admin user, so they must be set in every line of the csv file. Opposed to this the credentials of the masteradmin
are always the same.</p></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extended options</h3></div></div></div><div
+
are always the same.
class="informaltable"><table border="0"><tr><td align="left"> --email1 &lt;string&gt;</td><td align="left">Email1</td></tr><tr><td
+
 
align="left"> --birthday &lt;datevalue&gt;</td><td align="left">Birthday</td></tr><tr><td align="left"> --anniversary &lt;datevalue&gt;</td><td align="left">Anniversary</td></tr><tr><td
+
=== Extended options ===
align="left"> --branches &lt;string&gt;</td><td align="left">Branches</td></tr><tr><td align="left"> --business_category &lt;string&gt;</td><td align="left">Business_category</td></tr><tr><td
+
 
align="left"> --postal_code_business &lt;string&gt;</td><td align="left">Postal_code_business</td></tr><tr><td align="left"> --state_business &lt;string&gt;</td><td
+
{| border="1"
align="left">State_business</td></tr><tr><td align="left"> --street_business &lt;string&gt;</td><td align="left">Street_business</td></tr><tr><td align="left"> --telephone_callback
+
|-
&lt;string&gt;</td><td align="left">Telephone_callback</td></tr><tr><td align="left"> --city_home &lt;string&gt;</td><td align="left">City_home</td></tr><tr><td align="left"> --commercial_register
+
| --email1 &lt;string&gt;
&lt;string&gt;</td><td align="left">Commercial_register</td></tr><tr><td align="left"> --country_home &lt;string&gt;</td><td align="left">Country_home</td></tr><tr><td align="left"> --email2
+
|Email1
&lt;string&gt;</td><td align="left">Email2</td></tr><tr><td align="left"> --email3 &lt;string&gt;</td><td align="left">Email3</td></tr><tr><td align="left"> --employeetype &lt;string&gt;</td><td
+
|-
align="left">EmployeeType</td></tr><tr><td align="left"> --fax_business &lt;string&gt;</td><td align="left">Fax_business</td></tr><tr><td align="left"> --fax_home &lt;string&gt;</td><td
+
| --birthday &lt;datevalue&gt;
align="left">Fax_home</td></tr><tr><td align="left"> --fax_other &lt;string&gt;</td><td align="left">Fax_other</td></tr><tr><td align="left"> --imapserver &lt;string&gt;</td><td
+
|Birthday
align="left">ImapServer</td></tr><tr><td align="left"> --imaplogin &lt;string&gt;</td><td align="left">ImapLogin</td></tr><tr><td align="left"> --smtpserver &lt;string&gt;</td><td
+
|-
align="left">SmtpServer</td></tr><tr><td align="left"> --instant_messenger1 &lt;string&gt;</td><td align="left">Instant_messenger1</td></tr><tr><td align="left"> --instant_messenger2
+
| --anniversary &lt;datevalue&gt;
&lt;string&gt;</td><td align="left">Instant_messenger2</td></tr><tr><td align="left"> --telephone_ip &lt;string&gt;</td><td align="left">Telephone_ip</td></tr><tr><td align="left">
+
|Anniversary
--telephone_isdn &lt;string&gt;</td><td align="left">Telephone_isdn</td></tr><tr><td align="left"> --mail_folder_drafts_name &lt;string&gt;</td><td
+
|-
align="left">Mail_folder_drafts_name</td></tr><tr><td align="left"> --mail_folder_sent_name &lt;string&gt;</td><td align="left">Mail_folder_sent_name</td></tr><tr><td align="left">
+
| --branches &lt;string&gt;
--mail_folder_spam_name &lt;string&gt;</td><td align="left">Mail_folder_spam_name</td></tr><tr><td align="left"> --mail_folder_trash_name &lt;string&gt;</td><td
+
|Branches
align="left">Mail_folder_trash_name</td></tr><tr><td align="left"> --manager_name &lt;string&gt;</td><td align="left">Manager_name</td></tr><tr><td align="left"> --marital_status
+
|-
&lt;string&gt;</td><td align="left">Marital_status</td></tr><tr><td align="left"> --cellular_telephone1 &lt;string&gt;</td><td align="left">Cellular_telephone1</td></tr><tr><td align="left">
+
| --business_category &lt;string&gt;
--cellular_telephone2 &lt;string&gt;</td><td align="left">Cellular_telephone2</td></tr><tr><td align="left"> --info &lt;string&gt;</td><td align="left">Info</td></tr><tr><td align="left">
+
|Business_category
--nickname &lt;string&gt;</td><td align="left">Nickname</td></tr><tr><td align="left"> --number_of_children &lt;string&gt;</td><td align="left">Number_of_children</td></tr><tr><td align="left">
+
|-
--note &lt;string&gt;</td><td align="left">Note</td></tr><tr><td align="left"> --number_of_employee &lt;string&gt;</td><td align="left">Number_of_employee</td></tr><tr><td align="left">
+
| --postal_code_business &lt;string&gt;
--telephone_pager &lt;string&gt;</td><td align="left">Telephone_pager</td></tr><tr><td align="left"> --password_expired &lt;booleanvalue&gt;</td><td align="left">Password_expired</td></tr><tr><td
+
|Postal_code_business
align="left"> --telephone_assistant &lt;string&gt;</td><td align="left">Telephone_assistant</td></tr><tr><td align="left"> --telephone_business1 &lt;string&gt;</td><td
+
|-
align="left">Telephone_business1</td></tr><tr><td align="left"> --telephone_business2 &lt;string&gt;</td><td align="left">Telephone_business2</td></tr><tr><td align="left"> --telephone_car
+
| --state_business &lt;string&gt;
&lt;string&gt;</td><td align="left">Telephone_car</td></tr><tr><td align="left"> --telephone_company &lt;string&gt;</td><td align="left">Telephone_company</td></tr><tr><td align="left">
+
|State_business
--telephone_home1 &lt;string&gt;</td><td align="left">Telephone_home1</td></tr><tr><td align="left"> --telephone_home2 &lt;string&gt;</td><td align="left">Telephone_home2</td></tr><tr><td
+
|-
align="left"> --telephone_other &lt;string&gt;</td><td align="left">Telephone_other</td></tr><tr><td align="left"> --postal_code_home &lt;string&gt;</td><td
+
| --street_business &lt;string&gt;
align="left">Postal_code_home</td></tr><tr><td align="left"> --profession &lt;string&gt;</td><td align="left">Profession</td></tr><tr><td align="left"> --telephone_radio &lt;string&gt;</td><td
+
|Street_business
align="left">Telephone_radio</td></tr><tr><td align="left"> --room_number &lt;string&gt;</td><td align="left">Room_number</td></tr><tr><td align="left"> --sales_volume &lt;string&gt;</td><td
+
|-
align="left">Sales_volume</td></tr><tr><td align="left"> --city_other &lt;string&gt;</td><td align="left">City_other</td></tr><tr><td align="left"> --country_other &lt;string&gt;</td><td
+
| --telephone_callback &lt;string&gt;
align="left">Country_other</td></tr><tr><td align="left"> --middle_name &lt;string&gt;</td><td align="left">Middle_name</td></tr><tr><td align="left"> --postal_code_other &lt;string&gt;</td><td
+
|Telephone_callback
align="left">Postal_code_other</td></tr><tr><td align="left"> --state_other &lt;string&gt;</td><td align="left">State_other</td></tr><tr><td align="left"> --street_other &lt;string&gt;</td><td
+
|-
align="left">Street_other</td></tr><tr><td align="left"> --spouse_name &lt;string&gt;</td><td align="left">Spouse_name</td></tr><tr><td align="left"> --state_home &lt;string&gt;</td><td
+
| --city_home &lt;string&gt;
align="left">State_home</td></tr><tr><td align="left"> --street_home &lt;string&gt;</td><td align="left">Street_home</td></tr><tr><td align="left"> --suffix &lt;string&gt;</td><td
+
|City_home
align="left">Suffix</td></tr><tr><td align="left"> --tax_id &lt;string&gt;</td><td align="left">Tax_id</td></tr><tr><td align="left"> --telephone_telex &lt;string&gt;</td><td
+
|-
align="left">Telephone_telex</td></tr><tr><td align="left"> --telephone_ttytdd &lt;string&gt;</td><td align="left">Telephone_ttytdd</td></tr><tr><td align="left"> --uploadFileSizeLimitPerFile
+
| --commercial_register &lt;string&gt;
&lt;string&gt;</td><td align="left">uploadFileSizeLimitPerFile</td></tr><tr><td align="left"> --uploadFileSizeLimit &lt;string&gt;</td><td align="left">uploadFileSizeLimit</td></tr><tr><td
+
|Commercial_register
align="left"> --url &lt;string&gt;</td><td align="left">Url</td></tr><tr><td align="left"> --userfield01 &lt;string&gt;</td><td align="left">Userfield01</td></tr><tr><td align="left">
+
|-
--userfield02 &lt;string&gt;</td><td align="left">Userfield02</td></tr><tr><td align="left"> --userfield03 &lt;string&gt;</td><td align="left">Userfield03</td></tr><tr><td align="left">
+
| --country_home &lt;string&gt;
--userfield04 &lt;string&gt;</td><td align="left">Userfield04</td></tr><tr><td align="left"> --userfield05 &lt;string&gt;</td><td align="left">Userfield05</td></tr><tr><td align="left">
+
|Country_home
--userfield06 &lt;string&gt;</td><td align="left">Userfield06</td></tr><tr><td align="left"> --userfield07 &lt;string&gt;</td><td align="left">Userfield07</td></tr><tr><td align="left">
+
|-
--userfield08 &lt;string&gt;</td><td align="left">Userfield08</td></tr><tr><td align="left"> --userfield09 &lt;string&gt;</td><td align="left">Userfield09</td></tr><tr><td align="left">
+
| --email2 &lt;string&gt;
--userfield10 &lt;string&gt;</td><td align="left">Userfield10</td></tr><tr><td align="left"> --userfield11 &lt;string&gt;</td><td align="left">Userfield11</td></tr><tr><td align="left">
+
|Email2
--userfield12 &lt;string&gt;</td><td align="left">Userfield12</td></tr><tr><td align="left"> --userfield13 &lt;string&gt;</td><td align="left">Userfield13</td></tr><tr><td align="left">
+
|-
--userfield14 &lt;string&gt;</td><td align="left">Userfield14</td></tr><tr><td align="left"> --userfield15 &lt;string&gt;</td><td align="left">Userfield15</td></tr><tr><td align="left">
+
| --email3 &lt;string&gt;
--userfield16 &lt;string&gt;</td><td align="left">Userfield16</td></tr><tr><td align="left"> --userfield17 &lt;string&gt;</td><td align="left">Userfield17</td></tr><tr><td align="left">
+
|Email3
--userfield18 &lt;string&gt;</td><td align="left">Userfield18</td></tr><tr><td align="left"> --userfield19 &lt;string&gt;</td><td align="left">Userfield19</td></tr><tr><td align="left">
+
|-
--userfield20 &lt;string&gt;</td><td align="left">Userfield20</td></tr><tr><td align="left"> --city_business &lt;string&gt;</td><td align="left">City_business</td></tr><tr><td align="left">
+
| --employeetype &lt;string&gt;
--country_business &lt;string&gt;</td><td align="left">Country_business</td></tr><tr><td align="left"> --assistant_name &lt;string&gt;</td><td align="left">Assistant_name</td></tr><tr><td
+
|EmployeeType
align="left"> --telephone_primary &lt;string&gt;</td><td align="left">Telephone_primary</td></tr><tr><td align="left"> --categories &lt;string&gt;</td><td align="left">Categories</td></tr><tr><td
+
|-
align="left"> --mail_folder_confirmed_ham_name &lt;string&gt;</td><td align="left">Mail_folder_confirmed_ham_name</td></tr><tr><td align="left"> --mail_folder_confirmed_spam_name
+
| --fax_business &lt;string&gt;
&lt;string&gt;</td><td align="left">Mail_folder_confirmed_spam_name</td></tr><tr><td align="left"> --Spam_filter_capabilities_enabled &lt;booleanvalue&gt;</td><td
+
|Fax_business
align="left">Spam_filter_capabilities_enabled</td></tr><tr><td align="left"> --mailenabled &lt;true/false&gt;</td><td align="left">Mailenabled</td></tr><tr><td align="left"> --defaultsenderaddress
+
|-
&lt;stringvalue&gt;</td><td align="left">DefaultSenderAddress</td></tr><tr><td align="left"> --title &lt;string&gt;</td><td align="left">Title</td></tr><tr><td align="left"> --position
+
| --fax_home &lt;string&gt;
&lt;string&gt;</td><td align="left">Position</td></tr><tr><td align="left"> --access-calendar &lt;on/off&gt;</td><td align="left">Calendar module (Default is off)</td></tr><tr><td align="left">
+
|Fax_home
--access-contacts &lt;on/off&gt;</td><td align="left">Contact module access (Default is on)</td></tr><tr><td align="left"> --access-delegate-tasks &lt;on/off&gt;</td><td align="left">Delegate
+
|-
tasks access (Default is off)</td></tr><tr><td align="left"> --access-edit-public-folder &lt;on/off&gt;</td><td align="left">Edit public folder access (Default is off)</td></tr><tr><td
+
| --fax_other &lt;string&gt;
align="left"> --access-forum &lt;on/off&gt;</td><td align="left">Forum module access (Default is off)</td></tr><tr><td align="left"> --access-ical &lt;on/off&gt;</td><td align="left">Ical module
+
|Fax_other
access (Default is off)</td></tr><tr><td align="left"> --access-infostore &lt;on/off&gt;</td><td align="left">Infostore module access (Default is off)</td></tr><tr><td align="left">
+
|-
--access-pinboard-write &lt;on/off&gt;</td><td align="left">Pinboard write access (Default is off)</td></tr><tr><td align="left"> --access-projects &lt;on/off&gt;</td><td align="left">Project
+
| --imapserver &lt;string&gt;
module access (Default is off)</td></tr><tr><td align="left"> --access-read-create-shared-Folders &lt;on/off&gt;</td><td align="left">Read create shared folder access (Default is
+
|ImapServer
off)</td></tr><tr><td align="left"> --access-rss-bookmarks &lt;on/off&gt;</td><td align="left">RSS bookmarks access (Default is off)</td></tr><tr><td align="left"> --access-rss-portal
+
|-
&lt;on/off&gt;</td><td align="left">RSS portal access (Default is off)</td></tr><tr><td align="left"> --access-syncml &lt;on/off&gt;</td><td align="left">Syncml access (Default is
+
| --imaplogin &lt;string&gt;
off)</td></tr><tr><td align="left"> --access-active-sync &lt;on/off&gt;</td><td align="left">Exchange Active Sync access (Default is off)</td></tr><tr><td align="left"> --access-usm
+
|ImapLogin
&lt;on/off&gt;</td><td align="left">Universal Sync Module access (Default is off)</td></tr><tr><td align="left"> --access-tasks &lt;on/off&gt;</td><td align="left">Tasks access (Default is
+
|-
off)</td></tr><tr><td align="left"> --access-vcard &lt;on/off&gt;</td><td align="left">Vcard access (Default is off)</td></tr><tr><td align="left"> --access-webdav &lt;on/off&gt;</td><td
+
| --smtpserver &lt;string&gt;
align="left">Webdav access (Default is off)</td></tr><tr><td align="left"> --access-webdav-xml &lt;on/off&gt;</td><td align="left">Webdav-Xml access (Default is off)</td></tr><tr><td align="left">
+
|SmtpServer
--access-webmail &lt;on/off&gt;</td><td align="left">Webmail access (Default is on)</td></tr><tr><td align="left"> --access-publication &lt;on/off&gt;</td><td align="left">Publication permission
+
|-
(Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium</td></tr><tr><td align="left"> --access-subscription &lt;on/off&gt;</td><td
+
| --instant_messenger1 &lt;string&gt;
align="left">Subscription permission (Default is on)</td></tr><tr><td align="left"> --access-edit-group &lt;on/off&gt;</td><td align="left">Edit group access (Default is off)</td></tr><tr><td
+
|Instant_messenger1
align="left"> --access-edit-resource &lt;on/off&gt;</td><td align="left">Edit resource access (Default is off)</td></tr><tr><td align="left"> --access-edit-password &lt;on/off&gt;</td><td
+
|-
align="left">Edit password access (Default is off)</td></tr><tr><td align="left"> --access-collect-email-addresses &lt;on/off&gt;</td><td align="left">Edit collect email addresses (Default is
+
| --instant_messenger2 &lt;string&gt;
off)</td></tr><tr><td align="left"> --access-multiple-mail-accounts &lt;on/off&gt;</td><td align="left">Use multiple mail account feature (Default is off)</td></tr><tr><td align="left">
+
|Instant_messenger2
--access-global-address-book-disabled &lt;on/off&gt;</td><td align="left">Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM
+
|-
and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder. </td></tr><tr><td align="left"> --access--voipnow
+
| --telephone_ip &lt;string&gt;
&lt;on/off&gt;</td><td align="left">Access to VoiceOverIP feature.</td></tr><tr><td align="left"> --access-public-folder-editable &lt;on/off&gt;</td><td align="left">Access to public folders.
+
|Telephone_ip
Allows or denies to see public folders. </td></tr><tr><td align="left">--foldertree &lt;0/1&gt;</td><td align="left">0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.
+
|-
</td></tr><tr><td align="left">--access-olox20 &lt;on/off&gt;</td><td align="left"> Access to Olox2.0</td></tr></table></div></div><div class="sect2" lang="en-EN"><div
+
| --telephone_isdn &lt;string&gt;
class="titlepage"><div><div><h3 class="title">Open-Xchange module access</h3></div></div></div><p> With Open-Xchange it is
+
|Telephone_isdn
 +
|-
 +
| --mail_folder_drafts_name &lt;string&gt;
 +
|Mail_folder_drafts_name
 +
|-
 +
| --mail_folder_sent_name &lt;string&gt;
 +
|Mail_folder_sent_name
 +
|-
 +
| --mail_folder_spam_name &lt;string&gt;
 +
|Mail_folder_spam_name
 +
|-
 +
| --mail_folder_trash_name &lt;string&gt;
 +
|Mail_folder_trash_name
 +
|-
 +
| --mail_folder_archive_full_name &lt;string&gt;
 +
|Mail_folder_archive_full_name
 +
|-
 +
| --manager_name &lt;string&gt;
 +
|Manager_name
 +
|-
 +
| --marital_status &lt;string&gt;
 +
|Marital_status
 +
|-
 +
| --cellular_telephone1 &lt;string&gt;
 +
|Cellular_telephone1
 +
|-
 +
| --cellular_telephone2 &lt;string&gt;
 +
|Cellular_telephone2
 +
|-
 +
| --info &lt;string&gt;
 +
|Info
 +
|-
 +
| --nickname &lt;string&gt;
 +
|Nickname
 +
|-
 +
| --number_of_children &lt;string&gt;
 +
|Number_of_children
 +
|-
 +
| --note &lt;string&gt;
 +
|Note
 +
|-
 +
| --number_of_employee &lt;string&gt;
 +
|Number_of_employee
 +
|-
 +
| --telephone_pager &lt;string&gt;
 +
|Telephone_pager
 +
|-
 +
| --password_expired &lt;booleanvalue&gt;
 +
|Password_expired
 +
|-
 +
| --telephone_assistant &lt;string&gt;
 +
|Telephone_assistant
 +
|-
 +
| --telephone_business1 &lt;string&gt;
 +
|Telephone_business1
 +
|-
 +
| --telephone_business2 &lt;string&gt;
 +
|Telephone_business2
 +
|-
 +
| --telephone_car &lt;string&gt;
 +
|Telephone_car
 +
|-
 +
| --telephone_company &lt;string&gt;
 +
|Telephone_company
 +
|-
 +
| --telephone_home1 &lt;string&gt;
 +
|Telephone_home1
 +
|-
 +
| --telephone_home2 &lt;string&gt;
 +
|Telephone_home2
 +
|-
 +
| --telephone_other &lt;string&gt;
 +
|Telephone_other
 +
|-
 +
| --postal_code_home &lt;string&gt;
 +
|Postal_code_home
 +
|-
 +
| --profession &lt;string&gt;
 +
|Profession
 +
|-
 +
| --telephone_radio &lt;string&gt;
 +
|Telephone_radio
 +
|-
 +
| --room_number &lt;string&gt;
 +
|Room_number
 +
|-
 +
| --sales_volume &lt;string&gt;
 +
|Sales_volume
 +
|-
 +
| --city_other &lt;string&gt;
 +
|City_other
 +
|-
 +
| --country_other &lt;string&gt;
 +
|Country_other
 +
|-
 +
| --middle_name &lt;string&gt;
 +
|Middle_name
 +
|-
 +
| --postal_code_other &lt;string&gt;
 +
|Postal_code_other
 +
|-
 +
| --state_other &lt;string&gt;
 +
|State_other
 +
|-
 +
| --street_other &lt;string&gt;
 +
|Street_other
 +
|-
 +
| --spouse_name &lt;string&gt;
 +
|Spouse_name
 +
|-
 +
| --state_home &lt;string&gt;
 +
|State_home
 +
|-
 +
| --street_home &lt;string&gt;
 +
|Street_home
 +
|-
 +
| --suffix &lt;string&gt;
 +
|Suffix
 +
|-
 +
| --tax_id &lt;string&gt;
 +
|Tax_id
 +
|-
 +
| --telephone_telex &lt;string&gt;
 +
|Telephone_telex
 +
|-
 +
| --telephone_ttytdd &lt;string&gt;
 +
|Telephone_ttytdd
 +
|-
 +
| --uploadfilesizelimitperfile &lt;string&gt;
 +
|Upload file size limit per file for mail attachments
 +
|-
 +
| --uploadfilesizelimit &lt;string&gt;
 +
|Total upload file size limit for mail attachments
 +
|-
 +
| --url &lt;string&gt;
 +
|Url
 +
|-
 +
| --userfield01 &lt;string&gt;
 +
|Userfield01
 +
|-
 +
| --userfield02 &lt;string&gt;
 +
|Userfield02
 +
|-
 +
| --userfield03 &lt;string&gt;
 +
|Userfield03
 +
|-
 +
| --userfield04 &lt;string&gt;
 +
|Userfield04
 +
|-
 +
| --userfield05 &lt;string&gt;
 +
|Userfield05
 +
|-
 +
| --userfield06 &lt;string&gt;
 +
|Userfield06
 +
|-
 +
| --userfield07 &lt;string&gt;
 +
|Userfield07
 +
|-
 +
| --userfield08 &lt;string&gt;
 +
|Userfield08
 +
|-
 +
| --userfield09 &lt;string&gt;
 +
|Userfield09
 +
|-
 +
| --userfield10 &lt;string&gt;
 +
|Userfield10
 +
|-
 +
| --userfield11 &lt;string&gt;
 +
|Userfield11
 +
|-
 +
| --userfield12 &lt;string&gt;
 +
|Userfield12
 +
|-
 +
| --userfield13 &lt;string&gt;
 +
|Userfield13
 +
|-
 +
| --userfield14 &lt;string&gt;
 +
|Userfield14
 +
|-
 +
| --userfield15 &lt;string&gt;
 +
|Userfield15
 +
|-
 +
| --userfield16 &lt;string&gt;
 +
|Userfield16
 +
|-
 +
| --userfield17 &lt;string&gt;
 +
|Userfield17
 +
|-
 +
| --userfield18 &lt;string&gt;
 +
|Userfield18
 +
|-
 +
| --userfield19 &lt;string&gt;
 +
|Userfield19
 +
|-
 +
| --userfield20 &lt;string&gt;
 +
|Userfield20
 +
|-
 +
| --city_business &lt;string&gt;
 +
|City_business
 +
|-
 +
| --country_business &lt;string&gt;
 +
|Country_business
 +
|-
 +
| --assistant_name &lt;string&gt;
 +
|Assistant_name
 +
|-
 +
| --telephone_primary &lt;string&gt;
 +
|Telephone_primary
 +
|-
 +
| --categories &lt;string&gt;
 +
|Categories
 +
|-
 +
| --mail_folder_confirmed_ham_name &lt;string&gt;
 +
|Mail_folder_confirmed_ham_name
 +
|-
 +
| --mail_folder_confirmed_spam_name &lt;string&gt;
 +
|Mail_folder_confirmed_spam_name
 +
|-
 +
| --gui_spam_filter_capabilities_enabled &lt;booleanvalue&gt;
 +
|GUI_spam_filter_capabilities_enabled
 +
|-
 +
| --mailenabled &lt;true/false&gt;
 +
|Mailenabled
 +
|-
 +
| --defaultsenderaddress &lt;stringvalue&gt;
 +
|DefaultSenderAddress
 +
|-
 +
| --title &lt;string&gt;
 +
|Title
 +
|-
 +
| --position &lt;string&gt;
 +
|Position
 +
|-
 +
| --access-calendar &lt;on/off&gt;
 +
|Calendar module (Default is off)
 +
|-
 +
| --access-contacts &lt;on/off&gt;
 +
|Contact module access (Default is on)
 +
|-
 +
| --access-delegate-tasks &lt;on/off&gt;
 +
|Delegate tasks access (Default is off)
 +
|-
 +
| --access-edit-public-folder &lt;on/off&gt;
 +
|Edit public folder access (Default is off)
 +
|-
 +
| --access-ical &lt;on/off&gt;
 +
|Ical module access (Default is off)
 +
|-
 +
| --access-infostore &lt;on/off&gt;
 +
|Infostore module access (Default is off)
 +
|-
 +
| --access-read-create-shared-Folders &lt;on/off&gt;
 +
|Read create shared folder access (Default is off)
 +
|-
 +
| --access-syncml &lt;on/off&gt;
 +
|Syncml access (Default is off)
 +
|-
 +
| --access-active-sync &lt;on/off&gt;
 +
|Exchange Active Sync access (Default is off)
 +
|-
 +
| --access-usm &lt;on/off&gt;
 +
|Universal Sync Module access (Default is off)
 +
|-
 +
| --access-tasks &lt;on/off&gt;
 +
|Tasks access (Default is off)
 +
|-
 +
| --access-vcard &lt;on/off&gt;
 +
|Vcard access (Default is off)
 +
|-
 +
|
 +
--access-webmail &lt;on/off&gt;
 +
|Webmail access (Default is on)
 +
|-
 +
| --access-publication &lt;on/off&gt;
 +
|[DEPRECATED] Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium
 +
|-
 +
| --access-subscription &lt;on/off&gt;
 +
|Subscription permission (Default is on)
 +
|-
 +
| --access-edit-group &lt;on/off&gt;
 +
|Edit group access (Default is off)
 +
|-
 +
| --access-edit-resource &lt;on/off&gt;
 +
|Edit resource access (Default is off)
 +
|-
 +
| --access-edit-password &lt;on/off&gt;
 +
|Edit password access (Default is off)
 +
|-
 +
| --access-collect-email-addresses &lt;on/off&gt;
 +
|Edit collect email addresses (Default is off)
 +
|-
 +
| --access-multiple-mail-accounts &lt;on/off&gt;
 +
|Use multiple mail account feature (Default is off)
 +
|-
 +
| --access-global-address-book-disabled &lt;on/off&gt;
 +
|Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder.
 +
|-
 +
| --access--voipnow &lt;on/off&gt;
 +
|Access to VoiceOverIP feature.
 +
|-
 +
| --access-public-folder-editable &lt;on/off&gt;
 +
|Access to public folders. Allows or denies to see public folders.
 +
|-
 +
| --foldertree &lt;0/1&gt;
 +
|0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.
 +
|-
 +
| --access-olox20 &lt;on/off&gt;
 +
| [DEPRECATED] Access to Olox2.0
 +
|-
 +
| --default-folder-mode
 +
| The mode how the default folders should be created. 'default', 'default-deletable', 'no-default-folders'. If not selected, 'default' is applied.
 +
|}
 +
 
 +
=== Open-Xchange module access ===
 +
 
 +
With Open-Xchange it is
 
possible to limit the access to the available modules per context i. e., all users in one context per default get the same access rights. The rights though can be changed per user. Currently,
 
possible to limit the access to the available modules per context i. e., all users in one context per default get the same access rights. The rights though can be changed per user. Currently,
 
following modules are implemented: access-calendar, access-contacts, access-delegate-tasks, access-edit-public-folder, access-ical, access-infostore, access-read-create-shared-Folders,
 
following modules are implemented: access-calendar, access-contacts, access-delegate-tasks, access-edit-public-folder, access-ical, access-infostore, access-read-create-shared-Folders,
access-tasks, access-vcard, access-webdav, access-webdav-xml, access-syncml and access-webmail. There are several combinations possible and four are supported (not mentioned modules need to be
+
access-tasks, access-vcard, access-webdav, access-syncml and access-webmail. There are several combinations possible and four are supported (not mentioned modules need to be
 
disabled). This limitation is needed because some modules depend on access to others. There are different Open-Xchange packages available for the customer: Webmail+, PIM+, Groupware+, Premium.
 
disabled). This limitation is needed because some modules depend on access to others. There are different Open-Xchange packages available for the customer: Webmail+, PIM+, Groupware+, Premium.
 
These packages have to be configured per context i. e., all users in a context need to use the same package. Each package consists of a combination of modules that has to be set up appropriately.
 
These packages have to be configured per context i. e., all users in a context need to use the same package. Each package consists of a combination of modules that has to be set up appropriately.
 
The following sections quickly introduce the packages and their module configuration. Open-Xchange also provides the possibility to use "access combination names" when creating and changing
 
The following sections quickly introduce the packages and their module configuration. Open-Xchange also provides the possibility to use "access combination names" when creating and changing
 
contexts/users. If you want to change the package acess rights for a context, you can simply add the "access-combination-name" switch to the appropriate tool
 
contexts/users. If you want to change the package acess rights for a context, you can simply add the "access-combination-name" switch to the appropriate tool
(createcontext,createuser,changecontext etc.). </p><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">Webmail+</h4></div></div></div><p> If there are no access rights specified when creating a new user Webmail+ is used as default. Webmail+ is a base package that allows access to the
+
(createcontext,createuser,changecontext etc.).
webmail interface and a personal address book. To grant access to this package, the following modules have to be set to "on" for all users in a context: </p><div class="informaltable"><table
 
border="0"><tr><td align="left">* access-contacts</td><td align="left">Access combination name: webmail_plus</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-webmail</td><td align="left">Access combination
 
name: webmail_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr></table></div><p>
 
  
</p></div><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">PIM+</h4></div></div></div><p> PIM+
+
 
 +
==== Webmail+ ====
 +
 
 +
If there are no access rights specified when creating a new user Webmail+ is used as default. Webmail+ is a base package that allows access to the
 +
webmail interface and a personal address book. To grant access to this package, the following modules have to be set to "on" for all users in a context:
 +
 
 +
 
 +
{| border="1"
 +
|-
 +
|access-contacts
 +
|Access combination name: webmail_plus
 +
|-
 +
|access-webmail
 +
|Access combinationname: webmail_plus
 +
|}
 +
 
 +
==== PIM+ ====
 +
 
 +
PIM+
 
is another base package that gives access to the webmailer, personal address book, calendar and tasks. Group appointments and delegating tasks are not supported. To grant access to this package,
 
is another base package that gives access to the webmailer, personal address book, calendar and tasks. Group appointments and delegating tasks are not supported. To grant access to this package,
 
the following modules have to be set to "on" for all users in a context:
 
the following modules have to be set to "on" for all users in a context:
  
</p><div class="informaltable"><table border="0"><tr><td align="left">* access-contacts</td><td align="left">Access
 
combination name: pim_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-webmail</td><td
 
align="left">Access combination name: pim_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">*
 
access-calendar</td><td align="left">Access combination name: pim_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-delegate-tasks</td><td align="left">Access combination name: pim_plus</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-tasks</td><td align="left">Access combination name: pim_plus</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr></table></div><p>
 
  
</p></div><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">Groupware+</h4></div></div></div><p>
+
{| border="1"
 +
|-
 +
|access-contacts
 +
|Access combination name: pim_plus
 +
|-
 +
|access-webmail
 +
|Access combination name: pim_plus
 +
|-
 +
|access-calendar
 +
|Access combination name: pim_plus
 +
|-
 +
|access-delegate-tasks
 +
|Access combination name: pim_plus
 +
|-
 +
|access-tasks
 +
|Access combination name: pim_plus
 +
|}
 +
 
 +
==== Groupware+ ====
 +
 
 
Groupware+ is an upsell package that provides full groupware functionality: private, shared and public folders, conflict handling for appointments, team view. Furthermore, the InfoStore is
 
Groupware+ is an upsell package that provides full groupware functionality: private, shared and public folders, conflict handling for appointments, team view. Furthermore, the InfoStore is
 
available. To grant access to this package, the following modules have to be set to "on" for all users in a context:
 
available. To grant access to this package, the following modules have to be set to "on" for all users in a context:
  
</p><div class="informaltable"><table border="0"><tr><td align="left">* access-contacts</td><td align="left">Access
 
combination name: groupware_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">*
 
access-webmail</td><td align="left">Access combination name: groupware_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-calendar</td><td align="left">Access combination name: groupware_plus</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-delegate-tasks</td><td align="left">Access combination name: groupware_plus</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-tasks</td><td align="left">Access combination name:
 
groupware_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-edit-public-folder</td><td
 
align="left">Access combination name: groupware_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td
 
align="left">* access-infostore</td><td align="left">Access combination name: groupware_plus</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-read-create-shared-Folders</td><td align="left">Access combination name: groupware_plus</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr></table></div><p>
 
  
</p></div><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">Premium</h4></div></div></div><p>
+
{| border="1"
 +
|-
 +
|access-contacts
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-webmail
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-calendar
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-delegate-tasks
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-tasks
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-edit-public-folder
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-infostore
 +
|Access combination name: groupware_plus
 +
|-
 +
|access-read-create-shared-Folders
 +
|Access combination name: groupware_plus
 +
|}
 +
 
 +
==== Premium ====
 +
 
 
Premium is a desktop integration package. It provides the functionality of the "Groupware+" package and comes with interfaces to integrate with other software: The OXtender for MS Outlook and the
 
Premium is a desktop integration package. It provides the functionality of the "Groupware+" package and comes with interfaces to integrate with other software: The OXtender for MS Outlook and the
 
WebDAV interface to integrate the InfoStore with desktops. To grant access to this package, the following modules have to be set to "on" for all users in a context:
 
WebDAV interface to integrate the InfoStore with desktops. To grant access to this package, the following modules have to be set to "on" for all users in a context:
  
</p><div class="informaltable"><table border="0"><tr><td align="left">* access-contacts</td><td align="left">Access
 
combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-webmail</td><td
 
align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">*
 
access-calendar</td><td align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-delegate-tasks</td><td align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-tasks</td><td align="left">Access combination name: premium</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-edit-public-folder</td><td align="left">Access
 
combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-infostore</td><td
 
align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">*
 
access-read-create-shared-Folders</td><td align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-ical</td><td align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-vcard</td><td align="left">Access combination name: premium</td><td
 
class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-webdav</td><td align="left">Access combination
 
name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr><tr><td align="left">* access-webdavxml</td><td
 
align="left">Access combination name: premium</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td><td class="auto-generated">&nbsp;</td></tr></table></div><p>
 
  
</p></div><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title"><a name="clt.sect.packages.access.configuration"></a>Package access
+
{| border="1"
configuration</h4></div></div></div><p>This section provides a quick overview about the different packages that can be configured per context and the
+
|-
required access configuration:</p><div class="informaltable"><table border="0"><tr><td align="left">Module</td><td
+
|access-contacts
align="left">Webmail+</td><td align="left">PIM+</td><td align="left">Groupware+</td><td align="left">Premium</td></tr><tr><td align="left">–access-calendar</td><td align="left">off</td><td
+
|Access combination name: premium
align="left">on</td><td align="left">on</td><td align="left">on</td></tr><tr><td align="left">–access-contacts</td><td align="left">on</td><td align="left">on</td><td align="left">on</td><td
+
|-
align="left">on</td></tr><tr><td align="left">–access-delegate-tasks</td><td align="left">off</td><td align="left">on</td><td align="left">on</td><td align="left">on</td></tr><tr><td
+
|access-webmail
align="left">–access-edit-public-folder</td><td align="left">off</td><td align="left">off</td><td align="left">on</td><td align="left">on</td></tr><tr><td align="left">–access-forum</td><td
+
|Access combination name: premium
align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">off</td></tr><tr><td align="left">–access-ical</td><td align="left">off</td><td align="left">off</td><td
+
|-
align="left">off</td><td align="left">on</td></tr><tr><td align="left">–access-infostore</td><td align="left">off</td><td align="left">off</td><td align="left">on</td><td
+
|access-calendar
align="left">on</td></tr><tr><td align="left">–access-pinboard-write</td><td align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">off</td></tr><tr><td
+
|Access combination name: premium
align="left">–access-projects</td><td align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">off</td></tr><tr><td
+
|-
align="left">–access-read-create-shared-Folders</td><td align="left">off</td><td align="left">off</td><td align="left">on</td><td align="left">on</td></tr><tr><td
+
|access-delegate-tasks
align="left">–access-rss-bookmarks</td><td align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">off</td></tr><tr><td align="left">–access-rss-portal</td><td
+
|Access combination name: premium
align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">off</td></tr><tr><td align="left">–access-syncml</td><td align="left">off</td><td align="left">off</td><td
+
|-
align="left">off</td><td align="left">off</td></tr><tr><td align="left">–access-tasks</td><td align="left">off</td><td align="left">on</td><td align="left">on</td><td
+
|access-tasks
align="left">on</td></tr><tr><td align="left">–access-vcard</td><td align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">on</td></tr><tr><td
+
|Access combination name: premium
align="left">–access-webdav</td><td align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">on</td></tr><tr><td align="left">–access-webdav-xml</td><td
+
|-
align="left">off</td><td align="left">off</td><td align="left">off</td><td align="left">on</td></tr><tr><td align="left">–access-webmail</td><td align="left">on</td><td align="left">on</td><td
+
|access-edit-public-folder
align="left">on</td><td align="left">on</td></tr></table></div></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra
+
|Access combination name: premium
parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td
+
|-
align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Context admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Context admin
+
|access-infostore
password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code
+
|Access combination name: premium
class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>contextid {adminuser adminpass} username displayname givenname surname password
+
|-
email</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On
+
|access-read-create-shared-Folders
success:</p><p><code class="computeroutput">user &lt;userid&gt; in context &lt;contextid&gt; created</code></p><p>On failure:</p><p><code class="computeroutput">user in context &lt;contextid&gt;
+
|Access combination name: premium
could not be created: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/createuser -c 123 -u jd -d "john doe"
+
|-
-g John -s Doe -p userpw -e jd@example.com</code></strong></p><p><code class="computeroutput">user 3 in context 123 created</code></p></div></div>
+
|access-ical
 +
|Access combination name: premium
 +
|-
 +
|access-vcard
 +
|Access combination name: premium
 +
|-
 +
|access-webdav
 +
|Access combination name: premium
 +
|}
 +
 
 +
==== All ====
 +
The setting <code>all</code> is equivalent to <code>premium</code> for ordinary users. For context administrators, it adds the right <code>publicfoldereditable</code>, which allows the admin to change the access rights to public folders for groups.
 +
 
 +
==== Package access configuration ====
 +
 
 +
This section provides a quick overview about the different packages that can be configured per context and the
 +
required access configuration:
 +
 
 +
 
 +
{| border="1"
 +
|-
 +
|Module
 +
|Webmail+
 +
|PIM+
 +
|Groupware+
 +
|Premium
 +
|-
 +
| -access-calendar
 +
|off
 +
|on
 +
|on
 +
|on
 +
|-
 +
| -access-contacts
 +
|on
 +
|on
 +
|on
 +
|on
 +
|-
 +
| -access-delegate-tasks
 +
|off
 +
|on
 +
|on
 +
|on
 +
|-
 +
| -access-edit-public-folder
 +
|off
 +
|off
 +
|on
 +
|on
 +
|-
 +
| -access-ical
 +
|off
 +
|off
 +
|off
 +
|on
 +
|-
 +
| -access-infostore
 +
|off
 +
|off
 +
|on
 +
|on
 +
|-
 +
| -access-read-create-shared-Folders
 +
|off
 +
|off
 +
|on
 +
|on
 +
|-
 +
| -access-syncml
 +
|off
 +
|off
 +
|off
 +
|off
 +
|-
 +
|–access-tasks
 +
|off
 +
|on
 +
|on
 +
|on
 +
|-
 +
| -access-vcard
 +
|off
 +
|off
 +
|off
 +
|on
 +
|-
 +
| -access-webdav
 +
|off
 +
|off
 +
|off
 +
|on
 +
|-
 +
| -access-webmail
 +
|on
 +
|on
 +
|on
 +
|on
 +
|}
 +
 
 +
=== Extra parameters when authentication is enabled ===
 +
 
 +
{| border="1"
 +
|-
 +
| -A,--adminuser &lt;string&gt;
 +
|Context admin user name
 +
|-
 +
| -P,--adminpass &lt;string&gt;
 +
|Context admin password
 +
|}
 +
 
 +
=== Return value ===
 +
 
 +
<code>0</code> on success
 +
 
 +
<code>&gt;0</code> on failure
 +
 
 +
 
 +
=== Mandatory parameters ===
 +
 
 +
<code>contextid {adminuser adminpass} username displayname givenname surname password email</code>
 +
 
 +
=== Command output ===
 +
 
 +
On success:
 +
 
 +
<code>user &lt;userid&gt; in context &lt;contextid&gt; created</code>
 +
 
 +
On failure:
 +
 
 +
<code>user in context &lt;contextid&gt; could not be created: &lt;reason from server&gt;</code>
 +
 
 +
 
 +
=== Example ===
 +
 
 +
<code>root@oxhe~# </code>'''<code>/opt/open-xchange/sbin/createuser -c 123 -u jd -d "john doe"
 +
-g John -s Doe -p userpw -e jd@example.com</code>'''
 +
 
 +
 
 +
<code>user 3 in context 123 created</code>
 +
 
 +
 +
== deleteuser ==
 +
 
 +
'''<code>deleteuser</code>''' is the tool to delete a user in a given context. If you delete a user the public folder entries of this user are
 +
transferred to the admin user. All other data are deleted.
 +
 
 +
 
 +
=== Parameters ===
 +
 
 +
{| border="1"
 +
|-
 +
| -h,--help
 +
|Prints a help text
 +
|-
 +
| --environment
 +
|Show info about commandline environment
 +
|-
 +
| --nonl
 +
|Remove all newlines (\n) from output
 +
|-
 +
| --responsetimeout &lt;integer&gt;
 +
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
 +
|-
 +
| -c,--contextid &lt;integer&gt;
 +
|The id of them context
 +
|-
 +
| -i,--userid &lt;integer&gt;
 +
|Id of the user
 +
|-
 +
| -u,--username &lt;string&gt;
 +
|Username ofthe user
 +
|}
 +
 
 +
=== Extra parameters when authentication is enabled ===
 +
 
 +
{| border="1"
 +
|-
 +
| -A,--adminuser &lt;string&gt;
 +
|Context Admin user name
 +
|-
 +
| -P,--adminpass &lt;string&gt;
 +
|Context Admin password
 +
|}
 +
 
 +
=== Return value ===
 +
 
 +
<code>0</code> on success
 +
 
 +
<code>&gt;0</code> on failure
 +
 
 +
 
 +
=== Mandatory parameters ===
 +
<code>contextid {adminuser adminpass} (userid or username)</code>
 +
 
 +
=== Command output ===
 +
 
 +
On success:
 +
 
 +
<code>user &lt;userid&gt; in context &lt;contextid&gt; deleted</code>
 +
 
 +
 
 +
On failure:
 +
 
 +
<code>user &lt;userid&gt; in context &lt;contextid&gt; could not be deleted: &lt;reason from
 +
server&gt;</code>
 +
 
 +
 
 +
=== Example ===
 +
 
 +
<code>root@oxhe~# </code>'''<code> /opt/open-xchange/deleteuser -c 123 -i 3</code>'''
 +
 
 +
<code>user 3 in context 123 deleted</code>
 +
 
 +
 +
== listuser ==
 +
 
 +
'''<code>listuser</code>''' is the tool to list and search for users.
 +
 
 +
 
 +
=== Parameters ===
 +
 
 +
{| border="1"
 +
|-
 +
| -h,--help
 +
|Prints a help text
 +
|-
 +
| --environment
 +
|Show info about commandline environment
 +
|-
 +
| --nonl
 +
|Remove all newlines (\n) from output
 +
|-
 +
| --responsetimeout &lt;integer&gt;
 +
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
 +
|-
 +
| -c,--contextid &lt;integer&gt;
 +
|The id of the context
 +
|-
 +
| -s,--searchpattern &lt;string&gt;
 +
|Search/List pattern, default “*”
 +
|-
 +
| --csv
 +
|Command output as csv
 +
|-
 +
| -i,--ignorecase
 +
|Do a case-insensitive search with the given search pattern
 +
|-
 +
| --includeguests
 +
|Add guest users to listing '''Available with v7.8.0'''
 +
|-
 +
| --excludeusers
 +
|Exclude usual users from listing '''Available with v7.8.0'''
 +
|}
 +
 
 +
=== Extra parameters when authentication is enabled ===
 +
 
 +
{| border="1"
 +
|-
 +
| -A,--adminuser &lt;string&gt;
 +
|Context Admin user name
 +
|-
 +
| -P,--adminpass &lt;string&gt;
 +
|Context Admin password
 +
|}
 +
 
 +
=== Return value ===
 +
 
 +
<code>0</code> on success
 +
 
 +
<code>&gt;0</code> on failure
 +
 
 +
=== Mandatory parameters ===
 +
<code>contextid adminuser adminpass</code>
 +
 
 +
=== Command output ===
 +
 
 +
Standard output (only a subset of available attributes are printed also only disabled
 +
modules):
 +
 
 +
 
 +
{| border="1"
 +
|-
 +
|id
 +
|enabled
 +
|imapServer
 +
|smtpserver
 +
|language
 +
|Webdav
 +
|-
 +
|3
 +
|true
 +
|localhost
 +
|localhost
 +
|en_US
 +
|false
 +
|false
 +
|}
 +
 
 +
csv output:
 +
Name,Language,Id,Display_name,PrimaryEmail,MaxQuota,UsedQuota,Email1,Mailenabled,Password,Sur_name,Given_name,
 +
FilestoreId,FilestoreOwner,Filestore_name,Birthday,Anniversary,Branches,Business_category,Postal_code_business,
 +
State_business,Street_business,Telephone_callback,City_home,Commercial_register,Country_home,Company,Department,
 +
Email2,Email3,EmployeeType,Fax_business,Fax_home,Fax_other,ImapServer,ImapLogin,SmtpServer,Instant_messenger1,
 +
Instant_messenger2,Telephone_ip,Telephone_isdn,Mail_folder_drafts_name,Mail_folder_sent_name,
 +
Mail_folder_spam_name,Mail_folder_trash_name,Mail_folder_archive_full_name,Manager_name,Marital_status,Cellular_telephone1,Cellular_telephone2,
 +
Info,Nickname,Number_of_children,Note,Number_of_employee,Telephone_pager,Password_expired,Telephone_assistant,
 +
Telephone_business1,Telephone_business2,Telephone_car,Telephone_company,Telephone_home1,Telephone_home2,
 +
Telephone_other,Position,Postal_code_home,Profession,Telephone_radio,Room_number,Sales_volume,City_other,
 +
Country_other,Middle_name,Postal_code_other,State_other,Street_other,Spouse_name,State_home,Street_home,Suffix,
 +
Tax_id,Telephone_telex,Timezone,Title,Telephone_ttytdd,UploadFileSizeLimit,UploadFileSizeLimitPerFile,Url,
 +
Userfield01,Userfield02,Userfield03,Userfield04,Userfield05,Userfield06,Userfield07,Userfield08,Userfield09,
 +
Userfield10,Userfield11,Userfield12,Userfield13,Userfield14,Userfield15,Userfield16,Userfield17,Userfield18,
 +
Userfield19,Userfield20,Aliases,City_business,Country_business,Assistant_name,Telephone_primary,Categories,
 +
PasswordMech,Mail_folder_confirmed_ham_name,Mail_folder_confirmed_spam_name,GUI_Spam_filter_capabilities_enabled,
 +
DefaultSenderAddress,FolderTree,UserAttributes,GuiPreferences,access-calendar,access-contacts,
 +
access-delegate-tasks,access-edit-public-folder,access-ical,access-infostore,
 +
access-read-create-shared-Folders,access-syncml,access-tasks,access-vcard,access-webdav,
 +
access-webmail,access-edit-group,access-edit-resource,access-edit-password,access-collect-email-addresses,
 +
access-multiple-mail-accounts,access-subscription,access-publication,access-active-sync,access-usm,
 +
access-olox20,access-denied-portal,access-global-address-book-disabled,access-public-folder-editable
 +
 
 +
=== Example ===
 +
 
 +
<pre> root@oxhe:~# /opt/open-xchange/sbin/listuser -c 6 Id Name Displayname Email 2 admin admin admin@example.com 3 holger Holger
 +
holger@example.com
 +
</pre>
 +
 
 +
 
 +
== getusercapabilities ==
 +
 
 +
'''<code>getusercapabilities</code>''' is the tool to list available capabilities for a certain user.
 +
 
 +
 
 +
=== Parameters ===
 +
 
 +
{| border="1"
 +
|-
 +
| -h,--help
 +
|Prints a help text
 +
|-
 +
| --environment
 +
|Show info about commandline environment
 +
|-
 +
| --nonl
 +
|Remove all newlines (\n) from output
 +
|-
 +
| --responsetimeout &lt;integer&gt;
 +
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
 +
|-
 +
| -c,--contextid &lt;integer&gt;
 +
|The id of the context
 +
|-
 +
| -i,--userid &lt;userid&gt;
 +
|Id of the user
 +
|-
 +
| -u,--username &lt;username&gt;
 +
|Username of the user
 +
|}
 +
 
 +
=== Extra parameters when authentication is enabled ===
 +
 
 +
{| border="1"
 +
|-
 +
| -A,--adminuser &lt;string&gt;
 +
|Context Admin user name
 +
|-
 +
| -P,--adminpass &lt;string&gt;
 +
|Context Admin password
 +
|}
 +
 
 +
=== Return value ===
 +
 
 +
<code>0</code> on success
 +
 
 +
<code>&gt;0</code> on failure
 +
 
 +
=== Mandatory parameters ===
 +
<code>contextid userid adminuser adminpass</code>
 +
 
 +
=== Command output ===
 +
 
 +
Either "There are no capabilities set for user &lt;user-id&gt; in context &lt;context-id&gt;"
 +
or a line-wise listing of identifiers for available capabilities
 +
 
 +
=== Example ===
 +
 
 +
<pre> root@oxhe:~# /opt/open-xchange/sbin/getusercapabilities -c 6 -i 345
 +
</pre>
 +
 
 +
== changeuser ==
 +
 
 +
The '''<code>changeuser</code>''' tool allows to modify attributes of an existing user in a given context. The displayname must be unique in
 +
one context.
 +
 
 +
 
 +
=== Parameters ===
 +
 
 +
{| border="1"
 +
|-
 +
| -h,--help
 +
|Prints a help text
 +
|-
 +
| --environment
 +
|Show info about commandline environment
 +
|-
 +
| --nonl
 +
|Remove all newlines (\n) from output
 +
|-
 +
| --responsetimeout &lt;integer&gt;
 +
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''
 +
|-
 +
| --extendedoptions
 +
|Set this if you want to see all options, use this instead of help option
 +
|-
 +
| -c,--contextid &lt;integer&gt;
 +
|The id of the context
 +
|-
 +
| -i,--userid &lt;integer&gt;
 +
|Id of the user
 +
|-
 +
| -u,--username &lt;string&gt;
 +
|Username of the user
 +
|-
 +
| -d,--displayname &lt;string&gt;
 +
|Display name of the user
 +
|-
 +
| -g,--givenname &lt;string&gt;
 +
|Given name for the user
 +
|-
 +
| -s,--surname &lt;string&gt;
 +
|Surname of the user
 +
|-
 +
| -p,--password &lt;string&gt;
 +
|Password for the user
 +
|-
 +
| -e,--email &lt;string&gt;
 +
|Primary mail address
 +
|-
 +
| -l,--language &lt;lang&gt;
 +
|Language for the user (de_DE,en_US, fr_FR)
 +
|-
 +
| -t,--timezone &lt;timezone&gt;
 +
|Timezone of the user (Europe/Berlin)
 +
|-
 +
| -x,--department &lt;string&gt;
 +
|Department of the user
 +
|-
 +
| -z,--company &lt;string&gt;
 +
|Company of the user
 +
|-
 +
| -a,--aliases &lt;string&gt;
 +
|E-Mail aliases of the user, separated by ","
 +
|-
 +
| --access-combination-name &lt;access-combination-name&gt;
 +
|Access combination name
 +
|-
 +
| --addguipreferences &lt;addguipreferences&gt;
 +
|Add a GUI setting (key=value)
 +
|-
 +
| --removeguipreferences &lt;removeguipreferences&gt;
 +
|Remove a GUI setting
 +
|-
 +
| --access-denied-portal &lt;on/off&gt;
 +
|Denies portal access (Default is off)
 +
|-
 +
| --capabilities-to-add &lt;capabilities-to-add&gt;
 +
| The capabilities to add as a comma-separated string (from 7.2.0 on)
 +
|-
 +
| --capabilities-to-remove &lt;capabilities-to-remove&gt;
 +
|The capabilities to remove as a comma-separated string (from 7.2.0 on)
 +
|-
 +
| --capabilities-to-drop &lt;capabilities-to-drop&gt;
 +
|The capabilities to drop; e.g. cleanse from storage; as a comma-separated string (from 7.6.0 on)
 +
|}
 +
For the GUI preferences please also see http://www.open-xchange.com/wiki/index.php?title=Gui_path
 +
 
 +
=== Extended options ===
 +
 
 +
{| border="1"
 +
|-
 +
| --email1 &lt;string&gt;
 +
|Email1
 +
|-
 +
| --mailenabled &lt;booleanvalue &gt;
 +
|Mailenabled
 +
|-
 +
| --birthday &lt;datevalue&gt;
 +
|Birthday
 +
|-
 +
| --anniversary &lt;datevalue&gt;
 +
|Anniversary
 +
|-
 +
| --branches &lt;string&gt;
 +
|Branches
 +
|-
 +
| --business_category &lt;string&gt;
 +
|Business_category
 +
|-
 +
| --postal_code_business &lt;string&gt;
 +
|Postal_code_business
 +
|-
 +
| --state_business &lt;string&gt;
 +
|State_business
 +
|-
 +
| --street_business &lt;string&gt;
 +
|Street_business
 +
|-
 +
| --telephone_callback &lt;string&gt;
 +
|Telephone_callback
 +
|-
 +
| --city_home &lt;string&gt;
 +
|City_home
 +
|-
 +
| --commercial_register &lt;string&gt;
 +
|Commercial_register
 +
|-
 +
| --country_home &lt;string&gt;
 +
|Country_home
 +
|-
 +
| --email2 &lt;string&gt;
 +
|Email2
 +
|-
 +
| --email3 &lt;string&gt;
 +
|Email3
 +
|-
 +
| --employeetype &lt;string&gt;
 +
|EmployeeType
 +
|-
 +
| --fax_business &lt;string&gt;
 +
|Fax_business
 +
|-
 +
| --fax_home &lt;string&gt;
 +
|Fax_home
 +
|-
 +
| --fax_other &lt;string&gt;
 +
|Fax_other
 +
|-
 +
| --imapserver &lt;string&gt;
 +
|ImapServer
 +
|-
 +
| --imaplogin &lt;string&gt;
 +
|ImapLogin
 +
|-
 +
| --smtpserver &lt;string&gt;
 +
|SmtpServer
 +
|-
 +
| --instant_messenger1 &lt;string&gt;
 +
|Instant_messenger1
 +
|-
 +
| --instant_messenger2 &lt;string&gt;
 +
|Instant_messenger2
 +
|-
 +
| --telephone_ip &lt;string&gt;
 +
|Telephone_ip
 +
|-
 +
| --telephone_isdn &lt;string&gt;
 +
|Telephone_isdn
 +
|-
 +
| --mail_folder_drafts_name &lt;string&gt;
 +
|Mail_folder_drafts_name
 +
|-
 +
| --mail_folder_sent_name &lt;string&gt;
 +
|Mail_folder_sent_name
 +
|-
 +
| --mail_folder_spam_name &lt;string&gt;
 +
|Mail_folder_spam_name
 +
|-
 +
| --mail_folder_trash_name &lt;string&gt;
 +
|Mail_folder_trash_name
 +
|-
 +
| --mail_folder_archive_full_name &lt;string&gt;
 +
|Mail_folder_archive_full_name
 +
|-
 +
| --manager_name &lt;string&gt;
 +
|Manager_name
 +
|-
 +
| --marital_status &lt;string&gt;
 +
|Marital_status
 +
|-
 +
| --cellular_telephone1 &lt;string&gt;
 +
|Cellular_telephone1
 +
|-
 +
| --cellular_telephone2 &lt;string&gt;
 +
|Cellular_telephone2
 +
|-
 +
| --info &lt;string&gt;
 +
|Info
 +
|-
 +
| --nickname &lt;string&gt;
 +
|Nickname
 +
|-
 +
| --number_of_children &lt;string&gt;
 +
|Number_of_children
 +
|-
 +
| --note &lt;string&gt;
 +
|Note
 +
|-
 +
| --number_of_employee &lt;string&gt;
 +
|Number_of_employee
 +
|-
 +
| --telephone_pager &lt;string&gt;
 +
|Telephone_pager
 +
|-
 +
| --password_expired &lt;booleanvalue&gt;
 +
|Password_expired
 +
|-
 +
| --telephone_assistant &lt;string&gt;
 +
|Telephone_assistant
 +
|-
 +
| --telephone_business1 &lt;string&gt;
 +
|Telephone_business1
 +
|-
 +
| --telephone_business2 &lt;string&gt;
 +
|Telephone_business2
 +
|-
 +
| --telephone_car &lt;string&gt;
 +
|Telephone_car
 +
|-
 +
| --telephone_company &lt;string&gt;
 +
|Telephone_company
 +
|-
 +
| --telephone_home1 &lt;string&gt;
 +
|Telephone_home1
 +
|-
 +
| --telephone_home2 &lt;string&gt;
 +
|Telephone_home2
 +
|-
 +
| --telephone_other &lt;string&gt;
 +
|Telephone_other
 +
|-
 +
| --postal_code_home &lt;string&gt;
 +
|Postal_code_home
 +
|-
 +
| --profession &lt;string&gt;
 +
|Profession
 +
|-
 +
| --telephone_radio &lt;string&gt;
 +
|Telephone_radio
 +
|-
 +
| --room_number &lt;string&gt;
 +
|Room_number
 +
|-
 +
| --sales_volume &lt;string&gt;
 +
|Sales_volume
 +
|-
 +
| --city_other &lt;string&gt;
 +
|City_other
 +
|-
 +
| --country_other &lt;string&gt;
 +
|Country_other
 +
|-
 +
| --middle_name &lt;string&gt;
 +
|Middle_name
 +
|-
 +
| --postal_code_other &lt;string&gt;
 +
|Postal_code_other
 +
|-
 +
| --state_other &lt;string&gt;
 +
|State_other
 +
|-
 +
| --street_other &lt;string&gt;
 +
|Street_other
 +
|-
 +
| --spouse_name &lt;string&gt;
 +
|Spouse_name
 +
|-
 +
| --state_home &lt;string&gt;
 +
|State_home
 +
|-
 +
| --street_home &lt;string&gt;
 +
|Street_home
 +
|-
 +
| --suffix &lt;string&gt;
 +
|Suffix
 +
|-
 +
| --tax_id &lt;string&gt;
 +
|Tax_id
 +
|-
 +
| --telephone_telex &lt;string&gt;
 +
|Telephone_telex
 +
|-
 +
| --telephone_ttytdd &lt;string&gt;
 +
|Telephone_ttytdd
 +
|-
 +
| --url &lt;string&gt;
 +
|Url
 +
|-
 +
| --userfield01 &lt;string&gt;
 +
|Userfield01
 +
|-
 +
| --userfield02 &lt;string&gt;
 +
|Userfield02
 +
|-
 +
| --userfield03 &lt;string&gt;
 +
|Userfield03
 +
|-
 +
| --userfield04 &lt;string&gt;
 +
|Userfield04
 +
|-
 +
| --userfield05 &lt;string&gt;
 +
|Userfield05
 +
|-
 +
| --userfield06 &lt;string&gt;
 +
|Userfield06
 +
|-
 +
| --userfield07 &lt;string&gt;
 +
|Userfield07
 +
|-
 +
| --userfield08 &lt;string&gt;
 +
|Userfield08
 +
|-
 +
| --userfield09 &lt;string&gt;
 +
|Userfield09
 +
|-
 +
| --userfield10 &lt;string&gt;
 +
|Userfield10
 +
|-
 +
| --userfield11 &lt;string&gt;
 +
|Userfield11
 +
|-
 +
| --userfield12 &lt;string&gt;
 +
|Userfield12
 +
|-
 +
| --userfield13 &lt;string&gt;
 +
|Userfield13
 +
|-
 +
| --userfield14 &lt;string&gt;
 +
|Userfield14
 +
|-
 +
| --userfield15 &lt;string&gt;
 +
|Userfield15
 +
|-
 +
| --userfield16 &lt;string&gt;
 +
|Userfield16
 +
|-
 +
| --userfield17 &lt;string&gt;
 +
|Userfield17
 +
|-
 +
| --userfield18 &lt;string&gt;
 +
|Userfield18
 +
|-
 +
| --userfield19 &lt;string&gt;
 +
|Userfield19
 +
|-
 +
| --userfield20 &lt;string&gt;
 +
|Userfield20
 +
|-
 +
| --city_business &lt;string&gt;
 +
|City_business
 +
|-
 +
| --country_business &lt;string&gt;
 +
|Country_business
 +
|-
 +
| --assistant_name &lt;string&gt;
 +
|Assistant_name
 +
|-
 +
| --telephone_primary &lt;string&gt;
 +
|Telephone_primary
 +
|-
 +
| --categories &lt;string&gt;
 +
|Categories
 +
|-
 +
| --mail_folder_confirmed_ham_name &lt;string&gt;
 +
|Mail_folder_confirmed_ham_name
 +
|-
 +
| --mail_folder_confirmed_spam_name &lt;string&gt;
 +
|Mail_folder_confirmed_spam_name
 +
|-
 +
| --gui_spam_filter_capabilities_enabled &lt;booleanvalue&gt;
 +
|GUI_Spam_filter_capabilities_enabled
 +
|-
 +
| --defaultsenderaddress&lt;string&gt;
 +
|DefaultSenderAddress
 +
|-
 +
| --title &lt;string&gt;
 +
|Title
 +
|-
 +
| --position &lt;string&gt;
 +
|Position
 +
|-
 +
| --access-calendar
 +
&lt;on/off&gt;
 +
|Calendar module (Default is off)
 +
|-
 +
| --access-contacts &lt;on/off&gt;
 +
|Contact module access (Default is on)
 +
|-
 +
| --access-delegate-tasks &lt;on/off&gt;
 +
|Delegate tasks access (Default is off)
 +
|-
 +
| --access-edit-public-folder &lt;on/off&gt;
 +
|Edit public folder access (Default is off)
 +
|-
 +
| --access-ical &lt;on/off&gt;
 +
|Ical module access (Default is off)
 +
|-
 +
| --access-infostore &lt;on/off&gt;
 +
|Infostore module access (Default is off)
 +
|-
 +
| --access-read-create-shared-Folders &lt;on/off&gt;
 +
|Read create shared folder access (Default is off)
 +
|-
 +
| --access-syncml &lt;on/off&gt;
 +
|Syncml access (Default is off)
 +
|-
 +
| --access-active-sync &lt;on/off&gt;
 +
|Exchange Active Sync access (Default is off)
 +
|-
 +
| --access-usm &lt;on/off&gt;
 +
|Universal Sync Module access (Default is off)
 +
|-
 +
| --access-tasks &lt;on/off&gt;
 +
|Tasks access (Default is off)
 +
|-
 +
| --access-vcard &lt;on/off&gt;
 +
|Vcard access (Default is off)
 +
|-
 +
| --access-webdav &lt;on/off&gt;
 +
|Webdav access (Default is off)
 +
|-
 +
| --access-webmail &lt;on/off&gt;
 +
|Webmail access (Default is on)
 +
|-
 +
| --access-publication &lt;on/off&gt;
 +
|[DEPRECATED] Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium
 +
|-
 +
| --access-subscription &lt;on/off&gt;
 +
|Subscription permission (Default is on)
 +
|-
 +
| --access-edit-group &lt;on/off&gt;
 +
|Edit group access (Default is off)
 +
|-
 +
| --access-edit-resource &lt;on/off&gt;
 +
|Edit resource access (Default is off)
 +
|-
 +
| --access-edit-password &lt;on/off&gt;
 +
|Edit password access (Default is off)
 +
|-
 +
| --access-collect-email-addresses &lt;on/off&gt;
 +
|Edit collect email addresses (Default is off)
 +
|-
 +
| --access-multiple-mail-accounts &lt;on/off&gt;
 +
|Use multiple mail account feature (Default is off)
 +
|-
 +
| --access-global-address-book-disabled &lt;on/off&gt;
 +
|Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder.
 +
|-
 +
| --access--voipnow &lt;on/off&gt;
 +
|Access to VoiceOverIP feature.
 +
|-
 +
| --access-public-folder-editable &lt;on/off&gt;
 +
|Access to public folders. Allows or denies to see public folders.
 +
|-
 +
| --foldertree &lt;0/1&gt;
 +
|0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.
 +
|-
 +
| --access-olox20 &lt;on/off&gt;
 +
| [DEPRECATED] Access to Olox2.0
 +
|}
 +
 
 +
=== Access changes for existing users ===
 +
 
 +
Changes to module access must be done for all users in a given context. On downgrade i. e., to revoke former given access, the data for objects will still be present in the database and on the filestore but is not visible to the customer any more. Please note that only the specified modules are changed. That is why it is required to explicitly turn modules off. A list of packages and the required module configuration is provided in [[the section called “Package access configuration”]].
 +
 
 +
 
 +
=== Extra parameters when authentication is enabled ===
 +
 
 +
{| border="1"
 +
|-
 +
|-A,--adminuser &lt;string&gt;
 +
|Context Admin user name
 +
|-
 +
|-P,--adminpass &lt;string&gt;
 +
|Context Admin password
 +
|}
 +
 
 +
=== Return value ===
 +
 
 +
<code>0</code> on success
 +
 
 +
 
 +
<code>&gt;0</code> on failure
 +
 
 +
 
 +
=== Mandatory parameters ===
 +
 
 +
'''<code>contextid {adminuser adminpass} (userid or username) and at minimum one attribute to change</code>'''
 +
 
 +
primaryMail, Email1 and defaultSenderAddress must be present in set of aliases i. e., whenever you want to change one of
 +
* --email
 +
* --email1
 +
* --defaultsenderaddress
 +
you MUST take care, that the address you want to set is already contained in the aliases of the user.
 +
 
 +
 
 +
So when user has aliases: foo, bar and you want to change email to anotheraddr, you
 +
must add anotheraddr to the aliases, first.
 +
 
 +
 
 +
If needed, this can be done with one commandline call, e.g.:
 +
 
 +
 
 +
'''<code>/changeuser -A oxadmin -P secret -c 666 -i 4 -e
 +
anotheraddr -a foo,bar,anotheraddr</code>'''
 +
 
 +
=== Command output ===
 +
 
 +
On success:
 +
 
 +
 
 +
<code>user &lt;userid&gt; in &lt;contextid&gt; changed</code>
 +
 
 +
 
 +
On failure:
 +
 
 +
 
 +
<code>user
 +
&lt;userid&gt; in &lt;contextid&gt; could not be changed: &lt;reason from server&gt;</code>
 +
 
 +
 
 +
=== Example ===
 +
 
 +
<code>root@oxhe~#</code>'''<code> changeuser -c 123 -i 3 -p newpwd</code>'''
 +
 
  
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">deleteuser</h2></div></div></div><p><strong class="userinput"><code>deleteuser</code></strong> is the tool to delete a user in a given context. If you delete a user the public folder entries of this user are
+
<code>user 3 in context 123 changed</code>
transferred to the admin user. All other data are deleted.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td
 
align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left"> --environment</td><td align="left">Show info about commandline environment</td></tr><tr><td
 
align="left"> --nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the
 
context</td></tr><tr><td align="left">-i,--userid &lt;integer&gt;</td><td align="left">Id of the user</td></tr><tr><td align="left">-u,--username &lt;string&gt;</td><td align="left">Username of
 
the user</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is
 
enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser
 
&lt;string&gt;</td><td align="left">Context Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Context Admin
 
password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code
 
class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>contextid {adminuser adminpass} (userid or username)</code></strong></p></div><div class="sect2"
 
lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">user &lt;userid&gt;
 
in context &lt;contextid&gt; deleted</code></p><p>On failure:</p><p><code class="computeroutput">user &lt;userid&gt; in context &lt;contextid&gt; could not be deleted: &lt;reason from
 
server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code
 
class="computeroutput">root@oxhe~# </code><strong class="userinput"><code> /opt/open-xchange/deleteuser -c 123 -i 3</code></strong></p><p><code class="computeroutput">user 3 in context 123
 
deleted</code></p></div></div>
 
  
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">listuser</h2></div></div></div><p><strong class="userinput"><code>listuser</code></strong> is the tool to list and search for users.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
 
class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td
 
align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left"> --environment</td><td align="left">Show info about commandline environment</td></tr><tr><td
 
align="left"> --nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the
 
context</td></tr><tr><td align="left">-s,--searchpattern &lt;string&gt;</td><td align="left">Search/List pattern, default “<span class="quote">*</span>”</td></tr><tr><td align="left">--csv</td><td
 
align="left">Command output as csv</td></tr><tr><td align="left">-i,--ignorecase </td><td align="left">Do a case-insensitive search with the given search
 
pattern</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is
 
enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser
 
&lt;string&gt;</td><td align="left">Context Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Context Admin
 
password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code
 
class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>contextid adminuser adminpass</code></strong></p></div><div class="sect2" lang="en-EN"><div
 
class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>Standard output (only a subset of available attributes are printed also only disabled
 
modules):</p><div class="informaltable"><table border="0"><tr><td align="left">id</td><td
 
align="left">enabled</td><td align="left">imapServer</td><td align="left">smtpserver</td><td align="left">language</td><td align="left">Webdav</td><td align="left">WebdavXml</td></tr><tr><td
 
align="left">3</td><td align="left">true</td><td align="left">localhost</td><td align="left">localhost</td><td align="left">en_US</td><td align="left">false</td><td
 
align="left">false</td></tr></table></div><p>csv
 
output:</p><p>PasswordMech2String,Enabled,Username,PrimaryEmail,Sur_name,Given_name,Birthday,Anniversary,Branches,Business_category,Postal_code_business,State_business,
 
Street_business,Telephone_callback,City_home,Commercial_register,Country_home,Company,Department,Display_name,Email2,Email3,EmployeeType,Fax_business,Fax_home,Fax_other,ImapServer,
 
ImapLogin,SmtpServer,Instant_messenger1,Instant_messenger2,Telephone_ip,Telephone_isdn,Mail_folder_drafts_name,Mail_folder_sent_name,Mail_folder_spam_name,Mail_folder_trash_name,
 
Manager_name,Marital_status,Cellular_telephone1,Cellular_telephone2,Nickname,Number_of_children,Note,Number_of_employee,Telephone_pager,Password_expired,Telephone_assistant,
 
Telephone_business1,Telephone_business2,Telephone_car,Telephone_company,Telephone_home1,Telephone_home2,Telephone_other,Postal_code_home,Profession,Telephone_radio,Room_number,
 
Sales_volume,City_other,Country_other,Middle_name,Postal_code_other,State_other,Street_other,Spouse_name,State_home,Street_home,Suffix,Tax_id,Telephone_telex,Timezone,Telephone_ttytdd,
 
Url,Userfield01,Userfield02,Userfield03,Userfield04,Userfield05,Userfield06,Userfield07,Userfield08,Userfield09,Userfield10,Userfield11,Userfield12,Userfield13,Userfield14,Userfield15,
 
Userfield16,Userfield17,Userfield18,Userfield19,Userfield20,City_business,Country_business,Assistant_name,Telephone_primary,Email1,PasswordMech,Mail_folder_confirmed_ham_name,
 
Mail_folder_confirmed_spam_name,Spam_filter_enabled,Id,Info,Title,Position,Password,Aliases,Categories,access-calendar,access-contacts,access-delegate-tasks,access-edit-public-folder,
 
access-forum,access-ical,access-infostore,access-pinboard-write,access-projects,access-read-create-shared-Folders,access-rss-bookmarks,access-rss-portal,access-syncml,access-tasks,
 
access-vcard,access-webdav,access-webdav-xml,access-webmail </p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><pre class="screen"> root@oxhe:~# /opt/open-xchange/sbin/listuser -c 6 Id Name Displayname Email 2 admin admin admin@example.com 3 holger Holger
 
holger@example.com </pre></div></div>
 
  
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">changeuser</h2></div></div></div><p>The <strong class="userinput"><code>changeuser</code></strong> tool allows to modify attributes of an existing user in a given context. The displayname must be unique in
 
one context.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table
 
border="0"><tr><td align="left"> -h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">
 
--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left"> --nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td
 
align="left"> --extendedoptions </td><td align="left">Set this if you want to see all options, use this instead of help option</td></tr><tr><td align="left"> -c,--contextid &lt;integer&gt;</td><td
 
align="left">The id of the context</td></tr><tr><td align="left"> -i,--userid &lt;integer&gt;</td><td align="left">Id of the user</td></tr><tr><td align="left"> -u,--username
 
&lt;string&gt;</td><td align="left">Username of the user </td></tr><tr><td align="left"> -d,--displayname &lt;string&gt;</td><td align="left">Display name of the user </td></tr><tr><td
 
align="left"> -g,--givenname &lt;string&gt;</td><td align="left">Given name for the user </td></tr><tr><td align="left"> -s,--surname &lt;string&gt;</td><td align="left">Surname of the user
 
</td></tr><tr><td align="left"> -p,--password &lt;string&gt;</td><td align="left">Password for the user </td></tr><tr><td align="left"> -e,--email &lt;string&gt;</td><td align="left">Primary mail
 
address </td></tr><tr><td align="left"> -l,--language &lt;lang&gt;</td><td align="left">Language for the user (de_DE,en_US, fr_FR)</td></tr><tr><td align="left"> -t,--timezone
 
&lt;timezone&gt;</td><td align="left">Timezone of the user (Europe/Berlin)</td></tr><tr><td align="left"> -x,--department &lt;string&gt;</td><td align="left">Department of the user
 
</td></tr><tr><td align="left"> -z,--company &lt;string&gt;</td><td align="left">Company of the user </td></tr><tr><td align="left"> -a,--aliases &lt;string&gt;</td><td align="left">E-Mail aliases
 
of the user, separated by ","</td></tr><tr><td align="left">--access-combination-name &lt;access-combination-name&gt;</td><td align="left">Access combination name </td></tr><tr><td
 
align="left">--addguipreferences &lt;addguipreferences&gt;</td><td align="left">Add a GUI setting (key=value)</td></tr><tr><td align="left">--removeguipreferences
 
&lt;removeguipreferences&gt;</td><td align="left">Remove a GUI setting </td></tr><tr><td align="left">--access-denied-portal &lt;on/off&gt;</td><td align="left">Denies portal access (Default is
 
off)</td></tr></table></div><p>For the GUI preferences please also see <a class="ulink" href="http://www.open-xchange.com/wiki/index.php?title=Gui_path"
 
target="_top">http://www.open-xchange.com/wiki/index.php?title=Gui_path</a> </p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extended options</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">
 
--email1 &lt;string&gt;</td><td align="left">Email1</td></tr><tr><td align="left"> --mailenabled &lt;booleanvalue &gt;</td><td align="left">Mailenabled</td></tr><tr><td align="left"> --birthday
 
&lt;datevalue&gt;</td><td align="left">Birthday</td></tr><tr><td align="left"> --anniversary &lt;datevalue&gt;</td><td align="left">Anniversary</td></tr><tr><td align="left"> --branches
 
&lt;string&gt;</td><td align="left">Branches</td></tr><tr><td align="left"> --business_category &lt;string&gt;</td><td align="left">Business_category</td></tr><tr><td align="left">
 
--postal_code_business &lt;string&gt;</td><td align="left">Postal_code_business</td></tr><tr><td align="left"> --state_business &lt;string&gt;</td><td align="left">State_business</td></tr><tr><td
 
align="left"> --street_business &lt;string&gt;</td><td align="left">Street_business</td></tr><tr><td align="left"> --telephone_callback &lt;string&gt;</td><td
 
align="left">Telephone_callback</td></tr><tr><td align="left"> --city_home &lt;string&gt;</td><td align="left">City_home</td></tr><tr><td align="left"> --commercial_register &lt;string&gt;</td><td
 
align="left">Commercial_register</td></tr><tr><td align="left"> --country_home &lt;string&gt;</td><td align="left">Country_home</td></tr><tr><td align="left"> --email2 &lt;string&gt;</td><td
 
align="left">Email2</td></tr><tr><td align="left"> --email3 &lt;string&gt;</td><td align="left">Email3</td></tr><tr><td align="left"> --employeetype &lt;string&gt;</td><td
 
align="left">EmployeeType</td></tr><tr><td align="left"> --fax_business &lt;string&gt;</td><td align="left">Fax_business</td></tr><tr><td align="left"> --fax_home &lt;string&gt;</td><td
 
align="left">Fax_home</td></tr><tr><td align="left"> --fax_other &lt;string&gt;</td><td align="left">Fax_other</td></tr><tr><td align="left"> --imapserver &lt;string&gt;</td><td
 
align="left">ImapServer</td></tr><tr><td align="left"> --imaplogin &lt;string&gt;</td><td align="left">ImapLogin</td></tr><tr><td align="left"> --smtpserver &lt;string&gt;</td><td
 
align="left">SmtpServer</td></tr><tr><td align="left"> --instant_messenger1 &lt;string&gt;</td><td align="left">Instant_messenger1</td></tr><tr><td align="left"> --instant_messenger2
 
&lt;string&gt;</td><td align="left">Instant_messenger2</td></tr><tr><td align="left"> --telephone_ip &lt;string&gt;</td><td align="left">Telephone_ip</td></tr><tr><td align="left">
 
--telephone_isdn &lt;string&gt;</td><td align="left">Telephone_isdn</td></tr><tr><td align="left"> --mail_folder_drafts_name &lt;string&gt;</td><td
 
align="left">Mail_folder_drafts_name</td></tr><tr><td align="left"> --mail_folder_sent_name &lt;string&gt;</td><td align="left">Mail_folder_sent_name</td></tr><tr><td align="left">
 
--mail_folder_spam_name &lt;string&gt;</td><td align="left">Mail_folder_spam_name</td></tr><tr><td align="left"> --mail_folder_trash_name &lt;string&gt;</td><td
 
align="left">Mail_folder_trash_name</td></tr><tr><td align="left"> --manager_name &lt;string&gt;</td><td align="left">Manager_name</td></tr><tr><td align="left"> --marital_status
 
&lt;string&gt;</td><td align="left">Marital_status</td></tr><tr><td align="left"> --cellular_telephone1 &lt;string&gt;</td><td align="left">Cellular_telephone1</td></tr><tr><td align="left">
 
--cellular_telephone2 &lt;string&gt;</td><td align="left">Cellular_telephone2</td></tr><tr><td align="left"> --info &lt;string&gt;</td><td align="left">Info</td></tr><tr><td align="left">
 
--nickname &lt;string&gt;</td><td align="left">Nickname</td></tr><tr><td align="left"> --number_of_children &lt;string&gt;</td><td align="left">Number_of_children</td></tr><tr><td align="left">
 
--note &lt;string&gt;</td><td align="left">Note</td></tr><tr><td align="left"> --number_of_employee &lt;string&gt;</td><td align="left">Number_of_employee</td></tr><tr><td align="left">
 
--telephone_pager &lt;string&gt;</td><td align="left">Telephone_pager</td></tr><tr><td align="left"> --password_expired &lt;booleanvalue&gt;</td><td align="left">Password_expired</td></tr><tr><td
 
align="left"> --telephone_assistant &lt;string&gt;</td><td align="left">Telephone_assistant</td></tr><tr><td align="left"> --telephone_business1 &lt;string&gt;</td><td
 
align="left">Telephone_business1</td></tr><tr><td align="left"> --telephone_business2 &lt;string&gt;</td><td align="left">Telephone_business2</td></tr><tr><td align="left"> --telephone_car
 
&lt;string&gt;</td><td align="left">Telephone_car</td></tr><tr><td align="left"> --telephone_company &lt;string&gt;</td><td align="left">Telephone_company</td></tr><tr><td align="left">
 
--telephone_home1 &lt;string&gt;</td><td align="left">Telephone_home1</td></tr><tr><td align="left"> --telephone_home2 &lt;string&gt;</td><td align="left">Telephone_home2</td></tr><tr><td
 
align="left"> --telephone_other &lt;string&gt;</td><td align="left">Telephone_other</td></tr><tr><td align="left"> --postal_code_home &lt;string&gt;</td><td
 
align="left">Postal_code_home</td></tr><tr><td align="left"> --profession &lt;string&gt;</td><td align="left">Profession</td></tr><tr><td align="left"> --telephone_radio &lt;string&gt;</td><td
 
align="left">Telephone_radio</td></tr><tr><td align="left"> --room_number &lt;string&gt;</td><td align="left">Room_number</td></tr><tr><td align="left"> --sales_volume &lt;string&gt;</td><td
 
align="left">Sales_volume</td></tr><tr><td align="left"> --city_other &lt;string&gt;</td><td align="left">City_other</td></tr><tr><td align="left"> --country_other &lt;string&gt;</td><td
 
align="left">Country_other</td></tr><tr><td align="left"> --middle_name &lt;string&gt;</td><td align="left">Middle_name</td></tr><tr><td align="left"> --postal_code_other &lt;string&gt;</td><td
 
align="left">Postal_code_other</td></tr><tr><td align="left"> --state_other &lt;string&gt;</td><td align="left">State_other</td></tr><tr><td align="left"> --street_other &lt;string&gt;</td><td
 
align="left">Street_other</td></tr><tr><td align="left"> --spouse_name &lt;string&gt;</td><td align="left">Spouse_name</td></tr><tr><td align="left"> --state_home &lt;string&gt;</td><td
 
align="left">State_home</td></tr><tr><td align="left"> --street_home &lt;string&gt;</td><td align="left">Street_home</td></tr><tr><td align="left"> --suffix &lt;string&gt;</td><td
 
align="left">Suffix</td></tr><tr><td align="left"> --tax_id &lt;string&gt;</td><td align="left">Tax_id</td></tr><tr><td align="left"> --telephone_telex &lt;string&gt;</td><td
 
align="left">Telephone_telex</td></tr><tr><td align="left"> --telephone_ttytdd &lt;string&gt;</td><td align="left">Telephone_ttytdd</td></tr><tr><td align="left"> --url &lt;string&gt;</td><td
 
align="left">Url</td></tr><tr><td align="left"> --userfield01 &lt;string&gt;</td><td align="left">Userfield01</td></tr><tr><td align="left"> --userfield02 &lt;string&gt;</td><td
 
align="left">Userfield02</td></tr><tr><td align="left"> --userfield03 &lt;string&gt;</td><td align="left">Userfield03</td></tr><tr><td align="left"> --userfield04 &lt;string&gt;</td><td
 
align="left">Userfield04</td></tr><tr><td align="left"> --userfield05 &lt;string&gt;</td><td align="left">Userfield05</td></tr><tr><td align="left"> --userfield06 &lt;string&gt;</td><td
 
align="left">Userfield06</td></tr><tr><td align="left"> --userfield07 &lt;string&gt;</td><td align="left">Userfield07</td></tr><tr><td align="left"> --userfield08 &lt;string&gt;</td><td
 
align="left">Userfield08</td></tr><tr><td align="left"> --userfield09 &lt;string&gt;</td><td align="left">Userfield09</td></tr><tr><td align="left"> --userfield10 &lt;string&gt;</td><td
 
align="left">Userfield10</td></tr><tr><td align="left"> --userfield11 &lt;string&gt;</td><td align="left">Userfield11</td></tr><tr><td align="left"> --userfield12 &lt;string&gt;</td><td
 
align="left">Userfield12</td></tr><tr><td align="left"> --userfield13 &lt;string&gt;</td><td align="left">Userfield13</td></tr><tr><td align="left"> --userfield14 &lt;string&gt;</td><td
 
align="left">Userfield14</td></tr><tr><td align="left"> --userfield15 &lt;string&gt;</td><td align="left">Userfield15</td></tr><tr><td align="left"> --userfield16 &lt;string&gt;</td><td
 
align="left">Userfield16</td></tr><tr><td align="left"> --userfield17 &lt;string&gt;</td><td align="left">Userfield17</td></tr><tr><td align="left"> --userfield18 &lt;string&gt;</td><td
 
align="left">Userfield18</td></tr><tr><td align="left"> --userfield19 &lt;string&gt;</td><td align="left">Userfield19</td></tr><tr><td align="left"> --userfield20 &lt;string&gt;</td><td
 
align="left">Userfield20</td></tr><tr><td align="left"> --city_business &lt;string&gt;</td><td align="left">City_business</td></tr><tr><td align="left"> --country_business &lt;string&gt;</td><td
 
align="left">Country_business</td></tr><tr><td align="left"> --assistant_name &lt;string&gt;</td><td align="left">Assistant_name</td></tr><tr><td align="left"> --telephone_primary
 
&lt;string&gt;</td><td align="left">Telephone_primary</td></tr><tr><td align="left"> --categories &lt;string&gt;</td><td align="left">Categories</td></tr><tr><td align="left">
 
--mail_folder_confirmed_ham_name &lt;string&gt;</td><td align="left">Mail_folder_confirmed_ham_name</td></tr><tr><td align="left"> --mail_folder_confirmed_spam_name &lt;string&gt;</td><td
 
align="left">Mail_folder_confirmed_spam_name</td></tr><tr><td align="left"> --gui_spam_filter_capabilities_enabled &lt;booleanvalue&gt;</td><td
 
align="left">GUI_Spam_filter_capabilities_enabled</td></tr><tr><td align="left"> --defaultsenderaddress&lt;string&gt;</td><td align="left">DefaultSenderAddress</td></tr><tr><td align="left">
 
--title &lt;string&gt;</td><td align="left">Title</td></tr><tr><td align="left"> --position &lt;string&gt;</td><td align="left">Position</td></tr><tr><td align="left"> --access-calendar
 
&lt;on/off&gt;</td><td align="left">Calendar module (Default is off)</td></tr><tr><td align="left"> --access-contacts &lt;on/off&gt;</td><td align="left">Contact module access (Default is
 
on)</td></tr><tr><td align="left"> --access-delegate-tasks &lt;on/off&gt;</td><td align="left">Delegate tasks access (Default is off)</td></tr><tr><td align="left"> --access-edit-public-folder
 
&lt;on/off&gt;</td><td align="left">Edit public folder access (Default is off)</td></tr><tr><td align="left"> --access-forum &lt;on/off&gt;</td><td align="left">Forum module access (Default is
 
off)</td></tr><tr><td align="left"> --access-ical &lt;on/off&gt;</td><td align="left">Ical module access (Default is off)</td></tr><tr><td align="left"> --access-infostore &lt;on/off&gt;</td><td
 
align="left">Infostore module access (Default is off)</td></tr><tr><td align="left"> --access-pinboard-write &lt;on/off&gt;</td><td align="left">Pinboard write access (Default is
 
off)</td></tr><tr><td align="left"> --access-projects &lt;on/off&gt;</td><td align="left">Project module access (Default is off)</td></tr><tr><td align="left"> --access-read-create-shared-Folders
 
&lt;on/off&gt;</td><td align="left">Read create shared folder access (Default is off)</td></tr><tr><td align="left"> --access-rss-bookmarks &lt;on/off&gt;</td><td align="left">RSS bookmarks access
 
(Default is off)</td></tr><tr><td align="left"> --access-rss-portal &lt;on/off&gt;</td><td align="left">RSS portal access (Default is off)</td></tr><tr><td align="left"> --access-syncml
 
&lt;on/off&gt;</td><td align="left">Syncml access (Default is off)</td></tr><tr><td align="left"> --access-active-sync &lt;on/off&gt;</td><td align="left">Exchange Active Sync access (Default is
 
off)</td></tr><tr><td align="left"> --access-usm &lt;on/off&gt;</td><td align="left">Universal Sync Module access (Default is off)</td></tr><tr><td align="left"> --access-tasks
 
&lt;on/off&gt;</td><td align="left">Tasks access (Default is off)</td></tr><tr><td align="left"> --access-vcard &lt;on/off&gt;</td><td align="left">Vcard access (Default is off)</td></tr><tr><td
 
align="left"> --access-webdav &lt;on/off&gt;</td><td align="left">Webdav access (Default is off)</td></tr><tr><td align="left"> --access-webdav-xml &lt;on/off&gt;</td><td align="left">Webdav-Xml
 
access (Default is off)</td></tr><tr><td align="left"> --access-webmail &lt;on/off&gt;</td><td align="left">Webmail access (Default is on)</td></tr><tr><td align="left"> --access-publication
 
&lt;on/off&gt;</td><td align="left">Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium</td></tr><tr><td
 
align="left"> --access-subscription &lt;on/off&gt;</td><td align="left">Subscription permission (Default is on)</td></tr><tr><td align="left"> --access-edit-group &lt;on/off&gt;</td><td
 
align="left">Edit group access (Default is off)</td></tr><tr><td align="left"> --access-edit-resource &lt;on/off&gt;</td><td align="left">Edit resource access (Default is off)</td></tr><tr><td
 
align="left"> --access-edit-password &lt;on/off&gt;</td><td align="left">Edit password access (Default is off)</td></tr><tr><td align="left"> --access-collect-email-addresses
 
&lt;on/off&gt;</td><td align="left">Edit collect email addresses (Default is off)</td></tr><tr><td align="left"> --access-multiple-mail-accounts &lt;on/off&gt;</td><td align="left">Use multiple
 
mail account feature (Default is off)</td></tr><tr><td align="left"> --access-global-address-book-disabled &lt;on/off&gt;</td><td align="left">Access to global address book (Default is off). Note:
 
Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book
 
folder. </td></tr><tr><td align="left"> --access--voipnow &lt;on/off&gt;</td><td align="left">Access to VoiceOverIP feature.</td></tr><tr><td align="left"> --access-public-folder-editable
 
&lt;on/off&gt;</td><td align="left">Access to public folders. Allows or denies to see public folders. </td></tr><tr><td align="left">--foldertree &lt;0/1&gt;</td><td align="left">0 sets the OX
 
standard folder tree and 1 sets the Outlook-like folder tree. </td></tr><tr><td align="left">--access-olox20 &lt;on/off&gt;</td><td align="left"> Access to
 
Olox2.0</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Access changes for existing
 
users</h3></div></div></div><p>Changes to module access must be done for all users in a given context. On downgrade i. e., to revoke former given access,
 
the data for objects will still be present in the database and on the filestore but is not visible to the customer any more. Please note that only the specified modules are changed. That is why it
 
is required to explicitly turn modules off. A list of packages and the required module configuration is provided in <a class="xref" href="ch02.html#clt.sect.packages.access.configuration"
 
title="Package access configuration">the section called “Package access configuration”</a>.</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Context Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td
 
align="left">Context Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return
 
value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div
 
class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>contextid {adminuser adminpass} (userid or
 
username) and at minimum one attribute to change</code></strong></p><p>primaryMail, Email1 and defaultSenderAddress must be present in set of aliases i. e., whenever you want to change one of
 
</p><table class="simplelist" border="0" summary="Simple list"><tr><td>--email</td></tr><tr><td>--email1</td></tr><tr><td>--defaultsenderaddress</td></tr></table><p>
 
  
you MUST take care, that the address you want to set is already contained in the aliases of the user.</p><p>So when user has aliases: foo, bar and you want to change email to anotheraddr, you
 
must add anotheraddr to the aliases, first.</p><p>If needed, this can be done with one commandline call, e.g.:</p><p><strong class="userinput"><code>/changeuser -A oxadmin -P secret -c 666 -i 4 -e
 
anotheraddr -a foo,bar,anotheraddr</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command
 
output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">user &lt;userid&gt; in &lt;contextid&gt; changed</code></p><p>On failure:</p><p><code class="computeroutput">user
 
&lt;userid&gt; in &lt;contextid&gt; could not be changed: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~#</code><strong class="userinput"><code> changeuser -c 123 -i 3 -p newpwd</code></strong></p><p><code
 
class="computeroutput">user 3 in context 123 changed</code></p></div></div>
 
  
 +
[[Category: Administrator]]
  
[[Category: OX7]]
 
 
[[Category: AppSuite]]
 
[[Category: AppSuite]]
 
[[Category: AdminGuide]]
 
[[Category: AdminGuide]]
 +
[[Category: CommandLineTools]]

Revision as of 13:39, 26 November 2018

createuser

createuser is the tool to create new users in a given context. The displayname must be unique in one context.


Parameters

-h,--help Prints a help text
--environment Show infoabout commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
--extendedoptions Set this if you want to see all options, use this instead of help option
csv-import <CSV file> Full path to CSV file with user data to import. This option makes mandatory options obsolete, except credential options (if needed).
-c,--contextid <integer> The id of the context
-u,--username <string> Username of the user
-d,--displayname <string> Display name of the user
-g,--givenname <string> Given name for the user
-s,--surname <string> Surname of the user
-p,--password <string> Password for the user
-e,--email <string> Primary mail address
-l,--language <lang> Language for the user (de_DE,en_US,fr_FR)
-t,--timezone <timezone> Timezone of the user (Europe/Berlin)
-x,--department <string> Department of the user
-z,--company <string> Company of the user
-a,--aliases <string> E-Mail aliases of the user, separated by ","
--access-combination-name <access-combination-name> Access combination name
--addguipreferences <addguipreferences> Add a GUI setting (key=value)

For the GUI preferences please also see [1]


--csv-import <CSV file>

Full path to CSV file with user data to import. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.


With this option you can specify a csv file (a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix "--".


This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to be created, containing the whole data.


Note that the credentials of the masteradmin in the createcontext call must be given on the command line with the -A and -P options nevertheless - if authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this different behavior is that different contexts have different credentials for the admin user, so they must be set in every line of the csv file. Opposed to this the credentials of the masteradmin are always the same.

Extended options

--email1 <string> Email1
--birthday <datevalue> Birthday
--anniversary <datevalue> Anniversary
--branches <string> Branches
--business_category <string> Business_category
--postal_code_business <string> Postal_code_business
--state_business <string> State_business
--street_business <string> Street_business
--telephone_callback <string> Telephone_callback
--city_home <string> City_home
--commercial_register <string> Commercial_register
--country_home <string> Country_home
--email2 <string> Email2
--email3 <string> Email3
--employeetype <string> EmployeeType
--fax_business <string> Fax_business
--fax_home <string> Fax_home
--fax_other <string> Fax_other
--imapserver <string> ImapServer
--imaplogin <string> ImapLogin
--smtpserver <string> SmtpServer
--instant_messenger1 <string> Instant_messenger1
--instant_messenger2 <string> Instant_messenger2
--telephone_ip <string> Telephone_ip
--telephone_isdn <string> Telephone_isdn
--mail_folder_drafts_name <string> Mail_folder_drafts_name
--mail_folder_sent_name <string> Mail_folder_sent_name
--mail_folder_spam_name <string> Mail_folder_spam_name
--mail_folder_trash_name <string> Mail_folder_trash_name
--mail_folder_archive_full_name <string> Mail_folder_archive_full_name
--manager_name <string> Manager_name
--marital_status <string> Marital_status
--cellular_telephone1 <string> Cellular_telephone1
--cellular_telephone2 <string> Cellular_telephone2
--info <string> Info
--nickname <string> Nickname
--number_of_children <string> Number_of_children
--note <string> Note
--number_of_employee <string> Number_of_employee
--telephone_pager <string> Telephone_pager
--password_expired <booleanvalue> Password_expired
--telephone_assistant <string> Telephone_assistant
--telephone_business1 <string> Telephone_business1
--telephone_business2 <string> Telephone_business2
--telephone_car <string> Telephone_car
--telephone_company <string> Telephone_company
--telephone_home1 <string> Telephone_home1
--telephone_home2 <string> Telephone_home2
--telephone_other <string> Telephone_other
--postal_code_home <string> Postal_code_home
--profession <string> Profession
--telephone_radio <string> Telephone_radio
--room_number <string> Room_number
--sales_volume <string> Sales_volume
--city_other <string> City_other
--country_other <string> Country_other
--middle_name <string> Middle_name
--postal_code_other <string> Postal_code_other
--state_other <string> State_other
--street_other <string> Street_other
--spouse_name <string> Spouse_name
--state_home <string> State_home
--street_home <string> Street_home
--suffix <string> Suffix
--tax_id <string> Tax_id
--telephone_telex <string> Telephone_telex
--telephone_ttytdd <string> Telephone_ttytdd
--uploadfilesizelimitperfile <string> Upload file size limit per file for mail attachments
--uploadfilesizelimit <string> Total upload file size limit for mail attachments
--url <string> Url
--userfield01 <string> Userfield01
--userfield02 <string> Userfield02
--userfield03 <string> Userfield03
--userfield04 <string> Userfield04
--userfield05 <string> Userfield05
--userfield06 <string> Userfield06
--userfield07 <string> Userfield07
--userfield08 <string> Userfield08
--userfield09 <string> Userfield09
--userfield10 <string> Userfield10
--userfield11 <string> Userfield11
--userfield12 <string> Userfield12
--userfield13 <string> Userfield13
--userfield14 <string> Userfield14
--userfield15 <string> Userfield15
--userfield16 <string> Userfield16
--userfield17 <string> Userfield17
--userfield18 <string> Userfield18
--userfield19 <string> Userfield19
--userfield20 <string> Userfield20
--city_business <string> City_business
--country_business <string> Country_business
--assistant_name <string> Assistant_name
--telephone_primary <string> Telephone_primary
--categories <string> Categories
--mail_folder_confirmed_ham_name <string> Mail_folder_confirmed_ham_name
--mail_folder_confirmed_spam_name <string> Mail_folder_confirmed_spam_name
--gui_spam_filter_capabilities_enabled <booleanvalue> GUI_spam_filter_capabilities_enabled
--mailenabled <true/false> Mailenabled
--defaultsenderaddress <stringvalue> DefaultSenderAddress
--title <string> Title
--position <string> Position
--access-calendar <on/off> Calendar module (Default is off)
--access-contacts <on/off> Contact module access (Default is on)
--access-delegate-tasks <on/off> Delegate tasks access (Default is off)
--access-edit-public-folder <on/off> Edit public folder access (Default is off)
--access-ical <on/off> Ical module access (Default is off)
--access-infostore <on/off> Infostore module access (Default is off)
--access-read-create-shared-Folders <on/off> Read create shared folder access (Default is off)
--access-syncml <on/off> Syncml access (Default is off)
--access-active-sync <on/off> Exchange Active Sync access (Default is off)
--access-usm <on/off> Universal Sync Module access (Default is off)
--access-tasks <on/off> Tasks access (Default is off)
--access-vcard <on/off> Vcard access (Default is off)

--access-webmail <on/off>

Webmail access (Default is on)
--access-publication <on/off> [DEPRECATED] Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium
--access-subscription <on/off> Subscription permission (Default is on)
--access-edit-group <on/off> Edit group access (Default is off)
--access-edit-resource <on/off> Edit resource access (Default is off)
--access-edit-password <on/off> Edit password access (Default is off)
--access-collect-email-addresses <on/off> Edit collect email addresses (Default is off)
--access-multiple-mail-accounts <on/off> Use multiple mail account feature (Default is off)
--access-global-address-book-disabled <on/off> Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder.
--access--voipnow <on/off> Access to VoiceOverIP feature.
--access-public-folder-editable <on/off> Access to public folders. Allows or denies to see public folders.
--foldertree <0/1> 0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.
--access-olox20 <on/off> [DEPRECATED] Access to Olox2.0
--default-folder-mode The mode how the default folders should be created. 'default', 'default-deletable', 'no-default-folders'. If not selected, 'default' is applied.

Open-Xchange module access

With Open-Xchange it is possible to limit the access to the available modules per context i. e., all users in one context per default get the same access rights. The rights though can be changed per user. Currently, following modules are implemented: access-calendar, access-contacts, access-delegate-tasks, access-edit-public-folder, access-ical, access-infostore, access-read-create-shared-Folders, access-tasks, access-vcard, access-webdav, access-syncml and access-webmail. There are several combinations possible and four are supported (not mentioned modules need to be disabled). This limitation is needed because some modules depend on access to others. There are different Open-Xchange packages available for the customer: Webmail+, PIM+, Groupware+, Premium. These packages have to be configured per context i. e., all users in a context need to use the same package. Each package consists of a combination of modules that has to be set up appropriately. The following sections quickly introduce the packages and their module configuration. Open-Xchange also provides the possibility to use "access combination names" when creating and changing contexts/users. If you want to change the package acess rights for a context, you can simply add the "access-combination-name" switch to the appropriate tool (createcontext,createuser,changecontext etc.).


Webmail+

If there are no access rights specified when creating a new user Webmail+ is used as default. Webmail+ is a base package that allows access to the webmail interface and a personal address book. To grant access to this package, the following modules have to be set to "on" for all users in a context:


access-contacts Access combination name: webmail_plus
access-webmail Access combinationname: webmail_plus

PIM+

PIM+ is another base package that gives access to the webmailer, personal address book, calendar and tasks. Group appointments and delegating tasks are not supported. To grant access to this package, the following modules have to be set to "on" for all users in a context:


access-contacts Access combination name: pim_plus
access-webmail Access combination name: pim_plus
access-calendar Access combination name: pim_plus
access-delegate-tasks Access combination name: pim_plus
access-tasks Access combination name: pim_plus

Groupware+

Groupware+ is an upsell package that provides full groupware functionality: private, shared and public folders, conflict handling for appointments, team view. Furthermore, the InfoStore is available. To grant access to this package, the following modules have to be set to "on" for all users in a context:


access-contacts Access combination name: groupware_plus
access-webmail Access combination name: groupware_plus
access-calendar Access combination name: groupware_plus
access-delegate-tasks Access combination name: groupware_plus
access-tasks Access combination name: groupware_plus
access-edit-public-folder Access combination name: groupware_plus
access-infostore Access combination name: groupware_plus
access-read-create-shared-Folders Access combination name: groupware_plus

Premium

Premium is a desktop integration package. It provides the functionality of the "Groupware+" package and comes with interfaces to integrate with other software: The OXtender for MS Outlook and the WebDAV interface to integrate the InfoStore with desktops. To grant access to this package, the following modules have to be set to "on" for all users in a context:


access-contacts Access combination name: premium
access-webmail Access combination name: premium
access-calendar Access combination name: premium
access-delegate-tasks Access combination name: premium
access-tasks Access combination name: premium
access-edit-public-folder Access combination name: premium
access-infostore Access combination name: premium
access-read-create-shared-Folders Access combination name: premium
access-ical Access combination name: premium
access-vcard Access combination name: premium
access-webdav Access combination name: premium

All

The setting all is equivalent to premium for ordinary users. For context administrators, it adds the right publicfoldereditable, which allows the admin to change the access rights to public folders for groups.

Package access configuration

This section provides a quick overview about the different packages that can be configured per context and the required access configuration:


Module Webmail+ PIM+ Groupware+ Premium
-access-calendar off on on on
-access-contacts on on on on
-access-delegate-tasks off on on on
-access-edit-public-folder off off on on
-access-ical off off off on
-access-infostore off off on on
-access-read-create-shared-Folders off off on on
-access-syncml off off off off
–access-tasks off on on on
-access-vcard off off off on
-access-webdav off off off on
-access-webmail on on on on

Extra parameters when authentication is enabled

-A,--adminuser <string> Context admin user name
-P,--adminpass <string> Context admin password

Return value

0 on success

>0 on failure


Mandatory parameters

contextid {adminuser adminpass} username displayname givenname surname password email

Command output

On success:

user <userid> in context <contextid> created

On failure:

user in context <contextid> could not be created: <reason from server>


Example

root@oxhe~# /opt/open-xchange/sbin/createuser -c 123 -u jd -d "john doe" -g John -s Doe -p userpw -e jd@example.com


user 3 in context 123 created


deleteuser

deleteuser is the tool to delete a user in a given context. If you delete a user the public folder entries of this user are transferred to the admin user. All other data are deleted.


Parameters

-h,--help Prints a help text
--environment Show info about commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
-c,--contextid <integer> The id of them context
-i,--userid <integer> Id of the user
-u,--username <string> Username ofthe user

Extra parameters when authentication is enabled

-A,--adminuser <string> Context Admin user name
-P,--adminpass <string> Context Admin password

Return value

0 on success

>0 on failure


Mandatory parameters

contextid {adminuser adminpass} (userid or username)

Command output

On success:

user <userid> in context <contextid> deleted


On failure:

user <userid> in context <contextid> could not be deleted: <reason from server>


Example

root@oxhe~# /opt/open-xchange/deleteuser -c 123 -i 3

user 3 in context 123 deleted


listuser

listuser is the tool to list and search for users.


Parameters

-h,--help Prints a help text
--environment Show info about commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
-c,--contextid <integer> The id of the context
-s,--searchpattern <string> Search/List pattern, default “*”
--csv Command output as csv
-i,--ignorecase Do a case-insensitive search with the given search pattern
--includeguests Add guest users to listing Available with v7.8.0
--excludeusers Exclude usual users from listing Available with v7.8.0

Extra parameters when authentication is enabled

-A,--adminuser <string> Context Admin user name
-P,--adminpass <string> Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid adminuser adminpass

Command output

Standard output (only a subset of available attributes are printed also only disabled modules):


id enabled imapServer smtpserver language Webdav
3 true localhost localhost en_US false false

csv output: Name,Language,Id,Display_name,PrimaryEmail,MaxQuota,UsedQuota,Email1,Mailenabled,Password,Sur_name,Given_name, FilestoreId,FilestoreOwner,Filestore_name,Birthday,Anniversary,Branches,Business_category,Postal_code_business, State_business,Street_business,Telephone_callback,City_home,Commercial_register,Country_home,Company,Department, Email2,Email3,EmployeeType,Fax_business,Fax_home,Fax_other,ImapServer,ImapLogin,SmtpServer,Instant_messenger1, Instant_messenger2,Telephone_ip,Telephone_isdn,Mail_folder_drafts_name,Mail_folder_sent_name, Mail_folder_spam_name,Mail_folder_trash_name,Mail_folder_archive_full_name,Manager_name,Marital_status,Cellular_telephone1,Cellular_telephone2, Info,Nickname,Number_of_children,Note,Number_of_employee,Telephone_pager,Password_expired,Telephone_assistant, Telephone_business1,Telephone_business2,Telephone_car,Telephone_company,Telephone_home1,Telephone_home2, Telephone_other,Position,Postal_code_home,Profession,Telephone_radio,Room_number,Sales_volume,City_other, Country_other,Middle_name,Postal_code_other,State_other,Street_other,Spouse_name,State_home,Street_home,Suffix, Tax_id,Telephone_telex,Timezone,Title,Telephone_ttytdd,UploadFileSizeLimit,UploadFileSizeLimitPerFile,Url, Userfield01,Userfield02,Userfield03,Userfield04,Userfield05,Userfield06,Userfield07,Userfield08,Userfield09, Userfield10,Userfield11,Userfield12,Userfield13,Userfield14,Userfield15,Userfield16,Userfield17,Userfield18, Userfield19,Userfield20,Aliases,City_business,Country_business,Assistant_name,Telephone_primary,Categories, PasswordMech,Mail_folder_confirmed_ham_name,Mail_folder_confirmed_spam_name,GUI_Spam_filter_capabilities_enabled, DefaultSenderAddress,FolderTree,UserAttributes,GuiPreferences,access-calendar,access-contacts, access-delegate-tasks,access-edit-public-folder,access-ical,access-infostore, access-read-create-shared-Folders,access-syncml,access-tasks,access-vcard,access-webdav, access-webmail,access-edit-group,access-edit-resource,access-edit-password,access-collect-email-addresses, access-multiple-mail-accounts,access-subscription,access-publication,access-active-sync,access-usm, access-olox20,access-denied-portal,access-global-address-book-disabled,access-public-folder-editable

Example

 root@oxhe:~# /opt/open-xchange/sbin/listuser -c 6 Id Name Displayname Email 2 admin admin admin@example.com 3 holger Holger
holger@example.com 


getusercapabilities

getusercapabilities is the tool to list available capabilities for a certain user.


Parameters

-h,--help Prints a help text
--environment Show info about commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
-c,--contextid <integer> The id of the context
-i,--userid <userid> Id of the user
-u,--username <username> Username of the user

Extra parameters when authentication is enabled

-A,--adminuser <string> Context Admin user name
-P,--adminpass <string> Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid userid adminuser adminpass

Command output

Either "There are no capabilities set for user <user-id> in context <context-id>" or a line-wise listing of identifiers for available capabilities

Example

 root@oxhe:~# /opt/open-xchange/sbin/getusercapabilities -c 6 -i 345

changeuser

The changeuser tool allows to modify attributes of an existing user in a given context. The displayname must be unique in one context.


Parameters

-h,--help Prints a help text
--environment Show info about commandline environment
--nonl Remove all newlines (\n) from output
--responsetimeout <integer> response timeout in seconds for reading response from the backend (default 0s; infinite) Available with v7.8.0
--extendedoptions Set this if you want to see all options, use this instead of help option
-c,--contextid <integer> The id of the context
-i,--userid <integer> Id of the user
-u,--username <string> Username of the user
-d,--displayname <string> Display name of the user
-g,--givenname <string> Given name for the user
-s,--surname <string> Surname of the user
-p,--password <string> Password for the user
-e,--email <string> Primary mail address
-l,--language <lang> Language for the user (de_DE,en_US, fr_FR)
-t,--timezone <timezone> Timezone of the user (Europe/Berlin)
-x,--department <string> Department of the user
-z,--company <string> Company of the user
-a,--aliases <string> E-Mail aliases of the user, separated by ","
--access-combination-name <access-combination-name> Access combination name
--addguipreferences <addguipreferences> Add a GUI setting (key=value)
--removeguipreferences <removeguipreferences> Remove a GUI setting
--access-denied-portal <on/off> Denies portal access (Default is off)
--capabilities-to-add <capabilities-to-add> The capabilities to add as a comma-separated string (from 7.2.0 on)
--capabilities-to-remove <capabilities-to-remove> The capabilities to remove as a comma-separated string (from 7.2.0 on)
--capabilities-to-drop <capabilities-to-drop> The capabilities to drop; e.g. cleanse from storage; as a comma-separated string (from 7.6.0 on)

For the GUI preferences please also see http://www.open-xchange.com/wiki/index.php?title=Gui_path

Extended options

--email1 <string> Email1
--mailenabled <booleanvalue > Mailenabled
--birthday <datevalue> Birthday
--anniversary <datevalue> Anniversary
--branches <string> Branches
--business_category <string> Business_category
--postal_code_business <string> Postal_code_business
--state_business <string> State_business
--street_business <string> Street_business
--telephone_callback <string> Telephone_callback
--city_home <string> City_home
--commercial_register <string> Commercial_register
--country_home <string> Country_home
--email2 <string> Email2
--email3 <string> Email3
--employeetype <string> EmployeeType
--fax_business <string> Fax_business
--fax_home <string> Fax_home
--fax_other <string> Fax_other
--imapserver <string> ImapServer
--imaplogin <string> ImapLogin
--smtpserver <string> SmtpServer
--instant_messenger1 <string> Instant_messenger1
--instant_messenger2 <string> Instant_messenger2
--telephone_ip <string> Telephone_ip
--telephone_isdn <string> Telephone_isdn
--mail_folder_drafts_name <string> Mail_folder_drafts_name
--mail_folder_sent_name <string> Mail_folder_sent_name
--mail_folder_spam_name <string> Mail_folder_spam_name
--mail_folder_trash_name <string> Mail_folder_trash_name
--mail_folder_archive_full_name <string> Mail_folder_archive_full_name
--manager_name <string> Manager_name
--marital_status <string> Marital_status
--cellular_telephone1 <string> Cellular_telephone1
--cellular_telephone2 <string> Cellular_telephone2
--info <string> Info
--nickname <string> Nickname
--number_of_children <string> Number_of_children
--note <string> Note
--number_of_employee <string> Number_of_employee
--telephone_pager <string> Telephone_pager
--password_expired <booleanvalue> Password_expired
--telephone_assistant <string> Telephone_assistant
--telephone_business1 <string> Telephone_business1
--telephone_business2 <string> Telephone_business2
--telephone_car <string> Telephone_car
--telephone_company <string> Telephone_company
--telephone_home1 <string> Telephone_home1
--telephone_home2 <string> Telephone_home2
--telephone_other <string> Telephone_other
--postal_code_home <string> Postal_code_home
--profession <string> Profession
--telephone_radio <string> Telephone_radio
--room_number <string> Room_number
--sales_volume <string> Sales_volume
--city_other <string> City_other
--country_other <string> Country_other
--middle_name <string> Middle_name
--postal_code_other <string> Postal_code_other
--state_other <string> State_other
--street_other <string> Street_other
--spouse_name <string> Spouse_name
--state_home <string> State_home
--street_home <string> Street_home
--suffix <string> Suffix
--tax_id <string> Tax_id
--telephone_telex <string> Telephone_telex
--telephone_ttytdd <string> Telephone_ttytdd
--url <string> Url
--userfield01 <string> Userfield01
--userfield02 <string> Userfield02
--userfield03 <string> Userfield03
--userfield04 <string> Userfield04
--userfield05 <string> Userfield05
--userfield06 <string> Userfield06
--userfield07 <string> Userfield07
--userfield08 <string> Userfield08
--userfield09 <string> Userfield09
--userfield10 <string> Userfield10
--userfield11 <string> Userfield11
--userfield12 <string> Userfield12
--userfield13 <string> Userfield13
--userfield14 <string> Userfield14
--userfield15 <string> Userfield15
--userfield16 <string> Userfield16
--userfield17 <string> Userfield17
--userfield18 <string> Userfield18
--userfield19 <string> Userfield19
--userfield20 <string> Userfield20
--city_business <string> City_business
--country_business <string> Country_business
--assistant_name <string> Assistant_name
--telephone_primary <string> Telephone_primary
--categories <string> Categories
--mail_folder_confirmed_ham_name <string> Mail_folder_confirmed_ham_name
--mail_folder_confirmed_spam_name <string> Mail_folder_confirmed_spam_name
--gui_spam_filter_capabilities_enabled <booleanvalue> GUI_Spam_filter_capabilities_enabled
--defaultsenderaddress<string> DefaultSenderAddress
--title <string> Title
--position <string> Position
--access-calendar

<on/off>

Calendar module (Default is off)
--access-contacts <on/off> Contact module access (Default is on)
--access-delegate-tasks <on/off> Delegate tasks access (Default is off)
--access-edit-public-folder <on/off> Edit public folder access (Default is off)
--access-ical <on/off> Ical module access (Default is off)
--access-infostore <on/off> Infostore module access (Default is off)
--access-read-create-shared-Folders <on/off> Read create shared folder access (Default is off)
--access-syncml <on/off> Syncml access (Default is off)
--access-active-sync <on/off> Exchange Active Sync access (Default is off)
--access-usm <on/off> Universal Sync Module access (Default is off)
--access-tasks <on/off> Tasks access (Default is off)
--access-vcard <on/off> Vcard access (Default is off)
--access-webdav <on/off> Webdav access (Default is off)
--access-webmail <on/off> Webmail access (Default is on)
--access-publication <on/off> [DEPRECATED] Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium
--access-subscription <on/off> Subscription permission (Default is on)
--access-edit-group <on/off> Edit group access (Default is off)
--access-edit-resource <on/off> Edit resource access (Default is off)
--access-edit-password <on/off> Edit password access (Default is off)
--access-collect-email-addresses <on/off> Edit collect email addresses (Default is off)
--access-multiple-mail-accounts <on/off> Use multiple mail account feature (Default is off)
--access-global-address-book-disabled <on/off> Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder.
--access--voipnow <on/off> Access to VoiceOverIP feature.
--access-public-folder-editable <on/off> Access to public folders. Allows or denies to see public folders.
--foldertree <0/1> 0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.
--access-olox20 <on/off> [DEPRECATED] Access to Olox2.0

Access changes for existing users

Changes to module access must be done for all users in a given context. On downgrade i. e., to revoke former given access, the data for objects will still be present in the database and on the filestore but is not visible to the customer any more. Please note that only the specified modules are changed. That is why it is required to explicitly turn modules off. A list of packages and the required module configuration is provided in the section called “Package access configuration”.


Extra parameters when authentication is enabled

Context Admin user name
Context Admin password

Return value

0 on success


>0 on failure


Mandatory parameters

contextid {adminuser adminpass} (userid or username) and at minimum one attribute to change

primaryMail, Email1 and defaultSenderAddress must be present in set of aliases i. e., whenever you want to change one of

  • --email
  • --email1
  • --defaultsenderaddress

you MUST take care, that the address you want to set is already contained in the aliases of the user.


So when user has aliases: foo, bar and you want to change email to anotheraddr, you must add anotheraddr to the aliases, first.


If needed, this can be done with one commandline call, e.g.:


/changeuser -A oxadmin -P secret -c 666 -i 4 -e anotheraddr -a foo,bar,anotheraddr

Command output

On success:


user <userid> in <contextid> changed


On failure:


user <userid> in <contextid> could not be changed: <reason from server>


Example

root@oxhe~# changeuser -c 123 -i 3 -p newpwd


user 3 in context 123 changed