Malasa: /* Enable specific services only / Cascading Config */

2011-09-09T15:28:06Z

Enable specific services only / Cascading Config

← Older revision		Revision as of 15:28, 9 September 2011
Line 84:		Line 84:
	== Enable specific services only / Cascading Config ==		== Enable specific services only / Cascading Config ==

	Furthermore, the plugin will look for a particular configuration path, that is "ui.mail.services.enabled". If this path exists, you can control which services are enabled by the backend. In order to do so, you can add the following to <code>/opt/open-xchange/etc/groupware/settings/ui.properties</code>		Furthermore, the plugin will look for a particular configuration path, that is "ui/mail/services/enabled". If this path exists, you can control which services are enabled by the backend. In order to do so, you can add the following to <code>/opt/open-xchange/etc/groupware/settings/ui.properties</code>
	, for example:		, for example:

Malasa: Created page with "== General == At first, install the UI plugin open-xchange-gui-mail-accounts-plugin from the update tree. The plugin will install into the default UI plugin folder, e.g. <..."

2011-08-30T16:19:14Z

Created page with "== General == At first, install the UI plugin <b>open-xchange-gui-mail-accounts-plugin</b> from the update tree. The plugin will install into the default UI plugin folder, e.g. <..."

New page

== General ==
At first, install the UI plugin <b>open-xchange-gui-mail-accounts-plugin</b> from the update tree. The plugin will install into the default UI plugin folder, e.g. <code>/var/www/ox6/plugins/com.openexchange.mail.accounts/</code> on debian. This plugin has no server component. It's registered by automatically adding its name to plugins/static.conf during post installation. UI updates do not replace this file.

{{InstallPlugin|pluginname=open-xchange-gui-mail-accounts-plugin|sopath=updates}}

== Define services ==

Inside the plugin folder (see above), you will find the configuration file <code>services/config.js</code>. This file contains all services that you want to provide to your customers. Syntactically it's plain JavaScript and from the syntax perspective it's quite self-explaining. Here's an example of how to define just one single service, in this case it's "GoogleMail":

ox.mail.services = {
gmail: {
// Google Mail
name: "Google Mail",
domains: ["gmail.com", "googlemail.com"],
products: {
imap: {
name: "IMAP",
transport_server: "smtp.gmail.com",
mail_protocol: "imap",
mail_server: "imap.gmail.com"
},
pop: {
name: "POP3",
transport_server: "smtp.gmail.com",
mail_server: "pop.gmail.com"
}
},
description: "In order to use your GMail account, you have to enable ....", /*i18n*/
logo: {
src: "gmail.png",
height: "59px"
}
}
};

Each service has an unique id ("gmail"), a name which appears in the UI ("Google Mail"), a list of domains this service supports ("gmail.com" and "googlemail.com"), a description (for example help the user at figuring out how to enable POP3), as well as a logo and the color of the name (e.g. #E20074 for telecom magenta).

Moreover, each service has products instead of just differentiating IMAP from POP3. Some hosters have a huge set of different types of mail accounts (free, secure, fast, premium, business etc.) independent of the technical perspective (i.e. IMAP or POP3).

Each product has an unique id. The following fields are available:

{|
|-
! Field
! Description / defaults
|-
|name
|appears in the UI
|-
|transport_protocol
|default is "smtp"
|-
|transport_server
|IP or domain
|-
|transport_port
|25 or 465 (ssl)
|-
|transport_auth
|use authentication
|-
|transport_auth_short
|cut off domain part, "me" instead of "me@domain.tld"
|-
|transport_secure
|use SSL
|-
|mail_protocol
|"imap" or "pop3". default "pop3"
|-
|mail_server
|IP or domain
|-
|mail_port
|defaults: 110 (pop3), 995 (pop3/ssl), 143 (imap), 993 (imap/ssl)
|-
|mail_auth_short
|same as transport_auth_short
|-
|mail_secure
|use SSL
|}

== Enable specific services only / Cascading Config ==

Furthermore, the plugin will look for a particular configuration path, that is "ui.mail.services.enabled". If this path exists, you can control which services are enabled by the backend. In order to do so, you can add the following to <code>/opt/open-xchange/etc/groupware/settings/ui.properties</code>
, for example:

ui/mail/services/enabled/gmail = true
ui/mail/services/enabled/t_online = true

In this case only two services are enabled. All other services that might be defined in <code>/<plugindir>/services/config.js</code> will be ignored. This configuration supports the Cascading-Configuration, i.e. you can set values for different contexts or context groups. This, of course, requires a proper YAML file.

Install and configure the mail-account plugin - Revision history

Malasa: /* Enable specific services only / Cascading Config */

Malasa: Created page with "== General == At first, install the UI plugin open-xchange-gui-mail-accounts-plugin from the update tree. The plugin will install into the default UI plugin folder, e.g. <..."