File:MailStore Gateway Configuration.png

2024-10-09T07:41:09Z

Lgodesberg: Lgodesberg uploaded a new version of File:MailStore Gateway Configuration.png

System Requirements

2024-10-09T07:29:23Z

Lgodesberg: /* Other Software */

__NOTOC__
Before beginning the installation of MailStore Gateway, all system requirements must be met.

== Hardware Requirements ==
{| class="wikitable" width="100%"
! width="150" scope="row" | '''Processor'''
| Any x64 compatible CPU
|-
! width="150" scope="row" | '''Main Memory'''
| 512 MB
|-
! width="150" scope="row" | '''Hard Disk'''
| 150 MB available disk space + enough disk space to store expected email volume.
|-
! width="150" scope="row" | '''Network Bandwidth'''
| 100 MBit/s
|}

== Software Requirements ==
=== Operating System ===
MailStore Gateway is supported on the following operating systems:
* Microsoft Windows 11
* Microsoft Windows 10 (1607 or higher)
* Microsoft Windows Server 2022 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2019 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2016 (Essentials, Standard, Datacenter)
The TCP SMTP ports 25, 465 and 587, the TCP POP3 ports 110 and 995, and the TCP HTTPS port 8450 must not be used by any other program, such as an email server.

=== Web Browsers ===
The following web browsers in their respective current version are supported by the Management Console:
* Microsoft Edge (based on Chromium)
* Google Chrome
* Mozilla Firefox

=== Network ===
* Administrative access to the DNS zone is required to manage A and MX records.
* Administrative access to the firewall is required to manage port-forwarding rules.

=== Other Software ===
The following other software is required:
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 Microsoft .NET 8 Runtime]
[[de:Systemanforderungen]]
[[en:System Requirements]]

Management Console

2024-08-13T14:44:47Z

Lgodesberg: /* Create Mailbox */

__NOTOC__

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

[[File:MailStore_Gateway_Management_Console.png|center|550px]]

