Difference between revisions of "Management Console"

[unchecked revision][pending revision]
m (Dweuthen moved page Admin Console to Management Console without leaving a redirect)
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
The MailStore Gateway Admin Console is the primary tool for administrators to manage mailboxes in MailStore Gateway.
+
The MailStore Gateway Management Console is the primary tool for administrators to manage MailStore Gateway, and mailboxes in particular.
  
[[File:MailStore_Gateway_Admin_Console.png|center|550px]]
+
[[File:MailStore_Gateway_Management_Console.png|center|550px]]
  
 
== Create Mailbox ==
 
== Create Mailbox ==
* [[Login]] to the Admin Console.
+
* [[Login]] to the Management Console.
* Click on ''Create Mailbox''
+
* Click on ''Create Mailbox''.
* Type a name in the ''Name'' field, i.e. ''Office 365 Journal''
+
* Type a name in the ''Name'' field, i.e. ''Office 365 Journal''.
* ''Optional: '' Enter a description that helps to identify the purpose of the mailbox to be created, i.e. ''Target for journal emails from Office 365 domain example.com''
+
* ''Optional: '' Enter a description that helps to identify the purpose of the mailbox, e.g. ''Target for journal emails from Office 365 domain example.com''.
* Click ''OK''
+
* Click ''OK''.
* A strong, random password is generated and displayed. Make sure to store the password in a safe place. The password is not stored in MailStore Gateware and it represents the passphrase needed to decrypt the content of the mailbox. If the password is lost, there is no way to ever access emails that are still in the mailbox.  
+
* A strong, random password is generated and displayed.
 
*: [[File:MailStore_Gateway_Create_Mailbox.png|center|350px]]
 
*: [[File:MailStore_Gateway_Create_Mailbox.png|center|350px]]
 
* Carefully read the warning, and afterwards tick the checkbox ''I've read and understood the above warning''.
 
* Carefully read the warning, and afterwards tick the checkbox ''I've read and understood the above warning''.
* Click ''OK'' to finish the mailbox creation.
+
* Click ''OK'' to finish the mailbox creation.<br/><br/>
 
+
*; <p class="msnote">'''Important notice:''' Make sure to store the password in a safe place as it is not stored in MailStore Gateway. The password is needed to decrypt the content of the mailbox. If the password is lost, there is no way to access emails that are still in the mailbox ever again; a lost password cannot be retrieved.<br/><br/>For MailStore Server customers we recommend to use an enterprise password manager to store such critical passwords. For MSPs using MailStore Service Provider Edition we do not recommend to store these passwords but instead ensure that when providing them to end customers, add a note about the importance of keeping the password safe.</p>
<p class="msnote">'''Tip:''' For MailStore Server customers we recommend to use an enterprise grade password manager to store such critical passwords. For MSPs using MailStore Service Provider Edition we do not recommend to store these passwords but instead ensure that when provifing them them to customers, add a note about the importance of keeping the password safe.</p>
 
  
 
== Edit Mailbox ==
 
== Edit Mailbox ==
* [[Login]] to the Admin Console.
+
* [[Login]] to the Management Console.
 
* Select a mailbox from the table.
 
* Select a mailbox from the table.
 
* Click ''Edit Mailbox''.
 
* Click ''Edit Mailbox''.
 
*: [[File:MailStore_Gateway_Edit_Mailbox.png|center|350px]]  
 
*: [[File:MailStore_Gateway_Edit_Mailbox.png|center|350px]]  
 
* The following mailbox properties can be changed:
 
* The following mailbox properties can be changed:
** '''Name'''<br/>The name of the mailbox, i.e. G Suite Archiving
+
** '''Name'''<br/>The name of the mailbox, e.g. G Suite Archiving.
** '''Description'''<br/>The description helps to identify the purpose of the mailbox i.e. ''Destination for G Suite Archiving''
+
** '''Description'''<br/>The description helps to identify the purpose of the mailbox e.g. ''Destination for G Suite Archiving''.
** '''Status'''<br/>The status can be of the following values:
+
** '''Status'''<br/>The status can have the following values:
 
*** ''Active''<br/>Active mailboxes accept new messages, which can be archived.
 
*** ''Active''<br/>Active mailboxes accept new messages, which can be archived.
*** ''Suspended''<br/>Suspended mailboxes do not access new messages, but archiving from them is still possible. Typically this is needed when a mailbox is to be deleted, but still contains unarchived emails.
+
*** ''Suspended''<br/>Suspended mailboxes do not accept new messages but archiving from them is still possible. Typically this is needed when a mailbox is to be deleted, but still contains unarchived emails. A temporary error is thrown if an attempt is made to deliver an email to a suspended mailbox.
 
