C3Fire

Difference between revisions of "Config/Config Mail"

From C3LearningLabs
(Created page with "{{DISPLAYTITLE:Mail Configuration}}")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Mail Configuration}}
 
{{DISPLAYTITLE:Mail Configuration}}
 +
 +
=Mail Config=
 +
 +
The xml element MailConfig defines the main mail system properties. <br>
 +
Individual mail settings are defined in the role definition for all users.
 +
 +
More about the mail system at '''[[Doc/Organization#Mail|Mail System]]'''.
 +
 +
The mail is defined with the following properties:
 +
{| class="wikitable"
 +
|+
 +
|-
 +
!style="text-align: left;" |
 +
Property
 +
!style="text-align: left;" |
 +
Value
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
UseRoleSendButtons
 +
|style="vertical-align: text-top;"|
 +
Not used
 +
 +
Value example = ""
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
ViewNextMailButtonAlwaysEnabled
 +
|style="vertical-align: text-top;"|
 +
Value example= "true" 
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
ReceiveMailSound
 +
|style="vertical-align: text-top;"|
 +
The sound that are played when a role receive a mail.<br>
 +
The audio file should be located in the audio directory <C3FIRE-AUDIO> located at <C3FIRE-WWW-<br>ROOT>/audio/.
 +
 +
Value example= "bottle-open.wav" 
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
LineWrap
 +
|style="vertical-align: text-top;"|
 +
The text on a row in the mail box are automatically line wraped if the text is longer than the line.
 +
                                                       
 +
Value example= "true" ,False"
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
ReceiveAppend
 +
|style="vertical-align: text-top;"|
 +
If old mail should be visible or not.
 +
 +
If ReceiveAppend is set to true all mails will be saved in the mail view panel. If it is set to false the<br> present mail dissapear when a new mail is viewed.
 +
 +
Value example="True", "false"
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
UnReadMailBackgroundColor
 +
|style="vertical-align: text-top;"|
 +
The color of the mail read panel background when the user has a mail that he or she has not read.
 +
 +
Value example= "#F0D0D0" />  "#FFFFFF"<br>                 
 +
[[File:C3system-config-session-unit-window-unread-mail-background-color-small.gif]]<br>
 +
"#F0D0D0                                                                             
 +
|-
 +
|}
 +
 +
<syntaxhighlight lang="xml">
 +
  <MailConfig
 +
    AcceptedKeyStroke = ""
 +
    LineWrap = "true"
 +
    ReadMailDuringPause = "False"
 +
    ReceiveAppend = "true"
 +
    ReceiveMailSound = ""
 +
    SendMailDuringPause = "False"
 +
    UnReadMailBackgroundColor = "#A05050"
 +
    ViewNextMailButtonAlwaysEnabled = "true" />
 +
</syntaxhighlight>
 +
 +
=== Mail Groups ===
 +
It is possible to create mail grops so that all members of a group receives the mail when mail send to that group.
 +
 +
The xml element MailGroups defines the mail groups.
 +
 +
 +
The mail groups are defined with the following properties:
 +
{| class="wikitable"
 +
|+
 +
|-
 +
!style="text-align: left;" |
 +
Property
 +
!style="text-align: left;" |
 +
Value
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
IDName
 +
|style="vertical-align: text-top;"|
 +
The identification name
 +
 +
Value example = "FireChiefs"
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
Members
 +
|style="vertical-align: text-top;"|
 +
The members in the group.
 +
 +
Value example= "A,B,C" 
 +
|-
 +
|style="background-color:#bbeeff; vertical-align: text-top;"|
 +
ToText
 +
|style="vertical-align: text-top;"|
 +
The text on the mail button<br>
 +
or the mail adress that the sender should write to send to the group.
 +
 +
Value example= "Fire" 
 +
|}
 +
 +
Example
 +
