diff --git a/emailadmin/setup/tables_current.inc.php b/emailadmin/setup/tables_current.inc.php index 23476d705e..3f700e215e 100644 --- a/emailadmin/setup/tables_current.inc.php +++ b/emailadmin/setup/tables_current.inc.php @@ -14,46 +14,46 @@ $phpgw_baseline = array( 'egw_emailadmin' => array( 'fd' => array( - 'ea_profile_id' => array('type' => 'auto','nullable' => False), - 'ea_smtp_server' => array('type' => 'varchar','precision' => '80'), - 'ea_smtp_type' => array('type' => 'varchar','precision' => '56'), - 'ea_smtp_port' => array('type' => 'int','precision' => '4'), - 'ea_smtp_auth' => array('type' => 'varchar','precision' => '3'), - 'ea_editforwardingaddress' => array('type' => 'varchar','precision' => '3'), - 'ea_smtp_ldap_server' => array('type' => 'varchar','precision' => '80'), - 'ea_smtp_ldap_basedn' => array('type' => 'varchar','precision' => '200'), - 'ea_smtp_ldap_admindn' => array('type' => 'varchar','precision' => '200'), - 'ea_smtp_ldap_adminpw' => array('type' => 'varchar','precision' => '30'), - 'ea_smtp_ldap_use_default' => array('type' => 'varchar','precision' => '3'), - 'ea_imap_server' => array('type' => 'varchar','precision' => '80'), - 'ea_imap_type' => array('type' => 'varchar','precision' => '56'), - 'ea_imap_port' => array('type' => 'int','precision' => '4'), - 'ea_imap_login_type' => array('type' => 'varchar','precision' => '20'), - 'ea_imap_tsl_auth' => array('type' => 'varchar','precision' => '3'), - 'ea_imap_tsl_encryption' => array('type' => 'varchar','precision' => '3'), - 'ea_imap_enable_cyrus' => array('type' => 'varchar','precision' => '3'), - 'ea_imap_admin_user' => array('type' => 'varchar','precision' => '40'), - 'ea_imap_admin_pw' => array('type' => 'varchar','precision' => '40'), - 'ea_imap_enable_sieve' => array('type' => 'varchar','precision' => '3'), - 'ea_imap_sieve_server' => array('type' => 'varchar','precision' => '80'), - 'ea_imap_sieve_port' => array('type' => 'int','precision' => '4'), - 'ea_description' => array('type' => 'varchar','precision' => '200'), - 'ea_default_domain' => array('type' => 'varchar','precision' => '100'), - 'ea_organisation_name' => array('type' => 'varchar','precision' => '100'), - 'ea_user_defined_identities' => array('type' => 'varchar','precision' => '3'), - 'ea_user_defined_accounts' => array('type' => 'varchar','precision' => '3'), - 'ea_order' => array('type' => 'int','precision' => '4'), - 'ea_appname' => array('type' => 'varchar','precision' => '80'), - 'ea_group' => array('type' => 'varchar','precision' => '80'), - 'ea_user' => array('type' => 'varchar','precision' => '80'), - 'ea_active' => array('type' => 'int','precision' => '4'), - 'ea_smtp_auth_username' => array('type' => 'varchar','precision' => '80'), - 'ea_smtp_auth_password' => array('type' => 'varchar','precision' => '80'), - 'ea_user_defined_signatures' => array('type' => 'varchar','precision' => '3'), - 'ea_default_signature' => array('type' => 'text'), - 'ea_imap_auth_username' => array('type' => 'varchar','precision' => '80'), - 'ea_imap_auth_password' => array('type' => 'varchar','precision' => '80'), - 'ea_stationery_active_templates' => array('type' => 'text') + 'ea_profile_id' => array('type' => 'auto','nullable' => False,'comment'=>'the id of the profile; in programm its used as its negative counterpart'), + 'ea_smtp_server' => array('type' => 'varchar','precision' => '80','comment'=>'smtp server name or ip-address'), + 'ea_smtp_type' => array('type' => 'varchar','precision' => '56','comment'=>'smtp server type; designed to specify the corresponding php class to be used/loaded'), + 'ea_smtp_port' => array('type' => 'int','precision' => '4','comment'=>'port to be used'), + 'ea_smtp_auth' => array('type' => 'varchar','precision' => '3','comment'=>'multistate flag to indicate authentication required'), + 'ea_editforwardingaddress' => array('type' => 'varchar','precision' => '3','comment'=>'yes/no flag to indicate if a user is allowed to edit its own forwardingaddresses; server side restrictions must be met, and a suitable smtp server type selected'), + 'ea_smtp_ldap_server' => array('type' => 'varchar','precision' => '80','comment'=>'unused'), + 'ea_smtp_ldap_basedn' => array('type' => 'varchar','precision' => '200','comment'=>'unused'), + 'ea_smtp_ldap_admindn' => array('type' => 'varchar','precision' => '200','comment'=>'unused'), + 'ea_smtp_ldap_adminpw' => array('type' => 'varchar','precision' => '30','comment'=>'unused'), + 'ea_smtp_ldap_use_default' => array('type' => 'varchar','precision' => '3','comment'=>'unused'), + 'ea_imap_server' => array('type' => 'varchar','precision' => '80','comment'=>'imap server name or ip address'), + 'ea_imap_type' => array('type' => 'varchar','precision' => '56','comment'=>'imap server type, designed to specify the corresponding mail class to be loaded/used'), + 'ea_imap_port' => array('type' => 'int','precision' => '4','comment'=>'imap server port'), + 'ea_imap_login_type' => array('type' => 'varchar','precision' => '20','comment'=>'logintype to be used for authentication vs. the imap server, for this profile'), + 'ea_imap_tsl_auth' => array('type' => 'varchar','precision' => '3','comment'=>'flag to indicate wether to use certificate validation; only affects secure connections'), + 'ea_imap_tsl_encryption' => array('type' => 'varchar','precision' => '3','comment'=>'wether to use encryption 0=none, 1=STARTTLS, 2=TLS, 3=SSL'), + 'ea_imap_enable_cyrus' => array('type' => 'varchar','precision' => '3','comment'=>'flag to indicate if we have some server/system integration for account/email management'), + 'ea_imap_admin_user' => array('type' => 'varchar','precision' => '40','comment'=>'use this username for authentication on administrative purposes; or timed actions (sieve) for a user'), + 'ea_imap_admin_pw' => array('type' => 'varchar','precision' => '40','comment'=>'use this password for authentication on administrative purposes; or timed actions (sieve) for a user'), + 'ea_imap_enable_sieve' => array('type' => 'varchar','precision' => '3','comment'=>'flag to indicate that sieve support is assumed, and may be allowed to be utilized by the users affected by this profile'), + 'ea_imap_sieve_server' => array('type' => 'varchar','precision' => '80','comment'=>'sieve server name or ip-address'), + 'ea_imap_sieve_port' => array('type' => 'int','precision' => '4','comment'=>'sieve server port'), + 'ea_description' => array('type' => 'varchar','precision' => '200','comment'=>'textual descriptor used for readable distinction of profiles'), + 'ea_default_domain' => array('type' => 'varchar','precision' => '100','comment'=>'default domain string, used when vmailmanager is used as auth type for imap (also for smtp if auth is required)'), + 'ea_organisation_name' => array('type' => 'varchar','precision' => '100','comment'=>'textual organization string, may be used in mail header'), + 'ea_user_defined_identities' => array('type' => 'varchar','precision' => '3','comment'=>'yes/no flag to indicate if this profile is allowing the utiliszation of user defined identities'), + 'ea_user_defined_accounts' => array('type' => 'varchar','precision' => '3','comment'=>'yes/no flag to indicate if this profile is allowing the utilization of user defined mail accounts'), + 'ea_order' => array('type' => 'int','precision' => '4','comment'=>'helper to define the order of the profiles'), + 'ea_appname' => array('type' => 'varchar','precision' => '80','comment'=>'appname the profile is to be used for; of no practical use, as of my knowledge, was designed to allow notification to use a specific profile'), + 'ea_group' => array('type' => 'varchar','precision' => '80','comment'=>'the usergroup (primary) the given profile should be applied to','meta'=>'group'), + 'ea_user' => array('type' => 'varchar','precision' => '80','comment'=>'the user the given profile should be applied to','meta'=>'user'), + 'ea_active' => array('type' => 'int','precision' => '4','comment'=>'flag to indicate that a profile is active'), + 'ea_smtp_auth_username' => array('type' => 'varchar','precision' => '128','comment'=>'depending on smtp auth type, use this username for authentication; may hold a semicolon separated emailaddress, to specify the emailaddress to be used on sending e.g.:username;email@address.nfo'), + 'ea_smtp_auth_password' => array('type' => 'varchar','precision' => '80','comment'=>'depending on smtp auth type, the password to be used for authentication'), + 'ea_user_defined_signatures' => array('type' => 'varchar','precision' => '3','comment'=>'flag to indicate, that this profile allows its users to edit and use own signatures (rights to preferences-app needed)'), + 'ea_default_signature' => array('type' => 'text','comment'=>'the default signature (text or html)'), + 'ea_imap_auth_username' => array('type' => 'varchar','precision' => '80','comment'=>'depending on the imap auth type use this username for authentication purposes'), + 'ea_imap_auth_password' => array('type' => 'varchar','precision' => '80','comment'=>'depending on the imap auth type use this password for authentication purposes'), + 'ea_stationery_active_templates' => array('type' => 'text','comment'=>'stationery templates available for the profile') ), 'pk' => array('ea_profile_id'), 'fk' => array(), @@ -62,10 +62,10 @@ $phpgw_baseline = array( ), 'egw_mailaccounts' => array( 'fd' => array( - 'mail_id' => array('type' => 'auto','nullable' => False), - 'account_id' => array('type' => 'int','precision' => '4','nullable' => False), + 'mail_id' => array('type' => 'auto','nullable' => False,'comment'=>'the id'), + 'account_id' => array('type' => 'int','precision' => '4','nullable' => False,'comment'=>'account id of the owner, can be user AND group','meta'=>'account'), 'mail_type' => array('type' => 'int','precision' => '1','nullable' => False,'comment' => '0=active, 1=alias, 2=forward, 3=forwardOnly, 4=quota'), - 'mail_value' => array('type' => 'varchar','precision' => '128','nullable' => False) + 'mail_value' => array('type' => 'varchar','precision' => '128','nullable' => False,'comment'=>'the value (that should be) corresponding to the mail_type') ), 'pk' => array('mail_id'), 'fk' => array(), diff --git a/felamimail/setup/tables_current.inc.php b/felamimail/setup/tables_current.inc.php index f4642298ed..51015ce9e8 100644 --- a/felamimail/setup/tables_current.inc.php +++ b/felamimail/setup/tables_current.inc.php @@ -14,8 +14,8 @@ $phpgw_baseline = array( 'egw_felamimail_displayfilter' => array( 'fd' => array( - 'fmail_filter_accountid' => array('type' => 'int','precision' => '4','nullable' => False), - 'fmail_filter_data' => array('type' => 'text') + 'fmail_filter_accountid' => array('type' => 'int','precision' => '4','nullable' => False,'comment'=>'account id of filter owner','meta'=>'user'), + 'fmail_filter_data' => array('type' => 'text','comment'=>'','meta'=>'','comment'=>'serialized filter') ), 'pk' => array('fmail_filter_accountid'), 'fk' => array(), @@ -24,32 +24,32 @@ ), 'egw_felamimail_accounts' => array( 'fd' => array( - 'fm_owner' => array('type' => 'int','precision' => '4','nullable' => False), - 'fm_id' => array('type' => 'auto'), - 'fm_realname' => array('type' => 'varchar','precision' => '128'), - 'fm_organization' => array('type' => 'varchar','precision' => '128'), - 'fm_emailaddress' => array('type' => 'varchar','precision' => '128','nullable' => False), - 'fm_signatureid' => array('type' => 'int','precision' => '4'), - 'fm_ic_hostname' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_port' => array('type' => 'int','precision' => '4'), - 'fm_ic_username' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_password' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_encryption' => array('type' => 'int','precision' => '4'), - 'fm_og_hostname' => array('type' => 'varchar','precision' => '128'), - 'fm_og_port' => array('type' => 'int','precision' => '4'), - 'fm_og_smtpauth' => array('type' => 'bool'), - 'fm_og_username' => array('type' => 'varchar','precision' => '128'), - 'fm_og_password' => array('type' => 'varchar','precision' => '128'), - 'fm_active' => array('type' => 'bool','nullable' => False), - 'fm_ic_validatecertificate' => array('type' => 'bool'), - 'fm_ic_enable_sieve' => array('type' => 'bool','precision' => '255'), - 'fm_ic_sieve_server' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_sieve_port' => array('type' => 'int','precision' => '4'), - 'fm_ic_folderstoshowinhome' => array('type' => 'text'), - 'fm_ic_sentfolder' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_trashfolder' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_draftfolder' => array('type' => 'varchar','precision' => '128'), - 'fm_ic_templatefolder' => array('type' => 'varchar','precision' => '128'), + 'fm_owner' => array('type' => 'int','precision' => '4','nullable' => False,'comment'=>'account id of profile owner','meta'=>'user'), + 'fm_id' => array('type' => 'auto','comment'=>'id of the profile'), + 'fm_realname' => array('type' => 'varchar','precision' => '128','comment'=>'textual descriptor for the profile'), + 'fm_organization' => array('type' => 'varchar','precision' => '128','comment'=>'additional textual descriptor for the profile, used for organization in mail-header fields'), + 'fm_emailaddress' => array('type' => 'varchar','precision' => '128','nullable' => False,'comment'=>'email address'), + 'fm_signatureid' => array('type' => 'int','precision' => '4','comment'=>'reference to egw_felamimail_signatures'), + 'fm_ic_hostname' => array('type' => 'varchar','precision' => '128','comment'=>'incomming server hostname or ip'), + 'fm_ic_port' => array('type' => 'int','precision' => '4','comment'=>'incomming server port'), + 'fm_ic_username' => array('type' => 'varchar','precision' => '128','comment'=>'incomming server username to use in authentication process'), + 'fm_ic_password' => array('type' => 'varchar','precision' => '128','comment'=>'incomming server password to be used for authentication'), + 'fm_ic_encryption' => array('type' => 'int','precision' => '4','comment'=>'wether to use encryption 0=none, 1=STARTTLS, 2=TLS, 3=SSL'), + 'fm_og_hostname' => array('type' => 'varchar','precision' => '128','comment'=>'outgoing server hostname or ip'), + 'fm_og_port' => array('type' => 'int','precision' => '4', 'comment'=>'outgoing server port'), + 'fm_og_smtpauth' => array('type' => 'bool','comment'=>'flag to indicate that authentication is required for sending emails'), + 'fm_og_username' => array('type' => 'varchar','precision' => '128','comment'=>'outgoing server username to use for authentication'), + 'fm_og_password' => array('type' => 'varchar','precision' => '128','comment'=>'outgoing server password to be used to authenticate'), + 'fm_active' => array('type' => 'bool','nullable' => False,'comment'=>'flag to indicate that the profile is active; may be set to active even for identity profiles'), + 'fm_ic_validatecertificate' => array('type' => 'bool','comment'=>'flag to indicate wether to use certificate validation; only affects secure connections'), + 'fm_ic_enable_sieve' => array('type' => 'bool','precision' => '255','comment'=>'tell the program, that you expect SIEVE to be implemented SERVER side'), + 'fm_ic_sieve_server' => array('type' => 'varchar','precision' => '128','comment'=>'sieve server name or ip address; program simply stores a copy of incomming server'), + 'fm_ic_sieve_port' => array('type' => 'int','precision' => '4','comment'=>'Sieve server port'), + 'fm_ic_folderstoshowinhome' => array('type' => 'text','comment'=>'serialized array of a folderselection to be shown in home area (folder with counters)'), + 'fm_ic_sentfolder' => array('type' => 'varchar','precision' => '128','comment'=>'configuration option for ic server specific sent folder'), + 'fm_ic_trashfolder' => array('type' => 'varchar','precision' => '128','comment'=>'configuration option for ic server specific trash folder'), + 'fm_ic_draftfolder' => array('type' => 'varchar','precision' => '128','comment'=>'configuration option for ic server specific drafts folder'), + 'fm_ic_templatefolder' => array('type' => 'varchar','precision' => '128','comment'=>'configuration option for ic server specific templates folder'), ), 'pk' => array('fm_id'), 'fk' => array(), @@ -58,11 +58,11 @@ ), 'egw_felamimail_signatures' => array( 'fd' => array( - 'fm_signatureid' => array('type' => 'auto'), - 'fm_accountid' => array('type' => 'int','precision' => '11'), - 'fm_signature' => array('type' => 'text'), - 'fm_description' => array('type' => 'varchar','precision' => '255'), - 'fm_defaultsignature' => array('type' => 'bool') + 'fm_signatureid' => array('type' => 'auto','comment'=>'primary key; id of a signature'), + 'fm_accountid' => array('type' => 'int','precision' => '11','comment'=>'owner of the signature','meta'=>'user'), + 'fm_signature' => array('type' => 'text','comment'=>'signature in html or plain text format'), + 'fm_description' => array('type' => 'varchar','precision' => '255','comment'=>'textual description for the signature given'), + 'fm_defaultsignature' => array('type' => 'bool','comment'=>'flag to indicate wether this signature is to be used as default for the owner specified') ), 'pk' => array('fm_signatureid'), 'fk' => array(),