Difference between revisions of "Management Console"

[checked revision][pending revision]
(9 intermediate revisions by the same user not shown)
Line 31: Line 31:
  
 
== Delete Mailbox ==
 
== Delete Mailbox ==
To delete a mailbox, it must meet the following prerequisites:
+
To delete a mailbox, please use the following procedure below:
 
 
* Its status must be set to ''Suspended''.
 
 
 
If these prerequisites are met, a mailbox can be deleted by the following procedure:
 
  
 
* [[Login]] to the Management 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 confirm deleting the mailbox, or ''No'' to abort the deletion.
 
* Click ''Yes'' to confirm deleting the mailbox, or ''No'' to abort the deletion.
  
Line 74: Line 71:
 
* 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"
 +
 +
== Move MailStore Gateway to new machine ==
 +
To move MailStore Gateway to a new machine, please follow the steps below:
 +
 +
* Stop the MailStore Gateway service on the current machine.
 +
* Install MailStore Gateway on the new machine.
 +
* Stop the MailStore Gateway service on the new machine.
 +
* Adjust any DNS settings(internal DNS and external DNS if used).
 +
* Adjust firewall settings to point to the new machine where MailStore Gateway is installed.
 +
* If using a third-party certificate, copy and install the certificate to the new Gateway server.
 +
*: [[File:Changecertificate.png|center|350px]]
 +
* Copy the configuration file that holds your configuration settings over to the new server.
 +
** Copy the "config.json" file located in "C:\ProgramData\MailStore\Gateway" from the original Gateway Server to the same location on the new Gateway server.
 +
* Adjust archiving profiles.
 +
** adjust the MailStore Gateway server name in your existing archive profiles.
 +
* Adjust client settings if used as "proxy"
 +
** Adjust Names in client settings (i.e Outlook, Thunderbird) if used
 +
* Start the MailStore Gateway Service on the new machine.
 +
* Uninstall the MailStore Gateway Service from the old machine
  
 
== Sign Out ==
 
== Sign Out ==

Revision as of 11:23, 5 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"

Move MailStore Gateway to new machine

To move MailStore Gateway to a new machine, please follow the steps below:

  • Stop the MailStore Gateway service on the current machine.
  • Install MailStore Gateway on the new machine.
  • Stop the MailStore Gateway service on the new machine.
  • Adjust any DNS settings(internal DNS and external DNS if used).
  • Adjust firewall settings to point to the new machine where MailStore Gateway is installed.
  • If using a third-party certificate, copy and install the certificate to the new Gateway server.
    Changecertificate.png
  • Copy the configuration file that holds your configuration settings over to the new server.
    • Copy the "config.json" file located in "C:\ProgramData\MailStore\Gateway" from the original Gateway Server to the same location on the new Gateway server.
  • Adjust archiving profiles.
    • adjust the MailStore Gateway server name in your existing archive profiles.
  • Adjust client settings if used as "proxy"
    • Adjust Names in client settings (i.e Outlook, Thunderbird) if used
  • Start the MailStore Gateway Service on the new machine.
  • Uninstall the MailStore Gateway Service from the old machine

Sign Out

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