MailStore Server Help - User contributions [en]

Bulk Import of Email Files

2023-04-24T06:39:25Z

Rrommelrath: /* Migrating Exchange Archive Mailboxes into MailStore */

When archiving email files, MailStore only allows archiving of individual email files (PST, MBOX) or directories which contain email files of one user (EML, MSG).

The following describes how to archive all PST-, MBOX-, EML- or MSG-files of all users in a few steps, using a bulk import script written in Python.

The bulk import script expects the email files in folders that are named after the corresponding MailStore users. Such a folder structure can easily be created by another script included in the [[Media:Scripts.zip|Python scripting package]].

If you want to archive PST- or MBOX-files of one user only, you can use the bulk import scripts from the [[Media:Batchscripts.zip|batch scripting package]]; the installation of Python is not required in that case.

== Preparing Python ==
The provided scripts are written in Python. Python 3.2 or newer is required as well as the [[Media:scripts.zip|Python scripting package]].
The [[Python API Wrapper Tutorial|Python API-Wrapper]] has to be installed.

== Preparing the Folder Structure ==
The scripting package contains the <code>createUserFolders.py</code> script which prepares the folders by fetching a list of existing MailStore Server users and creating folders with the same names in the filesystem. The actual bulk archiving script uses these folder names to assign the enclosed files to the corresponding users in MailStore.

The MailStore Server Administration API must be enabled in the [[MailStore Server Service Configuration]].

After installing Python, the script can be modified by right-clicking on it, then selecting ''IDLE'', the supplied Python editor. Adapt the values of <code>USER</code>, <code>PASS</code>, <code>HOST</code> and <code>PORT</code> to your installation.

The <code>rootpath</code> variable contains the path where the folders will be created.

Press F5 to run the script. A security question follows.

== Preparing the Archiving Profile ==
Before executing the bulk import script, a new archiving profile that corresponds to the email files (PST, MBOX, EML/MSG) to be archived must be created manually in MailStore Server.

The profile must of the type ''Single User''. The settings in this archiving profile apply to all read files. For instance, if your exclude or include folders or define filters, they will be applied to all files you archive from.

The path you specify in the profile to the PST or MBOX file, or the folder containing EML/MSG files, is irrelevant, as it gets overwritten by the bulk import script. Additionally, sub folders are recognized when archiving EML/MSG files, whereas MailStore headers in EML files are always ignored.

'''Important Notice:''' If you want to archive PST files, Microsoft Outlook must be installed on the machine where the archiving profile is run.

Depending on the file type to be archived, the created profiles must be named <code>templateBulkImportEMLMSG</code>, <code>templateBulkImportPST</code> or <code>templateBulkImportMBOX</code>.

== Filling the Folders ==
For each user, put the email files to be archived into the corresponding folders under the <code>rootpath</code>. When archiving PST files, these can be located in subfolders. A simultaneous import of different file types is not supported. If you want to archive PST and MBOX files, a separate run is necessary for each.

== Archiving ==
Archiving is done by the <code>bulkImport.py</code> script. Before running it must be adapted to your MailStore installation by using ''IDLE''. Since this script uses the MailStore Client to connect to the server, rather than connecting to the MailStore Server Administration API you have to use slightly other values.

The path to <code>MailStoreCmdSilent.exe</code>, the host name, credentials of an administrator and the <code>rootpath</code> have to be adjusted.

When importing into MailStore Server the <code>HOST</code> has to be in the format <code>computer:port</code>. When importing into a MailStore SPE instance the format has to be <code><nowiki>https://computer:port/instanceid</nowiki></code>.

Similar to the <code>createUserFolders.py</code> script, <code>rootpath</code> points to the folder that contains the actual user folders.
The <code>filetype</code> variable can have one of the following values according to the file type to archive: <code>pst</code>, <code>mbox</code> or <code>emlmsg</code>.

In ''IDLE'', press the F5 key to run the script.

== Logging ==
While the archiving process runs, its progress can be monitored in the status window. The message ''exitcode: 0'' means that the file or folder has been archived successfully. A different output would show the error. The task logs of the procedures are stored in the <code>rootpath</code> folder and are named as follows:

Date-Time-User-File.log (PST,MBOX)

or

Date-Time-User.log (EML/MSG)

The table ''Recent Results'' in MailStore Client gives you an overview of all run archiving profiles. Failed runs can by easily identified by their start time as the file names of the log files begin with the same value.

== Migrating local Exchange Archive Mailboxes into MailStore ==

MailStore is not able to access local Exchange archive mailboxes directly. To archive messages contained therein they have to be copied to a location that MailStore is able to read from. The messages could either be moved back to the original mailbox by the end user through Outlook and then be archived with MailStore using Exchange or Outlook archiving profiles. Alternatively, an Exchange administrator exports the archive mailboxes into PST files. The latter can be done in one central location and fully automated. Afterwards the PST files can be archived by using the procedure described above.

To create PST files from archive mailboxes, follow these steps:

* Create a network share that can be reached from the Exchange Server.
* Grant the domain group ''Exchange Trusted Subsystem'' write permissions on this share.
* Open a Microsoft Exchange Management Shell session in the Microsoft Exchange Server.
* Execute the following command in the Microsoft Exchange Management Shell to grant export privileges to ''administrator@example.com''. Adjust the user name according to your environment:
<div style="margin-left: 2.5em;">
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
New-ManagementRoleAssignment -Role "Mailbox Import Export" -User administrator@example.com
</source>
</div>
* Define a new variable in the Exchange Management Shell session that points to the network share:
<div style="margin-left: 2.5em;">
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
$ExportPath = "\\NAS\PSTs"
</source>
</div>
* Execute the following script in the Exchange Management Shell to create the PST files. The Exchange Management Shell has to be started by the user to whom have been granted export privileges. You might have to restart the Exchange Management Shell session:
<div style="margin-left: 2.5em;">
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
foreach ($mailbox in (Get-Mailbox))
{
$directory = ("$ExportPath\{0}" -f $mailbox.Alias).toLower()
if (-not (test-path $directory) )
{
New-Item -ItemType directory -Path $directory
}
New-MailboxExportRequest -Mailbox $mailbox.Alias -FilePath ("{0}\{1}-Archive.pst" -f $directory,$mailbox.Alias) -IsArchive
}
</source>
</div>
'''Note:''' The New-MailboxExportRequest cmdlet only accepts exporting to UNC paths. Local paths are not supported. When the parameter ''-IsArchive'' is omitted, the regular mailbox will be copied into the PST file.
* The export processes are running in the background. The state can be checked with the following command:
<div style="margin-left: 2.5em;">
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
Get-MailboxExportRequest | Get-MailboxExportRequestStatistics
</source>
</div>
* The role assignments can be removed with the following commands:
<div style="margin-left: 2.5em;">
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
Get-ManagementRoleAssignment -Role "Mailbox Import Export" | select Name
Remove-ManagementRoleAssignment "Mailbox Import Export-Administrator"
</source>
</div>
* Once the export is finished, the PST files can be archived with the procedure described above.

[[de:Massenimport von E-Mail-Dateien]]
[[en:Bulk Import of Email Files]]

Synchronizing User Accounts with Microsoft 365 - Modern Authentication

2023-03-07T07:07:38Z

Rrommelrath: changed header note to reflect support for MS365 global and 21Vianet

