JBoss.orgCommunity Documentation
Since eXo Collaboration 2.2.0, MailSettingConfigPlugin is used to define the behavior, for example, showing/hiding fields and checking/unchecking checkboxes, of email account settings in the mail-server-configuration.xml file. It allows administrators to preconfigure all settings and to specify if end-users have the modification right on each specific setting or not.
<external-component-plugins>
<target-component>org.exoplatform.mail.service.MailService</target-component>
<component-plugin>
<name>cs.mail.service.settings</name>
<set-method>addPlugin</set-method>
<type>org.exoplatform.mail.service.MailSettingConfigPlugin</type>
<description>description</description>
<init-params>
<object-param>
<name>leaveOnServer</name>
<description>options to keep a copy of the message on the mail server after eXo Mail has downloaded the message</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>leaveOnServer</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>true</string></field>
</object>
</object-param>
<object-param>
<name>incomingServer</name>
<description>default incoming server to check for new mails.</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>incomingServer</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>imap.gmail.com</string></field>
</object>
</object-param>
<object-param>
<name>incomingPort</name>
<description>default port incoming server to check for new mails.</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>incomingPort</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>993</string></field>
</object>
</object-param>
<object-param>
<name>outgoingServer</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>outgoingServer</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>smtp.gmail.com</string></field>
</object>
</object-param>
<object-param>
<name>outgoingPort</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>outgoingPort</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>465</string></field>
</object>
</object-param>
<object-param>
<name>acceptIncomingSecureAuthentication</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>acceptIncomingSecureAuthentication</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>true</string></field>
</object>
</object-param>
<object-param>
<name>incomingSecureAuthentication</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>incomingSecureAuthentication</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>starttls</string></field>
</object>
</object-param>
<object-param>
<name>incomingAuthenticationMechanism</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>incomingAuthenticationMechanism</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>plain</string></field>
</object>
</object-param>
<object-param>
<name>acceptOutgoingSecureAuthentication</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>acceptOutgoingSecureAuthentication</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>true</string></field>
</object>
</object-param>
<object-param>
<name>outgoingSecureAuthentication</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>outgoingSecureAuthentication</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>starttls</string></field>
</object>
</object-param>
<object-param>
<name>outgoingAuthenticationMechanism</name>
<description>description</description>
<object type="org.exoplatform.mail.service.MailSettingConfig">
<field name="name"><string>outgoingAuthenticationMechanism</string></field>
<field name="userAllowed"><boolean>true</boolean></field>
<field name="defaultValue"><string>plain</string></field>
</object>
</object-param>
</init-params>
</component-plugin>
</external-component-plugins>
Details:
Name: cs.mail.service.settings
- The name of the mail settings.
Set-method: addPlugin
- The plugin which registers the method.
Type: org.exoplatform.mail.service.MailSettingConfigPlugin
- The plugin's class name.
object type: org.exoplatform.mail.service.MailSettingConfig
- A class of object that contains a specific setting.
Description: Describes what the setting is or what the setting does.
Object-param | Desciption |
---|---|
leaveOnServer | Options to keep the message on the mail server after it has been downloaded to the Mail application of eXo Collaboration. |
incomingServer | The default incoming server used to check new mails. |
incomingPort | The default port of the incoming server used to check new mails. |
outgoingServer | The default port of the outgoing server used to send new mails. |
outgoingPort | The default outgoing port to send new mails. |
acceptIncomingSecureAuthentication | Accept the secure authentication of the incoming server. |
incomingSecureAuthentication | The type of incoming secure authentication. |
incomingAuthenticationMechanism | The type of incoming authentication mechanism. |
acceptOutgoingSecureAuthentication | Accepts the secure authentication of the outgoing server. |
outgoingSecureAuthentication | The type of outgoing secure authentication. |
outgoingAuthenticationMechanism | The type of incoming authentication mechanism. |
The object parameters have the same field names, but the values of the parameters are different.
Field names | Description | Possible values |
---|---|---|
name | The field name in the account settings form. | String |
userAllowed | Allow users to edit the field in the account settings form or not. | Boolean |
defaultValue | The default value of the field in the account settings form. | String |