Difference between revisions of "stoney mail: OpenLDAP directory data organisation"

From stoney cloud
Jump to: navigation, search
[checked revision][checked revision]
(→‎= Mail Domain Forward (example.net))
(→‎Third Level Mail Account example (3734242@customers.example.com))
 
(21 intermediate revisions by the same user not shown)
Line 259: Line 259:
 
== Mail Domains ==
 
== Mail Domains ==
 
The leafs containing the mail domains for the stoney mail service. We can have one of the following mail domain types:
 
The leafs containing the mail domains for the stoney mail service. We can have one of the following mail domain types:
−
* Mail Domain: A local mail domain. For example: example.com.
+
* '''Mail Domain''': A local mail domain. For example: example.com.
−
* Mail Domain Aliases: A mail domain (for example: example.org), which points to a local mail domain. For example: example.com. All email addresses ending with @example.org are thus forwarded to the local mail domain example.com.
+
* '''Mail Domain Aliase''': A mail domain (for example: example.org), which points to a local mail domain. For example: example.com. All email addresses ending with @example.org are thus forwarded to the local mail domain example.com.
−
* Mail Domain Forwards: A mail domain (for example: example.net), which points to an external mail domain (for example: external-domain.com).
+
* '''Mail Domain Forward''': A mail domain (for example: example.net), which points to an external mail domain (for example: external-domain.com).
−
* Third Level Mail Domains: A third level mail domain (for example: customers.example.com).
+
* '''Third Level Mail Domain''': A third level mail domain (for example: customers.example.com). Actually a sub set of a normal mail domain.
  
 
=== Mail Domain example (example.com) ===
 
=== Mail Domain example (example.com) ===
Line 313: Line 313:
 
objectclass: sstProvisioning
 
objectclass: sstProvisioning
 
objectclass: sstRelationship
 
objectclass: sstRelationship
−
sstMail=@example.org
+
sstMail: @example.org
 
sstMailForward: @example.com
 
sstMailForward: @example.com
 
sstIsActive: TRUE
 
sstIsActive: TRUE
Line 325: Line 325:
 
</source>
 
</source>
  
−
=== Mail Domain Forward (example.net) ===
+
=== Mail Domain Forward example (example.net) ===
 +
A mail domain (for example: example.net), which points to an external mail domain (for example: external-domain.com).
 +
 
 +
=== Third Level Mail Domain example (customers.example.com) ===
 +
A third level mail domain (for example: customers.example.com).
 +
<source lang="ldif">
 +
dn:sstMailDomain=customers.example.com,ou=mail,ou=services,dc=stoney-cloud,dc=org
 +
objectclass: top
 +
objectclass: sstMailDomain
 +
objectclass: sstGroupwareOX
 +
objectclass: sstProvisioning
 +
objectclass: sstRelationship
 +
sstMailDomain: customers.example.com
 +
sstIsActive: TRUE
 +
sstGroupwareOXContextID: 3724493            # This is the product UID of the Mail Domain customers.stepping-stone.ch
 +
sstGroupwareOXDomain: groupware.example.com
 +
sstProvisioningExecutionDate: 0
 +
sstProvisioningMode: add                    # Shouldn't this be changed to added after a successful provisioning step?
 +
sstProvisioningState: 20100824T105847
 +
sstBelongsToResellerUID: 4000000
 +
sstBelongsToCustomerUID: 4000001
 +
sstBelongsToPersonUID: 4000002
 +
sstBelongsToBillingUID: 3724493              # This attribute has the same function as the product UID in other services.
 +
</source>
 +
 
 +
== Mail Accounts ==
 +
The leafs containing the mail accounts for the stoney mail service. We can have one of the following mail account types:
 +
* '''Mail Account''': ...
 +
* '''Mail Alias Aliase''': ...
 +
* ...
 +
* '''Third Level Mail Accounts'''': A third level mail account (for example: 3733908@customers.example.com). This is actually the same as a normal mail account.
 +
 
 +
=== Third Level Mail Account example (3734242@customers.example.com) ===
 +
A third level mail account example (for example: 3734242@customers.example.com).
 +
<source lang="ldif">
 +