{{Directory Services Preamble|Microsoft 365 tenant|Microsoft 365|{{#ev:youtube|https://youtu.be/OtJx2EKEW0Y|350|right|''Tech Tip: Preparation of the Microsoft 365 Tenant and User Synchronization''}}| Our Tech Tip video shows the essential configuration steps in this article.}}
 
== Prerequisites, Recommendations and Limitations ==
* For best user experience, the certificate used by MailStore Server should be trusted by all clients and the used web browsers. Using a certificate that is signed by a trusted certificate authority or [[Using_Lets_Encrypt_Certificates|using Let's Encrypt certificates]] is highly recommended.
* If users are supposed to log in to MailStore Server from outside the organization's network without a VPN using [[Accessing_the_Archive_with_the_MailStore_Client_software|MailStore Client]], [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration|MailStore Outlook Add-in]] or the [[Accessing_the_Archive_with_MailStore_Web_Access|Web Access]], the URIs mentioned in this article must be resolvable via DNS on the Internet and port-forwardings to the MailStore Server computer must be set up on the firewall or router if necessary.
* When using Microsoft 365 to authenticate users at login, [[Accessing_the_Archive_via_Integrated_IMAP_Server|accessing the archive via IMAP]] is not possible for technical reasons.
* MailStore Server supports synchronizing user accounts with Microsoft 365 (Modern Authentication) with the ''global Microsoft Cloud'' or ''Azure and Microsoft 365 operated by 21Vianet in China''.

== Connecting MailStore Server and Microsoft 365 ==
In order to synchronize user information from Microsoft 365, MailStore Server has to be connected to your Microsoft 365 tenant and been granted the required permissions. Microsoft 365 relies on Azure Active Directory as directory service. Each Microsoft 365 tenant corresponds to an Azure AD tenant that stores its user information.

=== Registering of MailStore Server as App in Azure AD ===
Through registration, MailStore Server gets an identity in Azure AD that makes it possible to authenticate to the tenant's services and use their resources.
* Sign in to the [https://portal.azure.com Azure Portal] as a Global Administrator for your Microsoft 365 tenant.
* In the navigation menu (☰), select the option ''Azure Active Directory''.
* On the next page, select ''App registrations'' in the ''Manage'' section of the left navigation menu.
* Select ''New Registration''. The ''Register an application'' page appears.
* In the ''Name'' field, enter a meaningful display name, e.g. ''MailStore Server''. This name will be shown to users on logon later on, for example.
* Leave all other settings on this page to their defaults.
* Click on ''Register''. If the registration has been successful, you are shown the overview page of the newly registered app.
The ''Application (client) ID'' shown on this page identifies MailStore Server in your Azure AD tenant and has to be copied into MailStore Server next, together with the ''Directory (tenant) ID''. Therefore, for the following steps, leave the overview page open in your web browser.

=== Creating Credentials in MailStore Server ===
Credentials for Microsoft 365 consist of the aforementioned IDs and a secret that MailStore Server uses to proof its identity to Azure AD. Microsoft recommends using certificates as secrets to identify apps in Azure AD. When creating credentials, such a certificate is generated automatically by MailStore Server but can also be recreated later on.
{{Directory Services Accessing Configuration|Microsoft 365 (Modern Authentication)|Microsoft 365 sync 01.png}}
* In the ''Connection'' section, click on the button (…) next to the ''Credentials'' drop-down list.
* In the ''Credential Manager'' that appears, click on ''Create…''
* In the ''Azure AD App Credentials'' dialog, enter the following information in the ''Settings'' section:
** '''Name''' A meaningful display name for the credentials, e.g. the name of your Microsoft 365 tenant.
** '''Application (client) ID''' The value of the corresponding field that you can copy from the Azure AD app overview page in your web browser.
** '''Directory (tenant) ID''' The value of the corresponding field that you can copy from the Azure AD app overview page in your web browser.
[[File:Microsoft 365 cred 01.png|center|347px]]
* In the ''Authentication'' section, click on the drop-down button next to the ''Certificate'' text box und select ''Download Certificate''. Save the certificate on your hard drive.
* Confirm your entries by clicking ''OK''.
* The newly created credentials are listed in the ''Credential Manager'' under the name you have entered with the type ''Microsoft 365''. Here you can also edit or delete existing credentials if necessary.
* Leave the ''Credential Manager'' by clicking ''Close''.
* The newly created credentials are selected in the corresponding drop-down list by default.

=== Publishing Credentials in Azure AD ===
For Azure AD to validate the identity of MailStore Server, the created certificate needs to be published in Azure AD.
* Switch to the Azure AD app overview page in your web browser.
* Select ''Certificates & secrets'' in the ''Manage'' section of the left navigation menu.
* Click on ''Upload certificate'' in the ''Certificates'' section. Select the certificate file that you have saved previously and upload it to Azure AD by clicking ''Add''.
* If uploading has been successful, the certificate's thumbprint as well as its start and expiry dates appear in the certificates list. You can compare the thumbprint and expiry date with those listed in the MailStore Credential Manager to check that you've uploaded the correct certificate.

=== Configuring App Authentication in Azure AD ===
For Azure AD to return the result of a user's authentication request to MailStore Server, the endpoint where MailStore Server expects authentication responses, the so-called ''Redirect URI'', has to be conveyed to Azure AD.
* In the Azure Portal in the web browser, select ''Authentication'' in the ''Manage'' section of the left navigation menu.
* Click on the ''Add a platform'' button in the ''Platform configurations'' section of the ''Authentication'' page.
* Select ''Web'' in the ''Web applications'' section of the ''Configure platforms'' menu page.
* In the field ''Redirect URI'', enter a URI in the format (without brackets)
*: <code>https://<fqdn>[:<port>]/oidc/signin</code>
*; with the following components<nowiki>:</nowiki>
*: '''https://''' Specifying the <code>https://</code> protocol is obligatory. To avoid certificate warnings during user logon, the web browsers on the client machines must trust the [[MailStore_Server_Service_Configuration#Certificate|certificate used by MailStore Server]].
*: '''FQDN''' The Fully Qualified Domain Name (FQDN) of your MailStore Server that consists of the machine name and the DNS domain, e.g. <code>mailstore.example.com</code>. This name must be resolvable by all clients from which users shall be able to log on to MailStore Server.
*: '''Port''' The TCP port of the MailStore Web Access (<code>8462</code> by default). This value must be equal to the port configured in the section ''Base Configuration > Network Settings > MailStore Web Access / Outlook Add-in (HTTPS)'' of the [[MailStore_Server_Service_Configuration#Services|MailStore Server Service Configuration]]. The TCP port has to be specified only if it is different from the default port of the HTTPS protocol (<code>443</code>).
*: '''/oidc/signin''' The endpoint where MailStore Server expects the authentication responses of Azure AD. This path has to be specified exactly as stated here at the end of the redirect URI.
* Leave the field ''Logout URL'' blank.
* Enable the ''ID tokens'' option in the ''Implicit grant'' section.
* Click on ''Configure'' to finish the configuration of the app authentication in Azure AD.
<div class="resp-table">
{| class="wikitable" style="font-size: 85%;"
|+ Examples for valid redirect URIs
|-
! style="width:80px;" | Product
! style="width:80px;" | FQDN
! style="width:40px;" | Port
! Resulting Redirect URI
|-
| align="center"| MailStore Server
| align="center"| mailstore.example.com
| align="center"| 8462
| <code><nowiki>https://mailstore.example.com:8462/oidc/signin</nowiki></code> Redirect URI with Fully Qualified Domain Name and MailStore Web Access default port
|-
| align="center"| MailStore Server
| align="center"| mailstore.example.com
| align="center"| 443
| <code><nowiki>https://mailstore.example.com/oidc/signin</nowiki></code> The port can be ommited if the HTTPS default port 443 has been configured for MailStore Web Access or as source port of a port-forwarding on the firewall or router.
|-
| align="center"| MailStore SPE
| align="center"| archive.example.com
| align="center"| 443
| <code><nowiki>https://archive.example.com/<instanceid>/oidc/signin</nowiki></code> The ''instanceid'' of the instance is part of the Redirect URI.
|-
|}
</div>
:: '''Important Notice:''' Please note that the redirect URI is case-sensitive. Also review the requirements on resolving URIs in the [[#Prerequisites, Recommendations and Limitations|Prerequisites, Recommendations and Limitations]] section.

=== Configuring the Redirect URI in MailStore Server ===
For MailStore Server to convey the redirect URI to requesting clients, it must be configured there, too.
* Switch to the ''Directory Services'' page in the MailStore Client.
* Enter the redirect URI in the corresponding field in the ''Authentication'' section. Just copy the value previously configured in Azure AD from the web browser.
[[File:Microsoft 365 sync 02.png|center|450px]]

=== Configuring API Permissions in Azure AD ===
* Switch again to Azure AD in your web browser.
* Select ''API permissions'' in the ''Manage'' section of the left navigation menu.
* Click on the ''Add a permission'' button in the ''Configured permissions'' section.
* On the ''Request API permissions'' menu page, select the API ''Microsoft Graph'' in the ''Commonly used Microsoft APIs'' section.
* Select the option ''Application permissions''.
* Enable the ''Directory > Directory.Read.All'' permission in the ''Select permissions'' section.
* Click on ''Add permissions''.
* The permissions are updated and the ''Directory.Read.All'' permission appears in the API permissions list under ''Microsoft Graph''.
* Click on the ''Add a permission'' button in the ''Configured permissions'' section again.
* On the ''Request API permissions'' menu page, select ''APIs my organization uses''.
* Search for ''Office 365 Exchange Online'' and click on the corresponding entry.
* Select the option ''Application permissions''.
* Enable the ''full_access_as_app'' permission in the ''Select permissions'' section.
* Click on ''Add permissions''.
* The permissions are updated and the ''full_access_as_app'' permission appears in the API permissions list under ''Exchange''.
* Now click on the ''Grant admin consent for <your tenant name>'' button in the ''Configured permissions'' section.
* Acknowledge the following notice with ''Yes''.
* The status of all granted permissions is updated to ''Granted for <your tenant name>''.
The configuration of MailStore Server's connection to Microsoft 365 within Azure AD is now complete. You can sign out of your Azure AD tenant and close the browser window. Switch to the ''Directory Services'' page in the MailStore Client again, all remaining configuration steps must be done there.

=== User Database Synchronization ===
After configuring the connection settings as described above, you can specify filter criteria for the Microsoft 365 synchronization in this section.
*'''Synchronize licensed Microsoft Exchange Online users only''' Only Microsoft 365 user accounts with a Microsoft Exchange Online license assigned to them will be taken into account by the synchronization.
*'''Synchronize enabled users only''' Only Microsoft 365 user accounts that do not have their login to Microsoft 365 blocked will be taken into account by the synchronization.
*'''Sync only these groups''' Choose one or several Microsoft 365 security groups if you only want their members to be created as MailStore Server users. That way it's possible to exclude certain users from being synchronized to MailStore Server.

{{Directory Services Options|Microsoft 365 tenant}}
{{Directory Services Assign Default Privileges|Microsoft 365}}
{{Directory Services Run Synchronization|Microsoft 365 tenant}}
[[File:Office365_sync_02.png|450px|center]]

{{Directory Services Test Authentication}}
[[de:Synchronisieren_von_Benutzerkonten_mit_Microsoft_365_(Modern_Authentication)]]
[[en:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)]]

Archiving Emails from Microsoft 365 - Modern Authentication

2023-03-07T07:02:36Z

Rrommelrath: changed header note to reflect support for MS365 global and 21Vianet

{{Implementation Guide Preamble|Exchange Online / Microsoft 365|{{#ev:youtube|https://youtu.be/X0Um0cDWGg0|350|right|''Tech Tip: Microsoft 365 Archiving Profiles''}}| Our Tech Tip video shows the essential configuration steps in this article.}}
 
{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from Microsoft 365 (Modern Authentication) with the global Microsoft Cloud. or ''Azure and Microsoft 365 operated by 21Vianet in China''.|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.}}

== App Registration & User Synchronization ==
Before archiving Microsoft 365 mailboxes, registering MailStore Server in your Microsoft 365 tenant is required. It is also highly recommended to synchronize users in MailStore Server directly with that tenant to fetch all information that is relevant for archiving such as email addresses. The registration and synchronization procedures are described in the chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.

'''Please note:''' MailStore Server runs as a [[MailStore Server Service Configuration|Windows service]] and thus must use ''Application Permissions'' to access user mailboxes in Microsoft 365. By design, on the Microsoft identity platform, which is at the heart of Microsoft 365 authentication and authorization, this permission scope encloses the full level of privileges implied by a permission. As a consequence, once registered as described above, MailStore Server has access to all mailboxes in your Microsoft 365 tenant. Therefore, with regard to security, access to the Microsoft 365 archiving profiles in MailStore Server is limited to MailStore Server administrators.

=== Including Microsoft 365 Shared Mailboxes ===
In Microsoft 365, shared mailboxes are special mailboxes that multiple users have access to. Unlike a normal mailbox, a shared mailbox is not associated to a licensed Microsoft 365 user. For MailStore Server to create user entries for shared mailboxes, you must therefore deactivate the option ''Synchronize licensed Microsoft Exchange Online users only'' in the section [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)#User_Database_Synchronization|User Database Synchronization]]. 
After synchronization you can grant MailStore Server users access to the archive of the shared mailbox by [[Users,_Folders_and_Settings#Folder_Access_.28e.g._Access_to_the_Emails_of_Other_Users.29|assigning privileges]]. For archiving shared mailboxes, just proceed as for individual or multiple mailboxes as detailed below.

== Archiving Individual Microsoft 365 Mailboxes ==
{{Archiving Single Mailbox Preamble|Microsoft 365}}
For each mailbox, please proceed as follows:

* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 mailbox 01.png|center|347px]]
* Select ''Single Mailbox'' and click on ''OK''.
*; [[File:Microsoft 365 mailbox 02.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* In the ''Mailbox'' field, enter the primary email address of the user whose mailbox you want to archive.
* Click on ''Test'' to verify that MailStore Server can access the mailbox.
* Click on ''Next''.
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections).
*; [[File:Microsoft_365_mailbox_03.png|center|347px]]
* Click on ''Next'' to continue.
* Select the archive of the user for whom the selected mailbox is to be archived. If the user does not exist yet, click on ''Create a New User…''.
*; [[File:Microsoft_365_mailbox_04.png|center|347px]]
* Click on ''Next''.
* In the last step, a name for the archiving profile can be specified. After clicking ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and, if desired, can be run immediately or automatically.

More information on how to execute archiving profiles can be found under the topic [[Email Archiving with MailStore Basics]]

== Archiving Multiple Microsoft 365 Mailboxes Centrally ==
{{Archiving Multiple Mailboxes Preamble|Microsoft 365}}
Please proceed as follows:

* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 mailboxes 01.png|center|347px]]
* Select ''Multiple Mailboxes'' and click ''OK''. 
*; {{Archiving_Multiple_or_Multidrop_Note|multiple mailboxes|[[#App_Registration_.26_User_Synchronization|directory synchronization]]}}
*; [[File:Microsoft 365 mailboxes 02.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 mailboxes 03.png|center|347px]]
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections). Please keep in mind that these settings apply to all mailboxes to be archived, as specified in the next step.
*; {{Archiving_Multiple_Mailboxes_Centrally_Options|Microsoft_365_mailboxes_04.png|Microsoft 365}}

== Archiving Incoming and Outgoing Emails Directly ==
{{Archiving Exchange Journal Mailbox Preamble|Exchange Online}}

=== Step 1: Setup and Configure MailStore Gateway ===
Please refer to the [https://help.mailstore.com/en/gateway/ MailStore Gateway Manual] for detailed instructions about:

* Installation and Setup of MailStore Gateway
* Logging on to MailStore Gateway's Management Console
* Creating MailStore Gateway mailboxes

After these steps, a mailbox with an individual email address (e.g. mbx-dead1234beef5678@gateway.example.com) should exist.

=== Step 2: Configure MailStore Server ===
{{Archiving MailStore Gateway Mailbox|''In- and Outbound E-Mail Automatically''|Microsoft 365 journal 01.png|Arch_MailStore_Gateway_Office365_02.png|''Microsoft 365''|TargetFolderHint=DontShow|POP3Hint=DontShow|DSLink=[[#App_Registration_.26_User_Synchronization|directory synchronization]]}}

=== Step 3: Creating a Journal Rule ===
The following steps describe how to set up journaling for your Microsoft 365 account.

Since you are planning to use an external mailbox (MailStore Gateway) as the recipient for Journal reports, we highly recommend to first create an external contact with this mail address in your Exchange mailbox administration to prevent any later errors or warnings about an unknown recipient in the process.

* Sign in to the [https://admin.microsoft.com/ Microsoft 365 admin center] as an Exchange or Global Administrator for your Microsoft 365 tenant.
* Expand the left navigation menu by clicking ''Show all''.
* In the ''Admin centers'' section, either use this [https://compliance.microsoft.com/exchangeinformationgovernance?viewid=exoJournalRule direct link] or follow these steps:
** In the left navigation menu, click ''Compliance''. The Microsoft Purview compliance portal is opened.
** In the left navigation menu, select ''Data Lifecycle Management'', then select ''Exchange (legacy)''.
* Open the ''Settings'' on the top right.
* Enter a mailbox in the ''Send undeliverable journal reports to'' section. This mailbox should be a dedicated mailbox for this purpose. This mailbox receives None Delivery Reports (NDRs) for undeliverable journal reports in case the primary journal mailbox is unreachable.
* Return to the ''Exchange (legacy)'' settings.
* Open the page ''Journal rules''.
* Create a new journaling rule by clicking on ''+ (New rule)''.
*:[[File:Arch_office365_journal_01.png|center|550px]]
* Enter the email address of the previously created MailStore Gateway mailbox in the ''Send journal reports to:'' box.
* Enter a name for the journal rule, e.g. ''Journaling''.
* In the ''Journal messages sent or received from'' section, select whether the rule should apply to everyone or to specific users or groups.
* Under ''Type of message to journal'', choose whether to capture all messages, internal messages only, or external messages only.
* Click on ''Next'', then validate your settings, click ''Submit'' to activate the rule.

== Public Folders ==
{{Archiving Exchange Public Folders Preamble|Exchange Online|Microsoft 365}}
* Sign in to the [https://admin.microsoft.com/ Microsoft 365 admin center] as an Exchange or Global Administrator for your Microsoft 365 tenant.
* Expand the left navigation menu by clicking ''Show all''.
* In the ''Admin centers'' section, choose ''Exchange''.
* In the ''Exchange admin center'', navigate to ''public folders''.
* Click on the ''Ellipsis (…)'' and select ''Root permissions''.
*: [[File:Microsoft_365_pf_01.png|center|480px]]
* A new browser window opens. Click on ''+ (Add)''.
* Use ''Browse'' to choose the Microsoft 365 user you want to grant permissions.
* Choose ''Custom'' as ''Permission level'' and grant ''Read items'' and ''Delete all'' permissions.
*: [[File:Arch_office365_pf_02.png|center|347px]]
* Click on ''Save''.
* Enable the option ''Apply changes to this public folder and all its subfolders.''
* Click on ''Save''.
* Click on ''Close'' after saving has been completed successfully.

=== Step 3: Setting up the Archiving Process ===
* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 pf 03.png|center|347px]]
* Select ''Public Folders'' and click on ''OK''. 
*; [[File:Microsoft 365 pf 04.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* In the ''Mailbox'' field, enter the primary email address of the user that has access to the public folders as described above.
* The value of the ''Target Folder'' box defines the top level folder below which the public folder hierarchy will be created in the target archive. Usually, you can leave this value to its default.
* Click on ''Test'' to verify that MailStore can access the public folders.
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 pf 05.png|center|347px]]
* Adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]]. By default, all public folders that contain emails will be archived.
* If needed, adjust [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|the filter]] and the [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]]. By default, no emails will be deleted from the public folders. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections).
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 pf 06.png|center|347px]]
* In the next step, select the archive of the user you have prepared in step 1.
* In the last step, specify a name for the archiving profile. After clicking ''Finish'' the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically if desired.

[[de:E-Mail-Archivierung_von_Microsoft_365_(Modern_Authentication)]]
[[en:Archiving_Emails_from_Microsoft_365_(Modern_Authentication)]]

Administration API - Function Reference

2023-03-01T11:44:15Z

Rrommelrath: /* SetRetentionPolicies */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>type</tt>
| string
| Type of archive store.
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Advanced file system-based archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CompactMasterDatabase ==
Compact master database.

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateBackup ==
Create a backup of the entire archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>path</tt>
| string
| Path to directory into which the backup should be written.
|-
| <tt>excludeSearchIndexes</tt>
| bool (optional)
| Indicates whether the search index files should be excluded from the backup.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The id of the time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

=== Argument Values ===

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>type</tt>
| string (optional)
| Type of archive store.
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Standard archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateUser ==
Create new MailStore user. Use [[Administration_API_-_Function_Reference#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] to grant that user privileges on the user's own archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Administration_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| string
| The unique identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| string
| Unique ID of message. Format: <store_id>:<message_num>
|-
| <tt>reason</tt>
| string
| The reason why that message has to be deleted which will be written into the audit log.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.
Neither the user's archive nor the user's archive emails are deleted when deleting a user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== DetachStore ==
Detach an archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== GetActiveSessions ==
Get list of current user sessions.

== GetChildFolders ==
Get child folders.
Depending on compliance settings this method may return only the first folder hierarchy level.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Parent folder whose child folders should be returned. If omitted, all archives and folder will be returned.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

== GetFolderStatistics ==
Get folder statistics.

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

== GetJobs ==
Retrieve list of jobs.

== GetLicenseInformation ==
Retrieve license information.

Example license information object:

{
"productKey": "YOUR-MAIL-STORE-PRODUCT-KEY",
"productVersion": "13.1.0.12345",
"maxNamedUsers": 100,
"namedUsers": 95,
"unusedNamedUsers": 5,
"supportExpiryDate": "2023-12-31",
"supportLevel": "Premium Service",
"validFrom": null,
"validTo": null,
"licensedTo": "MailStore Software GmbH",
"machineName": "MAILSTORE"
}

The properties ''validFrom'' and ''validTo'' are only set when Trial or NFR product keys are used.

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetRetentionPolicies ==
Get the retention policies.

Example retention policies object:

[
{
"name": "Keep All Mails for 10 Years",
"order": 1,
"enabled": true,
"searchCriteria": {
"from": null,
"to": null,
"query": null,
"queryAttachmentContents": false,
"queryAttachments": false,
"queryMessageBody": false,
"querySubject": false,
"includedArchives": null,
"excludedArchives": [
"admin"
]
},
"period": 10,
"periodInterval": "year",
"delete": false
}
]

== GetServerInfo ==
Get MailStore Server version and machine name.

== GetServiceConfiguration ==
Get MailStore Server service configuration. This includes the path to the Master Database, the location of the audit log, whether the different debug logs are enabled and the endpoint configuration.

== GetSmtpSettings ==
Get current SMTP configuration.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

== GetStoreIndexes ==
Get list of full text indexes.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| Unique ID of archive store.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>includeSize</tt>
| bool (optional)
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
|}

== GetTimeZones ==
Get a list of available time zones.

The ''id'' of the output can be used as ''timeZoneId'' in [[Administration_API_-_Function_Reference#CreateJob|CreateJob]], [[Administration_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Administration_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Administration_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Administration_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== MaintainFileSystemDatabases ==
Run database maintenance on all databases of file system based archive stores.

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== ProcessRetentionPolicies ==
Processes the configured retention policies.

== RebuildSelectedStoreIndexes ==
Rebuild all full-text indexes selected for rebuild.

== RebuildStoreIndex ==
Rebuild search index for given archive folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>folder</tt>
| string
| Name of folder name.
|}

== RecoverStore ==
Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>encryptionKey</tt>
| string (optional)
| Encryption key of the archive store. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

When the ''recoverDeletedMessages'' parameter is set to ''true'', only deleted messages that still have leftovers in the recovery records can be recovered. When an archive store has been compacted with [[#CompactStore|CompactStore]] or recovery record files have grown to their auto-compacting size of 32 MiB these leftovers could already be removed and deleted messages cannot be recovered.

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records. Cannot be used for external archive stores that store their content in the database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RefreshAllStoreStatistics ==
Refresh statistics of all archive stores.

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RenewMasterKey ==
Renews the master key which is used to encrypt the encryption keys.

== RepairStoreDatabase ==
Tries to resolve certain issues with archive store databases (e.g. missing database indexes).

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RetryOpenStores ==
Retry opening stores that failed previously.

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the MailStore Client. Client side profiles can be started by using the [[MailStore_Server_Management_Shell|MailStoreCmd]] and the commands ''import-execute'' and ''export-execute''.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the MailStore Client.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.

== SelectAllStoreIndexesForRebuild ==
Select all full-text indexes for rebuild.

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use [[Administration_API_-_Function_Reference#GetComplianceConfiguration|GetComplianceConfiguration]] to receive supported values.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"passwordPolicyEnabled": true,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

== SetProfileServerSideExecution ==
Disables or enables the automatic server-sided execution with its parameters.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique profile ID of the profile to be modified.
|-
| <tt>automatic</tt>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

Use the API command [[Administration_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument ''automatic=false'' and no additional parameters to disable the automation, or with ''automatic=true'' and at least the ''automaticPauseBetweenExecutions'' value given. The ''automaticMaintenanceWindows'' parameter is optional. Setting an already automated profile to automatic again, will restart the profile.

== SetRetentionPolicies ==
Set retention policies.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Retention policy configuration.
|}

To get example policies use the client to create retention policies manually. Then use the API command [[Administration_API_-_Function_Reference#GetRetentionPolicies|GetRetentionPolicies]] to retrieve the json values. 
Please be aware that the API is case-sensitive. Especially the archive inclusion/exclusion criteria must not contain upper case characters, as the user archives are always handled lower-case internally.
Due to a more complex distributed permission concept, retention policies can not be edited via the API for the MailStore Service Provider Edition.

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddresses": ["administrator@example.com", "user@example.com"]
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"sizeThreshold" : int or null,
"databaseBaseDirectory" : string,
"contentBaseDirectory" : string,
"indexBaseDirectory" : string
}
</source>

== SetStoreProperties ==
Set properties of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Set properties of archive store.
|-
| <tt>type</tt>
| string (optional)
|
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Advanced file system-based archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Administration_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

== UnlockStore ==
Unlock a foreign archive store. In case an archive store from a foreign MailStore installation is attached, this method can be used to unlock that archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store to unlock.
|-
| <tt>passphrase</tt>
| string
| Product key or recovery key of the foreign MailStore installation.
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the archive store to be verified.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

[[de:Administration API - Function Reference]]
[[en:Administration API - Function Reference]]

Administration API - Function Reference

2023-03-01T11:29:05Z

Rrommelrath: /* GetRetentionPolicies */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>type</tt>
| string
| Type of archive store.
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Advanced file system-based archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CompactMasterDatabase ==
Compact master database.

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateBackup ==
Create a backup of the entire archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>path</tt>
| string
| Path to directory into which the backup should be written.
|-
| <tt>excludeSearchIndexes</tt>
| bool (optional)
| Indicates whether the search index files should be excluded from the backup.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The id of the time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

=== Argument Values ===

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>type</tt>
| string (optional)
| Type of archive store.
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Standard archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateUser ==
Create new MailStore user. Use [[Administration_API_-_Function_Reference#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] to grant that user privileges on the user's own archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Administration_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| string
| The unique identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| string
| Unique ID of message. Format: <store_id>:<message_num>
|-
| <tt>reason</tt>
| string
| The reason why that message has to be deleted which will be written into the audit log.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.
Neither the user's archive nor the user's archive emails are deleted when deleting a user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== DetachStore ==
Detach an archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== GetActiveSessions ==
Get list of current user sessions.

== GetChildFolders ==
Get child folders.
Depending on compliance settings this method may return only the first folder hierarchy level.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Parent folder whose child folders should be returned. If omitted, all archives and folder will be returned.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

== GetFolderStatistics ==
Get folder statistics.

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

== GetJobs ==
Retrieve list of jobs.

== GetLicenseInformation ==
Retrieve license information.

Example license information object:

{
"productKey": "YOUR-MAIL-STORE-PRODUCT-KEY",
"productVersion": "13.1.0.12345",
"maxNamedUsers": 100,
"namedUsers": 95,
"unusedNamedUsers": 5,
"supportExpiryDate": "2023-12-31",
"supportLevel": "Premium Service",
"validFrom": null,
"validTo": null,
"licensedTo": "MailStore Software GmbH",
"machineName": "MAILSTORE"
}

The properties ''validFrom'' and ''validTo'' are only set when Trial or NFR product keys are used.

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetRetentionPolicies ==
Get the retention policies.

Example retention policies object:

[
{
"name": "Keep All Mails for 10 Years",
"order": 1,
"enabled": true,
"searchCriteria": {
"from": null,
"to": null,
"query": null,
"queryAttachmentContents": false,
"queryAttachments": false,
"queryMessageBody": false,
"querySubject": false,
"includedArchives": null,
"excludedArchives": [
"admin"
]
},
"period": 10,
"periodInterval": "year",
"delete": false
}
]

== GetServerInfo ==
Get MailStore Server version and machine name.

== GetServiceConfiguration ==
Get MailStore Server service configuration. This includes the path to the Master Database, the location of the audit log, whether the different debug logs are enabled and the endpoint configuration.

== GetSmtpSettings ==
Get current SMTP configuration.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

== GetStoreIndexes ==
Get list of full text indexes.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| Unique ID of archive store.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>includeSize</tt>
| bool (optional)
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
|}

== GetTimeZones ==
Get a list of available time zones.

The ''id'' of the output can be used as ''timeZoneId'' in [[Administration_API_-_Function_Reference#CreateJob|CreateJob]], [[Administration_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Administration_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Administration_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Administration_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== MaintainFileSystemDatabases ==
Run database maintenance on all databases of file system based archive stores.

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== ProcessRetentionPolicies ==
Processes the configured retention policies.

== RebuildSelectedStoreIndexes ==
Rebuild all full-text indexes selected for rebuild.

== RebuildStoreIndex ==
Rebuild search index for given archive folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>folder</tt>
| string
| Name of folder name.
|}

== RecoverStore ==
Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>encryptionKey</tt>
| string (optional)
| Encryption key of the archive store. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

When the ''recoverDeletedMessages'' parameter is set to ''true'', only deleted messages that still have leftovers in the recovery records can be recovered. When an archive store has been compacted with [[#CompactStore|CompactStore]] or recovery record files have grown to their auto-compacting size of 32 MiB these leftovers could already be removed and deleted messages cannot be recovered.

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records. Cannot be used for external archive stores that store their content in the database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RefreshAllStoreStatistics ==
Refresh statistics of all archive stores.

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RenewMasterKey ==
Renews the master key which is used to encrypt the encryption keys.

== RepairStoreDatabase ==
Tries to resolve certain issues with archive store databases (e.g. missing database indexes).

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RetryOpenStores ==
Retry opening stores that failed previously.

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the MailStore Client. Client side profiles can be started by using the [[MailStore_Server_Management_Shell|MailStoreCmd]] and the commands ''import-execute'' and ''export-execute''.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the MailStore Client.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.

== SelectAllStoreIndexesForRebuild ==
Select all full-text indexes for rebuild.

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use [[Administration_API_-_Function_Reference#GetComplianceConfiguration|GetComplianceConfiguration]] to receive supported values.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"passwordPolicyEnabled": true,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

== SetProfileServerSideExecution ==
Disables or enables the automatic server-sided execution with its parameters.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique profile ID of the profile to be modified.
|-
| <tt>automatic</tt>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

Use the API command [[Administration_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument ''automatic=false'' and no additional parameters to disable the automation, or with ''automatic=true'' and at least the ''automaticPauseBetweenExecutions'' value given. The ''automaticMaintenanceWindows'' parameter is optional. Setting an already automated profile to automatic again, will restart the profile.

== SetRetentionPolicies ==
Set retention policies.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Retention policy configuration.
|}

To get example policies use the client to create retention policies manually. Then use the API command [[Administration_API_-_Function_Reference#GetRetentionPolicies|GetRetentionPolicies]] to retrieve the json values.

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddresses": ["administrator@example.com", "user@example.com"]
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"sizeThreshold" : int or null,
"databaseBaseDirectory" : string,
"contentBaseDirectory" : string,
"indexBaseDirectory" : string
}
</source>

== SetStoreProperties ==
Set properties of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Set properties of archive store.
|-
| <tt>type</tt>
| string (optional)
|
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Advanced file system-based archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Administration_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

== UnlockStore ==
Unlock a foreign archive store. In case an archive store from a foreign MailStore installation is attached, this method can be used to unlock that archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store to unlock.
|-
| <tt>passphrase</tt>
| string
| Product key or recovery key of the foreign MailStore installation.
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the archive store to be verified.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

[[de:Administration API - Function Reference]]
[[en:Administration API - Function Reference]]

File:Retention Policies Bsp 05a.png

2023-03-01T08:33:19Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies Bsp 05a.png

File:Retention Policies Bsp 03a.png

2023-03-01T08:32:51Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies Bsp 03a.png

File:Retention Policies Bsp 02a.png

2023-03-01T08:32:27Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies Bsp 02a.png

File:Retention Policies Bsp 01a.png

2023-03-01T08:31:50Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies Bsp 01a.png

File:Retention Policies 06.png

2023-03-01T08:30:41Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies 06.png

File:Retention Policies 03.png

2023-03-01T08:30:01Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies 03.png

File:Retention Policies 02.png

2023-03-01T08:29:17Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies 02.png

File:Retention Policies 01.png

2023-03-01T08:27:37Z

Rrommelrath: Rrommelrath uploaded a new version of File:Retention Policies 01.png

System Requirements

2023-02-13T09:59:03Z

Rrommelrath:

== Hardware ==
The calculator below helps to specify the hardware needs subject to the number of users, stored email, and the [[Choosing_the_Right_Archiving_Strategy|archiving strategy]].

Calculations are based on the following base values:

* Yearly Email Volume per User: 10000
* Email Size: 75Kb
* Compression Ratio: 60%

<system_requirements product="server"/>

'''Please note: '''For a planned MailStore Server installation with more than 500 users, please contact our [https://www.mailstore.com/en/support/ Technical Support] to determine the optimal hardware setup.

== Software ==

=== Operating System ===
MailStore Server, [[Accessing_the_Archive_with_the_MailStore_Client_software|MailStore Client]] and [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration|MailStore Outlook Add-in]] require the following operating systems for installation and execution. Both 32-bit and 64-bit versions are supported.

* Microsoft Windows 11
* Microsoft Windows 10
* Microsoft Windows Server 2022 (Standard, Datacenter)
* Microsoft Windows Server 2019 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2016 (Essentials, Standard, Datacenter)
* Microsoft Windows Server 2012 R2 (Foundation, Essentials, Standard, Datacenter)
* Microsoft Windows Server 2012 (Foundation, Essentials, Standard, Datacenter)

'''Please note: '''For a MailStore Server installation with more than 25 users, a Microsoft Windows Server operating system is required for the [[MailStore_Server_Service_Configuration|MailStore Server Service]] because of restrictions of concurrent connections of Microsoft Windows client operating systems.

=== Other Software ===
The following other software is required:

* Microsoft .NET Framework Version 4.8
* ''Optional:'' [[Search_Indexes#Install_Missing_IFilters|IFilter drivers]] on the MailStore Server computer for filetypes to be indexed

=== Outlook Versions ===
MailStore Outlook Add-in is compatible with the following versions of Microsoft Outlook for Windows. Both, 32-bit and 64-bit versions are supported.

* Microsoft Outlook 2021 (Click-to-Run only, Windows Store version is '''not''' supported)
* Microsoft Outlook 2019 (Click-to-Run only, Windows Store version is '''not''' supported)
* Microsoft Outlook 2016 as component for Office 365 (Click-to-Run)
* Microsoft Outlook 2016
* Microsoft Outlook 2013 as component for Office 365 (Click-to-Run)
* Microsoft Outlook 2013
* Microsoft Outlook 2010 (Click-to-Run is '''not''' supported)
* Microsoft Outlook 2007
* Microsoft Outlook 2003

{{Multiline_Notices|Heading=Important Notice|{{3rd_Party_Product_EOL_Notice|Outlook 2003, 2007 and 2010|Microsoft|are}}}}

=== Web Browsers ===
The following web browsers are officially supported by MailStore Web Access. Other browsers based on the same rendering engine as the once below (e.g. Opera) ''may'' work as well.

{| class="wikitable" |
! Operating System / Browser
! Edge
! IE 11
! Firefox (Latest)
! Chrome (Latest)
! Safari (Latest)
|-
! Windows 10
| style="text-align: center; | Supported
| style="text-align: center; | Supported
| style="text-align: center; | Supported
| style="text-align: center; | Supported
|
|-
! Windows 8.1
|
| style="text-align: center; | Supported
| style="text-align: center; | Supported
| style="text-align: center; | Supported
|
|-
! Windows 7 (SP1)
|
| style="text-align: center; | Supported
| style="text-align: center; | Supported
| style="text-align: center; | Supported
|
|-
! macOS
|
|
| style="text-align: center; | Supported
| style="text-align: center; | Supported
| style="text-align: center; | Supported
|-
! Linux
|
|
| style="text-align: center; | Supported
| style="text-align: center; | Supported
|
|}

== Frequently Asked Questions ==
=== Email Volume ===
'''Q:''' How do large email volumes affect the performance and what is recommended maximum?

'''A:''' The more emails are archived on a daily basis the more resources are required and more time is needed to execute certain tasks such as searching the archive. Environment with much higher volumes than 10000 emails per user per year, may experience degraded performance over time.

=== Dedicated machine ===
'''Q:''' Can I install MailStore Server on the same computer where Microsoft Exchange or any other email server is installed or do I have to install it on a dedicated machine?

'''A:''' Primarily this depends on the size of your setup, the archiving strategy and the kind of usage. Whenever possible, the MailStore Server service should be installed on a dedicated machine.

=== Database server ===
'''Q:''' Most email archiving products on the market seem to require Microsoft SQL Server or a similar product installed. Does MailStore Server also require an external database server?

'''A:''' MailStore Server comes with an [[Storage_Locations|integrated storage]] and does not depend on any other external database server.

=== Web server ===
'''Q:''' Do I need an additional web server like Microsoft IIS or Apache to offer MailStore Web Access to my clients?

'''A:''' No. MailStore Server runs its own HTTP server on the corresponding TCP ports. Therefore you do not need an additional web server to use MailStore Web Access.

=== Anti-Virus Software ===
'''F:''' What needs to be considered while using anti-virus software with MailStore?

'''A:''' When using file based virus scanners, it is recommended to exclude all archive directories (master database and archive stores) from scanning. For more information, please refer to the [[Notes_on_Antivirus_Software|notes on anti-virus software]].

=== Virtualization ===
'''Q:''' Is it possible to run MailStore Server on virtual machines like VMware guests or similar?

'''A:''' Yes it is possible, as long as the underlying operating system supports it, there is no problem running MailStore Server inside a virtualized environment.

=== Terminal Server environments ===
'''Q:''' Is it possible to run MailStore in a terminal server environment?

'''A:''' Yes, running MailStore Client and MailStore Outlook Add-in is absolutely possible. Running MailStore Server service on a terminal server is not recommended.

=== Network Attached Storage ===
'''Q:''' Do I have to store the archive on the local hard disk, or can I also store it (or parts of it) on network attached storage, e.g. a network share?

'''A:''' In general, using local storage is preferable to using network storage. To use MailStore Server with storage on a NAS, different options are available which are described in the article [[Using Network Attached Storage (NAS)]].

[[de:Systemanforderungen]]
[[en:System Requirements]]

Changing Archiving from Microsoft Exchange Server to Microsoft 365

2022-11-17T10:31:46Z

Rrommelrath: additional SPE hints to prevent providers from using Server-specific articles

{{#ev:youtube|https://youtu.be/fWm-GaUstZk|350|right|''Tech Tip: Changing Archiving from Microsoft Exchange Server to Microsoft 365''}}
This article shows the changes required in MailStore Server when switching the email environment from a local Microsoft Exchange installation to Microsoft 365.

Our Tech Tip video provides an overview. Please note that the actual steps might deviate from those shown in the video based on the current configuration.
 

== Notes and Considerations ==
As with any changes in a production environment, changing archiving in MailStore Server should be planned carefully in advance. Therefore, before implementing any changes, please take the following notes into consideration:
* It is strongly recommended to implement the modifications described in this article in a test environment first because the changes to your Exchange and MailStore Server installations may not be reverted without huge effort if at all.
* Please make sure that you have a current [[Backup_and_Restore|backup]] of your Exchange and MailStore Server installations before applying any modifications to your production environment. For the Service Provider Edition, refer to this [https://help.mailstore.com/en/spe/Backup_and_Restore Backup] article.
* It is recommended to update MailStore Server to the latest version before applying any modifications. Please make sure that your [https://www.mailstore.com/en/products/mailstore-server/faq/ Update and Support Service contract] is valid (not relevant for Service Provider Edition) and take heed of the [[Update_Notices_for_MailStore_Server|update notices]] (MailStore Server) / [https://help.mailstore.com/en/spe/Update_Notices update notices] (Service Provider Edition).
* It is assumed that MailStore Server currently runs in an Active Directory / Exchange Server environment according to the [[Archiving_Emails_from_Microsoft_Exchange|MailStore Implementation Guides for Microsoft Exchange Servers]] and shall run according to the [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|MailStore Implementation Guide for Microsoft 365 (Modern Authentication)]] hereafter.
* The modifications to the configuration of MailStore Server should be applied in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] to avoid interference by background tasks or user interaction. For the Service Provider Edition, refer to [https://help.mailstore.com/en/spe/Management_Console_-_General Management Console], section "Safe Mode".
* Microsoft 365 does not support journal mailboxes hosted within Microsoft 365 itself. If you archive all incoming and outgoing emails with MailStore Server, you need a journal mailboxes that is hosted outside Microsoft 365. MailStore offers [https://help.mailstore.com/en/gateway/Main_Page MailStore Gateway] as a free solution that can provide journal mailboxes in your company intranet.

== Changing User Synchronization ==
As a first step, you must change the directory services that MailStore Server synchronizes its users with from ''Active Directory'' to ''Microsoft 365 (Modern Authentication)''. This is necessary because Microsoft 365 uses Azure Active Directory instead of a local Active Directory as directory service.

Initially, please run a [[Active_Directory_Integration#Running_Directory_Services_Synchronization|directory services synchronization]] in MailStore Server with the current configuration to make sure that all user data is complete and up-to-date.

== User Name Format ==
The steps required for changing the directory service depend on the [[Active_Directory_Integration#User_Database_Synchronization|user name format]] that is currently being used in MailStore Server for user synchronization with the local Active Directory.
* If you are currently using the ''SAM Account Name'' or the ''User Principal Name (Local Part)'', i.e. a "flat" user name without domain part (e.g.<code>john.doe</code>) as user name in MailStore Server, users and archive folders must be renamed in MailStore Server. In this case, please follow the steps in the next section.
* If you are already using the the full ''User Principal Name'' (''UPN'', e.g.<code>john.doe@example.com</code>) as user name in MailStore Server and
** exactly that UPN will be used to log on to Microsoft 365 in the future, you can leave the user names, archive folders and source folders in MailStore Server as is. Please continue directly with the section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
** you want to change the naming scheme of the UPN (e.g. from <code>john.doe@example.com</code> to <code>jdoe@example.com</code> or from <code>jane.doe@example.com</code> to <code>jane.doe@example.org</code>) for logging on to Microsoft 365, user names, archive folders and source folders in MailStore Server need to be renamed. In this case, please follow the steps in the next section.

=== MailStore Migration Scripts ===
The modifications in the following sections rely on Windows PowerShell scripts which require Windows PowerShell 3.0 or higher.
* You can download the scripts for MailStore Server [[Media:MailStoreServerMigrationScripts.zip|here]]; they can be found in the folder <code>migration</code> after extraction. For the MailStore Service Provider Edition, please use [[Media:MailStoreServiceProviderEditionMigrationScripts.zip|these]] scripts instead.
* To use the scripts with MailStore Server, access to the [[Administration_API_-_Using_the_API|MailStore Administration API]] in the [[MailStore_Server_Service_Configuration#Services|MailStore Server Service Configuration]] must be enabled.
* In case of the MailStore Service Provider Edition, [https://help.mailstore.com/en/spe/Accessing_Instances provider access] to the respective instance must be enabled as well.

=== Renaming Users and Archives in MailStore Server ===
MailStore Server distinguishes users by user name only. For example, <code>john.doe</code> and <code>john.doe@example.com</code> are two different users from a MailStore Server perspective, requiring two user licenses. Furthermore, a user's archive is also associated by user name alone, so that, for a user named <code>john.doe</code>, MailStore always creates an archive ''(Archive) john.doe''. However, once such an archive contains archived emails, it will retain its name even if the associated user name changes.

For these reasons, user names and archive folders in MailStore Server must be equal to the user names of the directory service that MailStore Server synchronizes its users with. Because Azure Active Directory uses the full ''User Principal Name'' (''UPN'', usually the primary email address) as user name, you must rename users and archive folders if you are currently using a different user name format or want to change the ''UPN''.

For renaming users and archive folder, please proceed as follows (for the MailStore Service Provider Edition, the files have the prefix ''SPE_'', but act the same way):
* Edit the scripts <code>MSS_1_prepare_users.ps1</code> and <code>MSS_2_update_users.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.
* Run the script <code>MSS_1_prepare_users.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-users.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the current MailStore Server user names.
* Edit this file in a text editor. Change the new user names after the "=", so that the entries look like this:
*; <pre>AD user name=Microsoft 365 user name</pre> 
*; Example (with changes highlighted)
*; <code>jane.doe=jane.doe</code><code style="color: blue">@example.com</code> 
*; Please use only lower case for letters in user names. For user names that should not change (e.g. the default ''admin'' user), just leave the corresponding entries as is.
* Save the file <code>mailstore-users.txt</code> that now should contain the current and the future user names.
* Run the script <code>MSS_2_update_users.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the users and their archive folder in MailStore Server and also updates the archive folder permissions accordingly.
* Log on as MailStore Server administrator with the MailStore Client and check the new user names and archive folders.
* If the local part of the users' email addresses (the part before the "@") has not changed, you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]]. Otherwise the source folders may need to be renamed as described in the next section.

=== Renaming Source Folders in MailStore Server ===
The folder level below the archive folders reflects the source from which MailStore Server has archived the emails. In case of Exchange archiving, the folder name consists of the prefix ''Exchange'' and the local part of the email address (the part before the "@"), so that for the email address <code>john.doe@example.com</code> the source folder name in MailStore Server would be ''Exchange john.doe@example.com''.

Source folder names only need to be renamed if '''all''' of the following conditions and requirements are met. Otherwise you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
* The local part of the email address shall be changed in course of migrating to Microsoft 365 (e.g. from <code>john.doe@example.com</code> to <code>j.doe@example.com</code>) '''and'''
* both the emails that have been archived so far from the local Exchange Server and those that will be archived from Microsoft 365 henceforth should appear in the same folder structure on source level (e.g. so far in ''Exchange john.doe'' and in ''Exchange j.doe'' after).

For renaming the source folders, please proceed as follows:
* Enable access to user archives by administrators in MailStore Server; it is disabled by default. Changing this option is described in chapter [[Compliance_General#Archive_Access|Compliance General]] of the MailStore Server manual.
* Edit the scripts <code>MSS_3_prepare_folders.ps1</code> and <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.

* Run the script <code>MSS_3_prepare_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-folders.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the full paths of the current source folders that consist of user names and the source folder names, separated by "/".
* Edit this file in a text editor. Change the new source folders after the "=", so that the entries look like this:
*; <pre>Old source folder path=new source folder path</pre> 
*; Example (with changes highlighted)
*;<code>j.doe@example.com/</code><code style="color: red">Exchange jane.doe</code><code>=j.doe@example.com/</code><code style="color: blue">Exchange j.doe</code> 
*; For source folders that should not change, just leave the corresponding entries as is.
* Save the file <code>mailstore-folders.txt</code> that now should contain the current and the future source folders.
* Run the script <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the source folders in MailStore Server.
* Log on as MailStore Server administrator with the MailStore Client and check the new source folders.

=== Changing Directory Service Synchronization to Microsoft 365 ===
To enable users to log on to MailStore Server with their Microsoft 365 credentials instead of their Active Directory, you must switch the directory service synchronization to ''Microsoft 365 (Modern Authentication)''. Please follow the steps in chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.
Initially, just test the synchronization using the ''Test Settings'' button. Check the directory service synchronization results, migrated users should show as ''modified''. You can also check that user authentication against Microsoft 365 works as expected.

== Changing the Archiving Profiles ==
For archiving Microsoft 365 mailboxes, MailStore Server offers dedicated Microsoft 365 archiving profiles that support modern authentication. Existing Exchange archiving profiles cannot be used for archiving Microsoft 365 mailboxes because they only support basic authentication.

=== Deactivating Existing Profiles and Jobs ===
If you run MailStore Server in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] as recommended before, automatic execution of archiving profiles and by jobs is disabled (for the Service Provider Edition: [https://help.mailstore.com/en/spe/Management_Console_-_General Management Console], Safe Mode). To deactivate them permanently, please proceed as follows:
* Log on as MailStore Server administrator through the MailStore Client.
* Click on ''Archive E‑mail''
* Below the profiles list, enable the option ''Show Profiles of All Users''.
* Switch every Exchange archiving profile to ''Manual'' through the context menu.
* If you have configured Exchange export profiles, click on ''Export E‑mail'' in the menu tree and repeat the previous steps.
* If you have configured scheduled job for running Exchange profiles, click on ''Administrative Tools > Management API > Jobs'' and deactivate every job that run an Exchange profile through the context menu.

=== Creating new Microsoft 365 Profiles ===
Create new Microsoft 365 profiles and jobs according to the following articles. They should be set to manual initially to check their execution and results.
* For archiving Microsoft 365 mailboxes, follow the implementation guide [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|Archiving Emails from Microsoft 365 (Modern Authentication)]].
* Creating Microsoft 365 export profiles is described in chapter [[Exporting Email]] of the MailStore Server manual.
* Once the profiles have been set up you can update existing jobs as described in chapter [[Jobs#Properties|jobs]] of the MailStore Server manual.

== Finalizing the Migration ==
To finalize the migration in MailStore Server, please proceed as follows:
* Close all MailStore Client sessions and restart the MailStore Server service.
* Log on as MailStore Server administrator again through the MailStore Client.
* In the main menu tree, go to ''Administrative Tools > Users and Archives > Archives'' and check the names of the archive folders.
* Switch to ''Archive E‑mail'' and run each Microsoft 365 archiving profile manually. If you are satisfied with the results, you can delete the old Exchange archiving profiles.
* If applicable, repeat the previous step for export profiles and jobs.
* If you have previously enabled access to user archives by administrators in MailStore Server as described in chapter [[Compliance_General#Archive_Access|Compliance General]], revert that change.
* If you have enabled ''Single-Sign-On (SSO)'' by setting the server name of the MailStore Server computer and the authentication method to ''Windows Authentication'' through group policies [[MailStore_Client_Deployment#Configuring_Policy_Settings|for the MailStore Client]] or the [[MailStore_Outlook_Add-in_Deployment|for the MailStore Outlook Add-in]], you must change the group policy setting ''Authentication'' to ''Standard Authentication''.
* During login, the MailStore Web Access, MailStore Clients and Outlook Add-In call the default web browser to have the user log in through the Microsoft 365 login dialog; this communication is TLS-encrypted via HTTPS. Therefore, for a better user experience, it is recommended to configure an SSL certificate in MailStore Server that is trusted by the web browser. Further information can be found in the [[Using_Your_Own_SSL_Certificate|Using Your Own SSL Certificate]] article (for the Service provider Edition: [https://help.mailstore.com/en/spe/Replace_Self-signed_SSL_Certificates Replace Self-Signed SSL Certificates]).

After finishing these tasks successfully, the migration in MailStore Server is complete.
[[de:Umstellung_der_Archivierung_von_Microsoft_Exchange_Server_auf_Microsoft_365]]
[[en:Changing_Archiving_from_Microsoft_Exchange_Server_to_Microsoft_365]]

File:MailStoreServerMigrationScripts.zip

2022-11-17T09:29:03Z

Rrommelrath: Rrommelrath uploaded a new version of File:MailStoreServerMigrationScripts.zip

Changing Archiving from Microsoft Exchange Server to Microsoft 365

2022-11-15T09:58:44Z

Rrommelrath: /* MailStore Migration Scripts */

{{#ev:youtube|https://youtu.be/fWm-GaUstZk|350|right|''Tech Tip: Changing Archiving from Microsoft Exchange Server to Microsoft 365''}}
This article shows the changes required in MailStore Server when switching the email environment from a local Microsoft Exchange installation to Microsoft 365.

Our Tech Tip video provides an overview. Please note that the actual steps might deviate from those shown in the video based on the current configuration.
 

== Notes and Considerations ==
As with any changes in a production environment, changing archiving in MailStore Server should be planned carefully in advance. Therefore, before implementing any changes, please take the following notes into consideration:
* It is strongly recommended to implement the modifications described in this article in a test environment first because the changes to your Exchange and MailStore Server installations may not be reverted without huge effort if at all.
* Please make sure that you have a current [[Backup_and_Restore|backup]] of your Exchange and MailStore Server installations before applying any modifications to your production environment.
* It is recommended to update MailStore Server to the latest version before applying any modifications. Please make sure that your [https://www.mailstore.com/en/products/mailstore-server/faq/ Update and Support Service contract] is valid and take heed of the [[Update_Notices_for_MailStore_Server|update notices]].
* It is assumed that MailStore Server currently runs in an Active Directory / Exchange Server environment according to the [[Archiving_Emails_from_Microsoft_Exchange|MailStore Implementation Guides for Microsoft Exchange Servers]] and shall run according to the [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|MailStore Implementation Guide for Microsoft 365 (Modern Authentication)]] hereafter.
* The modifications to the configuration of MailStore Server should be applied in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] to avoid interference by background tasks or user interaction.
* Microsoft 365 does not support journal mailboxes hosted within Microsoft 365 itself. If you archive all incoming and outgoing emails with MailStore Server, you need a journal mailboxes that is hosted outside Microsoft 365. MailStore offers [https://help.mailstore.com/en/gateway/Main_Page MailStore Gateway] as a free solution that can provide journal mailboxes in your company intranet.

== Changing User Synchronization ==
As a first step, you must change the directory services that MailStore Server synchronizes its users with from ''Active Directory'' to ''Microsoft 365 (Modern Authentication)''. This is necessary because Microsoft 365 uses Azure Active Directory instead of a local Active Directory as directory service.

Initially, please run a [[Active_Directory_Integration#Running_Directory_Services_Synchronization|directory services synchronization]] in MailStore Server with the current configuration to make sure that all user data is complete and up-to-date.

== User Name Format ==
The steps required for changing the directory service depend on the [[Active_Directory_Integration#User_Database_Synchronization|user name format]] that is currently being used in MailStore Server for user synchronization with the local Active Directory.
* If you are currently using the ''SAM Account Name'' or the ''User Principal Name (Local Part)'', i.e. a "flat" user name without domain part (e.g.<code>john.doe</code>) as user name in MailStore Server, users and archive folders must be renamed in MailStore Server. In this case, please follow the steps in the next section.
* If you are already using the the full ''User Principal Name'' (''UPN'', e.g.<code>john.doe@example.com</code>) as user name in MailStore Server and
** exactly that UPN will be used to log on to Microsoft 365 in the future, you can leave the user names, archive folders and source folders in MailStore Server as is. Please continue directly with the section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
** you want to change the naming scheme of the UPN (e.g. from <code>john.doe@example.com</code> to <code>jdoe@example.com</code> or from <code>jane.doe@example.com</code> to <code>jane.doe@example.org</code>) for logging on to Microsoft 365, user names, archive folders and source folders in MailStore Server need to be renamed. In this case, please follow the steps in the next section.

=== MailStore Migration Scripts ===
The modifications in the following sections rely on Windows PowerShell scripts which require Windows PowerShell 3.0 or higher.
* You can download the scripts for MailStore Server [[Media:MailStoreServerMigrationScripts.zip|here]]; they can be found in the folder <code>migration</code> after extraction. For the MailStore Service Provider Edition, please use [[Media:MailStoreServiceProviderEditionMigrationScripts.zip|these]] scripts instead.
* To use the scripts, access to the [[Administration_API_-_Using_the_API|MailStore Administration API]] in the [[MailStore_Server_Service_Configuration#Services|MailStore Server Service Configuration]] must be enabled.
* In case of the MailStore Service Provider Edition, [https://help.mailstore.com/en/spe/Accessing_Instances provider access] to the respective instance must be enabled as well.

=== Renaming Users and Archives in MailStore Server ===
MailStore Server distinguishes users by user name only. For example, <code>john.doe</code> and <code>john.doe@example.com</code> are two different users from a MailStore Server perspective, requiring two user licenses. Furthermore, a user's archive is also associated by user name alone, so that, for a user named <code>john.doe</code>, MailStore always creates an archive ''(Archive) john.doe''. However, once such an archive contains archived emails, it will retain its name even if the associated user name changes.

For these reasons, user names and archive folders in MailStore Server must be equal to the user names of the directory service that MailStore Server synchronizes its users with. Because Azure Active Directory uses the full ''User Principal Name'' (''UPN'', usually the primary email address) as user name, you must rename users and archive folders if you are currently using a different user name format or want to change the ''UPN''.

For renaming users and archive folder, please proceed as follows (for the MailStore Service Provider Edition, the files have the prefix ''SPE_'', but act the same way):
* Edit the scripts <code>MSS_1_prepare_users.ps1</code> and <code>MSS_2_update_users.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.
* Run the script <code>MSS_1_prepare_users.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-users.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the current MailStore Server user names.
* Edit this file in a text editor. Change the new user names after the "=", so that the entries look like this:
*; <pre>AD user name=Microsoft 365 user name</pre> 
*; Example (with changes highlighted)
*; <code>jane.doe=jane.doe</code><code style="color: blue">@example.com</code> 
*; Please use only lower case for letters in user names. For user names that should not change (e.g. the default ''admin'' user), just leave the corresponding entries as is.
* Save the file <code>mailstore-users.txt</code> that now should contain the current and the future user names.
* Run the script <code>MSS_2_update_users.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the users and their archive folder in MailStore Server and also updates the archive folder permissions accordingly.
* Log on as MailStore Server administrator with the MailStore Client and check the new user names and archive folders.
* If the local part of the users' email addresses (the part before the "@") has not changed, you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]]. Otherwise the source folders may need to be renamed as described in the next section.

=== Renaming Source Folders in MailStore Server ===
The folder level below the archive folders reflects the source from which MailStore Server has archived the emails. In case of Exchange archiving, the folder name consists of the prefix ''Exchange'' and the local part of the email address (the part before the "@"), so that for the email address <code>john.doe@example.com</code> the source folder name in MailStore Server would be ''Exchange john.doe@example.com''.

Source folder names only need to be renamed if '''all''' of the following conditions and requirements are met. Otherwise you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
* The local part of the email address shall be changed in course of migrating to Microsoft 365 (e.g. from <code>john.doe@example.com</code> to <code>j.doe@example.com</code>) '''and'''
* both the emails that have been archived so far from the local Exchange Server and those that will be archived from Microsoft 365 henceforth should appear in the same folder structure on source level (e.g. so far in ''Exchange john.doe'' and in ''Exchange j.doe'' after).

For renaming the source folders, please proceed as follows:
* Enable access to user archives by administrators in MailStore Server; it is disabled by default. Changing this option is described in chapter [[Compliance_General#Archive_Access|Compliance General]] of the MailStore Server manual.
* Edit the scripts <code>MSS_3_prepare_folders.ps1</code> and <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.

* Run the script <code>MSS_3_prepare_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-folders.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the full paths of the current source folders that consist of user names and the source folder names, separated by "/".
* Edit this file in a text editor. Change the new source folders after the "=", so that the entries look like this:
*; <pre>Old source folder path=new source folder path</pre> 
*; Example (with changes highlighted)
*;<code>j.doe@example.com/</code><code style="color: red">Exchange jane.doe</code><code>=j.doe@example.com/</code><code style="color: blue">Exchange j.doe</code> 
*; For source folders that should not change, just leave the corresponding entries as is.
* Save the file <code>mailstore-folders.txt</code> that now should contain the current and the future source folders.
* Run the script <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the source folders in MailStore Server.
* Log on as MailStore Server administrator with the MailStore Client and check the new source folders.

=== Changing Directory Service Synchronization to Microsoft 365 ===
To enable users to log on to MailStore Server with their Microsoft 365 credentials instead of their Active Directory, you must switch the directory service synchronization to ''Microsoft 365 (Modern Authentication)''. Please follow the steps in chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.
Initially, just test the synchronization using the ''Test Settings'' button. Check the directory service synchronization results, migrated users should show as ''modified''. You can also check that user authentication against Microsoft 365 works as expected.

== Changing the Archiving Profiles ==
For archiving Microsoft 365 mailboxes, MailStore Server offers dedicated Microsoft 365 archiving profiles that support modern authentication. Existing Exchange archiving profiles cannot be used for archiving Microsoft 365 mailboxes because they only support basic authentication.

=== Deactivating Existing Profiles and Jobs ===
If you run MailStore Server in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] as recommended before, automatic execution of archiving profiles and by jobs is disabled. To deactivate them permanently, please proceed as follows:
* Log on as MailStore Server administrator through the MailStore Client.
* Click on ''Archive E‑mail''
* Below the profiles list, enable the option ''Show Profiles of All Users''.
* Switch every Exchange archiving profile to ''Manual'' through the context menu.
* If you have configured Exchange export profiles, click on ''Export E‑mail'' in the menu tree and repeat the previous steps.
* If you have configured scheduled job for running Exchange profiles, click on ''Administrative Tools > Management API > Jobs'' and deactivate every job that run an Exchange profile through the context menu.

=== Creating new Microsoft 365 Profiles ===
Create new Microsoft 365 profiles and jobs according to the following articles. They should be set to manual initially to check their execution and results.
* For archiving Microsoft 365 mailboxes, follow the implementation guide [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|Archiving Emails from Microsoft 365 (Modern Authentication)]].
* Creating Microsoft 365 export profiles is described in chapter [[Exporting Email]] of the MailStore Server manual.
* Once the profiles have been set up you can update existing jobs as described in chapter [[Jobs#Properties|jobs]] of the MailStore Server manual.

== Finalizing the Migration ==
To finalize the migration in MailStore Server, please proceed as follows:
* Close all MailStore Client sessions and restart the MailStore Server service.
* Log on as MailStore Server administrator again through the MailStore Client.
* In the main menu tree, go to ''Administrative Tools > Users and Archives > Archives'' and check the names of the archive folders.
* Switch to ''Archive E‑mail'' and run each Microsoft 365 archiving profile manually. If you are satisfied with the results, you can delete the old Exchange archiving profiles.
* If applicable, repeat the previous step for export profiles and jobs.
* If you have previously enabled access to user archives by administrators in MailStore Server as described in chapter [[Compliance_General#Archive_Access|Compliance General]], revert that change.
* If you have enabled ''Single-Sign-On (SSO)'' by setting the server name of the MailStore Server computer and the authentication method to ''Windows Authentication'' through group policies [[MailStore_Client_Deployment#Configuring_Policy_Settings|for the MailStore Client]] or the [[MailStore_Outlook_Add-in_Deployment|for the MailStore Outlook Add-in]], you must change the group policy setting ''Authentication'' to ''Standard Authentication''.
* During login, MailStore Server calls the default web browser to have the user log in through the Microsoft 365 login dialog; this communication is TLS-encrypted via HTTPS. Therefore, for a better user experience, it is recommended to configure a SSL certificate in MailStore Server that is trusted by the web browser. Further information can be found in the [[Using_Your_Own_SSL_Certificate|Using Your Own SSL Certificate]] article.

After finishing these tasks successfully, the migration in MailStore Server is complete.
[[de:Umstellung_der_Archivierung_von_Microsoft_Exchange_Server_auf_Microsoft_365]]
[[en:Changing_Archiving_from_Microsoft_Exchange_Server_to_Microsoft_365]]

Changing Archiving from Microsoft Exchange Server to Microsoft 365

2022-11-15T09:41:38Z

Rrommelrath: /* Renaming Users and Archives in MailStore Server */

{{#ev:youtube|https://youtu.be/fWm-GaUstZk|350|right|''Tech Tip: Changing Archiving from Microsoft Exchange Server to Microsoft 365''}}
This article shows the changes required in MailStore Server when switching the email environment from a local Microsoft Exchange installation to Microsoft 365.

Our Tech Tip video provides an overview. Please note that the actual steps might deviate from those shown in the video based on the current configuration.
 

== Notes and Considerations ==
As with any changes in a production environment, changing archiving in MailStore Server should be planned carefully in advance. Therefore, before implementing any changes, please take the following notes into consideration:
* It is strongly recommended to implement the modifications described in this article in a test environment first because the changes to your Exchange and MailStore Server installations may not be reverted without huge effort if at all.
* Please make sure that you have a current [[Backup_and_Restore|backup]] of your Exchange and MailStore Server installations before applying any modifications to your production environment.
* It is recommended to update MailStore Server to the latest version before applying any modifications. Please make sure that your [https://www.mailstore.com/en/products/mailstore-server/faq/ Update and Support Service contract] is valid and take heed of the [[Update_Notices_for_MailStore_Server|update notices]].
* It is assumed that MailStore Server currently runs in an Active Directory / Exchange Server environment according to the [[Archiving_Emails_from_Microsoft_Exchange|MailStore Implementation Guides for Microsoft Exchange Servers]] and shall run according to the [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|MailStore Implementation Guide for Microsoft 365 (Modern Authentication)]] hereafter.
* The modifications to the configuration of MailStore Server should be applied in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] to avoid interference by background tasks or user interaction.
* Microsoft 365 does not support journal mailboxes hosted within Microsoft 365 itself. If you archive all incoming and outgoing emails with MailStore Server, you need a journal mailboxes that is hosted outside Microsoft 365. MailStore offers [https://help.mailstore.com/en/gateway/Main_Page MailStore Gateway] as a free solution that can provide journal mailboxes in your company intranet.

== Changing User Synchronization ==
As a first step, you must change the directory services that MailStore Server synchronizes its users with from ''Active Directory'' to ''Microsoft 365 (Modern Authentication)''. This is necessary because Microsoft 365 uses Azure Active Directory instead of a local Active Directory as directory service.

Initially, please run a [[Active_Directory_Integration#Running_Directory_Services_Synchronization|directory services synchronization]] in MailStore Server with the current configuration to make sure that all user data is complete and up-to-date.

== User Name Format ==
The steps required for changing the directory service depend on the [[Active_Directory_Integration#User_Database_Synchronization|user name format]] that is currently being used in MailStore Server for user synchronization with the local Active Directory.
* If you are currently using the ''SAM Account Name'' or the ''User Principal Name (Local Part)'', i.e. a "flat" user name without domain part (e.g.<code>john.doe</code>) as user name in MailStore Server, users and archive folders must be renamed in MailStore Server. In this case, please follow the steps in the next section.
* If you are already using the the full ''User Principal Name'' (''UPN'', e.g.<code>john.doe@example.com</code>) as user name in MailStore Server and
** exactly that UPN will be used to log on to Microsoft 365 in the future, you can leave the user names, archive folders and source folders in MailStore Server as is. Please continue directly with the section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
** you want to change the naming scheme of the UPN (e.g. from <code>john.doe@example.com</code> to <code>jdoe@example.com</code> or from <code>jane.doe@example.com</code> to <code>jane.doe@example.org</code>) for logging on to Microsoft 365, user names, archive folders and source folders in MailStore Server need to be renamed. In this case, please follow the steps in the next section.

=== MailStore Migration Scripts ===
The modifications in the following sections rely on Windows PowerShell scripts which require Windows PowerShell 3.0 or higher.
* You can download the scripts for MailStore Server [[Media:MailStoreServerMigrationScripts.zip|here]]; they can be found in the folder <code>migration</code> after extraction. For the MailStore Service Provider Edition, please use [[Media:MailStoreServiceProviderEditionMigrationScripts.zip|these]] scripts instead.
* To use the scripts, access to the [[Administration_API_-_Using_the_API|MailStore Administration API]] in the [[MailStore_Server_Service_Configuration#Services|MailStore Server Service Configuration]] must be enabled.

=== Renaming Users and Archives in MailStore Server ===
MailStore Server distinguishes users by user name only. For example, <code>john.doe</code> and <code>john.doe@example.com</code> are two different users from a MailStore Server perspective, requiring two user licenses. Furthermore, a user's archive is also associated by user name alone, so that, for a user named <code>john.doe</code>, MailStore always creates an archive ''(Archive) john.doe''. However, once such an archive contains archived emails, it will retain its name even if the associated user name changes.

For these reasons, user names and archive folders in MailStore Server must be equal to the user names of the directory service that MailStore Server synchronizes its users with. Because Azure Active Directory uses the full ''User Principal Name'' (''UPN'', usually the primary email address) as user name, you must rename users and archive folders if you are currently using a different user name format or want to change the ''UPN''.

For renaming users and archive folder, please proceed as follows (for the MailStore Service Provider Edition, the files have the prefix ''SPE_'', but act the same way):
* Edit the scripts <code>MSS_1_prepare_users.ps1</code> and <code>MSS_2_update_users.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.
* Run the script <code>MSS_1_prepare_users.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-users.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the current MailStore Server user names.
* Edit this file in a text editor. Change the new user names after the "=", so that the entries look like this:
*; <pre>AD user name=Microsoft 365 user name</pre> 
*; Example (with changes highlighted)
*; <code>jane.doe=jane.doe</code><code style="color: blue">@example.com</code> 
*; Please use only lower case for letters in user names. For user names that should not change (e.g. the default ''admin'' user), just leave the corresponding entries as is.
* Save the file <code>mailstore-users.txt</code> that now should contain the current and the future user names.
* Run the script <code>MSS_2_update_users.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the users and their archive folder in MailStore Server and also updates the archive folder permissions accordingly.
* Log on as MailStore Server administrator with the MailStore Client and check the new user names and archive folders.
* If the local part of the users' email addresses (the part before the "@") has not changed, you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]]. Otherwise the source folders may need to be renamed as described in the next section.

=== Renaming Source Folders in MailStore Server ===
The folder level below the archive folders reflects the source from which MailStore Server has archived the emails. In case of Exchange archiving, the folder name consists of the prefix ''Exchange'' and the local part of the email address (the part before the "@"), so that for the email address <code>john.doe@example.com</code> the source folder name in MailStore Server would be ''Exchange john.doe@example.com''.

Source folder names only need to be renamed if '''all''' of the following conditions and requirements are met. Otherwise you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
* The local part of the email address shall be changed in course of migrating to Microsoft 365 (e.g. from <code>john.doe@example.com</code> to <code>j.doe@example.com</code>) '''and'''
* both the emails that have been archived so far from the local Exchange Server and those that will be archived from Microsoft 365 henceforth should appear in the same folder structure on source level (e.g. so far in ''Exchange john.doe'' and in ''Exchange j.doe'' after).

For renaming the source folders, please proceed as follows:
* Enable access to user archives by administrators in MailStore Server; it is disabled by default. Changing this option is described in chapter [[Compliance_General#Archive_Access|Compliance General]] of the MailStore Server manual.
* Edit the scripts <code>MSS_3_prepare_folders.ps1</code> and <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.

* Run the script <code>MSS_3_prepare_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-folders.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the full paths of the current source folders that consist of user names and the source folder names, separated by "/".
* Edit this file in a text editor. Change the new source folders after the "=", so that the entries look like this:
*; <pre>Old source folder path=new source folder path</pre> 
*; Example (with changes highlighted)
*;<code>j.doe@example.com/</code><code style="color: red">Exchange jane.doe</code><code>=j.doe@example.com/</code><code style="color: blue">Exchange j.doe</code> 
*; For source folders that should not change, just leave the corresponding entries as is.
* Save the file <code>mailstore-folders.txt</code> that now should contain the current and the future source folders.
* Run the script <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the source folders in MailStore Server.
* Log on as MailStore Server administrator with the MailStore Client and check the new source folders.

=== Changing Directory Service Synchronization to Microsoft 365 ===
To enable users to log on to MailStore Server with their Microsoft 365 credentials instead of their Active Directory, you must switch the directory service synchronization to ''Microsoft 365 (Modern Authentication)''. Please follow the steps in chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.
Initially, just test the synchronization using the ''Test Settings'' button. Check the directory service synchronization results, migrated users should show as ''modified''. You can also check that user authentication against Microsoft 365 works as expected.

== Changing the Archiving Profiles ==
For archiving Microsoft 365 mailboxes, MailStore Server offers dedicated Microsoft 365 archiving profiles that support modern authentication. Existing Exchange archiving profiles cannot be used for archiving Microsoft 365 mailboxes because they only support basic authentication.

=== Deactivating Existing Profiles and Jobs ===
If you run MailStore Server in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] as recommended before, automatic execution of archiving profiles and by jobs is disabled. To deactivate them permanently, please proceed as follows:
* Log on as MailStore Server administrator through the MailStore Client.
* Click on ''Archive E‑mail''
* Below the profiles list, enable the option ''Show Profiles of All Users''.
* Switch every Exchange archiving profile to ''Manual'' through the context menu.
* If you have configured Exchange export profiles, click on ''Export E‑mail'' in the menu tree and repeat the previous steps.
* If you have configured scheduled job for running Exchange profiles, click on ''Administrative Tools > Management API > Jobs'' and deactivate every job that run an Exchange profile through the context menu.

=== Creating new Microsoft 365 Profiles ===
Create new Microsoft 365 profiles and jobs according to the following articles. They should be set to manual initially to check their execution and results.
* For archiving Microsoft 365 mailboxes, follow the implementation guide [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|Archiving Emails from Microsoft 365 (Modern Authentication)]].
* Creating Microsoft 365 export profiles is described in chapter [[Exporting Email]] of the MailStore Server manual.
* Once the profiles have been set up you can update existing jobs as described in chapter [[Jobs#Properties|jobs]] of the MailStore Server manual.

== Finalizing the Migration ==
To finalize the migration in MailStore Server, please proceed as follows:
* Close all MailStore Client sessions and restart the MailStore Server service.
* Log on as MailStore Server administrator again through the MailStore Client.
* In the main menu tree, go to ''Administrative Tools > Users and Archives > Archives'' and check the names of the archive folders.
* Switch to ''Archive E‑mail'' and run each Microsoft 365 archiving profile manually. If you are satisfied with the results, you can delete the old Exchange archiving profiles.
* If applicable, repeat the previous step for export profiles and jobs.
* If you have previously enabled access to user archives by administrators in MailStore Server as described in chapter [[Compliance_General#Archive_Access|Compliance General]], revert that change.
* If you have enabled ''Single-Sign-On (SSO)'' by setting the server name of the MailStore Server computer and the authentication method to ''Windows Authentication'' through group policies [[MailStore_Client_Deployment#Configuring_Policy_Settings|for the MailStore Client]] or the [[MailStore_Outlook_Add-in_Deployment|for the MailStore Outlook Add-in]], you must change the group policy setting ''Authentication'' to ''Standard Authentication''.
* During login, MailStore Server calls the default web browser to have the user log in through the Microsoft 365 login dialog; this communication is TLS-encrypted via HTTPS. Therefore, for a better user experience, it is recommended to configure a SSL certificate in MailStore Server that is trusted by the web browser. Further information can be found in the [[Using_Your_Own_SSL_Certificate|Using Your Own SSL Certificate]] article.

After finishing these tasks successfully, the migration in MailStore Server is complete.
[[de:Umstellung_der_Archivierung_von_Microsoft_Exchange_Server_auf_Microsoft_365]]
[[en:Changing_Archiving_from_Microsoft_Exchange_Server_to_Microsoft_365]]

Changing Archiving from Microsoft Exchange Server to Microsoft 365

2022-11-15T09:39:35Z

Rrommelrath: /* MailStore Migration Scripts */

{{#ev:youtube|https://youtu.be/fWm-GaUstZk|350|right|''Tech Tip: Changing Archiving from Microsoft Exchange Server to Microsoft 365''}}
This article shows the changes required in MailStore Server when switching the email environment from a local Microsoft Exchange installation to Microsoft 365.

Our Tech Tip video provides an overview. Please note that the actual steps might deviate from those shown in the video based on the current configuration.
 

== Notes and Considerations ==
As with any changes in a production environment, changing archiving in MailStore Server should be planned carefully in advance. Therefore, before implementing any changes, please take the following notes into consideration:
* It is strongly recommended to implement the modifications described in this article in a test environment first because the changes to your Exchange and MailStore Server installations may not be reverted without huge effort if at all.
* Please make sure that you have a current [[Backup_and_Restore|backup]] of your Exchange and MailStore Server installations before applying any modifications to your production environment.
* It is recommended to update MailStore Server to the latest version before applying any modifications. Please make sure that your [https://www.mailstore.com/en/products/mailstore-server/faq/ Update and Support Service contract] is valid and take heed of the [[Update_Notices_for_MailStore_Server|update notices]].
* It is assumed that MailStore Server currently runs in an Active Directory / Exchange Server environment according to the [[Archiving_Emails_from_Microsoft_Exchange|MailStore Implementation Guides for Microsoft Exchange Servers]] and shall run according to the [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|MailStore Implementation Guide for Microsoft 365 (Modern Authentication)]] hereafter.
* The modifications to the configuration of MailStore Server should be applied in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] to avoid interference by background tasks or user interaction.
* Microsoft 365 does not support journal mailboxes hosted within Microsoft 365 itself. If you archive all incoming and outgoing emails with MailStore Server, you need a journal mailboxes that is hosted outside Microsoft 365. MailStore offers [https://help.mailstore.com/en/gateway/Main_Page MailStore Gateway] as a free solution that can provide journal mailboxes in your company intranet.

== Changing User Synchronization ==
As a first step, you must change the directory services that MailStore Server synchronizes its users with from ''Active Directory'' to ''Microsoft 365 (Modern Authentication)''. This is necessary because Microsoft 365 uses Azure Active Directory instead of a local Active Directory as directory service.

Initially, please run a [[Active_Directory_Integration#Running_Directory_Services_Synchronization|directory services synchronization]] in MailStore Server with the current configuration to make sure that all user data is complete and up-to-date.

== User Name Format ==
The steps required for changing the directory service depend on the [[Active_Directory_Integration#User_Database_Synchronization|user name format]] that is currently being used in MailStore Server for user synchronization with the local Active Directory.
* If you are currently using the ''SAM Account Name'' or the ''User Principal Name (Local Part)'', i.e. a "flat" user name without domain part (e.g.<code>john.doe</code>) as user name in MailStore Server, users and archive folders must be renamed in MailStore Server. In this case, please follow the steps in the next section.
* If you are already using the the full ''User Principal Name'' (''UPN'', e.g.<code>john.doe@example.com</code>) as user name in MailStore Server and
** exactly that UPN will be used to log on to Microsoft 365 in the future, you can leave the user names, archive folders and source folders in MailStore Server as is. Please continue directly with the section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
** you want to change the naming scheme of the UPN (e.g. from <code>john.doe@example.com</code> to <code>jdoe@example.com</code> or from <code>jane.doe@example.com</code> to <code>jane.doe@example.org</code>) for logging on to Microsoft 365, user names, archive folders and source folders in MailStore Server need to be renamed. In this case, please follow the steps in the next section.

=== MailStore Migration Scripts ===
The modifications in the following sections rely on Windows PowerShell scripts which require Windows PowerShell 3.0 or higher.
* You can download the scripts for MailStore Server [[Media:MailStoreServerMigrationScripts.zip|here]]; they can be found in the folder <code>migration</code> after extraction. For the MailStore Service Provider Edition, please use [[Media:MailStoreServiceProviderEditionMigrationScripts.zip|these]] scripts instead.
* To use the scripts, access to the [[Administration_API_-_Using_the_API|MailStore Administration API]] in the [[MailStore_Server_Service_Configuration#Services|MailStore Server Service Configuration]] must be enabled.

=== Renaming Users and Archives in MailStore Server ===
MailStore Server distinguishes users by user name only. For example, <code>john.doe</code> and <code>john.doe@example.com</code> are two different users from a MailStore Server perspective, requiring two user licenses. Furthermore, a user's archive is also associated by user name alone, so that, for a user named <code>john.doe</code>, MailStore always creates an archive ''(Archive) john.doe''. However, once such an archive contains archived emails, it will retain its name even if the associated user name changes.

For these reasons, user names and archive folders in MailStore Server must be equal to the user names of the directory service that MailStore Server synchronizes its users with. Because Azure Active Directory uses the full ''User Principal Name'' (''UPN'', usually the primary email address) as user name, you must rename users and archive folders if you are currently using a different user name format or want to change the ''UPN''.

For renaming users and archive folder, please proceed as follows:
* Edit the scripts <code>MSS_1_prepare_users.ps1</code> and <code>MSS_2_update_users.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.
* Run the script <code>MSS_1_prepare_users.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-users.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the current MailStore Server user names.
* Edit this file in a text editor. Change the new user names after the "=", so that the entries look like this:
*; <pre>AD user name=Microsoft 365 user name</pre> 
*; Example (with changes highlighted)
*; <code>jane.doe=jane.doe</code><code style="color: blue">@example.com</code> 
*; Please use only lower case for letters in user names. For user names that should not change (e.g. the default ''admin'' user), just leave the corresponding entries as is.
* Save the file <code>mailstore-users.txt</code> that now should contain the current and the future user names.
* Run the script <code>MSS_2_update_users.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the users and their archive folder in MailStore Server and also updates the archive folder permissions accordingly.
* Log on as MailStore Server administrator with the MailStore Client and check the new user names and archive folders.
* If the local part of the users' email addresses (the part before the "@") has not changed, you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]]. Otherwise the source folders may need to be renamed as described in the next section.

=== Renaming Source Folders in MailStore Server ===
The folder level below the archive folders reflects the source from which MailStore Server has archived the emails. In case of Exchange archiving, the folder name consists of the prefix ''Exchange'' and the local part of the email address (the part before the "@"), so that for the email address <code>john.doe@example.com</code> the source folder name in MailStore Server would be ''Exchange john.doe@example.com''.

Source folder names only need to be renamed if '''all''' of the following conditions and requirements are met. Otherwise you can proceed directly with the steps in section [[#Changing Directory Service Synchronization to Microsoft 365|Changing Directory Service Synchronization to Microsoft 365]].
* The local part of the email address shall be changed in course of migrating to Microsoft 365 (e.g. from <code>john.doe@example.com</code> to <code>j.doe@example.com</code>) '''and'''
* both the emails that have been archived so far from the local Exchange Server and those that will be archived from Microsoft 365 henceforth should appear in the same folder structure on source level (e.g. so far in ''Exchange john.doe'' and in ''Exchange j.doe'' after).

For renaming the source folders, please proceed as follows:
* Enable access to user archives by administrators in MailStore Server; it is disabled by default. Changing this option is described in chapter [[Compliance_General#Archive_Access|Compliance General]] of the MailStore Server manual.
* Edit the scripts <code>MSS_3_prepare_folders.ps1</code> and <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE and adjust the values in the section ''Adjust these values according to your installation'' according to your MailStore Server installation.

* Run the script <code>MSS_3_prepare_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The file <code>mailstore-folders.txt</code> will be created (in the folder <code>C:\Users\<Your user name>\</code> by default). It contains the full paths of the current source folders that consist of user names and the source folder names, separated by "/".
* Edit this file in a text editor. Change the new source folders after the "=", so that the entries look like this:
*; <pre>Old source folder path=new source folder path</pre> 
*; Example (with changes highlighted)
*;<code>j.doe@example.com/</code><code style="color: red">Exchange jane.doe</code><code>=j.doe@example.com/</code><code style="color: blue">Exchange j.doe</code> 
*; For source folders that should not change, just leave the corresponding entries as is.
* Save the file <code>mailstore-folders.txt</code> that now should contain the current and the future source folders.
* Run the script <code>MSS_4_update_folders.ps1</code> in the PowerShell ISE with ''F5''.
* The script now renames the source folders in MailStore Server.
* Log on as MailStore Server administrator with the MailStore Client and check the new source folders.

=== Changing Directory Service Synchronization to Microsoft 365 ===
To enable users to log on to MailStore Server with their Microsoft 365 credentials instead of their Active Directory, you must switch the directory service synchronization to ''Microsoft 365 (Modern Authentication)''. Please follow the steps in chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.
Initially, just test the synchronization using the ''Test Settings'' button. Check the directory service synchronization results, migrated users should show as ''modified''. You can also check that user authentication against Microsoft 365 works as expected.

== Changing the Archiving Profiles ==
For archiving Microsoft 365 mailboxes, MailStore Server offers dedicated Microsoft 365 archiving profiles that support modern authentication. Existing Exchange archiving profiles cannot be used for archiving Microsoft 365 mailboxes because they only support basic authentication.

=== Deactivating Existing Profiles and Jobs ===
If you run MailStore Server in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]] as recommended before, automatic execution of archiving profiles and by jobs is disabled. To deactivate them permanently, please proceed as follows:
* Log on as MailStore Server administrator through the MailStore Client.
* Click on ''Archive E‑mail''
* Below the profiles list, enable the option ''Show Profiles of All Users''.
* Switch every Exchange archiving profile to ''Manual'' through the context menu.
* If you have configured Exchange export profiles, click on ''Export E‑mail'' in the menu tree and repeat the previous steps.
* If you have configured scheduled job for running Exchange profiles, click on ''Administrative Tools > Management API > Jobs'' and deactivate every job that run an Exchange profile through the context menu.

=== Creating new Microsoft 365 Profiles ===
Create new Microsoft 365 profiles and jobs according to the following articles. They should be set to manual initially to check their execution and results.
* For archiving Microsoft 365 mailboxes, follow the implementation guide [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)|Archiving Emails from Microsoft 365 (Modern Authentication)]].
* Creating Microsoft 365 export profiles is described in chapter [[Exporting Email]] of the MailStore Server manual.
* Once the profiles have been set up you can update existing jobs as described in chapter [[Jobs#Properties|jobs]] of the MailStore Server manual.

== Finalizing the Migration ==
To finalize the migration in MailStore Server, please proceed as follows:
* Close all MailStore Client sessions and restart the MailStore Server service.
* Log on as MailStore Server administrator again through the MailStore Client.
* In the main menu tree, go to ''Administrative Tools > Users and Archives > Archives'' and check the names of the archive folders.
* Switch to ''Archive E‑mail'' and run each Microsoft 365 archiving profile manually. If you are satisfied with the results, you can delete the old Exchange archiving profiles.
* If applicable, repeat the previous step for export profiles and jobs.
* If you have previously enabled access to user archives by administrators in MailStore Server as described in chapter [[Compliance_General#Archive_Access|Compliance General]], revert that change.
* If you have enabled ''Single-Sign-On (SSO)'' by setting the server name of the MailStore Server computer and the authentication method to ''Windows Authentication'' through group policies [[MailStore_Client_Deployment#Configuring_Policy_Settings|for the MailStore Client]] or the [[MailStore_Outlook_Add-in_Deployment|for the MailStore Outlook Add-in]], you must change the group policy setting ''Authentication'' to ''Standard Authentication''.
* During login, MailStore Server calls the default web browser to have the user log in through the Microsoft 365 login dialog; this communication is TLS-encrypted via HTTPS. Therefore, for a better user experience, it is recommended to configure a SSL certificate in MailStore Server that is trusted by the web browser. Further information can be found in the [[Using_Your_Own_SSL_Certificate|Using Your Own SSL Certificate]] article.

After finishing these tasks successfully, the migration in MailStore Server is complete.
[[de:Umstellung_der_Archivierung_von_Microsoft_Exchange_Server_auf_Microsoft_365]]
[[en:Changing_Archiving_from_Microsoft_Exchange_Server_to_Microsoft_365]]

File:MailStoreServiceProviderEditionMigrationScripts.zip

2022-11-15T09:38:10Z

Rrommelrath:

File:Xchg public 01.png

2022-11-14T11:08:20Z

Rrommelrath: Rrommelrath uploaded a new version of File:Xchg public 01.png

Importing image file

File:Xchg sharedmbx 01.png

2022-11-14T11:06:37Z

Rrommelrath: Rrommelrath uploaded a new version of File:Xchg sharedmbx 01.png

File:Xchg jour mailstore 01.png

2022-11-04T10:38:20Z

Rrommelrath: Rrommelrath uploaded a new version of File:Xchg jour mailstore 01.png

Importing image file

File:Arch imap catch 02.png

2022-11-04T10:36:23Z

Rrommelrath: Rrommelrath uploaded a new version of File:Arch imap catch 02.png

File:Arch mailboxes 01.png

2022-11-04T10:34:29Z

Rrommelrath: Rrommelrath uploaded a new version of File:Arch mailboxes 01.png

Importing image file

File:Xchg mailboxes 01.png

2022-11-04T10:32:51Z

Rrommelrath: Rrommelrath uploaded a new version of File:Xchg mailboxes 01.png

Importing image file

File:Xchg mailbox 01.png

2022-11-04T10:31:26Z

Rrommelrath: Rrommelrath uploaded a new version of File:Xchg mailbox 01.png

Importing image file

Template:Archiving Exchange Single Mailbox

2022-11-04T08:57:44Z

Rrommelrath:

For each mailbox, please proceed as follows:

* Unless the mailbox of the current user is to be archived into his or her own user archive, log on to MailStore Client as MailStore administrator. Only an administrator can archive emails for other users.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings.
* Select ''Single Mailbox''.
{{#ifeq: {{{1}}}|Office 365|*: [[File:Office365_mailbox_01.png|center|347px]]
* Leave the protocol under ''Access via'' on ''HTTPS''. Also the option ''Ignore SSL Warnings'' should be left deactivated because Office 365 uses official certificates.|*: [[File:Xchg_mailbox_01.png|center|347px]]
* Under ''Access via'', select the protocol to be used to access the Exchange server. Whenever possible, ''HTTPS'' should be used.
*: '''Please note:''' {{Option Accept all certificates}} }}
* {{#ifeq: {{{1}}}|Office 365|Leave the setting of ''Host'' to its default ''(Auto Detect)''.|Under ''Host'', enter the name of your Exchange server.}}
* Under ''User Name'', enter the {{{1|Windows}}} login name of the user whose emails are to be archived (e.g. {{#ifeq: {{{1}}}|Office 365|barbara.ross@example.com|barbara.ross@example.local or barbara.ross@example.com}}).
*: '''Please note:''' Alternatively, any user with the appropriate access permissions for the mailbox to be archived can be specified. In this case, it is imperative that this mailbox is specified under ''Mailbox'' (see below).
* Under ''Password'', enter the user's password.
* The field ''Mailbox'' must be left blank if a user, whose {{{1|Windows}}} login name and password is being used, wants to archive his own mailbox. Otherwise, the primary email address of the user whose mailbox you want to archive has to be entered here.
* Click on ''Test'' to verify that MailStore can access the mailbox.
* Click on ''Next''.
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow servers).
*:[[File:Xchg_mailbox_03.png|center|347px]]
*: '''Important notice:''' Did you specify ''IMAP'' as the protocol and have also defined a deletion rule? If so, folders containing no emails, such as ''Tasks'', ''Calendar'' or ''Contacts'' have to be added to the list of excluded folders manually. This is the only way to avoid these folders being archived and deleted according to the deletion rule specified. Please read more in chapter [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Archiving Specific Folders]].
* Click on ''Next'' to continue.
* If logged on to MailStore Server as MailStore administrator, the ''Target Archive'' can be specified. Select the archive of the user for whom the selected mailbox is to be archived. If the user does not exist yet, click on ''Create a New User''.
*:[[File:Xchg_mailbox_02.png|center|347px]]
* Click on ''Next''.
* In the last step, a name for the archiving profile can be specified. After clicking ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and, if desired, can be run immediately or automatically.
<noinclude>
[[de:Vorlage:Archivierung Einzelnes Exchange-Postfach archivieren]]
[[en:Template:Archiving Exchange Single Mailbox]]
</noinclude>

Template:Archiving Exchange Public Folder

2022-11-04T08:56:59Z

Rrommelrath:

Please proceed as follows:

* Log on to MailStore Client as administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings.
* Select ''Public Folders''.
{{#ifeq: {{{1}}}|Office 365|*: [[File:Office365_public_01.png|center|347px]]
* Under ''Access via'', leave the protocol on ''HTTPS''. The option ''Accept all certificates'' should also be left deactivated because Office 365 uses trusted certificates.|*:[[File:Xchg_public_01.png|center|350px]]
* Under ''Access via'', either ''HTTPS'' or ''HTTP'' has to be selected as protocol to archive public folders.
*: '''Please note if you choose HTTPS:''' {{Option Accept all certificates}} }}
* {{#ifeq: {{{1}}}|Office 365|Leave the setting of ''Host'' to its default ''(Auto Detect)''.|Under ''Host'', enter the name of your Exchange server.}}
* Under ''User Name'', enter the {{{1|Windows}}} login name of the user you have prepared in step 2 for public folder access.
* Under ''Password'', enter the user's password.
* Leave the field ''Mailbox'' to its preset value ''/public''.
* Click on ''Test'' to verify that MailStore can access the public folders.
* Click on ''Next'' to continue.
*:[[File:Xchg_public_03.png|center|347px]]
* Adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]]. By default, all public folders that contain emails will be archived.
* If needed, adjust [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|the filter]] and the [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]]. By default, no emails will be deleted from the public folders. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow servers).
* Click on ''Next'' to continue.
*:[[File:Xchg_public_02.png|center|347px]]
* In the next step, select the archive of the user you have prepared in step 1.
* In the last step, specify a name for the archiving profile. After clicking ''Finish'' the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically if desired.
<noinclude>
[[de:Vorlage:Archivierung Exchange Öffentliche Ordner archivieren]]
[[en:Template:Archiving Exchange Public Folder]]
</noinclude>

Template:Archiving Exchange Multiple Mailboxes

2022-11-04T08:55:17Z

Rrommelrath:

Template:Archiving Exchange Journal Mailbox

2022-11-04T08:54:48Z

Rrommelrath:

Please proceed as follows:

* Log on to MailStore Client as MailStore administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings.
* Select ''In- and Outbound Email Automatically''.
*: {{#if:{{{DSLink|}}}|{{Archiving_Multiple_or_Multidrop_Note|from a journal mailbox|{{{DSLink}}}}}|{{Archiving_Multiple_or_Multidrop_Note|from a journal mailbox}}}}
{{#ifeq: {{{1|Exchange}}}|Office 365|*: [[File:Office365_jour_mailstore_01.png|center|347px]]
* Under ''Access via'', select the protocol to be used to access the email server that hosts the journal mailbox. If this is an Exchange server, ''HTTPS'' should be used whenever possible.
*: '''Please note:''' {{Option Accept all certificates}}
* Under ''Host'', enter the name of the email server that hosts the journal mailbox.
* Under ''User Name'' and ''Password'' enter the credentials for the journal mailbox.
* If the journal mailbox is an Exchange mailbox that you want to access through ''HTTP/HTTPS'' with credentials that are not those of the mailbox owner, you have to specify the primary email address of the journal mailbox in the field ''Mailbox (opt.)''.
|*:[[File:Xchg_jour_mailstore_01.png|center|350px]]
* Under ''Access via'', select the protocol to be used to access the Exchange server. Whenever possible, ''HTTPS'' should be used.
*: '''Please note:''' {{Option Accept all certificates}}
* Under ''Host'' enter the name of the Exchange server.
* Under ''User Name'' and ''Password'' enter the credentials for the Exchange journal mailbox.
* If you want to access the journal mailbox through ''HTTP/HTTPS'' with credentials that are not those of the mailbox owner, you have to specify the primary email address of the journal mailbox in the field ''Mailbox (opt.)''.}}
* Click on ''Test'' to verify that MailStore can access the mailbox.
* '''Synchronize with Directory Services before archiving''' If this option is enabled, the MailStore user list will be synchronized with configured directory service before the archiving process actually runs. This has the advantage that, for example, new employees will be created as MailStore users before archiving which enables MailStore to sort their emails into the correct archives. This option is recommended if you want to have the journal archiving job run automatically.
* '''Messages with unknown e-mail addresses''' In this section you can configure whether to archive messages that contain only email addresses which do not belong to any MailStore user. By default, such emails will be archived into a ''catchall'' folder but you can select another folder through the ''Ellipsis (…)''. Alternatively, you can opt not to archive these emails at all.
* '''When e-mails are successfully archived''' Enabling the option ''Delete them in origin mailbox'' will delete emails automatically in the journal mailbox after they have been archived successfully by MailStore. The option has no effect whatsoever on the emails in the users' mailboxes.
* Click on ''Next'' to continue.
* A ''Timeout'' value can be specified. Change this value only in case of definite need (e.g. with very slow servers).
* Click on ''Next'' to continue.
* In the last, step a name for the archiving profile can be specified. After clicking ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically, if desired.
<noinclude>
[[de:Vorlage:Archivierung Exchange Journal-Postfach archivieren]]
[[en:Template:Archiving Exchange Journal Mailbox]]
</noinclude>

Template:Archiving Exchange Multiple Mailboxes

2022-11-04T08:26:05Z

Rrommelrath:

Template:Archiving Exchange Journal Mailbox

2022-11-04T08:25:32Z

Rrommelrath:

Please proceed as follows:

* Log on to MailStore Client as MailStore administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings.
* Select ''In- and Outbound Email Automatically''.
*: {{#if:{{{DSLink|}}}|{{Archiving_Multiple_or_Multidrop_Note|from a journal mailbox|{{{DSLink}}}}}|{{Archiving_Multiple_or_Multidrop_Note|from a journal mailbox}}}}
{{#ifeq: {{{1|Exchange}}}|Office 365|*: [[File:Office365_jour_mailstore_01.png|center|347px]]
* Under ''Access via'', select the protocol to be used to access the email server that hosts the journal mailbox. If this is an Exchange server, ''HTTPS'' should be used whenever possible.
*: '''Please note:''' Depending on the protocol chosen, there is the option to ''Accept all certificates''. Generally, these warnings appear if an unofficial or self-signed certificate is used on the server.
* Under ''Host'', enter the name of the email server that hosts the journal mailbox.
* Under ''User Name'' and ''Password'' enter the credentials for the journal mailbox.
* If the journal mailbox is an Exchange mailbox that you want to access through ''HTTP/HTTPS'' with credentials that are not those of the mailbox owner, you have to specify the primary email address of the journal mailbox in the field ''Mailbox (opt.)''.
|*:[[File:Xchg_jour_mailstore_01.png|center|350px]]
* Under ''Access via'', select the protocol to be used to access the Exchange server. Whenever possible, ''HTTPS'' should be used.
*: '''Please note:''' Depending on the protocol chosen, there is the option to ''Accept all certificates''. Generally, these warnings appear if an unofficial or self-signed certificate is used on the server.
* Under ''Host'' enter the name of the Exchange server.
* Under ''User Name'' and ''Password'' enter the credentials for the Exchange journal mailbox.
* If you want to access the journal mailbox through ''HTTP/HTTPS'' with credentials that are not those of the mailbox owner, you have to specify the primary email address of the journal mailbox in the field ''Mailbox (opt.)''.}}
* Click on ''Test'' to verify that MailStore can access the mailbox.
* '''Synchronize with Directory Services before archiving''' If this option is enabled, the MailStore user list will be synchronized with configured directory service before the archiving process actually runs. This has the advantage that, for example, new employees will be created as MailStore users before archiving which enables MailStore to sort their emails into the correct archives. This option is recommended if you want to have the journal archiving job run automatically.
* '''Messages with unknown e-mail addresses''' In this section you can configure whether to archive messages that contain only email addresses which do not belong to any MailStore user. By default, such emails will be archived into a ''catchall'' folder but you can select another folder through the ''Ellipsis (…)''. Alternatively, you can opt not to archive these emails at all.
* '''When e-mails are successfully archived''' Enabling the option ''Delete them in origin mailbox'' will delete emails automatically in the journal mailbox after they have been archived successfully by MailStore. The option has no effect whatsoever on the emails in the users' mailboxes.
* Click on ''Next'' to continue.
* A ''Timeout'' value can be specified. Change this value only in case of definite need (e.g. with very slow servers).
* Click on ''Next'' to continue.
* In the last, step a name for the archiving profile can be specified. After clicking ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically, if desired.
<noinclude>
[[de:Vorlage:Archivierung Exchange Journal-Postfach archivieren]]
[[en:Template:Archiving Exchange Journal Mailbox]]
</noinclude>

Template:Archiving Exchange Public Folder

2022-11-04T08:23:39Z

Rrommelrath:

Please proceed as follows:

* Log on to MailStore Client as administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings.
* Select ''Public Folders''.
{{#ifeq: {{{1}}}|Office 365|*: [[File:Office365_public_01.png|center|347px]]
* Under ''Access via'', leave the protocol on ''HTTPS''. The option ''Accept all certificates'' should also be left deactivated because Office 365 uses trusted certificates.|*:[[File:Xchg_public_01.png|center|350px]]
* Under ''Access via'', either ''HTTPS'' or ''HTTP'' has to be selected as protocol to archive public folders.
*: '''Please note:''' If you choose ''HTTPS'', you can enable the option to ''Accept all certificates''. Generally, these warnings appear if an unofficial or self-signed certificate is used on the Exchange server.}}
* {{#ifeq: {{{1}}}|Office 365|Leave the setting of ''Host'' to its default ''(Auto Detect)''.|Under ''Host'', enter the name of your Exchange server.}}
* Under ''User Name'', enter the {{{1|Windows}}} login name of the user you have prepared in step 2 for public folder access.
* Under ''Password'', enter the user's password.
* Leave the field ''Mailbox'' to its preset value ''/public''.
* Click on ''Test'' to verify that MailStore can access the public folders.
* Click on ''Next'' to continue.
*:[[File:Xchg_public_03.png|center|347px]]
* Adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]]. By default, all public folders that contain emails will be archived.
* If needed, adjust [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|the filter]] and the [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]]. By default, no emails will be deleted from the public folders. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow servers).
* Click on ''Next'' to continue.
*:[[File:Xchg_public_02.png|center|347px]]
* In the next step, select the archive of the user you have prepared in step 1.
* In the last step, specify a name for the archiving profile. After clicking ''Finish'' the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically if desired.
<noinclude>
[[de:Vorlage:Archivierung Exchange Öffentliche Ordner archivieren]]
[[en:Template:Archiving Exchange Public Folder]]
</noinclude>

Archiving Emails from Microsoft 365 Hybrid

2022-10-21T08:31:38Z

Rrommelrath:

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [https://learn.microsoft.com/en-us/exchange/exchange-hybrid Exchange Hybrid Deployments (Microsoft)] and only with the global Microsoft Cloud.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.
| Please test the described configurations early, preferably in the trial phase. In case your scenario differs from Microsoft's described best practices or is in any other way more individual, questions about feasibility can be identified early and discussed with our technical support.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a Azure AD Connector, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-21T08:29:09Z

Rrommelrath:

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [https://learn.microsoft.com/en-us/exchange/exchange-hybrid Exchange Hybrid Deployments (Microsoft)] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.
| Please test the described configurations early, preferably in the trial phase. In case your scenario differs from Microsoft's described best practices or is in any other way more individual, questions about feasibility can be identified early and discussed with our technical support.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-21T08:24:53Z

Rrommelrath:

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [[https://learn.microsoft.com/en-us/exchange/exchange-hybrid | Exchange Hybrid Deployments (Microsoft)]] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.
| Please test the described configurations early, preferably in the trial phase. In case your scenario differs from Microsoft's described best practices or is in any other way more individual, questions about feasibility can be identified early and discussed with our technical support.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Implementation

2022-10-21T08:20:56Z

Rrommelrath:

__NOTOC__
==== Microsoft 365 & Microsoft Exchange Servers ====
* [[Archiving Emails from Microsoft 365 (Modern Authentication)|Microsoft Exchange Online / Microsoft 365 (Modern Authentication)]]
* [[Archiving Emails from Microsoft 365 Hybrid|Microsoft Exchange Online / Microsoft 365 Hybrid]]
* [[Archiving Emails from Microsoft Exchange 2019|Microsoft Exchange 2019]]
* [[Archiving Emails from Microsoft Exchange 2016|Microsoft Exchange 2016]]
* [[Archiving Emails from Microsoft Exchange 2013|Microsoft Exchange 2013]]

==== Google Workspace & Gmail ====
* [[Archiving_Emails_from_Google_Workspace|Google Workspace]]
* [[Archiving_Emails_from_Gmail|Gmail]]
==== IMAP/POP3-based Email Servers ====
* [[Archiving Emails from MDaemon|MDaemon Email Server]]
* [[Archiving Emails from Kerio Connect|Kerio Connect (Kerio MailServer)]]
* [[Archiving Emails from IceWarp Server|IceWarp Server]]
* [[Archiving Emails from Intra2net Systems|Intra2net Appliance Pro / Business Server]]
* [[Archiving Emails from hMailServer|hMailServer]]
* [[Archiving Emails from SmarterMail|SmarterMail]]
* [[Archiving Emails from Tobit David.fx|Tobit David.fx]]
* [[Archiving Emails from Zimbra|Zimbra Collaboration Suite]]
* [[Archiving Emails from Linux-based Email Servers|Linux-based Email Server]]
* [[Archiving Emails Without Your Own Emailserver]] (e.g. Hosted Exchange or POP3/IMAP-mailbox provided by an ISP)
==== Legacy Implementation Guides ====
{{{1|}}}
* [[Archiving Emails from Microsoft 365 (Basic Authentication)|Microsoft Exchange Online / Microsoft 365 (Basic Authentication)]]
* [[Archiving Emails from Microsoft Exchange 2010|Microsoft Exchange 2010]]
* [[Archiving Emails from Microsoft Exchange 2007|Microsoft Exchange 2007]]
* [[Archiving Emails from Microsoft Exchange 2003|Microsoft Exchange 2003]]
* [[Archiving Emails from Kolab|Kolab]]
* [[Archiving Emails from Scalix|Scalix]]
<noinclude>
[[de:Implementation]]
[[en:Implementation]]
</noinclude>

Implementation

2022-10-21T08:20:26Z

Rrommelrath:

__NOTOC__
==== Microsoft 365 & Microsoft Exchange Servers ====
* [[Archiving Emails from Microsoft 365 (Modern Authentication)|Microsoft Exchange Online / Microsoft 365 (Modern Authentication)]]
* [[Archiving Emails from Microsoft 365 (Hybrid)|Microsoft Exchange Online / Microsoft 365 Hybrid]]
* [[Archiving Emails from Microsoft Exchange 2019|Microsoft Exchange 2019]]
* [[Archiving Emails from Microsoft Exchange 2016|Microsoft Exchange 2016]]
* [[Archiving Emails from Microsoft Exchange 2013|Microsoft Exchange 2013]]

==== Google Workspace & Gmail ====
* [[Archiving_Emails_from_Google_Workspace|Google Workspace]]
* [[Archiving_Emails_from_Gmail|Gmail]]
==== IMAP/POP3-based Email Servers ====
* [[Archiving Emails from MDaemon|MDaemon Email Server]]
* [[Archiving Emails from Kerio Connect|Kerio Connect (Kerio MailServer)]]
* [[Archiving Emails from IceWarp Server|IceWarp Server]]
* [[Archiving Emails from Intra2net Systems|Intra2net Appliance Pro / Business Server]]
* [[Archiving Emails from hMailServer|hMailServer]]
* [[Archiving Emails from SmarterMail|SmarterMail]]
* [[Archiving Emails from Tobit David.fx|Tobit David.fx]]
* [[Archiving Emails from Zimbra|Zimbra Collaboration Suite]]
* [[Archiving Emails from Linux-based Email Servers|Linux-based Email Server]]
* [[Archiving Emails Without Your Own Emailserver]] (e.g. Hosted Exchange or POP3/IMAP-mailbox provided by an ISP)
==== Legacy Implementation Guides ====
{{{1|}}}
* [[Archiving Emails from Microsoft 365 (Basic Authentication)|Microsoft Exchange Online / Microsoft 365 (Basic Authentication)]]
* [[Archiving Emails from Microsoft Exchange 2010|Microsoft Exchange 2010]]
* [[Archiving Emails from Microsoft Exchange 2007|Microsoft Exchange 2007]]
* [[Archiving Emails from Microsoft Exchange 2003|Microsoft Exchange 2003]]
* [[Archiving Emails from Kolab|Kolab]]
* [[Archiving Emails from Scalix|Scalix]]
<noinclude>
[[de:Implementation]]
[[en:Implementation]]
</noinclude>

Archiving Emails from Microsoft 365 (Hybrid)

2022-10-21T08:18:26Z

Rrommelrath: Rrommelrath moved page Archiving Emails from Microsoft 365 (Hybrid) to Archiving Emails from Microsoft 365 Hybrid: Brackets are an issue with new Win Defenders

#REDIRECT [[Archiving Emails from Microsoft 365 Hybrid]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-21T08:18:26Z

Rrommelrath: Rrommelrath moved page Archiving Emails from Microsoft 365 (Hybrid) to Archiving Emails from Microsoft 365 Hybrid: Brackets are an issue with new Win Defenders

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [[https://learn.microsoft.com/en-us/exchange/exchange-hybrid|Exchange Hybrid Deployments (Microsoft)]] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.
| Please test the described configurations early, preferably in the trial phase. In case your scenario differs from Microsoft's described best practices or is in any other way more individual, questions about feasibility can be identified early and discussed with our technical support.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-20T12:00:27Z

Rrommelrath:

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [[https://learn.microsoft.com/en-us/exchange/exchange-hybrid|Exchange Hybrid Deployments (Microsoft)]] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.
| Please test the described configurations early, preferably in the trial phase. In case your scenario differs from Microsoft's described best practices or is in any other way more individual, questions about feasibility can be identified early and discussed with our technical support.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-20T11:59:11Z

Rrommelrath:

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [[https://learn.microsoft.com/en-us/exchange/exchange-hybrid|Exchange Hybrid Deployments (Microsoft)]] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.
| Please test the described configurations early, preferably in the trial phase. In case your scenario differs from Microsoft's described best practices or is in any other way more individual, questions about feasability can be identified early and discussed with our technical support.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-20T11:44:42Z

Rrommelrath:

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [[https://learn.microsoft.com/en-us/exchange/exchange-hybrid|Exchange Hybrid Deployments (Microsoft)]] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To provide proper access permissions to your Microsoft 365 tenant, you still need to partially proceed with the article on setting up user synchronization with Microsoft 365:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]
But only configure the app registration and permissions (skip steps 2.4, 2.7 following, and 4).
To then synchronize users locally, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Archiving Emails from Microsoft 365 Hybrid

2022-10-20T11:31:04Z

Rrommelrath: Created page with "{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premi..."

{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft 365 (Modern Authentication) and on-premises Exchange Server(s) only with the Microsoft's Best Practice Guides [[https://learn.microsoft.com/en-us/exchange/exchange-hybrid|Exchange Hybrid Deployments (Microsoft)]] and only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not suppoted.
|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.}}

== App Registration & User Synchronization ==
You have two different options to synchronize users and their information to make their mailboxes known and to allow them to log in with their Active Directory credentials.

* Synchronizing purely with Microsoft 365 (recommended for most scenarios):
Here MailStore Server will ''only'' be synchronized with the Azure Active Directory of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with the Azure Directory via a sync tool, all relevant users are also present in Microsoft 365.
The advantage is that you can use all modern authentication methods, such as especially MFA, in MailStore Server.
In this case, proceed as if you solely had a Microsoft 365 environment:
[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]

* Synchronizing with the local Active Directory of your company:
This is only recommended if there is a valid reason to do so.
Such a reason could be that you are using a local ADFS, meaning a local authentication service, or that you prefer to make use of local authentication methods, such as integrated Windows authentication (less secure, not recommended).
To synchronize users with this variant, proceed as described in the following article:
[[Active Directory Integration]]

== Archiving Microsoft 365 Mailboxes or Public Folders ==
Use the manual for archiving mailboxes in Microsoft 365 as a guide (also for actual on-premises Exchange mailboxes):
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Individual_Mailboxes|Archiving Individual Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Multiple_Exchange_Mailboxes_Centrally|Archiving Multiple Exchange Mailboxes Centrally]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Shared_Mailboxes|Shared Mailboxes]]
* [[Archiving_Emails_from_Microsoft_Exchange_2019#Public_Folders|Public Folders]]

== Archiving Incoming and Outgoing Emails Directly ==

One thing special that you need to be aware of is that both your Microsoft 365 tenant and on-premises Exchange Server(s) need to be configured to send journal reports for incoming and outgoing mails.

* First we recommend configuring the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly (Microsoft 365)]]
* Then configure your local Exchange Server(s) to also send their journal reports to the Gateway. Use the manual for your matching Exchange Server version, but we recommend not creating a journal mailbox (skip step 1 in this case), but to define the external email address of your MailStore Gateway to be the recipient of these reports. This way all reports are received at the same destination:
** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]
** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]
** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013]]

[[de:E-Mail-Archivierung_von_Microsoft_365_(Hybrid)]]
[[en:Archiving_Emails_from_Microsoft_365_(Hybrid)]]

Implementation

2022-10-20T09:33:59Z

Rrommelrath: /* Microsoft 365 Hybrid */

__NOTOC__
==== Microsoft 365 & Microsoft Exchange Servers ====
* [[Archiving Emails from Microsoft 365 (Modern Authentication)|Microsoft Exchange Online / Microsoft 365 (Modern Authentication)]]
* [[Archiving Emails from Microsoft 365 (Hybrid)|Microsoft Exchange Online / Microsoft 365 (Hybrid)]]
* [[Archiving Emails from Microsoft Exchange 2019|Microsoft Exchange 2019]]
* [[Archiving Emails from Microsoft Exchange 2016|Microsoft Exchange 2016]]
* [[Archiving Emails from Microsoft Exchange 2013|Microsoft Exchange 2013]]

==== Google Workspace & Gmail ====
* [[Archiving_Emails_from_Google_Workspace|Google Workspace]]
* [[Archiving_Emails_from_Gmail|Gmail]]
==== IMAP/POP3-based Email Servers ====
* [[Archiving Emails from MDaemon|MDaemon Email Server]]
* [[Archiving Emails from Kerio Connect|Kerio Connect (Kerio MailServer)]]
* [[Archiving Emails from IceWarp Server|IceWarp Server]]
* [[Archiving Emails from Intra2net Systems|Intra2net Appliance Pro / Business Server]]
* [[Archiving Emails from hMailServer|hMailServer]]
* [[Archiving Emails from SmarterMail|SmarterMail]]
* [[Archiving Emails from Tobit David.fx|Tobit David.fx]]
* [[Archiving Emails from Zimbra|Zimbra Collaboration Suite]]
* [[Archiving Emails from Linux-based Email Servers|Linux-based Email Server]]
* [[Archiving Emails Without Your Own Emailserver]] (e.g. Hosted Exchange or POP3/IMAP-mailbox provided by an ISP)
==== Legacy Implementation Guides ====
{{{1|}}}
* [[Archiving Emails from Microsoft 365 (Basic Authentication)|Microsoft Exchange Online / Microsoft 365 (Basic Authentication)]]
* [[Archiving Emails from Microsoft Exchange 2010|Microsoft Exchange 2010]]
* [[Archiving Emails from Microsoft Exchange 2007|Microsoft Exchange 2007]]
* [[Archiving Emails from Microsoft Exchange 2003|Microsoft Exchange 2003]]
* [[Archiving Emails from Kolab|Kolab]]
* [[Archiving Emails from Scalix|Scalix]]
<noinclude>
[[de:Implementation]]
[[en:Implementation]]
</noinclude>

Move Archiving Emails from Microsoft 365 - Modern Authentication

2022-10-11T13:57:28Z

Rrommelrath:

{{Implementation Guide Preamble|Exchange Online / Microsoft 365|{{#ev:youtube|https://youtu.be/X0Um0cDWGg0|350|right|''Tech Tip: Microsoft 365 Archiving Profiles''}}| Our Tech Tip video shows the essential configuration steps in this article.}}
 
{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from Microsoft 365 (Modern Authentication) only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not supported. For archiving emails from ''Office 365 Germany'' and ''Office 365 operated by 21Vianet'', please refer to the [[Synchronizing_User_Accounts_with_Microsoft_365_(Basic_Authentication)|corresponding implementation guide]].|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.}}

== App Registration & User Synchronization ==
Before archiving Microsoft 365 mailboxes, registering MailStore Server in your Microsoft 365 tenant is required. It is also highly recommended to synchronize users in MailStore Server directly with that tenant to fetch all information that is relevant for archiving such as email addresses. The registration and synchronization procedures are described in the chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.

'''Please note:''' MailStore Server runs as a [[MailStore Server Service Configuration|Windows service]] and thus must use ''Application Permissions'' to access user mailboxes in Microsoft 365. By design, on the Microsoft identity platform, which is at the heart of Microsoft 365 authentication and authorization, this permission scope encloses the full level of privileges implied by a permission. As a consequence, once registered as described above, MailStore Server has access to all mailboxes in your Microsoft 365 tenant. Therefore, with regard to security, access to the Microsoft 365 archiving profiles in MailStore Server is limited to MailStore Server administrators.

=== Including Microsoft 365 Shared Mailboxes ===
In Microsoft 365, shared mailboxes are special mailboxes that multiple users have access to. Unlike a normal mailbox, a shared mailbox is not associated to a licensed Microsoft 365 user. For MailStore Server to create user entries for shared mailboxes, you must therefore deactivate the option ''Synchronize licensed Microsoft Exchange Online users only'' in the section [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)#User_Database_Synchronization|User Database Synchronization]]. 
After synchronization you can grant MailStore Server users access to the archive of the shared mailbox by [[Users,_Folders_and_Settings#Folder_Access_.28e.g._Access_to_the_Emails_of_Other_Users.29|assigning privileges]]. For archiving shared mailboxes, just proceed as for individual or multiple mailboxes as detailed below.

== Archiving Individual Microsoft 365 Mailboxes ==
{{Archiving Single Mailbox Preamble|Microsoft 365}}
For each mailbox, please proceed as follows:

* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 mailbox 01.png|center|347px]]
* Select ''Single Mailbox'' and click on ''OK''.
*; [[File:Microsoft 365 mailbox 02.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* In the ''Mailbox'' field, enter the primary email address of the user whose mailbox you want to archive.
* Click on ''Test'' to verify that MailStore Server can access the mailbox.
* Click on ''Next''.
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections).
*; [[File:Microsoft_365_mailbox_03.png|center|347px]]
* Click on ''Next'' to continue.
* Select the archive of the user for whom the selected mailbox is to be archived. If the user does not exist yet, click on ''Create a New User…''.
*; [[File:Microsoft_365_mailbox_04.png|center|347px]]
* Click on ''Next''.
* In the last step, a name for the archiving profile can be specified. After clicking ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and, if desired, can be run immediately or automatically.

More information on how to execute archiving profiles can be found under the topic [[Email Archiving with MailStore Basics]]

== Archiving Multiple Microsoft 365 Mailboxes Centrally ==
{{Archiving Multiple Mailboxes Preamble|Microsoft 365}}
Please proceed as follows:

* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 mailboxes 01.png|center|347px]]
* Select ''Multiple Mailboxes'' and click ''OK''. 
*; {{Archiving_Multiple_or_Multidrop_Note|multiple mailboxes|[[#App_Registration_.26_User_Synchronization|directory synchronization]]}}
*; [[File:Microsoft 365 mailboxes 02.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 mailboxes 03.png|center|347px]]
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections). Please keep in mind that these settings apply to all mailboxes to be archived, as specified in the next step.
*; {{Archiving_Multiple_Mailboxes_Centrally_Options|Microsoft_365_mailboxes_04.png|Microsoft 365}}

== Archiving Incoming and Outgoing Emails Directly ==
{{Archiving Exchange Journal Mailbox Preamble|Exchange Online}}

=== Step 1: Setup and Configure MailStore Gateway ===
Please refer to the [https://help.mailstore.com/en/gateway/ MailStore Gateway Manual] for detailed instructions about:

* Installation and Setup of MailStore Gateway
* Logging on to MailStore Gateway's Management Console
* Creating MailStore Gateway mailboxes

After these steps, a mailbox with an individual email address (e.g. mbx-dead1234beef5678@gateway.example.com) should exist.

=== Step 2: Configure MailStore Server ===
{{Archiving MailStore Gateway Mailbox|''In- and Outbound E-Mail Automatically''|Microsoft 365 journal 01.png|Arch_MailStore_Gateway_Office365_02.png|''Microsoft 365''|TargetFolderHint=DontShow|POP3Hint=DontShow|DSLink=[[#App_Registration_.26_User_Synchronization|directory synchronization]]}}

=== Step 3: Creating a Journal Rule ===
The following steps describe how to set up journaling for your Microsoft 365 account.

Since you are planning to use an external mailbox (MailStore Gateway) as the recipient for Journal reports, we highly recommend to first create an external contact with this mail address in your Exchange mailbox administration to prevent any later errors or warnings about an unknown recipient in the process.

* Sign in to the [https://admin.microsoft.com/ Microsoft 365 admin center] as an Exchange or Global Administrator for your Microsoft 365 tenant.
* Expand the left navigation menu by clicking ''Show all''.
* In the ''Admin centers'' section, either use this [https://compliance.microsoft.com/exchangeinformationgovernance?viewid=exoJournalRule direct link] or use the now following path:
** In the left navigation menu, click "Compliance" (which will direct to a page called "Microsoft Purview")
** In the left navigation menu, select "Data Lifecycle Management", sub-item "Exchange(legacy)".
** On the Journal Rules page, in the top list, select "Journal Rules"
* First set up an alternative journal mailbox via "Settings" on the top right
* With ''Send undeliverable journal reports to'' select an alternate journaling mailbox that receives None Delivery Reports (NDRs) for undeliverable journal reports in case the primary journal mailbox is unreachable. This mailbox must be a dedicated mailbox, any mail sent directly to this mailbox won't be journaled.
* Once the alternative mailbox has been set, create a new journaling rule by clicking on ''+ (New)''.
*:The dialog window ''new journal rule'' opens:
*:[[File:Arch_office365_journal_01.png|center|550px]]
* Enter a name for the journal rule, e.g. ''Journaling''.
* In the ''If the message is sent to or received from…'' section select whether the rule should apply to all messages or to specific users or groups.
* Under ''Journal the following messages…'', choose whether to capture all messages, internally sent messages only, or only those messages with an external sender or recipient.
* Enter the email address of the previously created MailStore Gateway mailbox in the ''Send journal reports to:'' box.
* Click on ''Save'' to activate the rule.

== Public Folders ==
{{Archiving Exchange Public Folders Preamble|Exchange Online|Microsoft 365}}
* Sign in to the [https://admin.microsoft.com/ Microsoft 365 admin center] as an Exchange or Global Administrator for your Microsoft 365 tenant.
* Expand the left navigation menu by clicking ''Show all''.
* In the ''Admin centers'' section, choose ''Exchange''.
* In the ''Exchange admin center'', navigate to ''public folders''.
* Click on the ''Ellipsis (…)'' and select ''Root permissions''.
*: [[File:Microsoft_365_pf_01.png|center|480px]]
* A new browser window opens. Click on ''+ (Add)''.
* Use ''Browse'' to choose the Microsoft 365 user you want to grant permissions.
* Choose ''Custom'' as ''Permission level'' and grant ''Read items'' and ''Delete all'' permissions.
*: [[File:Arch_office365_pf_02.png|center|347px]]
* Click on ''Save''.
* Enable the option ''Apply changes to this public folder and all its subfolders.''
* Click on ''Save''.
* Click on ''Close'' after saving has been completed successfully.

=== Step 3: Setting up the Archiving Process ===
* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 pf 03.png|center|347px]]
* Select ''Public Folders'' and click on ''OK''. 
*; [[File:Microsoft 365 pf 04.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* In the ''Mailbox'' field, enter the primary email address of the user that has access to the public folders as described above.
* The value of the ''Target Folder'' box defines the top level folder below which the public folder hierarchy will be created in the target archive. Usually, you can leave this value to its default.
* Click on ''Test'' to verify that MailStore can access the public folders.
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 pf 05.png|center|347px]]
* Adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]]. By default, all public folders that contain emails will be archived.
* If needed, adjust [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|the filter]] and the [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]]. By default, no emails will be deleted from the public folders. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections).
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 pf 06.png|center|347px]]
* In the next step, select the archive of the user you have prepared in step 1.
* In the last step, specify a name for the archiving profile. After clicking ''Finish'' the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically if desired.

[[de:E-Mail-Archivierung_von_Microsoft_365_(Modern_Authentication)]]
[[en:Archiving_Emails_from_Microsoft_365_(Modern_Authentication)]]

Update Notices for MailStore Server

2022-10-10T12:50:40Z

Rrommelrath: MS-2283: clarify PostgreSQL requirements

== General Information ==

* '''Before you start the installation, please check if your current license really allows to upgrade the software.'''
* '''Before the installation, read the [https://go.mailstore.com?product=MailStore%20Server&target=changelog&lang=en changelog] for information about all changes in the respective versions.'''
* '''Make sure you have a recent backup of your archive. Learn more about backing up and restoring MailStore Server [[Backup and Restore|here]]'''.
* The installation process will uninstall older versions of the software automatically. All archives and the configuration data will be kept. There is no need to manually uninstall old versions previously.
* During the installation process the MailStore Server service is automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Should stopping the service fail for any reason, please stop the service manually and run the installation again.
* Carefully check the auto-detected settings during the installation process.
* Updating MailStore Client and/or MailStore Outlook Add-in installations
** Versions older than 9.x require an update of the MailStore Client and/or MailStore Outlook Add-in installations when updating to a new major or minor version (e.g. 5.1 to 5.2).
** Since version 9.x and up to 13.x this is typically required only for major version updates (e.g. 9.8 to 10). Exceptions are mentioned in the version specific notices below.
** For version 22.x and higher, version specific notices regarding these updates will be included if necessary.
*; Further information can be found in the articles [[MailStore Client Deployment]] and [[MailStore Outlook Add-in Deployment]]
* The following version specific upgrade notices are cumulative. Therefore, also read the notices regarding all version numbers between yours and the one you are going to install.
* For versions that are not explicitly listed here, the upgrade notices for preceding versions apply accordingly.

== Upgrading to 22.3.0 ==
* ''' Outlook Add-in ''' 
Starting with version 22.3.0, failed login attempts will slow down the login process. While this process is backwards compatible to older Outlook Add-ins, we strongly recommend updating the Outlook Add-in for the best user experience.

== Upgrading to 22.2.x ==
* '''System Requirements'''
*; Starting with version 22.2 MailStore Server, MailStore Client and MailStore Outlook Add-in require Microsoft .NET Framework version 4.8. Please refer to our [[System Requirements]]. If the framework is installed by the MailStore setup, the system might reboot without further notice.
* '''External Archive Stores'''
*; Starting with version 22.2, only versions 10 or newer are supported for PostgreSQL.

== Upgrading to 13.x ==
* '''Update of MailStore Client and Outlook Add-in''' Irrespective of MailStore Client's auto-update mechanism, a reinstallation of MailStore Client and the MailStore Outlook Add-in is required to make use of the following improvements:
** Unified validation of TLS certificates.
** Unified evaluation of group policies.
** Distinct error messages for certain certificate errors.
** Outlook Add-in: Due to the required changes of the login process to support modern authentication with Microsoft 365 and Google Workspace, the Outlook Add-in must be updated to version 13 to be able to connect to MailStore Server 13.x. Connecting to an older version of MailStore Server is no longer supported after the update.
* '''Unencrypted Connections'''
*; Support for unencrypted connections to MailStore Server has been fully removed. This affects MailStore Outlook Add-in, and the Legacy Web Access. After updating the Outlook Add-in, it automatically tries to connect to the default HTTPS port (8462) if either the default HTTP port (8461) or no port was set as part of the server name previously. In all other cases, the initial connections may fail and requires the server name to be adjusted by the user, or by an administrator via group policies.
* '''HTTP-to-HTTPS Redirect'''
*; The HTTP-to-HTTPS redirect option, which must be considered insecure without the use of properly configured [[wikipedia:HTTP_Strict_Transport_Security|HTTP Strict Transport Security (HSTS)]], has been removed. Users are required to use the correct HTTPS URL to access MailStore Web Access.
* '''Windows Authentication'''
*; The authentication method selection has been removed from the newly design login dialog. Therefore, traditional Windows Authentication available in on-prem Active Directory controlled environments, can only be enabled through group policies. Further information on group policies can be found in [[MailStore Client Deployment]] and [[MailStore Outlook Add-in Deployment]].
* '''Microsoft 365 Support'''
*; A new directory service synchronization profile [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]] as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance. Once Microsoft disables support for HTTP Basic Auth in Exchange Web Services on Microsoft 365, the existing directory service synchronization profile ''Microsoft 365 (Basic Auth)'' (formerly named ''Office 365'') and the Microsoft Exchange archiving and export profiles will stop working.
* '''Google Workspace Support'''
*; The [[Google Workspace Integration|Google Workspace directory service synchronization profile]] has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of Google Workspace are advised to regularly check for Google's announcement on the timeline for removing support for less secure apps, and should plan the migration to the new setting in advance. Once Google disables support for Less Secure Apps in Google Workspace, the existing directory service synchronization profile ''Google Workspace'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.
* '''IMAP Access to Archive'''
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google Workspace'' directory service synchronization profile, user that have been added by these profiles, can not access their archive via the integrated IMAP server as MailStore Server is not able to verify those passwords itself.
* '''Startup Scripts'''
*; The [[MailStore Server Service Configuration]] now provides functionality to configure connections to remote SMB/CIFS network shares without having to store credential in a plain text batch file. Therefore, startup scripts are no longer recommended to be used for that purpose. Unless there actually is a startup script found in MailStore Server's program directory, the corresponding menu item ''Startup Script'' will not be shown in the MailStore Server Service Configuration.
* '''Mobile Web Access'''
*; The dedicated Mobile Web Access has been removed due to no longer supported third-party components (e.g. jQuery Mobile) and in favor of MailStore Web Access, which has been received major enhancements in terms of performance and usability.
* '''Legacy Web Access'''
*; As parts of Legacy Web Access are representing the server-side of the Outlook Add-in, the Legacy Web Access is still present, but no longer advertised on the login screen of the Web Access.
* '''Group Policies'''
*; The following group policy settings are no longer supported in MailStore 13:
** '''MailStore Client: Accept Thumbprint'''
**; If a server name has been defined by a group policy, the certificate used by MailStore Server must be trusted by the client computer and it must not be revoked or expired.
** '''MailStore Outlook Add-in: Accept Thumbprint'''
**; If a server name has been defined by a group policy, the certificate used by MailStore Server must be trusted by the client computer and it must not be revoked or expired.
** '''MailStore Outlook Add-in: Enable TLS/SSL encryption'''
**; As MailStore Server no longer supports unencrypted inbound connections and the default behavior of MailStore Outlook Add-in as been modified accordingly, this option is ignored.

== Upgrading to 12.1 ==
* '''System Requirements'''
*; Windows Vista, Windows Server 2008, and Windows Small Business Server 2008 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].

== Upgrading to 12 ==
* '''Expired Certificates'''
*; Irrespective of whether the certificate's trust can be verified, no connection is established by MailStore Client to server's whose certificate has expired or was revoked. In such a case, the certificate must be replaced by means of the MailStore Server service configuration tool first.
* '''Using Certificates'''
*; If in the past, different certificates were used for the services provided by MailStore Server, the same certificate configuration as for new installations will be shown during the installation. The certificate configured in that step will afterwards be used for all provided services and can be change in the MailStore Server service configuration tool.

== Upgrading to 11 ==
* '''Upgrading Archive Stores'''
*; '''Depending on the archive size this can take an excessive amount of time. On average 50.000 messages are processed per minute during the upgrade.'''
*; Until the archive stores have been upgraded, not all functionality of the software is available. To facilitate
** retention policies,
** the search functionality,
** the improved recovery records,
*; the databases of the archive stores must be upgraded.
*;Proceed as follows to upgrade:
** Log in as MailStore administrator (admin).
** Click on ''Administrative Tools'' > ''Storage'' and then ''Storage Locations''.
** Either click on the yellow info box to upgrade all archive stores at once or right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
**: [[File:Fg_upgrade10.png|center]]
* '''Retention Policies''' If not all attached archive stores are available (State: ''Archive here'', ''Normal''), or their status is ''Write-Protected'', no automatic processing of retention policies takes place. Therefore verify if an archive store is set to ''Disabled'' or ''Write-Protected'' after the upgrade and change it to one of the above states or detach it completely.
* '''Access via Integrated IMAP Server''' To access the archive via the integrated IMAP server, an encrypted connection is now mandatory. If necessary, adjust the configuration of your email clients accordingly and enable TLS or STARTTLS.
* '''Management API Commands Get-/SetComplianceConfiguration''' The property ''globalRetentionTimeYears'' has been removed from the commands. Own scripts using these commands have to be adjusted accordingly. To manage retention policies, two new commands are available: ''GetRetentionPolicies'' and ''SetRetentionPolicies''.

== Upgrading to 10.2 ==
* '''Web Access''' The new responsive Web Access is exclusively available via the HTTPS port. User who are still using the unencrypted HTTP port to access Web Access, will see a corresponding notice about this circumstance. Thus it is recommended to use a trustworthy certificate signed by an official or internal certificate authority. See [[Using Your Own SSL Certificate]] for details.
=== Known Issues ===
* The backend of the new responsive Web Access expects MailStore Server to be reachable on IP address 127.0.0.1 (localhost) and the default TCP port 8460. If you configured MailStore to listen on a specific IP address for MailStore Client connections in the [[MailStore Server Service Configuration]], please reset it to ''(All IP Addresses)'' and ''Port'' 8460. This problem was fixed with version 10.2.3.

== Upgrading to 10.1 ==
* '''Archiving Emails''' If not all attached archive stores are available (State: ''Archive here'', ''Normal'', or ''Write-Protected''), no archiving takes place. Running archiving profiles are terminated with an appropriate message. Under certain circumstances this prevents the creation of duplicate emails while archiving. Therefore verify if an archive store is set to ''disabled'' after the upgrade and change it to one of the above states or detach it completely.
* '''Status Reports''' If a longer period should be covered by status reports, it must be ensured that the profile and job results are kept for at least that period. The default value of previous installations is one week and should be adjusted to the new default value of 90 days.

== Upgrading to Version 10 ==
* '''Encryption Notices''' Due to enhanced encryption mechanisms, MailStore archives that have been upgraded to version 10 are tied to the Windows-Installation on which MailStore Server has been installed. Under certain conditions some actions (e.g. restoring the default admin, attaching foreign archive stores, etc.) in MailStore require the input of a recovery key. By default this is the product key of the installation.Please make sure to store the product key entered during installation in a safe location.In environments with higher security requirements it is recommended to change the default recovery key and, depending on the backup target, exclude the unencrypted search indexes from backups. Corresponding information can be found in the [[MailStore Server Service Configuration]] article.
* '''Upgrade of Master Database''' To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of the MailStore Server service and encrypted afterwards. This process might extend the time required for the first start of the service by several minutes.
* '''Upgrading Archive Stores''' To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:
** Log in as MailStore administrator (admin).
** Click on ''Administrative Tools'' > ''Storage'' and then ''Storage Locations''.
** Either click on the yellow info box to upgrade all archive stores at once or right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
**: [[File:Fg_upgrade10.png|center]]
* '''Archives of Other Users''' These are no longer visible for MailStore administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked. Administrative functions such as deleting or renaming user archives are accessible through [[Archives|Administrative Tools > Users and Archives > Archives]].
* '''Export E-mails''' The previous change may also have an impact on export profiles owned by a MailStore administrator, in case the export scope contains archives of other users. As these are no longer visible to MailStore administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.
* '''Auditing''' All activities that are exclusively executable by MailStore administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of MailStore administrators, excluding ''MessageRetrieveContent'', are written into the audit log.
* '''Default Password''' If you have not changed the default MailStore administrators (admin) password yet, you will be asked to set a new password during the first logon after the update. The same occurs when the password has been reset to ''admin'' after restoring the default admin.

== Upgrading to Version 9.7 ==
* '''Search Indexes''' Due to changes in the area of indexing email attachment contents, the search index settings should be opened and confirmed after the update, so that MailStore can identify potentially missing or unsupported IFilters.
* '''Archiving from Gmail''' This version contains a new Gmail profile, that provides additional functionality such as support for deleting emails from the Gmail mailbox and OAuth2 authentication. Please notice, that it does not support any other folders than "All Mail" and "Sent Items". This new behavior anticipates scenarios which have been recognized as confusing by users in the past and that where caused by the interaction of Gmail labels, IMAP folders and MailStore's single instance store. Existing Google Mail profiles can still be modified and executed, but no new ones can be created. It is recommended to replace old "Google Mail" profiles by this new Gmail profile.

=== Known Issues ===
* Indexing the content of Open Document Format email attachments requires a working installation of OpenOffice or LibreOffice, though Microsoft Office 2010 Filter Pack officially provides support for these file types. Additional information can be found in the [[Search Indexes]] article.

== Upgrading to Version 9.6 ==
* '''Update of MailStore Client and Outlook Add-in''' Independent of MailStore Client's auto-update mechanism, a reinstallation of MailStore Client and the MailStore Outlook Add-in is required to make use of the following improvements:
** Client: Pin to taskbar now possible on Windows 7 and newer.
** Support for different SSL certificate thumbprint formats in group policies.
** Group policies allow configuration of client and Outlook Add-in language.
* '''MailStore Proxy''' Starting with version 9.6, MailStore Proxy requires .NET Framework 4.5.1. Hence the [[MailStore_Proxy#System_Requirements|system requirements of MailStore proxy]] have also changed in regards to the operating system.

== Upgrading to Version 9.3 ==
* '''Supported SSL certificates''' Using SSL certificates which utilize MD5-hash based signature algorithms (e.g. ''md5rsa'') is technically no longer possible since version 9.3. For years (approx. 2010) MD5-hash based signature algorithms have no longer been used for signing certificates. However, should the error message ''Authentication failed because the remote party has closed the transport stream.'' occur after installing the upgrade, please follow the instructions in the corresponding [https://cs.mailstore.com/index.php?/Knowledgebase/Article/View/120/5/erro-message-authentication-failed-because-the-remote-party-has-closed-the-transport-stream Knowledgebase article].

== Upgrading to Version 9.x ==
* '''System Requirements''' Please ensure that your system configuration matches the updated system requirements. MailStore Server, MailStore Client and MailStore Outlook Add-in now require .NET Framework 4.5.1 and Internet Explorer 8 or higher. Thus Windows Vista SP2 or newer is required.
* '''Server-side Execution of E-mail-Server Profiles and Internal Backup''' Archiving from and exporting to email servers as well as the internal backup function is now carried out by the MailStore Server service itself. Thus it is necessary that the MailStore Server computer has the required permissions to access email servers and network shares where applicable (see [[Using Network Attached Storage (NAS)]]). In either case, verify carefully that all automated tasks are still working properly after updating.
* '''Scheduling of Profiles''' For executing archiving and export profiles of type ''E-mail Servers'', an internal scheduler is now used. This scheduler is used for all newly created profiles as soon as automatic execution is enabled in the profile settings. Existing profiles of type ''E-mail Servers'' are set to manual execution after upgrading to MailStore Server 9. Their execution remains triggered based in the corresponding by task in the Windows Task Scheduler. To completely turn these profiles into independent server-side profiles, remove the corresponding task from the Windows Task Scheduler first and then enable automatic execution in the profile setting in MailStore Server. Further information can be found in [[Email_Archiving_with_MailStore_Basics#Working_with_Archiving_Profiles|Working with Archiving Profiles]] and [[Email_Archiving_with_MailStore_Basics#Automating_the_Archiving_Process|Automating the Archiving Process]]
* '''Group Policies''' New ADM and ADMX templates are used for the configuration of MailStore Client and MailStore Outlook Add-in. Group Policies created with the new templates are not compatible with older versions of MailStore Client and MailStore Outlook Add-In, nor does MailStore Client 9 and MailStore Outlook Add-in 9 support Group Policies that have been created based on previous versions of the ADM and ADMX templates. Please replace any existing Group Policies when upgrading to MailStore Server 9. Further information can be found in [[MailStore Client Deployment]] and [[MailStore Outlook Add-in Deployment]].
* '''Automatic Creation of New Archive Stores''' A new default threshold of 5 million emails has been introduced for the automatic creation of new archive stores in MailStore Server 9. For existing installations it is recommended to adjust this value after upgrading to MailStore Server 9 as described in [[Storage Locations]].
* '''PDF Support of Full Text Search''' PDF support has been removed from MailStore Server's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [http://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the MailStore Server computer.
* '''MailStore Server Administration API''' The API has been completely rewritten. As it does not provide and kind of backward compatibility with previous versions, it is required to carefully verify and, if necessary, to modify scripts that make use of the Administration API.
* '''AVM KEN! Support Removed''' After the vendor's support for AVM KEN! has already stopped in September 2010, the support by MailStore ends with MailStore Server 9. Existing AVM KEN! profiles are automatically removed from MailStore - archived emails remain in the archive.

=== Known Issues ===
* '''Missing Email Headers when Printing from MailStore Web Access''' '''''(resolved in version 9.6)''''' Due to the technical implementation of the HTML view, emails printed from within MailStore Web Access do not contain information about sender, recipient and subject. Until a fix is available, the workaround is to open the emails in an email client such as Microsoft Outlook or Mozilla Thunderbird for printing.

== Upgrading to Version 8.x ==

* '''System Requirements''' Please ensure that your system configuration matches the updated system requirements. MailStore Client and MailStore Outlook Add-in now require .NET Framework 3.5 SP1 and Internet Explorer 8 or higher.

== Upgrading to Version 7.0 ==

* '''Management Shell / Batch Scripts''' The server-side part of the Management Shell command set, which included commands such as <code>user-add</code> or <code>filegroup-create</code>, has completely been replaced by the more powerful [[Administration_API_-_Using_the_API|MailStore Server Administration API]]. If you have written custom scripts (e.g. batch scripts) for user management or store management, please update them so that it uses the new command set. [[MailStore_Server_Management_Shell|More information about the MailStore Server Management Shell]]

== Upgrading to Version 6.0 ==

* '''Upgrading File Groups''' The file group format has changed to ensure high performance and stability in the future. To upgrade existing file groups to the new format, proceed as follows:
** Log in as MailStore administrator (admin).
** Click on ''Administrative Tools'' > ''Storage'' and then ''Storage Locations''.
** Either click on the yellow info box to upgrade all file groups at once or right-click on a file group and select ''Perform Upgrade'' to upgrade a single file group.
**: [[File:Fg_upgrade6.png]]
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
** While the upgrade process is running, you will see a window showing information about the upgrade progress. You can click on ''Cancel'' at any time to interrupt the upgrade process in order to continue it later.
* '''Automatic Creation of New File Groups''' If you are using a scheduled task to create new file groups regularly, we recommend to remove that scheduled task and proceed as described in chapter [[Storage_Locations#Creating_File_Groups_Automatically|Creating File Groups Automatically]] of the MailStore Server manual. Please notice the recommended limit of 500.000 messages per file group; that is the default value for all new installations of MailStore Server 6.
* '''Active Directory Integration''' After upgrading to MailStore Server 6 it is required to reconfigure the Active Directory integration with the new Directory Service interface. Please follow the instructions in chapter [[Active Directory Integration]] of the MailStore Server manual. '''Important notice:''' From MailStore Server 6 on, accessing the Active Directory is done under the security scope of the MailStore Server service (instead of MailStore Client). Therefor, please pay attention to ''Authentication'' under ''Specifying Connection Settings''.
* '''Generic LDAP Integration''' After upgrading to MailStore Server 6 it is required to reconfigure the generic LDAP integration with the new Directory Service interface. Please follow the steps in chapter [[Generic LDAP Integration]] of the MailStore Server manual.
* '''Firewall Settings''' If you have set up firewall rules manually to allow access to MailStore Server, MailStore Web Access, MailStore Outlook Add-in or the MailStore integrated IMAP server, we recommend to remove the firewall rules before installing MailStore Server 6. If desired, MailStore Server 6 can set up and update firewall rules on its own, after changes have been made in the [[MailStore Server Service Configuration]] (formerly known as MailStore Server Base Configuration).
* '''No More Separate Downloads''' There is only one MailStore Server setup file, that includes all appropriate setup files for MailStore Client, MailStore Outlook Add-in and MailStore Proxy. MailStore Server setup creates a link on your desktop that opens an Explorer window with the setup files. If the desktop link does not exist you can find the setup files in the ''Setup-<version>'' sub-folder of your MailStore Server installation directory.

== Upgrading to Version 5.0 ==

* '''MailStore Outlook Add-In''' MailStore Outlook Add-in requires access to MailStore Web Access. Should the situation arise that your firewall block the MailStore Web Access ports (default: 8461 for HTTP and 8462 for HTTPS), please reconfigure you firewall accordingly.

== Upgrading to Version 4.5 ==

* '''Database Backups''' Database backup tasks or profiles which were created with an earlier version of MailStore Server need to be re-created with this version. Use the new backup functionality in Administrative Tools which provides you with several new features.
* '''Search Indexes''' If you have created search indexes with a MailStore Server version equal or earlier than 3.0.2, you will be prompted to rebuild them after your first administrator logon to MailStore Server. Depending on the number of users and file groups, this process might take several minutes or hours. You can continue to use MailStore Server during this process, however the search functionality might be limited until the process is finished.

[[de:Hinweise_zum_Update_von_MailStore_Server]]
[[en:Update Notices for MailStore Server]]

Move Archiving Emails from Microsoft 365 - Modern Authentication

2022-10-10T09:28:58Z

Rrommelrath: MS-2288: Changes to the Microsoft-side of Journaling to reflect the new admin center changes that occurred 10/2022.

{{Implementation Guide Preamble|Exchange Online / Microsoft 365|{{#ev:youtube|https://youtu.be/X0Um0cDWGg0|350|right|''Tech Tip: Microsoft 365 Archiving Profiles''}}| Our Tech Tip video shows the essential configuration steps in this article.}}
 
{{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from Microsoft 365 (Modern Authentication) only with the global Microsoft Cloud. National clouds such as ''Microsoft Cloud for US Government'', ''Microsoft Cloud Germany'' (operated by T-Systems) and ''Azure and Microsoft 365 operated by 21Vianet in China'' are not supported. For archiving emails from ''Office 365 Germany'' and ''Office 365 operated by 21Vianet'', please refer to the [[Synchronizing_User_Accounts_with_Microsoft_365_(Basic_Authentication)|corresponding implementation guide]].|For better readability, the terms ''Microsoft 365'' and ''Exchange Online'' are used interchangeably hereinafter instead of ''Exchange Online / Microsoft 365''.}}

== App Registration & User Synchronization ==
Before archiving Microsoft 365 mailboxes, registering MailStore Server in your Microsoft 365 tenant is required. It is also highly recommended to synchronize users in MailStore Server directly with that tenant to fetch all information that is relevant for archiving such as email addresses. The registration and synchronization procedures are described in the chapter [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]] of the MailStore Server manual.

'''Please note:''' MailStore Server runs as a [[MailStore Server Service Configuration|Windows service]] and thus must use ''Application Permissions'' to access user mailboxes in Microsoft 365. By design, on the Microsoft identity platform, which is at the heart of Microsoft 365 authentication and authorization, this permission scope encloses the full level of privileges implied by a permission. As a consequence, once registered as described above, MailStore Server has access to all mailboxes in your Microsoft 365 tenant. Therefore, with regard to security, access to the Microsoft 365 archiving profiles in MailStore Server is limited to MailStore Server administrators.

=== Including Microsoft 365 Shared Mailboxes ===
In Microsoft 365, shared mailboxes are special mailboxes that multiple users have access to. Unlike a normal mailbox, a shared mailbox is not associated to a licensed Microsoft 365 user. For MailStore Server to create user entries for shared mailboxes, you must therefore deactivate the option ''Synchronize licensed Microsoft Exchange Online users only'' in the section [[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)#User_Database_Synchronization|User Database Synchronization]]. 
After synchronization you can grant MailStore Server users access to the archive of the shared mailbox by [[Users,_Folders_and_Settings#Folder_Access_.28e.g._Access_to_the_Emails_of_Other_Users.29|assigning privileges]]. For archiving shared mailboxes, just proceed as for individual or multiple mailboxes as detailed below.

== Archiving Individual Microsoft 365 Mailboxes ==
{{Archiving Single Mailbox Preamble|Microsoft 365}}
For each mailbox, please proceed as follows:

* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 mailbox 01.png|center|347px]]
* Select ''Single Mailbox'' and click on ''OK''.
*; [[File:Microsoft 365 mailbox 02.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* In the ''Mailbox'' field, enter the primary email address of the user whose mailbox you want to archive.
* Click on ''Test'' to verify that MailStore Server can access the mailbox.
* Click on ''Next''.
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections).
*; [[File:Microsoft_365_mailbox_03.png|center|347px]]
* Click on ''Next'' to continue.
* Select the archive of the user for whom the selected mailbox is to be archived. If the user does not exist yet, click on ''Create a New User…''.
*; [[File:Microsoft_365_mailbox_04.png|center|347px]]
* Click on ''Next''.
* In the last step, a name for the archiving profile can be specified. After clicking ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and, if desired, can be run immediately or automatically.

More information on how to execute archiving profiles can be found under the topic [[Email Archiving with MailStore Basics]]

== Archiving Multiple Microsoft 365 Mailboxes Centrally ==
{{Archiving Multiple Mailboxes Preamble|Microsoft 365}}
Please proceed as follows:

* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 mailboxes 01.png|center|347px]]
* Select ''Multiple Mailboxes'' and click ''OK''. 
*; {{Archiving_Multiple_or_Multidrop_Note|multiple mailboxes|[[#App_Registration_.26_User_Synchronization|directory synchronization]]}}
*; [[File:Microsoft 365 mailboxes 02.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 mailboxes 03.png|center|347px]]
* If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. By default, no emails will be deleted from the mailbox. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections). Please keep in mind that these settings apply to all mailboxes to be archived, as specified in the next step.
*; {{Archiving_Multiple_Mailboxes_Centrally_Options|Microsoft_365_mailboxes_04.png|Microsoft 365}}

== Archiving Incoming and Outgoing Emails Directly ==
{{Archiving Exchange Journal Mailbox Preamble|Exchange Online}}

=== Step 1: Setup and Configure MailStore Gateway ===
Please refer to the [https://help.mailstore.com/en/gateway/ MailStore Gateway Manual] for detailed instructions about:

* Installation and Setup of MailStore Gateway
* Logging on to MailStore Gateway's Management Console
* Creating MailStore Gateway mailboxes

After these steps, a mailbox with an individual email address (e.g. mbx-dead1234beef5678@gateway.example.com) should exist.

=== Step 2: Configure MailStore Server ===
{{Archiving MailStore Gateway Mailbox|''In- and Outbound E-Mail Automatically''|Microsoft 365 journal 01.png|Arch_MailStore_Gateway_Office365_02.png|''Microsoft 365''|TargetFolderHint=DontShow|POP3Hint=DontShow|DSLink=[[#App_Registration_.26_User_Synchronization|directory synchronization]]}}

=== Step 3: Creating a Journal Rule ===
The following steps describe how to set up journaling for your Microsoft 365 account.

Since you are planning to use an external mailbox (MailStore Gateway) as the recipient for Journal reports, we highly recommend to first create an external contact with this mail address in your Exchange mailbox administration to prevent any later errors or warnings about an unknown recipient in the process.

* Sign in to the [https://admin.microsoft.com/ Microsoft 365 admin center] as an Exchange or Global Administrator for your Microsoft 365 tenant.
* Expand the left navigation menu by clicking ''Show all''.
* In the ''Admin centers'' section, choose ''Exchange''.
* In the ''Exchange admin center'', either use this [https://compliance.microsoft.com/exchangeinformationgovernance?viewid=exoJournalRule direct link] or use the now following path:
** In the left navigation menu, click "Compliance" (which will direct to a page called "Microsoft Purview")
** In the left navigation menu, select "Data Lifecycle Management", sub-item "Exchange(legacy)".
** On the Journal Rules page, in the top list, select "Journal Rules"
* First set up an alternative journal mailbox via "Settings" on the top right
* With ''Send undeliverable journal reports to'' select an alternate journaling mailbox that receives None Delivery Reports (NDRs) for undeliverable journal reports in case the primary journal mailbox is unreachable. This mailbox must be a dedicated mailbox, any mail sent directly to this mailbox won't be journaled.
* Once the alternative mailbox has been set, create a new journaling rule by clicking on ''+ (New)''.
*:The dialog window ''new journal rule'' opens:
*:[[File:Arch_office365_journal_01.png|center|550px]]
* Enter a name for the journal rule, e.g. ''Journaling''.
* In the ''If the message is sent to or received from…'' section select whether the rule should apply to all messages or to specific users or groups.
* Under ''Journal the following messages…'', choose whether to capture all messages, internally sent messages only, or only those messages with an external sender or recipient.
* Enter the email address of the previously created MailStore Gateway mailbox in the ''Send journal reports to:'' box.
* Click on ''Save'' to activate the rule.

== Public Folders ==
{{Archiving Exchange Public Folders Preamble|Exchange Online|Microsoft 365}}
* Sign in to the [https://admin.microsoft.com/ Microsoft 365 admin center] as an Exchange or Global Administrator for your Microsoft 365 tenant.
* Expand the left navigation menu by clicking ''Show all''.
* In the ''Admin centers'' section, choose ''Exchange''.
* In the ''Exchange admin center'', navigate to ''public folders''.
* Click on the ''Ellipsis (…)'' and select ''Root permissions''.
*: [[File:Microsoft_365_pf_01.png|center|480px]]
* A new browser window opens. Click on ''+ (Add)''.
* Use ''Browse'' to choose the Microsoft 365 user you want to grant permissions.
* Choose ''Custom'' as ''Permission level'' and grant ''Read items'' and ''Delete all'' permissions.
*: [[File:Arch_office365_pf_02.png|center|347px]]
* Click on ''Save''.
* Enable the option ''Apply changes to this public folder and all its subfolders.''
* Click on ''Save''.
* Click on ''Close'' after saving has been completed successfully.

=== Step 3: Setting up the Archiving Process ===
* Log on to MailStore Client as MailStore Server administrator.
* Click on ''Archive Email''.
* From the ''Email Servers'' list in the ''Create Profile'' area of the ''Archive Email'' page, select ''Microsoft 365'' to create a new archiving profile.
* A wizard opens to assist in specifying the archiving settings. 
*; [[File:Microsoft 365 pf 03.png|center|347px]]
* Select ''Public Folders'' and click on ''OK''. 
*; [[File:Microsoft 365 pf 04.png|center|347px]]
* Select the Microsoft 365 credentials that you have created during the registration of MailStore Server with Microsoft 365 from the ''Credentials'' drop-down list. You can also use the button (…) to access the [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server|Credential Manager]].
* In the ''Mailbox'' field, enter the primary email address of the user that has access to the public folders as described above.
* The value of the ''Target Folder'' box defines the top level folder below which the public folder hierarchy will be created in the target archive. Usually, you can leave this value to its default.
* Click on ''Test'' to verify that MailStore can access the public folders.
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 pf 05.png|center|347px]]
* Adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]]. By default, all public folders that contain emails will be archived.
* If needed, adjust [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|the filter]] and the [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]]. By default, no emails will be deleted from the public folders. The ''Timeout'' value only has to be adjusted in specific cases (e.g. with very slow network connections).
* Click on ''Next'' to continue.
*; [[File:Microsoft 365 pf 06.png|center|347px]]
* In the next step, select the archive of the user you have prepared in step 1.
* In the last step, specify a name for the archiving profile. After clicking ''Finish'' the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically if desired.

[[de:E-Mail-Archivierung_von_Microsoft_365_(Modern_Authentication)]]
[[en:Archiving_Emails_from_Microsoft_365_(Modern_Authentication)]]

Administration API - Function Reference

2022-08-22T14:52:38Z

Rrommelrath: /* SetProfileServerSideExecution */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>type</tt>
| string
| Type of archive store.
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Advanced file system-based archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CompactMasterDatabase ==
Compact master database.

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateBackup ==
Create a backup of the entire archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>path</tt>
| string
| Path to directory into which the backup should be written.
|-
| <tt>excludeSearchIndexes</tt>
| bool (optional)
| Indicates whether the search index files should be excluded from the backup.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The id of the time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

=== Argument Values ===

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>type</tt>
| string (optional)
| Type of archive store.
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Standard archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateUser ==
Create new MailStore user. Use [[Administration_API_-_Function_Reference#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] to grant that user privileges on the user's own archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Administration_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| string
| The unique identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| string
| Unique ID of message. Format: <store_id>:<message_num>
|-
| <tt>reason</tt>
| string
| The reason why that message has to be deleted which will be written into the audit log.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.
Neither the user's archive nor the user's archive emails are deleted when deleting a user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== DetachStore ==
Detach an archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== GetActiveSessions ==
Get list of current user sessions.

== GetChildFolders ==
Get child folders.
Depending on compliance settings this method may return only the first folder hierarchy level.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Parent folder whose child folders should be returned. If omitted, all archives and folder will be returned.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

== GetFolderStatistics ==
Get folder statistics.

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

== GetJobs ==
Retrieve list of jobs.

== GetLicenseInformation ==
Retrieve license information.

Example license information object:

{
"productKey": "YOUR-MAIL-STORE-PRODUCT-KEY",
"productVersion": "13.1.0.12345",
"maxNamedUsers": 100,
"namedUsers": 95,
"unusedNamedUsers": 5,
"supportExpiryDate": "2023-12-31",
"supportLevel": "Premium Service",
"validFrom": null,
"validTo": null,
"licensedTo": "MailStore Software GmbH",
"machineName": "MAILSTORE"
}

The properties ''validFrom'' and ''validTo'' are only set when Trial or NFR product keys are used.

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetRetentionPolicies ==
Get the retention policies.

Example retention policies object:

[
{
"name": "Keep All Mails for 10 Years",
"order": 1,
"enabled": true,
"searchCriteria": null,
"period": 10,
"periodInterval": "year",
"delete": false
}
]

== GetServerInfo ==
Get MailStore Server version and machine name.

== GetServiceConfiguration ==
Get MailStore Server service configuration. This includes the path to the Master Database, the location of the audit log, whether the different debug logs are enabled and the endpoint configuration.

== GetSmtpSettings ==
Get current SMTP configuration.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

== GetStoreIndexes ==
Get list of full text indexes.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| Unique ID of archive store.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>includeSize</tt>
| bool (optional)
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
|}

== GetTimeZones ==
Get a list of available time zones.

The ''id'' of the output can be used as ''timeZoneId'' in [[Administration_API_-_Function_Reference#CreateJob|CreateJob]], [[Administration_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Administration_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Administration_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Administration_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== MaintainFileSystemDatabases ==
Run database maintenance on all databases of file system based archive stores.

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== ProcessRetentionPolicies ==
Processes the configured retention policies.

== RebuildSelectedStoreIndexes ==
Rebuild all full-text indexes selected for rebuild.

== RebuildStoreIndex ==
Rebuild search index for given archive folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>folder</tt>
| string
| Name of folder name.
|}

== RecoverStore ==
Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

When the ''recoverDeletedMessages'' parameter is set to ''true'', only deleted messages that still have leftovers in the recovery records can be recovered. When an archive store has been compacted with [[#CompactStore|CompactStore]] or recovery record files have grown to their auto-compacting size of 32 MiB these leftovers could already be removed and deleted messages cannot be recovered.

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records. Cannot be used for external archive stores that store their content in the database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RefreshAllStoreStatistics ==
Refresh statistics of all archive stores.

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RenewMasterKey ==
Renews the master key which is used to encrypt the encryption keys.

== RepairStoreDatabase ==
Tries to resolve certain issues with archive store databases (e.g. missing database indexes).

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RetryOpenStores ==
Retry opening stores that failed previously.

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the MailStore Client. Client side profiles can be started by using the [[MailStore_Server_Management_Shell|MailStoreCmd]] and the commands ''import-execute'' and ''export-execute''.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the MailStore Client.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.

== SelectAllStoreIndexesForRebuild ==
Select all full-text indexes for rebuild.

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use [[Administration_API_-_Function_Reference#GetComplianceConfiguration|GetComplianceConfiguration]] to receive supported values.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"passwordPolicyEnabled": true,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

== SetProfileServerSideExecution ==
Disables or enables the automatic server-sided execution with its parameters.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique profile ID of the profile to be modified.
|-
| <tt>automatic</tt>
| boolean (true/false)
| enables (true) or disables (false) the named profile's server-side automation
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value of seconds to pause between re-executing an automatic profile
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm) for the time window where the execution should not be executed to e.g. schedule maintenance tasks instead.
|}

Use the API command [[Administration_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument automatic=false and no additional parameters to disable the automation, or with automatic=true and at least the automaticPauseBetweenExecutions value given. The automaticMaintenanceWindows parameter is optional to define a maintenance window. If not given, there will be no such window.
Setting an already automated profile to automatic again, will restart the profile.

=== Argument Values ===

==== automatic ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>true</tt>
| Enables the automation for the given profile.
|-
| <tt>false</tt>
| Disables the automation for the given profile.
|}

==== automaticPauseBetweenExecutions ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>0 - 2147483647</tt>
| seconds to pause before re-executing the profile automatically, argument is not allowed when setting automatic to false, required when setting automatic to true.
|}

==== automaticMaintenanceWindows ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>(parameter not given)</tt>
| There will be no maintenance windows, so the automated profile will continue its run/pause cycle over the complete 24 hrs of the day.
|-
| <tt>00:00-23:99</tt>
| There will be a maintenance window from/to the given time in hh:mm, where the profile automation will be paused.
|}

== SetRetentionPolicies ==
Set retention policies.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Retention policy configuration.
|}

To get example policies use the client to create retention policies manually. Then use the API command [[Administration_API_-_Function_Reference#GetRetentionPolicies|GetRetentionPolicies]] to retrieve the json values.

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddresses": ["administrator@example.com", "user@example.com"]
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"sizeThreshold" : int or null,
"databaseBaseDirectory" : string,
"contentBaseDirectory" : string,
"indexBaseDirectory" : string
}
</source>

== SetStoreProperties ==
Set properties of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Set properties of archive store.
|-
| <tt>type</tt>
| string (optional)
|
|-
| <tt>databaseName</tt>
| string (optional)
| Name of database on Microsoft SQL Server or PostgreSQL server.
|-
| <tt>databasePath</tt>
| string (optional)
| Path to directory in which database folder information and email meta data are stored.
|-
| <tt>contentPath</tt>
| string (optional)
| Path to directory in which email headers and contents are stored.
|-
| <tt>indexPath</tt>
| string (optional)
| Path to directory in which full text search indexes are stored.
|-
| <tt>serverName</tt>
| string (optional)
| Name of Microsoft SQL Server or PostgreSQL server.
|-
| <tt>userName</tt>
| string (optional)
| User name for accessing Microsoft SQL Server or PostgreSQL server.
|-
| <tt>password</tt>
| string (optional)
| Password for accessing Microsoft SQL Server or PostgreSQL server.
|}

=== Argument Values ===

==== type ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>FileSystemInternal</tt>
| Advanced file system-based archive store.
|-
| <tt>SQLServer</tt>
| Microsoft SQL Server-based archive store.
|-
| <tt>PostgreSQL</tt>
| PostgreSQL server-based archive store.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Administration_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

== UnlockStore ==
Unlock a foreign archive store. In case an archive store from a foreign MailStore installation is attached, this method can be used to unlock that archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store to unlock.
|-
| <tt>passphrase</tt>
| string
| Product key or recovery key of the foreign MailStore installation.
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the archive store to be verified.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

[[de:Administration API - Function Reference]]
[[en:Administration API - Function Reference]]