== Create Mailbox ==
You need one mailbox for each email source. E.g. when you receive journal messages from Microsoft 365 and you are using MailStore Gateway as POP3 and SMTP proxy, you need two mailboxes and two archiving profiles in MailStore Server or MailStore SPE of the correct type to archive from these mailboxes. 
* [[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.
*: [[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''.
* 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''.
*: [[File:MailStore_Gateway_Edit_Mailbox.png|center|350px]]
* 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.
* Double click on the mailbox and set its status to ''Suspended'', if it isn't already.
* Click ''Delete Mailbox''.
*: [[File:MailStore_Gateway_Delete_Mailbox_With_Mails.png|center|350px]]
* 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''.
*: [[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 ==
* [[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.

== Sign Out ==
* Click on the username in the upper right corner.
* Select ''Sign out''.

[[de:Management Console]]
[[en:Management Console]]

Quick Start Guide

2024-08-13T14:44:23Z

Lgodesberg: /* Creating A MailStore Gateway Mailbox */

=== Installation ===
* Download the MailStore Gateway setup file from here [https://www.mailstore.com/en/products/mailstore-gateway/].
* Start the installation process by double-clicking on the downloaded setup file .
* Select the language and click ''OK''.
* Read the license agreement.
* Select ''I accept the agreement'' and click ''Next''.
* Specify the target folder for the program files (default: ''C:\Program Files\MailStore\MailStore Gateway'') and click ''Next''.
* The setup program now extracts all program files into the given target folder.
* Click Finish to exit the installation program.

=== Initial Configuration ===
The initial configuration must be performed to set up the email domain and TLS certificate to use. Furthermore, the network environment must be adapted so that emails can be delivered to MailStore Gateway.

* Start the MailStore Gateway Config Tool by clicking on the desktop shortcut MailStore Gateway.
* Configure the ''E-Mail Domain'' by entering the domain you want to be handled by MailStore Gateway. Usually this domain is different than your primary domain.
* Add an A-record to your DNS zone which points to the public IP address of the MailStore Gateway server. The A-record should match one of the SANs (Subject Alternative Names) of the TLS certificate to be used.
* Add an MX-record to your DNS zone which points to the name of the A-record created in the previous step. The MX-record must match the ''E-Mail Domain'' setting.
* If MailStore Gateway is located behind a NAT router or firewall, additional configuration may be needed, e.g. SMTP and HTTP may need to be forwarded to MailStore Gateway. Refer to [[Firewall Configuration]] for further details.
*: [[File:MailStore Gateway Configuration.png|center|450px]]
* Leave the Management-console port set to the default of 8450 and the Let's Encrypt Port set to the default of 80.
* Next to the ''Certificate'' field, click the three dots box and select ''Create self-signed certificate...''.
* Enter the desired ''Common Name'' of the certificate. This name is also used as a ''Subject Alternative Name'' (SAN) of the certificate.
* Click ''OK''. The self-signed certificate is created and selected.
** Alternatively choose ''Obtain from Let's Encrypt...'' to obtain a certificate from Let's Encrypt. Refer to [[Using_Let%27s_Encrypt_Certificates|this article]] for further details.
* Click the ''Apply'' button to apply the configuration changes.
* Click ''Start Service'' to start the service.

=== Creating A MailStore Gateway Mailbox ===
The mailboxes are managed via the MailStore Gateway Management Console web interface.

You need one mailbox for each email source. E.g. when you receive journal messages from Microsoft 365 and you are using MailStore Gateway as POP3 and SMTP proxy, you need two mailboxes and two archiving profiles in MailStore Server or MailStore SPE of the correct type to archive from these mailboxes.

To log onto the MailStore Gateway Management Console and create a mailbox follow these instructions.
* Open a [[System_Requirements|supported web browser]].
* Navigate to <tt><nowiki>https://<hostname-of-mailstore-gateway-server>:8450</nowiki></tt>.
* Accept possible certificate warnings from your web browser when using a self-signed certificate.
*: [[File:MailStore_Gateway_Login.png|center|450px]]
* In the ''User Name'' field enter ''admin''.
* In the ''Password'' field enter the corresponding password of the admin user. For the first time login, the password is ''admin''. After the first login, a random, secure password is created automatically.
* Click ''Sign in'' to proceed.
* Click ''Create Mailbox'' to proceed.
* Type a name in the ''Name'' field, i.e. ''M365 Journal Mailbox''.
* ''Optional: '' Enter a description that helps to identify the purpose of the mailbox, e.g. ''Target for journal emails from Microsoft 365''.
* Click ''OK''.
* A strong, random password is generated and displayed.
*: [[File:JournalMailboxSetup.png|center|350px]]
* Carefully read the warning, copy the password, 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.

=== Using your new journal Mailbox hosted on MailStore Gateway===

* You now have a functional gateway mailbox to receive journal messages from your email host.
*: [[File:MailStore_Gateway_Management_Console_mailbox.png|center|450px]]
* From our domain above, the functional gateway mailbox address is as below: '' mbx-e52cdd7279194af9c57b3c2a064a7db@gateway.example.com''
* Head back to MailStore Server and set up archiving profiles that transfer the messages from MailStore Gateway to MailStore Server. [https://help.mailstore.com/en/server/MailStore_Help]

[[de:Quick Start Guide]]
[[en:Quick Start Guide]]

Management Console

2024-08-13T14:41:55Z

Lgodesberg: /* Create Mailbox */

__NOTOC__

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

[[File:MailStore_Gateway_Management_Console.png|center|550px]]

== Create Mailbox ==

You need one mailbox for each email source. E.g. when you receive journal messages from Microsoft 365 and you are using MailStore Gateway as POP3 and SMTP proxy, you need two mailboxes and two archiving profiles in MailStore Server or MailStore SPE of the correct type to archive from these mailboxes. 
* [[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.
*: [[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''.
* 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''.
*: [[File:MailStore_Gateway_Edit_Mailbox.png|center|350px]]
* 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.
* Double click on the mailbox and set its status to ''Suspended'', if it isn't already.
* Click ''Delete Mailbox''.
*: [[File:MailStore_Gateway_Delete_Mailbox_With_Mails.png|center|350px]]
* 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''.
*: [[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 ==
* [[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.

== Sign Out ==
* Click on the username in the upper right corner.
* Select ''Sign out''.

[[de:Management Console]]
[[en:Management Console]]

Quick Start Guide

2024-08-08T12:26:24Z

Lgodesberg: /* Creating A MailStore Gateway Mailbox */

=== Installation ===
* Download the MailStore Gateway setup file from here [https://www.mailstore.com/en/products/mailstore-gateway/].
* Start the installation process by double-clicking on the downloaded setup file .
* Select the language and click ''OK''.
* Read the license agreement.
* Select ''I accept the agreement'' and click ''Next''.
* Specify the target folder for the program files (default: ''C:\Program Files\MailStore\MailStore Gateway'') and click ''Next''.
* The setup program now extracts all program files into the given target folder.
* Click Finish to exit the installation program.

=== Initial Configuration ===
The initial configuration must be performed to set up the email domain and TLS certificate to use. Furthermore, the network environment must be adapted so that emails can be delivered to MailStore Gateway.

* Start the MailStore Gateway Config Tool by clicking on the desktop shortcut MailStore Gateway.
* Configure the ''E-Mail Domain'' by entering the domain you want to be handled by MailStore Gateway. Usually this domain is different than your primary domain.
* Add an A-record to your DNS zone which points to the public IP address of the MailStore Gateway server. The A-record should match one of the SANs (Subject Alternative Names) of the TLS certificate to be used.
* Add an MX-record to your DNS zone which points to the name of the A-record created in the previous step. The MX-record must match the ''E-Mail Domain'' setting.
* If MailStore Gateway is located behind a NAT router or firewall, additional configuration may be needed, e.g. SMTP and HTTP may need to be forwarded to MailStore Gateway. Refer to [[Firewall Configuration]] for further details.
*: [[File:MailStore Gateway Configuration.png|center|450px]]
* Leave the Management-console port set to the default of 8450 and the Let's Encrypt Port set to the default of 80.
* Next to the ''Certificate'' field, click the three dots box and select ''Create self-signed certificate...''.
* Enter the desired ''Common Name'' of the certificate. This name is also used as a ''Subject Alternative Name'' (SAN) of the certificate.
* Click ''OK''. The self-signed certificate is created and selected.
** Alternatively choose ''Obtain from Let's Encrypt...'' to obtain a certificate from Let's Encrypt. Refer to [[Using_Let%27s_Encrypt_Certificates|this article]] for further details.
* Click the ''Apply'' button to apply the configuration changes.
* Click ''Start Service'' to start the service.

=== Creating A MailStore Gateway Mailbox ===
You need one mailbox for each email source. E.g. when you receive journal messages from Microsoft 365 and you are using MailStore Gateway as POP3 and SMTP proxy, you need two mailboxes and two archiving profiles in MailStore Server or MailStore SPE of the correct type to archive from these mailboxes. 
To log onto the MailStore Gateway Management Console and create a mailbox follow these instructions.
* Open a [[System_Requirements|supported web browser]].
* Navigate to <tt><nowiki>https://<hostname-of-mailstore-gateway-server>:8450</nowiki></tt>.
* Accept possible certificate warnings from your web browser when using a self-signed certificate.
*: [[File:MailStore_Gateway_Login.png|center|450px]]
* In the ''User Name'' field enter ''admin''.
* In the ''Password'' field enter the corresponding password of the admin user. For the first time login, the password is ''admin''. After the first login, a random, secure password is created automatically.
* Click ''Sign in'' to proceed.
* Click ''Create Mailbox'' to proceed.
* Type a name in the ''Name'' field, i.e. ''M365 Journal Mailbox''.
* ''Optional: '' Enter a description that helps to identify the purpose of the mailbox, e.g. ''Target for journal emails from Microsoft 365''.
* Click ''OK''.
* A strong, random password is generated and displayed.
*: [[File:JournalMailboxSetup.png|center|350px]]
* Carefully read the warning, copy the password, 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.

=== Using your new journal Mailbox hosted on MailStore Gateway===

* You now have a functional gateway mailbox to receive journal messages from your email host.
*: [[File:MailStore_Gateway_Management_Console_mailbox.png|center|450px]]
* From our domain above, the functional gateway mailbox address is as below: '' mbx-e52cdd7279194af9c57b3c2a064a7db@gateway.example.com''
* Head back to MailStore Server and set up archiving profiles that transfer the messages from MailStore Gateway to MailStore Server. [https://help.mailstore.com/en/server/MailStore_Help]

[[de:Quick Start Guide]]
[[en:Quick Start Guide]]

Main Page

2024-07-29T09:19:25Z

Lgodesberg: /* Articles */

__NOTOC__
{{DISPLAYTITLE:MailStore Gateway Help}}

MailStore Gateway is a free, complementary tool for MailStore's email archiving solutions MailStore Server and MailStore Service Provider Edition.

It provides SMTP and POP3 proxy functionality, as well as simple mail server functionality to receive and store emails from Microsoft 365, Google G Suite or other email servers that are capable of sending emails to external archiving solutions via SMTP.

If you want to get started quickly, follow the [[Quick Start Guide]].

The following provides a walk-though of the essential steps to get the MailStore Gateway up and running, as well as some background information.

== Before You Start ==
{|
| style="vertical-align: top; width: 200px" | [[Overview]]
| Learn more about the scenarios in which MailStore Gateway is the right solution for common challenges.
|-
| [[System Requirements]]
| Before installing MailStore Gateway, ensure that the system requirements are met.
|}

== Installation and Setup ==
{|
| style="vertical-align: top; width: 200px" | [[Installing MailStore Gateway|Installation]]
| Irrespective of the projected scenario, it all begins with the installation of the software itself.
|-
| [[Configuration Tool|Basic Configuration]]
| After successful installation, some basic configuration settings should be reviewed and adjusted where needed.
|-
| [[Firewall Configuration|Firewall Configuration]]
| To access MailStore Gateway from remote systems, appropriate firewall rules may have to be set up.
|}

== Using MailStore Gateway ==
{|
| style="vertical-align: top; width: 200px" | [[Login|Logging On]]
| Learn how to login to MailStore Gateway's Management Console.
|-
| [[Management Console|Create and Manage Mailboxes]]
| MailStore Gateway mailboxes contain the emails that are to be archived by MailStore Server or MailStore Service Provider Edition.
|}

== Post Installation Tasks ==
{|
| style="vertical-align: top; width: 200px" | [[Backup and Restore]]
| To protect the configuration settings and mailbox content, it is highly recommended to create backups regularly.
|-
| [[Monitoring]]
| This article gives an overview of what services and parameters to proactively monitor with a suitable monitoring solution to always provide users the best possible experience.
|}

== Articles ==
{|
| style="vertical-align: top; width: 200px" | [[Move MailStore Gateway to new machine]]
| This article provides steps to move your existing MailStore Gateway install to a new machine.
|-
| [[Update MailStore Gateway]]
| This article provides steps how to update MailStore Gateway.
|-
| [[Using Let%27s Encrypt Certificates]]
| This article explains how to configure MailStore Gateway to use Let's Encrypt certificates.
|-
| [[Change Mailbox Folder location]]
| This article provides steps to move MailStore Gateway configuration and mailbox data to a different location.
|-
| [[Reset administrator password]]
| This article describes how to reset the administrator password.
|-
| [https://www.mailstore.com/en/products/mailstore-gateway/changelog/ Changelog]
| What's new in MailStore Gateway
|}

[[de:Hauptseite]]
[[en:Main_Page]]

Main Page

2024-07-29T09:11:11Z

Lgodesberg: /* Articles */

__NOTOC__
{{DISPLAYTITLE:MailStore Gateway Help}}

MailStore Gateway is a free, complementary tool for MailStore's email archiving solutions MailStore Server and MailStore Service Provider Edition.

It provides SMTP and POP3 proxy functionality, as well as simple mail server functionality to receive and store emails from Microsoft 365, Google G Suite or other email servers that are capable of sending emails to external archiving solutions via SMTP.

If you want to get started quickly, follow the [[Quick Start Guide]].

The following provides a walk-though of the essential steps to get the MailStore Gateway up and running, as well as some background information.

== Before You Start ==
{|
| style="vertical-align: top; width: 200px" | [[Overview]]
| Learn more about the scenarios in which MailStore Gateway is the right solution for common challenges.
|-
| [[System Requirements]]
| Before installing MailStore Gateway, ensure that the system requirements are met.
|}

== Installation and Setup ==
{|
| style="vertical-align: top; width: 200px" | [[Installing MailStore Gateway|Installation]]
| Irrespective of the projected scenario, it all begins with the installation of the software itself.
|-
| [[Configuration Tool|Basic Configuration]]
| After successful installation, some basic configuration settings should be reviewed and adjusted where needed.
|-
| [[Firewall Configuration|Firewall Configuration]]
| To access MailStore Gateway from remote systems, appropriate firewall rules may have to be set up.
|}

== Using MailStore Gateway ==
{|
| style="vertical-align: top; width: 200px" | [[Login|Logging On]]
| Learn how to login to MailStore Gateway's Management Console.
|-
| [[Management Console|Create and Manage Mailboxes]]
| MailStore Gateway mailboxes contain the emails that are to be archived by MailStore Server or MailStore Service Provider Edition.
|}

== Post Installation Tasks ==
{|
| style="vertical-align: top; width: 200px" | [[Backup and Restore]]
| To protect the configuration settings and mailbox content, it is highly recommended to create backups regularly.
|-
| [[Monitoring]]
| This article gives an overview of what services and parameters to proactively monitor with a suitable monitoring solution to always provide users the best possible experience.
|}

== Articles ==
{|
| style="vertical-align: top; width: 200px" | [[Move MailStore Gateway to new machine]]
| This article provides steps to move your existing MailStore Gateway install to a new machine.
|-
| [[Update MailStore Gateway]]
| This article provides steps how to update MailStore Gateway.
|-
| [[Using Let%27s Encrypt Certificates]]
| This article explains how to configure MailStore Gateway to use Let's Encrypt certificates.
|-
| [[Change Mailbox Folder location]]
| This article provides steps to move MailStore Gateway configuration and mailbox data to a different location.
|-
| [[Reset administrator password]]
| This article describes how to reset the administrator password.
|-
| [https://www.mailstore.com/en/products/mailstore-gateway/changelog/ Changelog]
| What’s New in MailStore Gateway
|}

[[de:Hauptseite]]
[[en:Main_Page]]

Move MailStore Gateway to new machine

2024-07-16T13:33:49Z

Lgodesberg:

MailStore Gateway has multiple dependencies to network infrastructure. Depending on your specific setup, firewalls and DNS zones have to be re-configured as well. Please read the following instructions completely and carefully before you start implementing them.

== Scenarios ==
The following scenarios are covered:
* MailStore Gateway is exposed to the internet through a firewall. It does not matter, whether the firewall only does port-forwarding or acts as reverse proxy.
* MailStore Gateway is exposed to the internet directly, e.g. when running in Azure or AWS.
Most steps are the same for both scenarios, differences will be pointed out when necessary.

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

* If MailStore Gateway is exposed to the internet directly, it might be beneficial to lower the TTL of the MX record of the Gateway email domain that points to the old machine beforehand.
* Create a [[Backup_and_Restore|backup]] of your OLD machine.
* [[Installing_MailStore_Gateway|Install]] MailStore Gateway on the NEW machine. The download can be found here [https://www.mailstore.com/en/products/mailstore-gateway/].
* On the NEW machine start the [[Configuration_Tool|MailStore Gateway Config Tool]] by clicking on the desktop shortcut ''MailStore Gateway''.
* On the NEW machine stop the Gateway service by clicking ''Stop Service''.
* On the NEW machine close the MailStore Gateway Config Tool.
* Copy the files ''config.json'' and ''gateway.db'' in the folder ''C:\ProgramData\MailStore\Gateway'' from the OLD machine to the same folder of the NEW machine, overwriting existing files.
* If using a third-party TLS certificate, copy and install the certificate to the NEW machine.
* Reopen the MailStore Gateway Config Tool from the desktop of the NEW machine and verify your settings. Especially that of the email domain and the certificate. [[Using_Let%27s_Encrypt_Certificates|Re-configure Let's Encrypt]], if necessary.
* Start the MailStore Gateway Service on the NEW machine.
* If MailStore Gateway is exposed to the internet through a firewall, adjust [[Firewall_Configuration|firewall settings]] to forward Gateway traffic to the NEW machine.
* Adjust DNS settings, if necessary.
* If MailStore Gatway is exposed to the internet directly, adjust the MX record of the Gateway email domain to point to the NEW machine. Adjust the TTL in case it has been altered beforehand.
* Ensure the NEW machine is receiving mails.
* Ensure the OLD machine is not receiving mails, anymore. If MailStore Gateway is directly exposed to the internet, depending on the TTL of the MX record, this might take 24 hours or even longer.
* After the machine is not receiving mails anymore, archive the remaining mails from the OLD machine.
* Adjust the archiving profiles in MailStore Server to point to the new Gateway.
* Adjust email client settings to point to the new Gateway if used as email proxy.
* Decommission the OLD machine.

[[de:MailStore Gateway auf einen anderen Server verschieben]]
[[en:Move_MailStore_Gateway_to_new_machine]]

Quick Start Guide

2024-04-17T12:27:12Z

Lgodesberg: /* Initial Configuration */

=== Installation ===
* Download the MailStore Gateway setup file from here [https://www.mailstore.com/en/products/mailstore-gateway/].
* Start the installation process by double-clicking on the downloaded setup file .
* Select the language and click ''OK''.
* Read the license agreement.
* Select I accept the agreement and click ''Next''.
* Specify the target folder for the program files (default: ''C:\Program Files\MailStore\MailStore Gateway'') and click ''Next''.
* The setup program now extracts all program files into the given target folder.
* Click Finish to exit the installation program.

=== Initial Configuration ===
The initial configuration must be performed to set up the email domain and TLS certificate to use. Furthermore, the network environment must be adapted so that emails can be delivered to MailStore Gateway.

Furthermore, the network environment must be adapted so that emails can be delivered to MailStore Gateway.

* Start the MailStore Gateway Config Tool by clicking on the desktop shortcut MailStore Gateway.
* Configure the ''E-Mail Domain'' by entering the domain you want to be handled by MailStore Gateway. Usually this domain is different than your primary domain.
* Add an A-record to your DNS zone which points to the public IP address of the MailStore Gateway server. The A-record should match one of the SANs (Subject Alternative Names) of the TLS certificate to be used.
* Add an MX-record to your DNS zone which points to the name of the A-record created in the previous step. The MX-record must match the ''E-Mail Domain'' setting.
* If MailStore Gateway is located behind a NAT router or firewall, additional configuration may be needed, e.g. SMTP and HTTP may need to be forwarded to MailStore Gateway. Refer to [[Firewall Configuration]] for further details.
*: [[File:MailStore Gateway Configuration.png|center|450px]]
* Leave the Management-console port set to the default of 8450 and the Let's Encrypt Port set to the default of 80.
* Next to the ''Certificate'' field, click the three dots box and select ''Create self-signed certificate...''.
* Enter the desired ''Common Name'' of the certificate. This name is also used as a ''Subject Alternative Name'' (SAN) of the certificate.
* Click ''OK''. The self-signed certificate is created and selected.
** Alternatively choose ''Obtain from Let's Encrypt...'' to obtain a certificate from Let's Encrypt. Refer to [[Using_Let%27s_Encrypt_Certificates|this article]] for further details.
* Click the ''Apply'' button to apply the configuration changes.
* Click ''Start Service'' to start the service.

=== Creating A MailStore Gateway Mailbox ===
To log onto the MailStore Gateway Management Console and create a mailbox follow these instructions.
* Open a [[System_Requirements|supported web browser]].
* Navigate to <tt><nowiki>https://<hostname-of-mailstore-gateway-server>:8450</nowiki></tt>.
* Accept possible certificate warnings from your web browser when using a self-signed certificate.
*: [[File:MailStore_Gateway_Login.png|center|450px]]
* In the ''User Name'' field enter ''admin''.
* In the ''Password'' field enter the corresponding password of the admin user. For the first time login, the password is ''admin''. After the first login, a random, secure password is created automatically.
* Click ''Sign in'' to proceed.
* Click ''Create Mailbox'' to proceed.
* Type a name in the ''Name'' field, i.e. ''M365 Journal Mailbox''.
* ''Optional: '' Enter a description that helps to identify the purpose of the mailbox, e.g. ''Target for journal emails from Microsoft 365''.
* Click ''OK''.
* A strong, random password is generated and displayed.
*: [[File:JournalMailboxSetup.png|center|350px]]
* Carefully read the warning, copy the password, 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.

=== Using your new journal Mailbox hosted on MailStore Gateway===

* You now have a functional gateway mailbox to receive journal messages from your email host.
*: [[File:MailStore_Gateway_Management_Console_mailbox.png|center|450px]]
* From our domain above, the functional gateway mailbox address is as below: '' mbx-e52cdd7279194af9c57b3c2a064a7db@gateway.example.com''
* Head back to MailStore Server and set up archiving profiles that transfer the messages from MailStore Gateway to MailStore Server. [https://help.mailstore.com/en/server/MailStore_Help]

[[de:Quick Start Guide]]
[[en:Quick Start Guide]]

System Requirements

2024-04-17T12:23:24Z

Lgodesberg:

__NOTOC__
Before beginning the installation of MailStore Gateway, all system requirements must be met.

== Hardware Requirements ==
{| class="wikitable" width="100%"
! width="150" scope="row" | '''Processor'''
| Any x64 compatible CPU
|-
! width="150" scope="row" | '''Main Memory'''
| 512 MB
|-
! width="150" scope="row" | '''Hard Disk'''
| 150 MB available disk space + enough disk space to store expected email volume.
|-
! width="150" scope="row" | '''Network Bandwidth'''
| 100 MBit/s
|}

== Software Requirements ==
=== Operating System ===
MailStore Gateway is supported on the following operating systems:
* Microsoft Windows 11
* Microsoft Windows 10 (1607 or higher)
* Microsoft Windows Server 2022 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2019 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2016 (Essentials, Standard, Datacenter)
The TCP SMTP ports 25, 465 and 587, the TCP POP3 ports 110 and 995, and the TCP HTTPS port 8450 must not be used by any other program, such as an email server.

=== Web Browsers ===
The following web browsers in their respective current version are supported by the Management Console:
* Microsoft Edge (based on Chromium)
* Google Chrome
* Mozilla Firefox

=== Network ===
* Administrative access to the DNS zone is required to manage A and MX records.
* Administrative access to the firewall is required to manage port-forwarding rules.

=== Other Software ===
The following other software is required:
* [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 Microsoft .NET 6 Runtime]
[[de:Systemanforderungen]]
[[en:System Requirements]]

System Requirements

2024-04-17T10:57:13Z

Lgodesberg: /* Network */

__NOTOC__
Before beginning the installation of MailStore Gateway, all system requirements must be met.

== Hardware Requirements ==
{| class="wikitable" width="100%"
! width="150" scope="row" | '''Processor'''
| Any x64 compatible CPU
|-
! width="150" scope="row" | '''Main Memory'''
| 512 MB
|-
! width="150" scope="row" | '''Hard Disk'''
| 150 MB available disk space + enough disk space to store expected email volume.
|-
! width="150" scope="row" | '''Network Bandwidth'''
| 100 MBit/s
|}

== Software Requirements ==
=== Operating System ===
MailStore Gateway is supported on the following operating systems:
* Microsoft Windows 11
* Microsoft Windows 10 (1607 or higher)
* Microsoft Windows Server 2022 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2019 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2016 (Essentials, Standard, Datacenter)
The TCP SMTP ports 25, 465 and 587, the TCP POP3 ports 110 and 995, and the TCP HTTPS port 8450 must not be used by any other program, such as an email server.

=== Web Browsers ===
The following web browsers in their respective current version are supported by the Management Console:
* Microsoft Edge (based on Chromium)
* Google Chrome
* Mozilla Firefox

=== Network ===
Administrative access to the DNS zone is required to manage A and MX records.

=== Other Software ===
The following other software is required:
* [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 Microsoft .NET 6 Runtime]
[[de:Systemanforderungen]]
[[en:System Requirements]]

Main Page

Lgodesberg: /* Initial Configuration */

=== Installation ===
* Download the MailStore Gateway setup file from here [https://www.mailstore.com/en/products/mailstore-gateway/].
* Start the installation process by double-clicking on the downloaded setup file .
* Select the language and click ''OK''.
* Read the license agreement.
* Select I accept the agreement and click ''Next''.
* Specify the target folder for the program files (default: ''C:\Program Files\MailStore\MailStore Gateway'') and click ''Next''.
* The setup program now extracts all program files into the given target folder.
* Click Finish to exit the installation program.

=== Initial Configuration ===
The initial configuration must be carried out in order to make MailStore Gateway aware of the email domain to be used and to set up the TLS certificate to be used.

* The Gateway config tool shortcut is located on the desktop of your machine and is named ''MailStore Gateway''. Double-click to open that tool.
* Configure the ''E-Mail Domain'' by entering the domain you want to be handled by MailStore Gateway. Usually this domain is different than your primary domain.
* Add an A-record to your DNS zone which points to the public IP address of the MailStore Gateway server. The A-record should match one of the SANs (Subject Alternative Names) of the certificate to be used.
* Add an MX-record to your DNS zone which points to the name of the A-record created in the previous step. The MX-record must match the ''E-Mail Domain'' setting.
* If MailStore Gateway is located behind a NAT router or firewall, additional configuration may be needed, e.g. SMTP and HTTP may need to be forwarded to MailStore Gateway. Refer to [[Firewall Configuration]] for further details.
*: [[File:MailStore Gateway Configuration.png|center|450px]]
* Leave the Management-console port set to the default of 8450 and the Let's Encrypt Port set to 80.
* In the "Certificate" field, click the box with the three dots and choose ''Create Self-Signed Certificate'' and click "OK". This will create a self-signed certificate using the FQDN of the MailStore Gateway machine which is the default configuration.
** Alternatively choose ''Obtain from Let's Encrypt...'' to obtain a certificate from Let's Encrypt. Refer to [[Using_Let%27s_Encrypt_Certificates|this article]] for further details.
* Click the ''Apply'' button to apply the configuration changes and then click ''Start Service''.

=== Creating A MailStore Gateway Mailbox ===
TO log onto the MailStore Gateway Management Console and create a mailbox follow these instructions.
* Open a [[System_Requirements|supported web browser]].
* Navigate to <tt><nowiki>https://<hostname-of-mailstore-gateway-server>:8450</nowiki></tt>.
* Accept possible certificate warnings from your web browser when using a self-signed certificate.
*: [[File:MailStore_Gateway_Login.png|center|450px]]
* In the ''User Name'' field enter ''admin''.
* In the ''Password'' field enter the corresponding password of the admin user. For the first time login, the password is ''admin''. After the first login, a random, secure password is created automatically.
* Click ''Sign in'' to proceed.
* Click ''Create Mailbox'' to proceed.
* 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 mytdomain.net''.
* Click ''OK''.
* A strong, random password is generated and displayed.
*: [[File:JournalMailboxSetup.png|center|350px]]
* 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.

=== Using your new journal Mailbox hosted on MailStore Gateway===

* You now have a functional gateway mailbox to receive journal messages from your email host.
*: [[File:MailStore_Gateway_Management_Console_mailbox.png|center|450px]]
* From our fictional domain above, the functional gateway mailbox address is as below:
** mbx-e52cdd7279194af9c57b3c2a064a7db@gateway.example.com

2024-04-15T17:02:49Z

Lgodesberg:

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

* Start the MailStore Gateway Config Tool by clicking on the desktop shortcut ''MailStore Gateway''.
* Stop the Gateway service by clicking ''Stop Service''.
* [[Installing_MailStore_Gateway|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_Configuration|firewall settings]] to forward traffic to the new machine where MailStore Gateway is installed.
* If using a third-party TLS certificate, copy and install the certificate to the new Gateway server.
* Replace the Gateway configuration folder on the new server by the folder from the older server. By default this is ''C:\ProgramData\MailStore\Gateway''.
* Reopen the MailStore Gateway Config Tool from the desktop of the new machine and verify your settings. Especially that of the email domain and the certificate.
* Adjust the archiving profiles in MailStore Server to point to the new Gateway.
* Adjust email client settings to point to the new Gateway if used as email proxy.
* Start the MailStore Gateway Service on the new machine.
* Uninstall MailStore Gateway from the old machine.

[[de:MailStore Gateway auf einen anderen Server verschieben]]
[[en:Move_MailStore_Gateway_to_new_machine]]