dn: sstMail=3734242@customers.example.com,sstMailDomain=customers.example.com,ou=mail,ou=services,dc=stoney-cloud,dc=org
 +
objectclass: top
 +
objectclass: sstMailAccount
 +
objectclass: amavisAccount
 +
objectclass: sstProvisioning
 +
objectclass: sstGroupwareOX
 +
objectclass: sstRelationship
 +
sstMail: 3734242@customers.example.com
 +
userPassword: {SSHA}aZGHe8drtP39HvKhW7eQoKsrR4c1ZjgwNmI0Mjcy
 +
sstMailMessageHomeDirectory: /var/vmail/2/242/734/3734242
 +
sstMailMessageStore: mdbox:~/mdbox
 +
sstMailReadIMAP: TRUE
 +
sstMailReadPOP: TRUE
 +
sstMailReceive: TRUE
 +
sstMailSend: TRUE
 +
sstMailWebmail: TRUE
 +
sstMailAccountFolderSent: Sent
 +
sstMailAccountFolderDrafts: Drafts
 +
sstMailAccountFolderTrash: Trash
 +
sstMailAccountFolderSpam: Spam
 +
sstQuota: 104857600
 +
sstIsActive: TRUE
 +
givenName: sst-int-tst-0001
 +
surname: os.stoney-cloud.org
 +
preferredLanguage: en-GB
 +
sstGender: 0
 +
sstGroupwareOXContextID: 3726904
 +
sstGroupwareOXAccountType: User
 +
sstProvisioningMode: add
 +
sstProvisioningExecutionDate: 0
 +
sstProvisioningState: 20100824T105847
 +
sstBelongsToResellerUID: 4000000
 +
sstBelongsToCustomerUID: 4000001
 +
sstBelongsToPersonUID: 4000002
 +
sstBelongsToServiceUID: 4000003
 +
sstBelongsToBillingUID: 3734242
 +
</source>
 +
 
 +