* Click ''OK'' to confirm the changes, or ''Cancel'' to abort.
 
* Click ''OK'' to confirm the changes, or ''Cancel'' to abort.
  
 
== Delete Mailbox ==
 
== Delete Mailbox ==
To be able to delete a mailbox, the mailbox must met the following prerequisites:
+
To delete a mailbox, please use the following procedure below:
* Mailbox must be empty
 
* Mailbox status must be set to ''Suspended''
 
 
 
When these preprequisits are met, a mailbox can be deleted by the following procedure:
 
  
* [[Login]] to the Admin Console.
+
* [[Login]] to the Management Console.
 
* Select a mailbox from the table.
 
* Select a mailbox from the table.
 +
* Change the status to "Suspended".
 
* Click ''Delete Mailbox''.
 
* Click ''Delete Mailbox''.
*: [[File:MailStore_Gateway_Delete_Mailbox.png|center|350px]]  
+
*: [[File:Delete_suspended_mailbox.png|center|350px]]  
* Click ''Yes'' to really delete the mailbox, or ''No'' to abort the deletion.
+
* Click ''Yes'' to confirm deleting the mailbox, or ''No'' to abort the deletion.
  
 
== Reset Mailbox Password ==
 
== Reset Mailbox Password ==
 +
To reset a mailbox password, the mailbox must meet the following prerequisites:
 +
 +
* The mailbox must be empty.
 +
* Its status must be set to ''Suspended''.
 +
 +
If these prerequisites are met, a mailbox password can be reset by the following procedure:
 +
 +
* [[Login]] to the Management Console.
 +
* Select a mailbox from the table.
 +
* Click ''Reset Password''.
 +
*: [[File:MailStore_Gateway_Reset_Mailbox_Password.png|center|350px]]
 +
* Click ''Yes'' to confirm resetting the mailbox password, or ''No'' to abort the password reset.
 +
* After clicking ''Yes'', a new password is generated and displayed.
 +
