-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs on dimail to describe interoperability between la régie and dimail
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# dimail | ||
|
||
## What is dimail ? | ||
|
||
The mailing solution provided in La Suite is [Open-XChange](https://www.open-xchange.com/) (OX) server. | ||
OX not having a provisioning API, 'dimail' or 'dimail-api' was created to allow mail-provisioning through La RĂ©gie. | ||
|
||
API and its documentation can be found [here](https://api.dev.ox.numerique.gouv.fr/docs#/). | ||
|
||
## Architectural links of dimail | ||
|
||
As dimail's primary goal is to act as an interface between La RĂ©gie and OX, its architecture is similar to th | ||
|
||
### Domains | ||
|
||
Upon creating a domain on domain manager tab of La RĂ©gie, the same domain is created on dimail and will undergo a serie of checks. When a domain passes all the checks, it's considered valid and mailboxes can be created on it. | ||
|
||
### Users | ||
|
||
The ones issuing requests. These users will reflect domain owners and administrators on la RĂ©gie, for logging purposes and to allow direct use of dimail, if desired. | ||
|
||
### Permissions | ||
|
||
These are the permissions linking users to domains | ||
A permission is automatically created when : | ||
- upon domain creation : perm for La RĂ©gie to manage domain | ||
- upon user creation : perm for La RĂ©gie to manage user | ||
- upon access creation, if owner or admin, perm for this user to manage domain |