The following table describes the different attributes:
 +
{| style="border-spacing:0;"
 +
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Attribute'''
 +
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Objectclass'''
 +
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Existence'''</center>
 +
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Mandatory'''</center>
 +
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMail
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| RFC822 Address.
 +
 
 +
For example: <code>sstMail: 3734242@customers.example.com</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| userPassword
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| SSHA user password. {SSHA} is a [http://www.ietf.org/rfc/rfc2307.txt RFC 2307] password scheme which uses the SHA1 secure hash algorithm. For example: <code>{SSHA}aZGHe8drtP39HvKhW7eQoKsrR4c1ZjgwNmI0Mjcy</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailMessageHomeDirectory
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Path to the message home directory. It corresponds with the 7 digit product UID (Unique Identifier) of the Mail Account (<code>sstBelongsToBillingUID: 3734242</code>).
 +
 
 +
The following example describes, how the directory structure is built up for the account with the uid 3734242.
 +
* <code>/var/vmail/g/efg/bcd/abcdefg</code>
 +
* <code>/var/vmail/2/242/734/3734242</code>
 +
 
 +
For example: <code>sstMailMessageHomeDirectory: /var/vmail/2/242/734/3734242</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailMessageStore
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Path to the message store. Either mdbox:~/mdbox, ~/sdbx or ~/Maildir. The default is <code>mdbox:~/mdbox</code>.
 +
 
 +
For example: <code>sstMailMessageStore: mdbox:~/mdbox</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailReadIMAP
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Does the user have access to the IMAP Server? Either yes (TRUE) or no (FALSE). Default is <code>TRUE</code>.
 +
 
 +
For example: <code>sstMailReadIMAP: TRUE</code>
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailReadPOP
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Does the user have access to the POP Server? Either yes (TRUE) or no (FALSE). Default is <code>TRUE</code>.
 +
 
 +
For example: <code>sstMailReadPOP: TRUE</code>
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailReceive
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Can the user receive mail? Either yes (TRUE) or no (FALSE). Default is <code>TRUE</code>.
 +
 
 +
For example: <code>sstMailReceive: TRUE</code>
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailSend
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Can the user send mail? Either yes (TRUE) or no (FALSE). Default is <code>TRUE</code>.
 +
 
 +
For example: <code>sstMailSend: TRUE</code>
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailWebmail
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Does the user have access to default webmail? Either yes (TRUE) or no (FALSE). Default is <code>TRUE</code>.
 +
 
 +
For example: <code>sstMailWebmail: TRUE</code>
 +
 
 +
Original is <code>TRUE</code>, </code>FALSE</code> would better, as we don't have a web mail for the customer mail accounts. But don't change now.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccountFolderSent
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The name of the IMAP sent folder. This value is dependent on the value of the attribute <code>preferredLanguage</code>:
 +
* en-GB: <code>Sent</code>
 +
* de-CH: <code>Gesendete Objekte</code>
 +
 
 +
For example: <code>sstMailAccountFolderSent: Sent</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccountFolderDrafts
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The name of the IMAP drafts folder. This value is dependent on the value of the attribute <code>preferredLanguage</code>:
 +
* en-GB: <code>Drafts</code>
 +
* de-CH: <code>Entwürfe</code>
 +
 
 +
For example: <code>sstMailAccountFolderDrafts: Drafts</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccountFolderTrash
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The name of the IMAP trash folder. This value is dependent on the value of the attribute <code>preferredLanguage</code>:
 +
* en-GB: <code>Trash</code>
 +
* de-CH: <code>Papierkorb</code>
 +
 
 +
For example: <code>sstMailAccountFolderTrash: Trash</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccountFolderSpam
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The name of the IMAP spam folder. This value is dependent on the value of the attribute <code>preferredLanguage</code>:
 +
* en-GB: <code>Spam</code>
 +
* de-CH: <code>Spam</code>
 +
 
 +
For example: <code>sstMailAccountFolderSpam: Spam</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstQuota
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The filesystem quota in bytes. For a customer mail account this is always 104857600 Bytes, which corresponds with 100 Mebibyte (MiB).
 +
 
 +
For example: <code>sstQuota: 104857600</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstIsActive
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Is the entry active? Either yes (TRUE) or no (FALSE). The default is <code>TRUE</code>.
 +
 
 +
For example: <code>sstIsActive: TRUE</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| givenName
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Given name (or first name), example: <code>Hans</code>.  For a customer mail account, this value contains the host name.
 +
 
 +
For example: <code>givenName: sst-int-tst-0001</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| surname
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Surname (or last name), example: <code>Muster/code>. For a customer mail account, this value contains the domain name.
 +
 
 +
For example: <code>surname: os.stoney-cloud.org</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| preferredLanguage
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Mail account language of the user according to RFC 1766, example: en-GB or de-CH. The default is <code>en-GB</code>. Currently supported:
 +
* de-CH
 +
* en-GB
 +
 
 +
For example: <code>preferredLanguage: en-GB</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstGender
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Gender, either 0 (neutral, m (male) or f (female). For a customer mail account, the default is <code>0</code>.
 +
 
 +
For example: <code>sstGender: 0</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstGroupwareOXContextID
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The Open-Xchange groupware context id, which corresponds wiht the product UID (Unique Identifier) of the Mail Domain <code>customers.example.com</code>.
 +
 
 +
For example: <code>sstGroupwareOXContextID: 3726904</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstGroupwareOXAccountType
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMailAccount
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The Open-Xchange Groupware account type, either <code>User</code> or <code>Resource</code>. The default is <code>User</code>.
 +
 
 +
For example: <code>sstGroupwareOXAccountType: User</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstProvisioningMode
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstProvisioning
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x<sup>1</sup></center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The provisioning mode, either <code>add</code>, <code>modify</code> or <code>delete</code>. For a new account, this attribute must be set to <code>add</code>. See the [[stoney_core:_OpenLDAP_provisioning | stoney core: OpenLDAP provisioning]] page for details. If the entry was successfully added, modified or deleted, the provisioning mode is changed to <code>added</code>, <code>modified</code> or <code>deleted</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstProvisioningExecutionDate
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstProvisioning
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The date the provisioning shall occur in the form of [YYYY][MM][DD] ([http://en.wikipedia.org/wiki/ISO_8601 ISO 8601]). For a new account, this attribute must be set to '''0'''. See the [[stoney_core:_OpenLDAP_provisioning | stoney core: OpenLDAP provisioning]] page for details.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstProvisioningState
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstProvisioning
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x<sup>2</sup></center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The provisioning state, either <code>0</code> or in the form of <code>[YYYY][MM][DD]T[hh][mm][ss]Z</code> ([http://en.wikipedia.org/wiki/ISO_8601 ISO 8601]). Z is the zone designator for the zero UTC offset. For a new OpenStack Domain, this attribute must be set to '''0'''. After the successful provisioning, the value is set to the time of the provisioning. For example: <code>sstProvisioningState: 20180819T083208Z</code>. See the [[stoney_core:_OpenLDAP_provisioning | stoney core: OpenLDAP provisioning]] page for details.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToResellerUID
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the reseller UID the leaf belongs to. A unique integer value with 7 digits or more.
 +
 
 +
For example: <code>sstBelongsToResellerUID: 4000000</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToCustomerUID
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry.
 +
 
 +
For example: <code>sstBelongsToCustomerUID: 4000001</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToPersonUID
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the person UID (Unique Identifier) the leaf belongs to.
 +
 
 +
For example: <code>sstBelongsToPersonUID: 4000002</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToServiceUID
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x<sup>3</sup></center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the UID (Unique Identifier) of the service the leaf belongs to. This UID can be used to look up other information. For a customer mail account, the service the account belongs to will most likely be a stoney cloud [[stoney_cloud:_OpenLDAP_directory_data_organisation#Units_.28instances.29 | unit]] (instance).
 +
 
 +
For example: <code>sstBelongsToServiceUID: 4000003</code>.
 +
 
 +
|-
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToBillingUID
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 +
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the billing UID (Unique Identifier) the leaf belongs to. This the product UID (Unique Identifier) of the Mail Account. For example: <code>3734242</code> (this corresponds with the value of the attribute <code>sstMail: 3734242@customers.example.com</code>.
 +
 
 +
For example: <code>sstBelongsToBillingUID: 3734242</code>.
 +
 
 +
|}
 +
 
 +
Legend:
 +
* '''x''': Mandatory in all cases.
 +
* '''x<sup>1</sup>''': Set <code>sstProvisioningMode</code> to either <code>added</code>, <code>modified</code> or <code>deleted</code> if modifying the entry manually.
 +
* '''x<sup>2</sup>''': Use <code>date --utc "+%Y%m%dT%H%M%SZ"</code> to set the attribute <code>sstProvisioningState</code> if modifying the entry manually.
 +
* '''x<sup>3</sup>''': The attribute <code>sstBelongsToServiceUID</code> must be set for all the stoney cloud [[stoney_cloud:_OpenLDAP_directory_data_organisation#Units_.28instances.29 | units]] (instances).
  
 
[[Category:stoney mail]][[Category:OpenLDAP directory]]
 
[[Category:stoney mail]][[Category:OpenLDAP directory]]

Latest revision as of 14:05, 5 March 2019

Abstract

This document describes the OpenLDAP directory data organisation for the stoney mail service, including groupware functionality based on Open-Xchange.

Data Organisation

The following chapters explain the data organisation of the stoney cloud OpenLDAP directory, in this case we looking at the stoney mail service.

Mail

The following LDIF shows the mail entry of the whole OpenLDAP directory tree for the stoney cloud: 

dn: ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: organizationalUnit
objectclass: top
ou: mail

Mail Configuration

The sub tree for the configuration of the stoney mail service: 

dn: ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: configuration
description: The sub tree for the configuration of the stoney mail service.

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
ou
MUST
x
 This configuration leaf (ou: Organizational Unit), collects the stoney mail service related configuration.
description
MAY
x
 The description of this leaf.

Legend:

  • x: Mandatory in all cases.

Mail Reseller

The sub tree for the reseller specific stoney mail service configuration: 

dn: ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: reseller
description: The sub tree for the reseller specific stoney mail service configuration.

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
ou
MUST
x
 This reseller leaf (ou: Organizational Unit), collects the stoney mail service reseller related configuration.
description
MAY
x
 The description of this leaf.

Legend:

  • x: Mandatory in all cases.

The sub tree for the specific stoney mail service settings for the reseller Reseller Ltd. with the uid 4000000. 

dn: uid=4000000,ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
objectclass: sstServiceConfigurationObjectClass
uid: 4000000
o: Reseller Ltd.
description: The sub tree for the specific stoney mail service settings for the reseller Reseller Ltd. with the uid 4000000.
sstIsActive: TRUE
sstIsDefault: TRUE
sstBelongsToResellerUID: 4000000

The following table describes the different attributes:

Attribute
Existence
Mandatory
Self-Service
Changeable
 Description
uid
MUST
x
A unique integer value with 7 digits or more. For example: 4000000.
organizationName
MAY
x
The organisation name of the reseller. For example: Reseller Ltd. when sstIsCompany: TRUE). Or in case of a person (sstIsCompany: FALSE), the organisation name would be set to: Surname, Name (The content of the attributes surname and givenName).
description
MAY
The description of the leaf.
sstIsCompany
MUST
x
Is the entry a company? Either TRUE (yes) or FALSE (no).
sstIsActive
MUST
x
Is the entry active? Either TRUE (yes) or FALSE (no).
sstExternalID
MAY
The ID (or number) of a customer, person or product in an external database (for example: 234567).
sstIsDefault
MAY
Contains the leaf a default entry? Either TRUE (yes) or FALSE (no). If sstIsDefault is set to TRUE, this entry acts as a fall back configuration. In other words: If a reseller doesn't have his own (online) backup service configuration, then this on will be used.
sstBelongsToResellerUID
MUST
x
Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000. In this case, the attribute uid and sstBelongsToResellerUID must match with each other!

Legend:

  • x: Mandatory in all cases.

Mail Reseller Logout-Redirection

The sub tree for the reseller logout-redirect specific stoney mail service configuration: 

dn: ou=logout-redirect, ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: logout-redirect
description: The sub tree for the reseller logout-redirect specific stoney mail service configuration.

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
ou
MUST
x
 This logout-redirect leaf (ou: Organizational Unit), collects the stoney mail service reseller logout-redirect related configuration.
description
MAY
x
 The description of this leaf.

Legend:

  • x: Mandatory in all cases.

The sub tree for the reseller logout-redirect specific stoney mail service settings, coming from the fully qualified domain name (fqdn) groupware.stoney-cloud.org. 

dn: ou=groupware.stoney-cloud.org,ou=logout-redirect, ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstLogoutRedirect
ou: groupware.stoney-cloud.org
description: The sub tree for the reseller logout-redirect specific stoney mail service settings, coming from the fully qualified domain name (fqdn) groupware.stoney-cloud.org.
sstWebsiteURL: http://www.stoney-cloud.org/

The following table describes the different attributes:

Attribute
Existence
Mandatory
Self-Service
Changeable
 Description
ou
MUST
x
This leaf (ou: Organizational Unit), contains the logout-redirect related configuration for a specific fully qualified domain name (fqdn). For example: groupware.stoney-cloud.org.
description
MAY
The description of the leaf.
sstWebsiteURL
MUST
x
The URI the user is redirected to, after they log out from the groupware application. For example: http://www.stoney-cloud.org/ or https://www.stoney-cloud.org/.

Legend:

  • x: Mandatory in all cases.

Mail Domains

The leafs containing the mail domains for the stoney mail service. We can have one of the following mail domain types:

  • Mail Domain: A local mail domain. For example: example.com.
  • Mail Domain Aliase: A mail domain (for example: example.org), which points to a local mail domain. For example: example.com. All email addresses ending with @example.org are thus forwarded to the local mail domain example.com.
  • Mail Domain Forward: A mail domain (for example: example.net), which points to an external mail domain (for example: external-domain.com).
  • Third Level Mail Domain: A third level mail domain (for example: customers.example.com). Actually a sub set of a normal mail domain.

Mail Domain example (example.com)

The following example shows the mail domain name stoney-cloud.org: 

dn:sstMailDomain=example.com,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstMailDomain
objectclass: sstGroupwareOX
objectclass: sstProvisioning
objectclass: sstRelationship
sstMailDomain: example.com
sstIsActive: TRUE
sstGroupwareOXContextID: 3724493
sstGroupwareOXDomain: groupware.example.com
sstProvisioningExecutionDate: 0
sstProvisioningMode: add                 # Shouldn't this be changed to added after a successful provisioning step?
sstProvisioningState: 20100824T105847
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002
sstBelongsToBillingUID: 3724493         # This attribute has the same function as the uid in other services.

Mail Domain Alias example (example.org)

The following example shows the mail domain alias example.org, which points to the local mail domain example.com. 

dn: sstMailDomain=example.org,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstMailDomainAlias
objectclass: sstProvisioning
objectclass: sstRelationship
sstMailDomain: example.org
sstIsActive: TRUE
sstProvisioningExecutionDate: 0
sstProvisioningMode: add                 # Shouldn't this be changed to added after a successful provisioning step?
sstProvisioningState: 20100824T115418
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002
sstBelongsToBillingUID: 3724533         # This attribute has the same function as the uid in other services.

The following sub tree is an essential part of the Mail Domain Alias example: 

dn: sstMail=@example.org,sstMailDomain=example.org,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstMailWildcardAlias
objectclass: amavisAccount
objectclass: sstProvisioning
objectclass: sstRelationship
sstMail: @example.org
sstMailForward: @example.com
sstIsActive: TRUE
sstProvisioningExecutionDate: 0
sstProvisioningMode: add                 # Shouldn't this be changed to added after a successful provisioning step?
sstProvisioningState: 20100824T115418
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002
sstBelongsToBillingUID: 3724533         # This attribute has the same function as the uid in other services.

Mail Domain Forward example (example.net)

A mail domain (for example: example.net), which points to an external mail domain (for example: external-domain.com).

Third Level Mail Domain example (customers.example.com)

A third level mail domain (for example: customers.example.com). 

dn:sstMailDomain=customers.example.com,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstMailDomain
objectclass: sstGroupwareOX
objectclass: sstProvisioning
objectclass: sstRelationship
sstMailDomain: customers.example.com
sstIsActive: TRUE
sstGroupwareOXContextID: 3724493             # This is the product UID of the Mail Domain customers.stepping-stone.ch
sstGroupwareOXDomain: groupware.example.com
sstProvisioningExecutionDate: 0
sstProvisioningMode: add                     # Shouldn't this be changed to added after a successful provisioning step?
sstProvisioningState: 20100824T105847
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002
sstBelongsToBillingUID: 3724493              # This attribute has the same function as the product UID in other services.

Mail Accounts

The leafs containing the mail accounts for the stoney mail service. We can have one of the following mail account types:

  • Mail Account: ...
  • Mail Alias Aliase: ...
  • ...
  • Third Level Mail Accounts': A third level mail account (for example: 3733908@customers.example.com). This is actually the same as a normal mail account.

Third Level Mail Account example (3734242@customers.example.com)

A third level mail account example (for example: 3734242@customers.example.com). 

dn: sstMail=3734242@customers.example.com,sstMailDomain=customers.example.com,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstMailAccount
objectclass: amavisAccount
objectclass: sstProvisioning
objectclass: sstGroupwareOX
objectclass: sstRelationship
sstMail: 3734242@customers.example.com
userPassword: {SSHA}aZGHe8drtP39HvKhW7eQoKsrR4c1ZjgwNmI0Mjcy
sstMailMessageHomeDirectory: /var/vmail/2/242/734/3734242
sstMailMessageStore: mdbox:~/mdbox
sstMailReadIMAP: TRUE
sstMailReadPOP: TRUE
sstMailReceive: TRUE
sstMailSend: TRUE
sstMailWebmail: TRUE
sstMailAccountFolderSent: Sent
sstMailAccountFolderDrafts: Drafts
sstMailAccountFolderTrash: Trash
sstMailAccountFolderSpam: Spam
sstQuota: 104857600
sstIsActive: TRUE
givenName: sst-int-tst-0001
surname: os.stoney-cloud.org
preferredLanguage: en-GB
sstGender: 0
sstGroupwareOXContextID: 3726904
sstGroupwareOXAccountType: User
sstProvisioningMode: add
sstProvisioningExecutionDate: 0
sstProvisioningState: 20100824T105847
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002
sstBelongsToServiceUID: 4000003
sstBelongsToBillingUID: 3734242

The following table describes the different attributes:

Attribute Objectclass
Existence
Mandatory
 Description
sstMail sstMailAccount
MUST
x
 RFC822 Address.

For example: sstMail: 3734242@customers.example.com.

userPassword sstMailAccount
MUST
x
 SSHA user password. {SSHA} is a RFC 2307 password scheme which uses the SHA1 secure hash algorithm. For example: {SSHA}aZGHe8drtP39HvKhW7eQoKsrR4c1ZjgwNmI0Mjcy.
sstMailMessageHomeDirectory sstMailAccount
MUST
x
 Path to the message home directory. It corresponds with the 7 digit product UID (Unique Identifier) of the Mail Account (sstBelongsToBillingUID: 3734242).

The following example describes, how the directory structure is built up for the account with the uid 3734242.

  • /var/vmail/g/efg/bcd/abcdefg
  • /var/vmail/2/242/734/3734242

For example: sstMailMessageHomeDirectory: /var/vmail/2/242/734/3734242.

sstMailMessageStore sstMailAccount
MUST
x
 Path to the message store. Either mdbox:~/mdbox, ~/sdbx or ~/Maildir. The default is mdbox:~/mdbox.

For example: sstMailMessageStore: mdbox:~/mdbox.

sstMailReadIMAP sstMailAccount
MUST
x
 Does the user have access to the IMAP Server? Either yes (TRUE) or no (FALSE). Default is TRUE.

For example: sstMailReadIMAP: TRUE

sstMailReadPOP sstMailAccount
MUST
x
 Does the user have access to the POP Server? Either yes (TRUE) or no (FALSE). Default is TRUE.

For example: sstMailReadPOP: TRUE

sstMailReceive sstMailAccount
MUST
x
 Can the user receive mail? Either yes (TRUE) or no (FALSE). Default is TRUE.

For example: sstMailReceive: TRUE

sstMailSend sstMailAccount
MUST
x
 Can the user send mail? Either yes (TRUE) or no (FALSE). Default is TRUE.

For example: sstMailSend: TRUE

sstMailWebmail sstMailAccount
MUST
x
 Does the user have access to default webmail? Either yes (TRUE) or no (FALSE). Default is TRUE.

For example: sstMailWebmail: TRUE

Original is TRUE, </code>FALSE</code> would better, as we don't have a web mail for the customer mail accounts. But don't change now.

sstMailAccountFolderSent sstMailAccount
MAY
x
 The name of the IMAP sent folder. This value is dependent on the value of the attribute preferredLanguage:
  • en-GB: Sent
  • de-CH: Gesendete Objekte

For example: sstMailAccountFolderSent: Sent.

sstMailAccountFolderDrafts sstMailAccount
MAY
x
 The name of the IMAP drafts folder. This value is dependent on the value of the attribute preferredLanguage:
  • en-GB: Drafts
  • de-CH: Entwürfe

For example: sstMailAccountFolderDrafts: Drafts.

sstMailAccountFolderTrash sstMailAccount
MAY
x
 The name of the IMAP trash folder. This value is dependent on the value of the attribute preferredLanguage:
  • en-GB: Trash
  • de-CH: Papierkorb

For example: sstMailAccountFolderTrash: Trash.

sstMailAccountFolderSpam sstMailAccount
MAY
x
 The name of the IMAP spam folder. This value is dependent on the value of the attribute preferredLanguage:
  • en-GB: Spam
  • de-CH: Spam

For example: sstMailAccountFolderSpam: Spam.

sstQuota sstMailAccount
MUST
x
 The filesystem quota in bytes. For a customer mail account this is always 104857600 Bytes, which corresponds with 100 Mebibyte (MiB).

For example: sstQuota: 104857600.

sstIsActive sstMailAccount
MUST
x
 Is the entry active? Either yes (TRUE) or no (FALSE). The default is TRUE.

For example: sstIsActive: TRUE.

givenName sstMailAccount
MUST
x
 Given name (or first name), example: Hans. For a customer mail account, this value contains the host name.

For example: givenName: sst-int-tst-0001.

surname sstMailAccount
MUST
x
 Surname (or last name), example: Muster/code>. For a customer mail account, this value contains the domain name.

For example: <code>surname: os.stoney-cloud.org.

preferredLanguage sstMailAccount
MUST
x
 Mail account language of the user according to RFC 1766, example: en-GB or de-CH. The default is en-GB. Currently supported:
  • de-CH
  • en-GB

For example: preferredLanguage: en-GB.

sstGender sstMailAccount
MUST
x
 Gender, either 0 (neutral, m (male) or f (female). For a customer mail account, the default is 0.

For example: sstGender: 0.

sstGroupwareOXContextID sstMailAccount
MAY
x
 The Open-Xchange groupware context id, which corresponds wiht the product UID (Unique Identifier) of the Mail Domain customers.example.com.

For example: sstGroupwareOXContextID: 3726904.

sstGroupwareOXAccountType sstMailAccount
MAY
x
 The Open-Xchange Groupware account type, either User or Resource. The default is User.

For example: sstGroupwareOXAccountType: User.

sstProvisioningMode sstProvisioning
MUST
x1
 The provisioning mode, either add, modify or delete. For a new account, this attribute must be set to add. See the stoney core: OpenLDAP provisioning page for details. If the entry was successfully added, modified or deleted, the provisioning mode is changed to added, modified or deleted.
sstProvisioningExecutionDate sstProvisioning
MUST
x
 The date the provisioning shall occur in the form of [YYYY][MM][DD] (ISO 8601). For a new account, this attribute must be set to 0. See the stoney core: OpenLDAP provisioning page for details.
sstProvisioningState sstProvisioning
MUST
x2
 The provisioning state, either 0 or in the form of [YYYY][MM][DD]T[hh][mm][ss]Z (ISO 8601). Z is the zone designator for the zero UTC offset. For a new OpenStack Domain, this attribute must be set to 0. After the successful provisioning, the value is set to the time of the provisioning. For example: sstProvisioningState: 20180819T083208Z. See the stoney core: OpenLDAP provisioning page for details.
sstBelongsToResellerUID sstRelationship
MUST
x
 Stores the reseller UID the leaf belongs to. A unique integer value with 7 digits or more.

For example: sstBelongsToResellerUID: 4000000.

sstBelongsToCustomerUID sstRelationship
MUST
x
 Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry.

For example: sstBelongsToCustomerUID: 4000001.

sstBelongsToPersonUID sstRelationship
MAY
Stores the person UID (Unique Identifier) the leaf belongs to.

For example: sstBelongsToPersonUID: 4000002.

sstBelongsToServiceUID sstRelationship
MAY
x3
 Stores the UID (Unique Identifier) of the service the leaf belongs to. This UID can be used to look up other information. For a customer mail account, the service the account belongs to will most likely be a stoney cloud unit (instance).

For example: sstBelongsToServiceUID: 4000003.

sstBelongsToBillingUID sstRelationship
MAY
x
 Stores the billing UID (Unique Identifier) the leaf belongs to. This the product UID (Unique Identifier) of the Mail Account. For example: 3734242 (this corresponds with the value of the attribute sstMail: 3734242@customers.example.com.

For example: sstBelongsToBillingUID: 3734242.

Legend:

  • x: Mandatory in all cases.
  • x1: Set sstProvisioningMode to either added, modified or deleted if modifying the entry manually.
  • x2: Use date --utc "+%Y%m%dT%H%M%SZ" to set the attribute sstProvisioningState if modifying the entry manually.
  • x3: The attribute sstBelongsToServiceUID must be set for all the stoney cloud units (instances).
Retrieved from "https://wiki.stoney-cloud.org/mediawiki/index.php?title=stoney_mail:_OpenLDAP_directory_data_organisation&oldid=4898"