* Proceed as detailed in the above section [[#Create Mailbox|Create Mailbox]].
  
 
== Change Language ==
 
== Change Language ==
* [[Login]] to the Admin Console.
+
* [[Login]] to the Management Console.
* Click on the username in the upper right corner
+
* Click on the username in the upper right corner.
 
* Select ''Settings''.
 
* Select ''Settings''.
 
* Select the intended language from the ''Language'' drop-down. The console is updated immediately when selecting an other language.
 
* Select the intended language from the ''Language'' drop-down. The console is updated immediately when selecting an other language.
Line 54: Line 64:
  
 
== Reset Own Password ==
 
== Reset Own Password ==
* [[Login]] to the Admin Console.
+
* [[Login]] to the Management Console.
* Click on the username in the upper right corner
+
* Click on the username in the upper right corner.
* Select ''Settings''
+
* Select ''Settings''.
 
* Click on the ''Reset own password'' link next to the ''Password'' label.
 
* Click on the ''Reset own password'' link next to the ''Password'' label.
 
* Type in your current password to confirm the password change.
 
* Type in your current password to confirm the password change.
 
* A new, random password is displayed. Make sure to keep it in a safe place.
 
* A new, random password is displayed. Make sure to keep it in a safe place.
* Click ''OK'' to save changes
+
* Click ''OK'' to save changes.
 +
 
 +
== Change Mailbox Folder location ==
 +
* Stop the Gateway service by clicking on the desktop shortcut "MailStore Gateway" and then click "Stop Service"
 +
* Move the folder "C:\ProgramData\MailStore\Gateway" to your desired location.
 +
* Open an elevated command prompt (cmd).
 +
* Navigate into "C:\ProgamData\MailStore"
 +
* Execute the command:
 +
mklink /D Gateway <full_path_where_you_moved_the_folder_to>
 +
* Restart the Gateway service by clicking on the desktop shortcut "MailStore Gateway" and then click "Start Service"
 +
 
 +
In our example below, we moved the "Gateway" folder to the "C:\TestDirectory" folder. Remember, you can move the Gateway folder to any local drive on the server.
 +
 
 +
: [[File:MailStore Gateway Command Prompt.png|center|350px]]
 +
 
 +
* After the command is ran successfully in the command prompt and the symbollic link is created, when you go back into the "C:\ProgramData\MailStore" directory, you will now see a shortcut which indicates that the move process was completed successfully. Please refer to the picture below.
 +
 
 +
 
 +
: [[File:MailStore Gateway Symbolic link.png|center|350px]]
  
 
== Sign Out ==
 
== Sign Out ==
* Click on the username in the upper right corner
+
* Click on the username in the upper right corner.
* Select ''Sign out''
+
* Select ''Sign out''.
 +
 
 +
[[de:Management Console]]
 +
[[en:Management Console]]

Revision as of 16:41, 6 March 2024


The MailStore Gateway Management Console is the primary tool for administrators to manage MailStore Gateway, and mailboxes in particular.

MailStore Gateway Management Console.png

Create Mailbox

  • Login to the Management Console.
  • Click on Create Mailbox.
  • Type a name in the Name field, i.e. Office 365 Journal.
  • Optional: Enter a description that helps to identify the purpose of the mailbox, e.g. Target for journal emails from Office 365 domain example.com.
  • Click OK.
  • A strong, random password is generated and displayed.
    MailStore Gateway Create Mailbox.png
  • Carefully read the warning, and afterwards tick the checkbox I've read and understood the above warning.
  • Click OK to finish the mailbox creation.

    Important notice: Make sure to store the password in a safe place as it is not stored in MailStore Gateway. The password is needed to decrypt the content of the mailbox. If the password is lost, there is no way to access emails that are still in the mailbox ever again; a lost password cannot be retrieved.

    For MailStore Server customers we recommend to use an enterprise password manager to store such critical passwords. For MSPs using MailStore Service Provider Edition we do not recommend to store these passwords but instead ensure that when providing them to end customers, add a note about the importance of keeping the password safe.

Edit Mailbox

  • Login to the Management Console.
  • Select a mailbox from the table.
  • Click Edit Mailbox.
    MailStore Gateway Edit Mailbox.png
  • The following mailbox properties can be changed:
    • Name
      The name of the mailbox, e.g. G Suite Archiving.
    • Description
      The description helps to identify the purpose of the mailbox e.g. Destination for G Suite Archiving.
    • Status
      The status can have the following values:
      • Active
        Active mailboxes accept new messages, which can be archived.
      • Suspended
        Suspended mailboxes do not accept new messages but archiving from them is still possible. Typically this is needed when a mailbox is to be deleted, but still contains unarchived emails. A temporary error is thrown if an attempt is made to deliver an email to a suspended mailbox.
  • Click OK to confirm the changes, or Cancel to abort.

Delete Mailbox

To delete a mailbox, please use the following procedure below:

  • Login to the Management Console.
  • Select a mailbox from the table.
  • Change the status to "Suspended".
  • Click Delete Mailbox.
    Delete suspended mailbox.png
  • Click Yes to confirm deleting the mailbox, or No to abort the deletion.

Reset Mailbox Password

To reset a mailbox password, the mailbox must meet the following prerequisites:

  • The mailbox must be empty.
  • Its status must be set to Suspended.

If these prerequisites are met, a mailbox password can be reset by the following procedure:

  • Login to the Management Console.
  • Select a mailbox from the table.
  • Click Reset Password.
    MailStore Gateway Reset Mailbox Password.png
  • Click Yes to confirm resetting the mailbox password, or No to abort the password reset.
  • After clicking Yes, a new password is generated and displayed.
  • Proceed as detailed in the above section Create Mailbox.

Change Language

  • Login to the Management Console.
  • Click on the username in the upper right corner.
  • Select Settings.
  • Select the intended language from the Language drop-down. The console is updated immediately when selecting an other language.
  • Click OK to close the settings.

Reset Own Password

  • Login to the Management Console.
  • Click on the username in the upper right corner.
  • Select Settings.
  • Click on the Reset own password link next to the Password label.
  • Type in your current password to confirm the password change.
  • A new, random password is displayed. Make sure to keep it in a safe place.
  • Click OK to save changes.

Change Mailbox Folder location

  • Stop the Gateway service by clicking on the desktop shortcut "MailStore Gateway" and then click "Stop Service"
  • Move the folder "C:\ProgramData\MailStore\Gateway" to your desired location.
  • Open an elevated command prompt (cmd).
  • Navigate into "C:\ProgamData\MailStore"
  • Execute the command:

mklink /D Gateway <full_path_where_you_moved_the_folder_to>

  • Restart the Gateway service by clicking on the desktop shortcut "MailStore Gateway" and then click "Start Service"

In our example below, we moved the "Gateway" folder to the "C:\TestDirectory" folder. Remember, you can move the Gateway folder to any local drive on the server.

MailStore Gateway Command Prompt.png
  • After the command is ran successfully in the command prompt and the symbollic link is created, when you go back into the "C:\ProgramData\MailStore" directory, you will now see a shortcut which indicates that the move process was completed successfully. Please refer to the picture below.


MailStore Gateway Symbolic link.png

Sign Out

  • Click on the username in the upper right corner.
  • Select Sign out.