Admin_Frontend_Cli
cli server for Admin
This class handles cli requests for the Admin
Extend:
Tinebase_Frontend_Cli_Abstract
Methods
| Name | Description |
|---|---|
| cleanupMailaccounts | removes mailaccounts that are no longer linked to a user |
| cleanupSmtpDestinations | updates/sanitizes smtp_destinations according to config |
| copyGroupmembersToDifferentGroup | Add all members from one group to another |
| createJwtAccessRoute | |
| createSystemGroupsForAddressbookLists | create system groups for addressbook lists that don't have a system group |
| deleteAccount | examples: - Admin.deleteAccount -- accountName=obsoleteUserName - Admin.deleteAccount -- accountEmail=obsolete@tine.mail |
| deleteUserlessContainers | Delete containers with no users |
| enableAutoMoveNotificationsinSystemEmailAccounts | enabled sieve_notification_move for all system accounts |
| getSetEmailAliasesAndForwards | usage: method=Admin.getSetEmailAliasesAndForwards [-d] [-v] [aliases_forwards.csv] [-- pwlist=pws.csv] |
| importGroups | import groups |
| importUser | import users |
| iterateAddressbookLists | iterate adb lists |
| ldapUserSearchQuery | |
| repairOccurenceTag | |
| repairUserSambaoptions | overwrite Samba options for users |
| setPasswords | set passwords for given user accounts (csv with email addresses or username) - random pw is generated if not in csv |
| setPasswordsFromEmailBackend | set use pws from email backend (for example dovecot) |
| shortenLoginnames | shorten loginnmes to fit ad samaccountname |
| synchronizeGroupAndListMembers | usage: method=Admin.synchronizeGroupAndListMembers [-d] |
| updateNotificationScripts | update notificationScript for all system accounts |
| updateSieveScript | update sieve Script for all mailinglist accounts |
Inherited methods
| Name | Description |
|---|---|
| createContainer | add container |
| createDemoData | create demo data |
| getHelp | echos usage information |
| importegw14 | import from egroupware |
| setContainerGrants | set container grants |
| setContainerGrantsHelper | set containers grants helper |
| setContainerGrantsReadOnly | setContainerGrantsReadOnly |
| updateImportExportDefinition | update or create import/export definition |
Admin_Frontend_Cli::cleanupMailaccounts
Description
public cleanupMailaccounts (\Zend_Console_Getopt $opts)
removes mailaccounts that are no longer linked to a user
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Admin_Frontend_Cli::cleanupSmtpDestinations
Description
public cleanupSmtpDestinations (\Zend_Console_Getopt $opts)
updates/sanitizes smtp_destinations according to config
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Admin_Frontend_Cli::copyGroupmembersToDifferentGroup
Description
public copyGroupmembersToDifferentGroup (\Zend_Console_Getopt $opts)
Add all members from one group to another
Parameters
(\Zend_Console_Getopt) $opts
Return Values
void
Throws Exceptions
\Tinebase_Exception_InvalidArgument
Admin_Frontend_Cli::createJwtAccessRoute
Description
createJwtAccessRoute (void)
Parameters
This function has no parameters.
Return Values
void
Admin_Frontend_Cli::createSystemGroupsForAddressbookLists
Description
public createSystemGroupsForAddressbookLists (\Zend_Console_Getopt $_opts)
create system groups for addressbook lists that don't have a system group
Parameters
(\Zend_Console_Getopt) $_opts
Return Values
void
Admin_Frontend_Cli::deleteAccount
Description
public deleteAccount (\Zend_Console_Getopt $_opts)
examples: - Admin.deleteAccount -- accountName=obsoleteUserName - Admin.deleteAccount -- accountEmail=obsolete@tine.mail
Parameters
(\Zend_Console_Getopt) $_opts
Return Values
int
Throws Exceptions
\Tinebase_Exception_Confirmation
\Tinebase_Exception_InvalidArgument
\Tinebase_Exception_Record_NotAllowed
Admin_Frontend_Cli::deleteUserlessContainers
Description
public deleteUserlessContainers (\Zend_Console_Getopt $opts)
Delete containers with no users
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Admin_Frontend_Cli::enableAutoMoveNotificationsinSystemEmailAccounts
Description
public enableAutoMoveNotificationsinSystemEmailAccounts (\Zend_Console_Getopt $opts)
enabled sieve_notification_move for all system accounts
usage: method=Admin.enableAutoMoveNotificationsinSystemEmailAccounts [-d] -- [folder=Benachrichtigungen]
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Admin_Frontend_Cli::getSetEmailAliasesAndForwards
Description
public getSetEmailAliasesAndForwards (\Zend_Console_Getopt $opts)
usage: method=Admin.getSetEmailAliasesAndForwards [-d] [-v] [aliases_forwards.csv] [-- pwlist=pws.csv]
Parameters
(\Zend_Console_Getopt) $opts
Return Values
void
Admin_Frontend_Cli::importGroups
Description
public importGroups (\Zend_Console_Getopt $_opts)
import groups
Parameters
(\Zend_Console_Getopt) $_opts
Return Values
void
Admin_Frontend_Cli::importUser
Description
public importUser (\Zend_Console_Getopt $_opts)
import users
Parameters
(\Zend_Console_Getopt) $_opts
Return Values
void
Admin_Frontend_Cli::iterateAddressbookLists
Description
public iterateAddressbookLists (\Tinebase_Record_RecordSet $records)
iterate adb lists
Parameters
(\Tinebase_Record_RecordSet) $records
Return Values
void
Admin_Frontend_Cli::ldapUserSearchQuery
Description
ldapUserSearchQuery (void)
Parameters
This function has no parameters.
Return Values
void
Admin_Frontend_Cli::repairOccurenceTag
Description
repairOccurenceTag (void)
Parameters
This function has no parameters.
Return Values
void
Admin_Frontend_Cli::repairUserSambaoptions
Description
public repairUserSambaoptions (void)
overwrite Samba options for users
Parameters
This function has no parameters.
Return Values
void
Admin_Frontend_Cli::setPasswords
Description
public setPasswords (\Zend_Console_Getopt $opts)
set passwords for given user accounts (csv with email addresses or username) - random pw is generated if not in csv
usage: method=Admin.setPasswords [-d] [-v] [userlist1.csv] [userlist2.csv] [-- pw=password sendmail=1 pwlist=pws.csv updateaccount=1 ignorepolicy=1]
- sendmail=1 -> sends mail to user with pw
- pwlist=pws.csv -> creates csv file with the users and their new pws
- updateaccount=1 -> also updates user-accounts (for example to create user email accounts)
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Throws Exceptions
\Tinebase_Exception_AccessDenied
\Tinebase_Exception_InvalidArgument
\Tinebase_Exception_NotFound
Admin_Frontend_Cli::setPasswordsFromEmailBackend
Description
public setPasswordsFromEmailBackend (\Zend_Console_Getopt $opts)
set use pws from email backend (for example dovecot)
usage: method=Admin.setPasswordsFromEmailBackend [-d]
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Admin_Frontend_Cli::shortenLoginnames
Description
public shortenLoginnames (void)
shorten loginnmes to fit ad samaccountname
Parameters
This function has no parameters.
Return Values
void
Admin_Frontend_Cli::synchronizeGroupAndListMembers
Description
public synchronizeGroupAndListMembers (\Zend_Console_Getopt $opts)
usage: method=Admin.synchronizeGroupAndListMembers [-d]
Parameters
(\Zend_Console_Getopt) $opts
Return Values
void
Admin_Frontend_Cli::updateNotificationScripts
Description
public updateNotificationScripts (\Zend_Console_Getopt $opts)
update notificationScript for all system accounts
usage: method=Admin.updateNotificationScripts [-d]
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Throws Exceptions
\Tinebase_Exception_InvalidArgument
\Tinebase_Exception_Record_Validation
Admin_Frontend_Cli::updateSieveScript
Description
public updateSieveScript (\Zend_Console_Getopt $opts)
update sieve Script for all mailinglist accounts
usage: method=Admin.updateNotificationScripts [-d]
Parameters
(\Zend_Console_Getopt) $opts
Return Values
int
Throws Exceptions
\Tinebase_Exception_InvalidArgument
\Tinebase_Exception_Record_Validation