<syntaxhighlight lang="xml">
 +
  <MailGroups>
 +
 +
    <MailGroup
 +
      IDName = "FireChiefs"
 +
      Members = "C,E,G"
 +
      ToText = "Fire" />
 +
 +
    <MailGroup
 +
      IDName = "RescueChiefs"
 +
      Members = "H,I,K"
 +
      ToText = "Rescue" />
 +
 +
  </MailGroups>
 +
</syntaxhighlight>
 +
 +
No mail gropes is defined with an empty MailGroups element.
 +
 +
<syntaxhighlight lang="xml">
 +
<MailGroups/>
 +
</syntaxhighlight>
 +
 +
 +
'''Role can send to'''<br>
 +
 +
In Role definition add the group IDName that the role should be able to send to.
 +
 +
Example
 +
<syntaxhighlight lang="xml">
 +
  <Role
 +
      ...
 +
      MailSendTo = "B,C,E,G,FireChiefs,RescueChiefs"
 +
      ...
 +
</syntaxhighlight>
 +
 +
<br>
 +
;Configuration Editor
 +
:Members of the mail groups can be defined in the mail group configuration Editor.
 +
 +
:[[File:c3fire-doc-agile-organization-mailgroup-edit.png|border|Mail group editor]]<br>
 +
 +
:More about UI supported configuration at '''[[Doc/AgileOrganization#Role_configuration|Role Configuration Editor]]'''.

Latest revision as of 15:28, 27 March 2022


Mail Config

The xml element MailConfig defines the main mail system properties.
Individual mail settings are defined in the role definition for all users.

More about the mail system at Mail System.

The mail is defined with the following properties:

Property

Value

UseRoleSendButtons

Not used

Value example = ""

ViewNextMailButtonAlwaysEnabled

Value example= "true"

ReceiveMailSound

The sound that are played when a role receive a mail.
The audio file should be located in the audio directory <C3FIRE-AUDIO> located at <C3FIRE-WWW-
ROOT>/audio/.

Value example= "bottle-open.wav"

LineWrap

The text on a row in the mail box are automatically line wraped if the text is longer than the line.

Value example= "true" ,False"

ReceiveAppend

If old mail should be visible or not.

If ReceiveAppend is set to true all mails will be saved in the mail view panel. If it is set to false the
present mail dissapear when a new mail is viewed.

Value example="True", "false"

UnReadMailBackgroundColor

The color of the mail read panel background when the user has a mail that he or she has not read.

Value example= "#F0D0D0" /> "#FFFFFF"
C3system-config-session-unit-window-unread-mail-background-color-small.gif
"#F0D0D0 

  <MailConfig
    AcceptedKeyStroke = ""
    LineWrap = "true"
    ReadMailDuringPause = "False"
    ReceiveAppend = "true"
    ReceiveMailSound = ""
    SendMailDuringPause = "False"
    UnReadMailBackgroundColor = "#A05050"
    ViewNextMailButtonAlwaysEnabled = "true" />

Mail Groups

It is possible to create mail grops so that all members of a group receives the mail when mail send to that group.

The xml element MailGroups defines the mail groups.


The mail groups are defined with the following properties:

Property

Value

IDName

The identification name

Value example = "FireChiefs"

Members

The members in the group.

Value example= "A,B,C"

ToText

The text on the mail button
or the mail adress that the sender should write to send to the group.

Value example= "Fire"

Example 

  <MailGroups>

    <MailGroup
      IDName = "FireChiefs"
      Members = "C,E,G"
      ToText = "Fire" />

    <MailGroup
      IDName = "RescueChiefs"
      Members = "H,I,K"
      ToText = "Rescue" />

  </MailGroups>

No mail gropes is defined with an empty MailGroups element. 

<MailGroups/>


Role can send to

In Role definition add the group IDName that the role should be able to send to.

Example 

   <Role
      ...
      MailSendTo = "B,C,E,G,FireChiefs,RescueChiefs"
      ...


Configuration Editor
Members of the mail groups can be defined in the mail group configuration Editor.
Mail group editor
More about UI supported configuration at Role Configuration Editor.
Retrieved from "http://192.168.1.141:36040/w/index.php?title=Config/Config_Mail&oldid=2620"