https://help.mailstore.com/en/server/api.php?action=feedcontributions&feedformat=atom&user=Cstelzmann 2026-04-09T12:30:10Z User contributions MediaWiki 1.35.14 https://help.mailstore.com/en/server/index.php?title=Graph_API_Error_Codes&diff=8024 2026-04-09T12:18:48Z

<p>Cstelzmann: /* text does not support structured data */</p> <hr /> <div>== text does not support structured data ==<br /> '''Problem:''' While archiving email from Microsoft 365 a Graph API error code ''text does not support structured data'' occurs.<br /> <br /> '''Solution:''' This kind of server error is caused by an internal Microsoft 365 function that is not able to convert a message from its internal format into the RFC822 compliant MIME format which is also used by MailStore Server. In nearly all cases the original MIME message received by the mail server already contained invalid data, such as an appointment request confirmation without references to the original appointment. Therefore it is usually safe to delete those emails.<br /> <br /> Due to that error, the archiving profile itself terminates with a non-successful status code. This behavior can be changed by modifying the global property ''public.arcclient.skipGraphContentConversionFailed'' by executing the following command in [[MailStore_Server_Management_Shell|MailStore's Management Shell]]:<br /> <br /> store-setprop --name=&quot;public.arcclient.skipGraphContentConversionFailed&quot; --value=&quot;true&quot;<br /> <br /> '''Please note:''' Independent of this global property, MailStore Server is neither able to archive messages where the above error occurred nor delete them from the mail server.<br /> <br /> [[de:Graph_API-Fehlermeldungen]]<br /> [[en:Graph_API_Error_Codes]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Server_Help:Books/MailStore_Server_26.1_User_Documentation&diff=7958 2026-01-14T10:58:16Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 26.1 == === User Documentation === :Inform...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 26.1 ==<br /> === User Documentation ===<br /> :[[Information about the Documentation]]<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> <br /> [[Category:Books|MailStore Server 26.1 User Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Server_Help:Books/MailStore_Server_26.1_Operational_Documentation&diff=7957 2026-01-14T10:57:24Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 26.1 == === Operational Documentation === :[...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 26.1 ==<br /> === Operational Documentation ===<br /> :[[Information about the Documentation]]<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> <br /> [[Category:Books|MailStore Server 26.1 Operational Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Server_Help:Books/MailStore_Server_26.1_Technical_System_Documentation&diff=7956 2026-01-14T10:55:41Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 26.1 == === Technical System Documentation =...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 26.1 ==<br /> === Technical System Documentation ===<br /> :[[Information about the Documentation]]<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|MailStore Server 26.1 Technical System Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=EWS_Migration&diff=7955 2026-01-13T11:44:21Z

<p>Cstelzmann: /* What Will Change for MailStore Server and the MailStore SPE? */</p> <hr /> <div>== Microsoft Is Discontinuing Its Exchange Web Services (EWS) for Microsoft 365 ==<br /> Microsoft [https://techcommunity.microsoft.com/blog/exchange/retirement-of-exchange-web-services-in-exchange-online/3924440 has announced] that it will no longer support Exchange Web Services (EWS) for Exchange Online as of October 1, 2026. This decision affects all companies that use EWS in combination with Exchange Online (Microsoft 365).<br /> <br /> EWS is a technology that was developed specifically for accessing Exchange data. The API enables access to data from Microsoft Exchange Server and Exchange Online, including emails and mailboxes. EWS has been a central interface for third-party solutions such as archiving systems.<br /> <br /> What Will Happen in October?<br /> Microsoft plans to disable EWS for Exchange Online starting October 1. This decision will force manufacturers to switch to the Microsoft Graph API.<br /> <br /> Please note: If you use Exchange Online Kiosk, Microsoft Office 365, and Office 365 F1/F3, you should make the change by June. Further information can be found [https://techcommunity.microsoft.com/blog/exchange/update-to-ews-access-for-kiosk--frontline-worker-licensed-users/4474299 here].<br /> <br /> == What Will Change for MailStore Server and the MailStore SPE? ==<br /> The shutdown of EWS initiated by Microsoft will require adjustments to MailStore Server and the MailStore SPE, depending on your archiving strategy.<br /> This is because archiving methods within MailStore Server and MailStore SPE that were accessing EWS will no longer be available from October 1 and will then run into errors. <br /> <br /> The following profiles are expected to be affected from October onwards, Graph API does not expose access to these and support is effectifely dropped:<br /> <br /> * Importing Exchange Online archive mailboxes<br /> * Importing Exchange Online public folders<br /> <br /> Regular Exchange Online Mailboxes and Shared Mailboxes are available using Graph API. New [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication|mailbox archiving profiles]] in MailStore will use Graph API starting with version 26.1. New export profiles will change with version 26.2. Existing EWS archiving and export profiles will work until October 2026. We will offer a migration path in the coming months.<br /> <br /> The [[Email_Archiving_with_MailStore_Basics|summary panel]] of the archiving or export profile tells which protocol is used. Microsoft 365 Journal archiving profiles do not typically use EWS and are therefore not affected.<br /> <br /> [[de:EWS Migration]]<br /> [[en:EWS Migration]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/MailStore_Server_25.4_User_Documentation&diff=7948 2026-01-12T16:46:40Z

<p>Cstelzmann: </p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === User Documentation ===<br /> :[[Information about the Documentation]]<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> <br /> [[Category:Books|MailStore Server 25.4 User Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/MailStore_Server_25.4_Technical_System_Documentation&diff=7947 2026-01-12T16:44:59Z

<p>Cstelzmann: </p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === Technical System Documentation ===<br /> :[[Information about the Documentation]]<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|MailStore Server 25.4 Technical System Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/MailStore_Server_25.4_Operational_Documentation&diff=7946 2026-01-12T16:43:50Z

<p>Cstelzmann: </p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === Operational Documentation ===<br /> :[[Information about the Documentation]]<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> <br /> [[Category:Books|MailStore Server 25.4 Operational Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Information_about_the_Documentation&diff=7945 2026-01-12T16:43:27Z

<p>Cstelzmann: Created page with &quot;__NOTOC__ ==== This documentation consists of three separately provided parts: ==== * User Documentation * Technical System Documentation * Operational Documentation ==== Th...&quot;</p> <hr /> <div>__NOTOC__<br /> <br /> ==== This documentation consists of three separately provided parts: ====<br /> * User Documentation<br /> * Technical System Documentation<br /> * Operational Documentation<br /> <br /> ==== This documentation is provided by: ====<br /> <br /> MailStore Software GmbH&lt;br&gt;<br /> Cloerather Str. 1-3&lt;br&gt;<br /> D-41748 Viersen&lt;br&gt;<br /> &lt;br&gt;<br /> Tel.: +49 (0)2162 - 50299-0&lt;br&gt;<br /> E-Mail: sales@mailstore.com</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/MailStore_Server_25.4_Operational_Documentation&diff=7944 2026-01-12T16:28:43Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.4 == === Operational Documentation === ;S...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === Operational Documentation ===<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> <br /> [[Category:Books|MailStore Server 25.4 Operational Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/MailStore_Server_25.4_Technical_System_Documentation&diff=7943 2026-01-12T16:27:15Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.4 == === Technical System Documentation =...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === Technical System Documentation ===<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|MailStore Server 25.4 Technical System Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/MailStore_Server_25.4_User_Documentation&diff=7942 2026-01-12T16:25:11Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.4 == === User Documentation === ;Archivin...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === User Documentation ===<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> <br /> [[Category:Books|MailStore Server 25.4 User Documentation]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Update_Notices_for_MailStore_Server&diff=7941 2026-01-12T15:30:57Z

<p>Cstelzmann: /* Upgrading to 26.1.0 */</p> <hr /> <div>== General Information ==<br /> <br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Before you start the installation, please check if your current license really allows to upgrade the software.'''&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Before the installation, read the [https://go.mailstore.com?product=MailStore%20Server&amp;target=changelog&amp;lang=en changelog] for information about all changes in the respective versions.'''&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Make sure you have a recent backup of your archive. Learn more about backing up and restoring MailStore Server [[Backup and Restore|here]]'''.&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Make sure the server where MailStore Server is installed on meets the [[System_Requirements|system requirements]]'''.&lt;/p&gt;<br /> * Close all open MailStore programs on the server, such as the MailStore Server Service Configuration, the MailStore Client, and Outlook. Open programs cannot be overwritten by the installation program, and this will result in an access error 5.<br /> * 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.<br /> * Installations with version 23.4 or older must first be updated to version 24.4 and all archive stores must be updated to Firebird 4. You can then update to the latest version. Please also read the [[Update Notices for MailStore Server to version 25.1 or newer]].<br /> * 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.<br /> * Carefully check the auto-detected settings during the installation process.<br /> * Updating the MailStore Client installations and/or the MailStore Outlook Add-In installations is only necessary if this is specifically stated in the version-specific notes.<br /> *; Further information can be found in the articles [[MailStore Client Deployment]] and [[MailStore Outlook Add-in Deployment]]<br /> * 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.<br /> * For versions that are not explicitly listed here, the upgrade notices for preceding versions apply accordingly.<br /> <br /> == Upgrading to 26.1.0 ==<br /> <br /> * External Microsoft SQL and PostgreSQL-based archive stores are deprecated and support will be removed in a future MailStore version.<br /> * New Microsoft 365 mailbox archiving profiles now use the Graph API. Please ensure you have registered the app in Entra ID according to our instructions; in particular, the Mail.ReadWrite permission is now required. This only applies to new profiles!<br /> <br /> == Upgrading to 25.4.0 ==<br /> * MailStore Client prefers Kerberos when Windows Authentication (Single-Sign-on) is configured via GPO.<br /> <br /> == Upgrading to 25.3.1 ==<br /> The known issues of version 25.3.0 have been fixed.<br /> <br /> == Upgrading to 25.3.0 ==<br /> * ''' Microsoft Windows Live Mail '''<br /> *; Support for the Microsoft Windows Live Mail email client has been removed from MailStore in this version.<br /> * ''' SmarterMail '''<br /> *; Support for the SmarterMail email server has been removed from MailStore in this version.<br /> * ''' Directory Service Synchronization '''<br /> *; After updating, check your directory service settings for functionality. Support for older authentication methods has been removed from MailStore in this version (Microsoft 365 Basic authentication and Google Workspace IMAP authentication), and third-party components have been updated.<br /> * ''' SMTP OAuth2 Authentication with Microsoft 365 '''<br /> *; Please note the [[SMTP Settings]] article if you would like to use your existing app registration in Entra ID to transmit emails via Microsoft 365 server.<br /> * ''' Gateway archiving '''<br /> *; Gateway archiving profiles that are meant for Google, generic mail servers and email clients do not extract journal reports and NDRs anymore. When archiving Microsoft 365 journal emails from a MailStore Gateway mailbox ensure you are using the proper Gateway archiving profile before updating. You can tell this because you cannot configure the target path in the archive in the archiving profile and the emails are sorted into the ''Journal Incoming'' and ''Journal Outgoing'' folders.<br /> <br /> === Known Issues ===<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''PostgreSQL databases cannot be loaded after an upgrade. Do not upgrade if you are using PostgreSQL based archive stores.'''&lt;/p&gt; This bug was fixed with version 25.3.1.<br /> * In WebAccess, emails that contain only plain text are not displayed correctly. This bug was fixed with version 25.3.1.<br /> <br /> == Upgrading to 25.2.0 ==<br /> There are no notes for this version.<br /> <br /> == Upgrading to 25.1.0 ==<br /> <br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Only installations with versions 24.2.0 to 24.4.0 can be updated directly.'''&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Until all archive stores have been updated, you must not update to version 25.1.0.'''&lt;/p&gt;<br /> * It is '''obligatory''' to also note the [[Update Notices for MailStore Server to version 25.1 or newer]].<br /> <br /> == Upgrading to 24.4.0 ==<br /> There are no notes for this version.<br /> <br /> == Upgrading to 24.3.0 ==<br /> * Saved searches containing search criteria that can be interpreted as [[Accessing_the_Archive_with_the_MailStore_Client_software#Searching_for_Alternatives|search for alternatives]] will return different search results than before the update.<br /> * Retention policies do not support [[Accessing_the_Archive_with_the_MailStore_Client_software#Searching_for_Alternatives|searches for alternatives]]. In case existing retention policies contain search criteria that can be interpreted as searches for alternatives, those have to be changed for retention policies to being able to be processed again.<br /> <br /> == Upgrading to 24.2.2 ==<br /> <br /> There are no notes for this version.<br /> <br /> == Upgrading to 24.2.1 ==<br /> If you are upgrading from a MailStore version before 24.2.0, please also note the instructions for upgrading to version 24.2.0.<br /> <br /> * '''Upgrading Archive Stores''' &lt;br /&gt;If you upgrade from MailStore 24.2.0, the archive stores need to be upgraded. To do this, proceed as follows:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> :&lt;p class=&quot;mswarning&quot;&gt;Until all archive stores have been upgraded, retention policies are not available.&lt;/p&gt;<br /> <br /> == Upgrading to 24.2.0 ==<br /> * '''Upgrade of Master Database'''&lt;br/&gt;The master database is upgraded to Firebird 4 during the first start of the MailStore Server service. This process might extend the time required for the first start of the service by several minutes.<br /> * '''Upgrading Archive Stores''' &lt;br /&gt;For the update to Firebird 4 the databases of the archive stores must be upgraded. Proceed as follows to upgrade:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> :&lt;p class=&quot;mswarning&quot;&gt;Until all archive stores have been upgraded, retention policies are not available.&lt;/p&gt;<br /> * '''System Requirements'''<br /> *; Internet Explorer support has been removed from MailStore in this version. For a current list of supported browsers, please refer to [[System Requirements]].<br /> * ''' Python API Wrapper '''<br /> *; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.<br /> <br /> === Known Issues ===<br /> * As long as an internal, Firebird-based archive store has not been updated, no recovery records will be written for emails in this archive store. This bug was fixed with version 24.2.1.<br /> * Users who have been synchronized from an Active Directory and who have MailStore multi-factor authentication (MFA) activated cannot log in using Windows authentication. To work around the issue, disable multi-factor authentication for those users in MailStore or let them use their username and password to log in. This bug was fixed with version 24.2.2.<br /> <br /> == Upgrading to 23.4.0 ==<br /> * '''System Requirements'''<br /> *; Windows Server 2012 and Windows Server 2012 R2 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].<br /> * ''' Python API Wrapper '''<br /> *; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.<br /> <br /> == Upgrading to 23.3.0 ==<br /> * ''' Microsoft Exchange 2013 Support '''<br /> *; Support for Microsoft Exchange 2013 has been removed from MailStore in this version.<br /> <br /> == Upgrading to 23.2.0 ==<br /> * ''' Outlook Add-in '''<br /> *; Starting with version 23.2.0, MailStore Server supports multi-factor authentication for users with integrated authentication. To support multi-factor authentication an update of the Outlook Add-in is required.<br /> *; The Outlook Add-In 23.2.0 is not backward compatible with older MailStore Server versions. When updating, MailStore Server should be updated first and then the Outlook Add-in.<br /> * ''' Scheduled Tasks, Management API, IMAP Access '''&lt;br /&gt;<br /> *; When multi-factor authentication is enabled for a user and that user wants to schedule client-side archiving profiles, access the Management API or access the IMAP server, an app password has to be used instead of the regular password.<br /> * ''' Python API Wrapper '''<br /> *; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.<br /> <br /> == Upgrading to 23.1.2 ==<br /> * &lt;p class=&quot;mswarning&quot;&gt;&lt;b&gt;Important:&lt;/b&gt; Let's Encrypt has announced to change their production request flow permanently on April 24th 2023. After that date, previous versions of MailStore Server will not be able to successfully request certificates from Let's Encrypt.&lt;/p&gt;<br /> <br /> == Upgrading to 23.1.0 ==<br /> * '''System Requirements'''<br /> *; Windows 7, Windows 8.1, Windows Server 2008 R2 and Windows Small Business Server 2011 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].<br /> <br /> == Upgrading to 22.4.0 ==<br /> There are no notes for this version.<br /> <br /> == Upgrading to 22.3.0 ==<br /> * ''' Outlook Add-in '''<br /> *; 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.<br /> <br /> == Upgrading to 22.2.x ==<br /> * '''System Requirements'''<br /> *; 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]].&lt;br/&gt;&lt;p class=&quot;mswarning&quot;&gt;If the framework is installed by the MailStore setup, the system might reboot without further notice.&lt;/p&gt;<br /> * '''External Archive Stores'''<br /> *; Starting with version 22.2, only versions 10 or newer are supported for PostgreSQL.<br /> <br /> == Upgrading to 13.x ==<br /> * '''Update of MailStore Client and Outlook Add-in'''&lt;br/&gt;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:<br /> ** Unified validation of TLS certificates.<br /> ** Unified evaluation of group policies.<br /> ** Distinct error messages for certain certificate errors.<br /> ** 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.<br /> * '''Unencrypted Connections'''<br /> *; 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.<br /> * '''HTTP-to-HTTPS Redirect'''<br /> *; 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.<br /> * '''Windows Authentication'''<br /> *; 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]].<br /> * '''Microsoft 365 Support'''<br /> *; 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 &amp; 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.&lt;br/&gt;&lt;p class=&quot;mswarning&quot;&gt;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.&lt;/p&gt;<br /> * '''Google Workspace Support'''<br /> *; The [[Google Workspace Integration|Google Workspace directory service synchronization profile]] has been extended with support for modern authentication (OAuth 2.0 &amp; 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.&lt;br/&gt;&lt;p class=&quot;mswarning&quot;&gt;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''.&lt;/p&gt;<br /> * '''IMAP Access to Archive'''<br /> *; 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. <br /> * '''Startup Scripts'''<br /> *; 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.<br /> * '''Mobile Web Access'''<br /> *; 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.<br /> * '''Legacy Web Access'''<br /> *; 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.<br /> * '''Group Policies'''<br /> *; The following group policy settings are no longer supported in MailStore 13:<br /> ** '''MailStore Client: Accept Thumbprint'''<br /> **; 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. <br /> ** '''MailStore Outlook Add-in: Accept Thumbprint'''<br /> **; 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.<br /> ** '''MailStore Outlook Add-in: Enable TLS/SSL encryption'''<br /> **; 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.<br /> <br /> == Upgrading to 12.1 ==<br /> * '''System Requirements'''<br /> *; 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]].<br /> <br /> == Upgrading to 12 ==<br /> * '''Expired Certificates'''<br /> *; 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.<br /> * '''Using Certificates'''<br /> *; 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.<br /> <br /> == Upgrading to 11 ==<br /> * '''Upgrading Archive Stores'''<br /> *; &lt;p class=&quot;mswarning&quot;&gt;'''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.'''&lt;/p&gt;<br /> *; Until the archive stores have been upgraded, not all functionality of the software is available. To facilitate<br /> ** retention policies,<br /> ** the search functionality,<br /> ** the improved recovery records,<br /> *; the databases of the archive stores must be upgraded.<br /> *;Proceed as follows to upgrade:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> * '''Retention Policies'''&lt;br/&gt;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.<br /> * '''Access via Integrated IMAP Server'''&lt;br/&gt;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.<br /> * '''Management API Commands Get-/SetComplianceConfiguration'''&lt;br/&gt;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''.<br /> <br /> == Upgrading to 10.2 ==<br /> * '''Web Access'''&lt;br/&gt;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.<br /> === Known Issues ===<br /> * 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.<br /> <br /> == Upgrading to 10.1 ==<br /> * '''Archiving Emails'''&lt;br/&gt;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. <br /> * '''Status Reports'''&lt;br/&gt;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.<br /> <br /> == Upgrading to Version 10 ==<br /> * '''Encryption Notices'''&lt;br/&gt;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.&lt;p class=&quot;mswarning&quot;&gt;Please make sure to store the product key entered during installation in a safe location.&lt;/p&gt;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.<br /> * '''Upgrade of Master Database'''&lt;br/&gt;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.<br /> * '''Upgrading Archive Stores''' &lt;br /&gt;To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> * '''Archives of Other Users'''&lt;br/&gt;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 &gt; Users and Archives &gt; Archives]].<br /> * '''Export E-mails'''&lt;br/&gt;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.<br /> * '''Auditing'''&lt;br/&gt;All activities that are exclusively executable by MailStore administrators are displayed as ''Enabled (locked)'' at ''Compliance'' &gt; ''Auditing''. Irrespective of the ''Disabled'' status, all activities of MailStore administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br /> * '''Default Password'''&lt;br/&gt;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.<br /> <br /> == Upgrading to Version 9.7 ==<br /> * '''Search Indexes'''&lt;br/&gt;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.<br /> * '''Archiving from Gmail'''&lt;br/&gt;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 &quot;All Mail&quot; and &quot;Sent Items&quot;. 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 &quot;Google Mail&quot; profiles by this new Gmail profile.<br /> <br /> === Known Issues ===<br /> * 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.<br /> <br /> == Upgrading to Version 9.6 ==<br /> * '''Update of MailStore Client and Outlook Add-in'''&lt;br/&gt;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:<br /> ** Client: Pin to taskbar now possible on Windows 7 and newer.<br /> ** Support for different SSL certificate thumbprint formats in group policies.<br /> ** Group policies allow configuration of client and Outlook Add-in language.<br /> * '''MailStore Proxy'''&lt;br/&gt;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.<br /> <br /> == Upgrading to Version 9.3 ==<br /> * '''Supported SSL certificates''' &lt;br/&gt;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].<br /> <br /> == Upgrading to Version 9.x ==<br /> * '''System Requirements''' &lt;br/&gt;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.<br /> * '''Server-side Execution of E-mail-Server Profiles and Internal Backup'''&lt;br/&gt;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)]]).&lt;br /&gt;&lt;p class=&quot;mswarning&quot;&gt;In either case, verify carefully that all automated tasks are still working properly after updating.&lt;/p&gt;<br /> * '''Scheduling of Profiles''' &lt;br/&gt;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.&lt;br/&gt;&lt;br/&gt;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]]<br /> * '''Group Policies''' &lt;br/&gt;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]].<br /> * '''Automatic Creation of New Archive Stores''' &lt;br/&gt;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]]. <br /> * '''PDF Support of Full Text Search''' &lt;br /&gt;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.<br /> * '''MailStore Server Administration API''' &lt;br /&gt;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.<br /> * '''AVM KEN! Support Removed''' &lt;br /&gt;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.<br /> <br /> === Known Issues ===<br /> * '''Missing Email Headers when Printing from MailStore Web Access''' '''''(resolved in version 9.6)'''''&lt;br /&gt;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.<br /> <br /> == Upgrading to Version 8.x ==<br /> <br /> * '''System Requirements''' &lt;br/&gt;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.<br /> <br /> == Upgrading to Version 7.0 ==<br /> <br /> * '''Management Shell / Batch Scripts''' &lt;br /&gt; The server-side part of the Management Shell command set, which included commands such as &lt;code&gt;user-add&lt;/code&gt; or &lt;code&gt;filegroup-create&lt;/code&gt;, 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]]<br /> <br /> == Upgrading to Version 6.0 ==<br /> <br /> * '''Upgrading File Groups''' &lt;br /&gt; 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:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> **: [[File:Fg_upgrade6.png]]<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> ** 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.<br /> * '''Automatic Creation of New File Groups''' &lt;br /&gt; 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.<br /> * '''Active Directory Integration''' &lt;br /&gt; 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. &lt;br /&gt; '''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''.<br /> * '''Generic LDAP Integration''' &lt;br /&gt; 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.<br /> * '''Firewall Settings''' &lt;br /&gt; 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).<br /> * '''No More Separate Downloads''' &lt;br /&gt; 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-&lt;version&gt;'' sub-folder of your MailStore Server installation directory.<br /> <br /> == Upgrading to Version 5.0 ==<br /> <br /> * '''MailStore Outlook Add-In''' &lt;br/&gt; 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.<br /> <br /> == Upgrading to Version 4.5 ==<br /> <br /> * '''Database Backups''' &lt;br/&gt;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.<br /> * '''Search Indexes''' &lt;br/&gt;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.<br /> <br /> [[de:Hinweise_zum_Update_von_MailStore_Server]]<br /> [[en:Update Notices for MailStore Server]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Moving_the_Archive&diff=7934 2026-01-08T10:11:25Z

<p>Cstelzmann: /* Moving the Content of an Archive Store to a different Archive Store */</p> <hr /> <div>It is possible to move a single archive store, its components or the complete MailStore Server archive to a new hard-disk, machine or network share at any time. What is required to successfully move an archive is described in the following sections.<br /> <br /> == Moving an Entire Single Archive Store ==<br /> To move an entire archive store to a different hard-disk or network share, follow the instructions below. The MailStore master database and all other archive stores remain unchanged.<br /> <br /> When moving an archive store to a network share, the information from the article [[Using Network Attached Storage (NAS)]] are also applicable.<br /> <br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> [[File:Tech_storageloc_01.png|center|550px]]<br /> * Follow these steps for the archive store you want to move:<br /> :* Make note of the status and the path on disk. You can find this information in the summary next to the archive store list.<br /> :* Change the status to ''Disabled''.<br /> :* In the file system, move the folder you've jotted down in the first step to the new location.<br /> :* In the context menu or in the details pane, click on ''Edit...''<br /> :* The ''Edit Archive Store Properties'' dialog opens.<br /> :* Change the base directory to the new folder. If a network share is used, enter the UNC path of the share i.e. &lt;code&gt;\\computer\myshare\folder&lt;/code&gt;.<br /> :* Click on ''Finish''.<br /> :* Change the status of the archive store back to the one you've noted in the first step.<br /> <br /> == Moving Components of an Archive Store ==<br /> In MailStore, archive stores always consist of the following three components:<br /> {{Archive_Stores_Structure}}<br /> These individual components can be moved to different physical storages. For example, you can move the database with folder information and meta data as well as the search index on a fast storage to accelerate folder operations and the MailStore search while leaving the email content files on a slower storage.&lt;br/&gt;<br /> To move parts of an archive store to another hard-disk or network share, follow the instructions below. The MailStore master database and all other archive stores remain unchanged.<br /> <br /> When moving an archive store to a network share, the information from the article [[Using Network Attached Storage (NAS)]] are also applicable.<br /> <br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> * Follow these steps for the archive store you want to move parts of:<br /> :* Make note of the status. You can find this information in the summary next to the archive store list.<br /> :* [[File:Tech_storageloc_03.png|right|350px]]Change the status to ''Disabled''.<br /> :* In the context menu or in the details pane, click on ''Edit...''<br /> :* The ''Edit Archive Store Properties'' dialog opens.<br /> :* Enable the option ''Use different directories for database, content and search index''. The folders of the individual archive store components are shown.<br /> :* In the file system, move the folders to their new locations.<br /> :* In the dialog, change the base directories to the new folders. If network shares are used, enter the UNC paths of the shares i.e. &lt;code&gt;\\computer\myshare\folder&lt;/code&gt;.<br /> :* Click on ''Finish''.<br /> :* Change the status of the archive store back to the one you've noted in the first step.<br /> <br /> <br /> == Moving the Archive to a Different Hard-Disk ==<br /> To move a MailStore Server installation, where all archive stores are located underneath the directory of the master database (default: &lt;code&gt;C:\MailArchive&lt;/code&gt;), to a different hard-disk, follow the steps below. The MailStore program directory remains unchanged. <br /> <br /> * Stop the MailStore Server service through the [[MailStore Server Service Configuration]].<br /> * Move the master database directory (default: &lt;code&gt;C:\MailArchive&lt;/code&gt;) and all subdirectories to the new location. The folder structure must remain unchanged.<br /> * Use the MailStore Server Service Configuration to change the directory of the &quot;Master Database&quot; to the new location.<br /> * Start the MailStore Server service again.<br /> <br /> '''Notice:''' Please be aware that the throughput of an external hard-disk may have a negative impact on the performance of MailStore Server.<br /> <br /> '''Please note:''' Archive stores that are not stored in a relative path to the master database may have to be re-attached or their paths edited after moving the archive. Details about managing archive stores are available in chapter [[Storage Locations]] of the MailStore Server manual.<br /> <br /> == Moving the Archive to a New Machine ==<br /> {{Multiline Notices|Heading=Important Notices|To move your MailStore archive to a new machine, you need your license key (Product-Key) and the computer name (Machine-Name) of the computer on which MailStore Server was previously installed. You can find both in the MailStore Client in the Administrative Tools under Miscellaneous &gt; License Management.|Only migrations to the same or newer versions are supported.|If you want to update to MailStore 25.1 or newer, read [[Update Notices for MailStore Server]] and the [[Update Notices for MailStore Server to version 25.1 or newer]]}}<br /> <br /> To move a MailStore Server archive, including all users, settings and emails, to a new machine, follow these steps:<br /> {{#ev:youtube|https://youtu.be/3XZgBhFgya0|350|center|''Tech Tip: How to Move MailStore Server''}}<br /> * Create a [[Backup_and_Restore|backup]] of the archive.<br /> * Stop the MailStore Server service on the current machine through the [[MailStore Server Service Configuration]].<br /> * Move the master database directory (default: &lt;code&gt;C:\MailArchive&lt;/code&gt;), all of its subdirectories and all archive stores that exist on the current machine to the new machine. The folder structure must remain unchanged.<br /> * Uninstall MailStore Server on the current machine.<br /> * Transfer your MailStore Server license to the new machine through our [https://my.mailstore.com/TransferLicense license portal].<br /> * [https://my.mailstore.com/downloads Install MailStore Server] on the new machine. You can install the latest version. Please note the [[Update_Notices_for_MailStore_Server|update notes]] and the [[Update Notices for MailStore Server to version 25.1 or newer]].<br /> * If the location of the master database directory to use does not match the default path &lt;code&gt;C:\MailArchive&lt;/code&gt;, run the MailStore Server Service Configuration, stop the MailStore Server service and change the directory of the &quot;Master Database&quot; to the new location.<br /> * If you have any client-sided scheduled tasks and are using your own SSL certificate, export the SSL certificate and private key (usually packaged in a PKCS#12 file) which is used by MailStore Server from the machines certificate store and import it to the same location on the new machine. Refer to the Windows help for further information about managing SSL certificates.<br /> * In case the new installation is using the same product key than the old installation and the product key is used as recovery key, nothing has to be done in regards to [[MailStore_Server_Service_Configuration#Security_and_Encryption|archive security]]. In case a different product key is used on the new machine or the archive was secured with a [[MailStore_Server_Service_Configuration#Set_Recovery_Key|generated random value]] the archive must be [[MailStore_Server_Service_Configuration#Reinitialize_Archive_Encryption|reinitialized]] before the first start.<br /> * Start the MailStore Server service on the new machine if it's not running.<br /> <br /> '''Please note:''' Archive stores that are not stored in a relative path to the master database may have to be re-attached or their paths edited after moving the archive. Details about managing archive stores are available in chapter [[Storage Locations]] of the MailStore Server manual.<br /> <br /> == Moving the Archive to a Network Share ==<br /> To move a MailStore Server archive, including all users, settings and emails, to a network share, follow the instructions below. The information from the article [[Using Network Attached Storage (NAS)]] are also applicable. The MailStore program directory remains unchanged.<br /> <br /> * Stop the MailStore Server service through the [[MailStore Server Service Configuration]].<br /> * Create a new share on the NAS-system.<br /> * Either grant the MailStore Server machine account or a user read-/write-permissions on that newly created share.<br /> * If you granted the permissions to a user object, configure MailStore Server as described in [[Using Network Attached Storage (NAS)]].<br /> * Move all files from the original archive folder to the network share.<br /> * Use the MailStore Server Service Configuration to set the path to the MailStore Server Master-Database to the UNC path of the share, i.e. &lt;code&gt;\\computer\myshare&lt;/code&gt;.<br /> * Start the MailStore Server service again.<br /> <br /> '''Please note:''' Archive stores that are not stored in a relative path to the master database may have to be re-attached or their paths edited after moving the archive. Details about managing archive stores are available in chapter [[Storage Locations]] of the MailStore Server manual.<br /> <br /> == Moving an Archive Store to a Different Installation ==<br /> To move an archive store to a different installation, follow the instructions below. The product key or the recovery key of the installation where the archive store is coming from is required.<br /> <br /> &lt;p class=msnote&gt;'''Please note:''' The archive store must be on version 7 or higher, so that it can move to a different archive. If that is not the case, the archive store and the associated Master Database have to be loaded once with MailStore Server 7 or higher, because then some necessary database upgrades will be performed.&lt;/p&gt;<br /> <br /> <br /> {{Multiline Notices|Heading=Important Notices|Only migrations to installations of the same or a newer version are supported.|If you want to move the archive store from a version prior to 25.1 to an installation of MailStore 25.1 or newer, all archive store databases must have been updated to Firebird 4. Please read the [[Update Notices for MailStore Server to version 25.1 or newer]].}}<br /> <br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges on the installation where the archive store is still attached to.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> * [[Storage_Locations#Detaching|Detach]] the archive store you want to move.<br /> * Move the folder or folders of the archive store to the new location.<br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges on the installation where the archive store will be attached to.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> * [[Storage_Locations#Attaching|Attach]] the moved archive store.<br /> <br /> == Moving the Content of an Archive Store to a different Archive Store ==<br /> <br /> Under certain circumstances it may be required that messages from one or more archive stores need to be copied to another archive store. E.g. the content of external Microsoft-SQL or PostgreSQL based archive stores needs to be transferred or when lots of small archive stores should be merged into one or more larger ones. When the copy process has finished, the source archive stores can usually be detached, because the content is available through the target store.<br /> <br /> There are some requirements before the process can be started:<br /> <br /> * Although the process is designed so it can be run while archiving processes are running and users are accessing their archives we recommend to start MailStore Server in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]]. <br /> * The [[MailStore_Server_Service_Configuration#Debug_Log|debug log]] has to be turned on in the MailStore Server Service Configuration.<br /> * The [[Storage_Locations#Setting_the_Status|status of all the source archive stores]] need to be set to ''Write-Protected'' so these are not modified while the process is running. Source archive stores also cannot be in an error state.<br /> * The resulting archive store size cannot exceed 30,000,000 messages. When the target store is selected automatically, new stores are created on demand. The settings to automatically create new stores when the size limit is reached is heeded. When the target store is selected manually, the process will not start when the sum of all messages of this store would exceed 30,000,000 messages.<br /> * The target store should be an internal archive store, since support for external archive stores is deprecated and will be removed in a future version.<br /> <br /> &lt;p class=msnote&gt;'''Important notice:''' Depending on the amount of mail to be copied the process will take some time. While the process is running, ensure that external backup tools are not accessing MailStore data, the server is not restarted, network shares are accessible, databases are reachable, etc.&lt;/p&gt;<br /> <br /> To transfer messages, the ''TransferStores'' command has to be executed in the [[MailStore_Server_Management_Shell|MailStore Server Management Shell]].<br /> <br /> The management shell can be started directly from MailStore: Log on to MailStore Client as administrator and click on Administrative Tools &gt; Management API &gt; Command Prompt.<br /> <br /> The syntax of the command is:<br /> TransferStores --sourceStores=&lt;String&gt; [--targetStore=&lt;Number&gt;] [--startIndex=&lt;String&gt;]<br /> <br /> <br /> {| class=&quot;wikitable&quot; <br /> ! width=20% | Parameter <br /> ! width=70% | Description<br /> |-<br /> | &lt;code&gt;--sourceStores&lt;/code&gt;<br /> | A comma separated list of the IDs of the source archive stores.<br /> |-<br /> | &lt;code&gt;--targetStore&lt;/code&gt;<br /> | Optional. ID of the target archive store. If no value is given the archive store marked as ''archive here'' is used.<br /> |-<br /> | &lt;code&gt;--startIndex&lt;/code&gt;<br /> | Optional. In case a previous run of TransferStores has been interrupted, a start index can be given. Messages coming before the start index will be skipped.<br /> |}<br /> <br /> * We recommend to check if the [[Search_Indexes|search index configuration]] needs any changes before starting the process, so that the transferred mails are directly indexed according to your needs.<br /> * Visit the [[Storage_Locations|storage locations page]], and take note of the IDs of the archive stores whose mails shall be transferred. When desired, create a new internal store. Ensure that the status of the target store is ''Archive here'' or ''Normal''. Take note of the ID of that store as well. Ensure that the status of the source stores is ''Write-Protected''.<br /> * Navigate to the [[MailStore_Server_Management_Shell|Management Shell]].<br /> * Execute the ''TransferStores'' command and wait for it to finish. See the ''Examples'' section below. This client session cannot be used for anything else, it has to wait for the process to finish.<br /> * In case the process aborted, check the debug log for details, it can be found in ''C:\ProgramData\MailStore\Debug Log''. The Management Shell also shows the command, which continues the process where it stopped.<br /> * When the process has finished without any errors, detach the source archive stores using the [[Storage_Locations|storage locations page]].<br /> * Verify that all mails have been copied.<br /> * Leave Safe Mode by restarting MailStore Server.<br /> * Remove artifacts of source archive store from filesystem, e.g. index files or ''Content'' folder, depending on your configuration.<br /> <br /> === Examples ===<br /> <br /> Use the following command to transfer all messages of archive store with ID 1 to the archive store marked as ''archive here''. When there are already messages in the target store, all messages of archive store 1 will be appended. When the threshold for the maximum amount of mails is reached, a new store is created automatically.<br /> <br /> TransferStores --sourceStores=1<br /> <br /> Use the following command to transfer all messages of archive stores with IDs 1, 2 and 3 to the archive store marked as ''archive here''. When there are already messages in the target store, all messages of archive stores 1,2 and 3 will be appended. When the threshold for the maximum amount of mails is reached, a new store is created automatically.<br /> <br /> TransferStores --sourceStores=1,2,3<br /> <br /> The order of the source store IDs is heeded. So the following command will process the source stores in the given order.<br /> <br /> TransferStores --sourceStores=3,1,2<br /> <br /> Use the following command to transfer all messages of archive store with ID 1 to the archive store with ID 4. When there are already messages in the target store, all messages of archive store 1 will be appended. When a target store is given, a check verifies that the resulting store will not exceed 30,000,000 messages. No new stores will be created automatically:<br /> <br /> TransferStores --sourceStores=1 --targetStore=4<br /> <br /> Use the following command to transfer messages of archive store with ID 1 and 2 beginning from mails with the internal mail ID 1000 of store 1 to the archive store with ID 4. When there are already messages in the target store, messages of archive stores 1 and 2 will be appended. When a target store is given, a check verifies that the resulting store will not exceed 30,000,000 messages. No new stores will be created automatically:<br /> <br /> TransferStores --sourceStores=1,2 --targetStore=4 --startIndex=1:1000<br /> <br /> [[de:Umziehen des Archivs]]<br /> [[en:Moving the Archive]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Moving_the_Archive&diff=7933 2026-01-08T09:38:49Z

<p>Cstelzmann: /* Moving the Content of an Archive Store to a different Archive Store */</p> <hr /> <div>It is possible to move a single archive store, its components or the complete MailStore Server archive to a new hard-disk, machine or network share at any time. What is required to successfully move an archive is described in the following sections.<br /> <br /> == Moving an Entire Single Archive Store ==<br /> To move an entire archive store to a different hard-disk or network share, follow the instructions below. The MailStore master database and all other archive stores remain unchanged.<br /> <br /> When moving an archive store to a network share, the information from the article [[Using Network Attached Storage (NAS)]] are also applicable.<br /> <br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> [[File:Tech_storageloc_01.png|center|550px]]<br /> * Follow these steps for the archive store you want to move:<br /> :* Make note of the status and the path on disk. You can find this information in the summary next to the archive store list.<br /> :* Change the status to ''Disabled''.<br /> :* In the file system, move the folder you've jotted down in the first step to the new location.<br /> :* In the context menu or in the details pane, click on ''Edit...''<br /> :* The ''Edit Archive Store Properties'' dialog opens.<br /> :* Change the base directory to the new folder. If a network share is used, enter the UNC path of the share i.e. &lt;code&gt;\\computer\myshare\folder&lt;/code&gt;.<br /> :* Click on ''Finish''.<br /> :* Change the status of the archive store back to the one you've noted in the first step.<br /> <br /> == Moving Components of an Archive Store ==<br /> In MailStore, archive stores always consist of the following three components:<br /> {{Archive_Stores_Structure}}<br /> These individual components can be moved to different physical storages. For example, you can move the database with folder information and meta data as well as the search index on a fast storage to accelerate folder operations and the MailStore search while leaving the email content files on a slower storage.&lt;br/&gt;<br /> To move parts of an archive store to another hard-disk or network share, follow the instructions below. The MailStore master database and all other archive stores remain unchanged.<br /> <br /> When moving an archive store to a network share, the information from the article [[Using Network Attached Storage (NAS)]] are also applicable.<br /> <br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> * Follow these steps for the archive store you want to move parts of:<br /> :* Make note of the status. You can find this information in the summary next to the archive store list.<br /> :* [[File:Tech_storageloc_03.png|right|350px]]Change the status to ''Disabled''.<br /> :* In the context menu or in the details pane, click on ''Edit...''<br /> :* The ''Edit Archive Store Properties'' dialog opens.<br /> :* Enable the option ''Use different directories for database, content and search index''. The folders of the individual archive store components are shown.<br /> :* In the file system, move the folders to their new locations.<br /> :* In the dialog, change the base directories to the new folders. If network shares are used, enter the UNC paths of the shares i.e. &lt;code&gt;\\computer\myshare\folder&lt;/code&gt;.<br /> :* Click on ''Finish''.<br /> :* Change the status of the archive store back to the one you've noted in the first step.<br /> <br /> <br /> == Moving the Archive to a Different Hard-Disk ==<br /> To move a MailStore Server installation, where all archive stores are located underneath the directory of the master database (default: &lt;code&gt;C:\MailArchive&lt;/code&gt;), to a different hard-disk, follow the steps below. The MailStore program directory remains unchanged. <br /> <br /> * Stop the MailStore Server service through the [[MailStore Server Service Configuration]].<br /> * Move the master database directory (default: &lt;code&gt;C:\MailArchive&lt;/code&gt;) and all subdirectories to the new location. The folder structure must remain unchanged.<br /> * Use the MailStore Server Service Configuration to change the directory of the &quot;Master Database&quot; to the new location.<br /> * Start the MailStore Server service again.<br /> <br /> '''Notice:''' Please be aware that the throughput of an external hard-disk may have a negative impact on the performance of MailStore Server.<br /> <br /> '''Please note:''' Archive stores that are not stored in a relative path to the master database may have to be re-attached or their paths edited after moving the archive. Details about managing archive stores are available in chapter [[Storage Locations]] of the MailStore Server manual.<br /> <br /> == Moving the Archive to a New Machine ==<br /> {{Multiline Notices|Heading=Important Notices|To move your MailStore archive to a new machine, you need your license key (Product-Key) and the computer name (Machine-Name) of the computer on which MailStore Server was previously installed. You can find both in the MailStore Client in the Administrative Tools under Miscellaneous &gt; License Management.|Only migrations to the same or newer versions are supported.|If you want to update to MailStore 25.1 or newer, read [[Update Notices for MailStore Server]] and the [[Update Notices for MailStore Server to version 25.1 or newer]]}}<br /> <br /> To move a MailStore Server archive, including all users, settings and emails, to a new machine, follow these steps:<br /> {{#ev:youtube|https://youtu.be/3XZgBhFgya0|350|center|''Tech Tip: How to Move MailStore Server''}}<br /> * Create a [[Backup_and_Restore|backup]] of the archive.<br /> * Stop the MailStore Server service on the current machine through the [[MailStore Server Service Configuration]].<br /> * Move the master database directory (default: &lt;code&gt;C:\MailArchive&lt;/code&gt;), all of its subdirectories and all archive stores that exist on the current machine to the new machine. The folder structure must remain unchanged.<br /> * Uninstall MailStore Server on the current machine.<br /> * Transfer your MailStore Server license to the new machine through our [https://my.mailstore.com/TransferLicense license portal].<br /> * [https://my.mailstore.com/downloads Install MailStore Server] on the new machine. You can install the latest version. Please note the [[Update_Notices_for_MailStore_Server|update notes]] and the [[Update Notices for MailStore Server to version 25.1 or newer]].<br /> * If the location of the master database directory to use does not match the default path &lt;code&gt;C:\MailArchive&lt;/code&gt;, run the MailStore Server Service Configuration, stop the MailStore Server service and change the directory of the &quot;Master Database&quot; to the new location.<br /> * If you have any client-sided scheduled tasks and are using your own SSL certificate, export the SSL certificate and private key (usually packaged in a PKCS#12 file) which is used by MailStore Server from the machines certificate store and import it to the same location on the new machine. Refer to the Windows help for further information about managing SSL certificates.<br /> * In case the new installation is using the same product key than the old installation and the product key is used as recovery key, nothing has to be done in regards to [[MailStore_Server_Service_Configuration#Security_and_Encryption|archive security]]. In case a different product key is used on the new machine or the archive was secured with a [[MailStore_Server_Service_Configuration#Set_Recovery_Key|generated random value]] the archive must be [[MailStore_Server_Service_Configuration#Reinitialize_Archive_Encryption|reinitialized]] before the first start.<br /> * Start the MailStore Server service on the new machine if it's not running.<br /> <br /> '''Please note:''' Archive stores that are not stored in a relative path to the master database may have to be re-attached or their paths edited after moving the archive. Details about managing archive stores are available in chapter [[Storage Locations]] of the MailStore Server manual.<br /> <br /> == Moving the Archive to a Network Share ==<br /> To move a MailStore Server archive, including all users, settings and emails, to a network share, follow the instructions below. The information from the article [[Using Network Attached Storage (NAS)]] are also applicable. The MailStore program directory remains unchanged.<br /> <br /> * Stop the MailStore Server service through the [[MailStore Server Service Configuration]].<br /> * Create a new share on the NAS-system.<br /> * Either grant the MailStore Server machine account or a user read-/write-permissions on that newly created share.<br /> * If you granted the permissions to a user object, configure MailStore Server as described in [[Using Network Attached Storage (NAS)]].<br /> * Move all files from the original archive folder to the network share.<br /> * Use the MailStore Server Service Configuration to set the path to the MailStore Server Master-Database to the UNC path of the share, i.e. &lt;code&gt;\\computer\myshare&lt;/code&gt;.<br /> * Start the MailStore Server service again.<br /> <br /> '''Please note:''' Archive stores that are not stored in a relative path to the master database may have to be re-attached or their paths edited after moving the archive. Details about managing archive stores are available in chapter [[Storage Locations]] of the MailStore Server manual.<br /> <br /> == Moving an Archive Store to a Different Installation ==<br /> To move an archive store to a different installation, follow the instructions below. The product key or the recovery key of the installation where the archive store is coming from is required.<br /> <br /> &lt;p class=msnote&gt;'''Please note:''' The archive store must be on version 7 or higher, so that it can move to a different archive. If that is not the case, the archive store and the associated Master Database have to be loaded once with MailStore Server 7 or higher, because then some necessary database upgrades will be performed.&lt;/p&gt;<br /> <br /> <br /> {{Multiline Notices|Heading=Important Notices|Only migrations to installations of the same or a newer version are supported.|If you want to move the archive store from a version prior to 25.1 to an installation of MailStore 25.1 or newer, all archive store databases must have been updated to Firebird 4. Please read the [[Update Notices for MailStore Server to version 25.1 or newer]].}}<br /> <br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges on the installation where the archive store is still attached to.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> * [[Storage_Locations#Detaching|Detach]] the archive store you want to move.<br /> * Move the folder or folders of the archive store to the new location.<br /> * Start the MailStore Client and log in as a MailStore user with administrative privileges on the installation where the archive store will be attached to.<br /> * Navigate to ''Administrative Tools &gt; Storage &gt; Storage Locations''.<br /> * [[Storage_Locations#Attaching|Attach]] the moved archive store.<br /> <br /> == Moving the Content of an Archive Store to a different Archive Store ==<br /> <br /> Under certain circumstances it may be required that messages from one or more archive stores need to be copied to another archive store. E.g. the content of external Microsoft-SQL or PostgreSQL based archive stores needs to be transferred or when lots of small archive stores should be merged into one or more larger ones. When the copy process has finished, the source archive stores can usually be detached, because the content is available through the target store.<br /> <br /> There are some requirements before the process can be started:<br /> <br /> * Although the process is designed so it can be run while archiving processes are running and users are accessing their archives we recommend to start MailStore Server in [[MailStore_Server_Service_Configuration#Controlling_the_Service|Safe Mode]]. <br /> * The [[MailStore_Server_Service_Configuration#Debug_Log|debug log]] has to be turned on in the MailStore Server Service Configuration.<br /> * The [[Storage_Locations#Setting_the_Status|status of all the source archive stores]] need to be set to ''Write-Protected'' so these are not modified while the process is running. Source archive stores also cannot be in an error state.<br /> * The resulting archive store size cannot exceed 30,000,000 messages. When the target store is selected automatically, new stores are created on demand. The settings to automatically create new stores when the size limit is reached is heeded. When the target store is selected manually, the process will not start when the sum of all messages of this store would exceed 30,000,000 messages.<br /> * The target store should be an internal archive store, since support for external archive stores is deprecated and will be removed in a future version.<br /> <br /> &lt;p class=msnote&gt;'''Important notice:''' Depending on the amount of mail to be copied the process will take some time. While the process is running, ensure that external backup tools are not accessing MailStore data, the server is not restarted, network shares are accessible, databases are reachable, etc.&lt;/p&gt;<br /> <br /> To transfer messages, the ''TransferStores'' command has to be executed in the [[MailStore_Server_Management_Shell|MailStore Server Management Shell]].<br /> <br /> The management shell can be started directly from MailStore: Log on to MailStore Client as administrator and click on Administrative Tools &gt; Management API &gt; Command Prompt.<br /> <br /> The syntax of the command is:<br /> TransferStores --sourceStores=&lt;String&gt; [--targetStore=&lt;Number&gt;] [--startIndex=&lt;String&gt;]<br /> <br /> <br /> {| class=&quot;wikitable&quot; <br /> ! width=20% | Parameter <br /> ! width=70% | Description<br /> |-<br /> | &lt;code&gt;--sourceStores&lt;/code&gt;<br /> | A comma separated list of the IDs of the source archive stores.<br /> |-<br /> | &lt;code&gt;--targetStore&lt;/code&gt;<br /> | Optional. ID of the target archive store. If no value is given the archive store marked as ''archive here'' is used.<br /> |-<br /> | &lt;code&gt;--startIndex&lt;/code&gt;<br /> | Optional. In case a previous run of TransferStores has been interrupted, a start index can be given. Messages coming before the start index will be skipped.<br /> |}<br /> <br /> * Visit the [[Storage_Locations|storage locations page]], and take note of the IDs of the archive stores whose mails shall be transferred. When desired, create a new internal store. Ensure that the status of the target store is ''Archive here'' or ''Normal''. Take note of the ID of that store as well. Ensure that the status of the source stores is ''Write-Protected''.<br /> * Navigate to the [[MailStore_Server_Management_Shell|Management Shell]].<br /> * Execute the ''TransferStores'' command and wait for it to finish. See the ''Examples'' section below. This client session cannot be used for anything else, it has to wait for the process to finish.<br /> * In case the process aborted, check the debug log for details, it can be found in ''C:\ProgramData\MailStore\Debug Log''. The Management Shell also shows the command, which continues the process where it stopped.<br /> * When the process has finished without any errors, detach the source archive stores using the [[Storage_Locations|storage locations page]].<br /> * Verify that all mails have been copied.<br /> * Leave Safe Mode by restarting MailStore Server.<br /> * Remove artifacts of source archive store from filesystem, e.g. index files or ''Content'' folder, depending on your configuration.<br /> <br /> === Examples ===<br /> <br /> Use the following command to transfer all messages of archive store with ID 1 to the archive store marked as ''archive here''. When there are already messages in the target store, all messages of archive store 1 will be appended. When the threshold for the maximum amount of mails is reached, a new store is created automatically.<br /> <br /> TransferStores --sourceStores=1<br /> <br /> Use the following command to transfer all messages of archive stores with IDs 1, 2 and 3 to the archive store marked as ''archive here''. When there are already messages in the target store, all messages of archive stores 1,2 and 3 will be appended. When the threshold for the maximum amount of mails is reached, a new store is created automatically.<br /> <br /> TransferStores --sourceStores=1,2,3<br /> <br /> The order of the source store IDs is heeded. So the following command will process the source stores in the given order.<br /> <br /> TransferStores --sourceStores=3,1,2<br /> <br /> Use the following command to transfer all messages of archive store with ID 1 to the archive store with ID 4. When there are already messages in the target store, all messages of archive store 1 will be appended. When a target store is given, a check verifies that the resulting store will not exceed 30,000,000 messages. No new stores will be created automatically:<br /> <br /> TransferStores --sourceStores=1 --targetStore=4<br /> <br /> Use the following command to transfer messages of archive store with ID 1 and 2 beginning from mails with the internal mail ID 1000 of store 1 to the archive store with ID 4. When there are already messages in the target store, messages of archive stores 1 and 2 will be appended. When a target store is given, a check verifies that the resulting store will not exceed 30,000,000 messages. No new stores will be created automatically:<br /> <br /> TransferStores --sourceStores=1,2 --targetStore=4 --startIndex=1:1000<br /> <br /> [[de:Umziehen des Archivs]]<br /> [[en:Moving the Archive]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Template:SQLDeprecation&diff=7915 2026-01-07T07:44:08Z

<p>Cstelzmann: </p> <hr /> <div>&lt;p class=&quot;msnote mswarning&quot;&gt;Since MailStore Server 26.1 it is not possible to create new Microsoft SQL or PostgreSQL based archive stores anymore. Attaching existing archive stores is still possible. Support for Microsoft SQL and PostgreSQL based archive stores will be removed completely in a future version of MailStore Server.&lt;/p&gt;<br /> <br /> &lt;noinclude&gt;<br /> [[de:Vorlage:SQLDeprecation]]<br /> [[en:Template:SQLDeprecation]]<br /> &lt;/noinclude&gt;</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Administration_API_-_Function_Reference&diff=7903 2025-11-25T12:26:24Z

<p>Cstelzmann: /* Arguments */</p> <hr /> <div>__NOTOC__<br /> <br /> == AttachStore ==<br /> Attach existing archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string <br /> | Meaningful name of archive store.<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string<br /> | Type of archive store.<br /> |-<br /> | &lt;tt&gt;databaseName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of database on Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;databasePath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which database folder information and email meta data are stored.<br /> |-<br /> | &lt;tt&gt;contentPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which email headers and contents are stored.<br /> |-<br /> | &lt;tt&gt;indexPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which full text search indexes are stored.<br /> |-<br /> | &lt;tt&gt;serverName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | User name for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;requestedState&lt;/tt&gt;<br /> | string (optional)<br /> | State of archive store after attaching.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== type ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;FileSystemInternal&lt;/tt&gt;<br /> | Advanced file system-based archive store.<br /> |-<br /> | &lt;tt&gt;SQLServer&lt;/tt&gt;<br /> | Microsoft SQL Server-based archive store.<br /> |-<br /> | &lt;tt&gt;PostgreSQL&lt;/tt&gt;<br /> | PostgreSQL server-based archive store.<br /> |}<br /> <br /> ==== requestedState ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;current&lt;/tt&gt;<br /> | Same as Normal but new messages will be archived in the archive store that is set to Current.<br /> |-<br /> | &lt;tt&gt;normal&lt;/tt&gt;<br /> | The content of archives store is available to users and can be modified if the user has the appropriate permission.<br /> |-<br /> | &lt;tt&gt;writeProtected&lt;/tt&gt;<br /> | 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)<br /> |-<br /> | &lt;tt&gt;disabled&lt;/tt&gt;<br /> | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.<br /> |}<br /> <br /> == CancelJobAsync ==<br /> Cancel a running job asynchronously.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique identifier of the job to be canceled.<br /> |}<br /> <br /> == ClearUserPrivilegesOnFolders ==<br /> Removes all privileges of a user on all archive folders.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |}<br /> <br /> == CompactMasterDatabase ==<br /> Compact master database.<br /> <br /> == CompactStore ==<br /> Compact archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store<br /> |}<br /> <br /> == CreateBackup == <br /> Create a backup of the entire archive.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;path&lt;/tt&gt;<br /> | string<br /> | Path to directory into which the backup should be written.<br /> |-<br /> | &lt;tt&gt;excludeSearchIndexes&lt;/tt&gt;<br /> | bool (optional)<br /> | Indicates whether the search index files should be excluded from the backup.<br /> |}<br /> <br /> == CreateJob ==<br /> Create a new job to execute Management API commands.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string (optional)<br /> | A meaningful name for the job. Example: ''Daily Backup''.<br /> |-<br /> | &lt;tt&gt;action&lt;/tt&gt;<br /> | string (optional)<br /> | Management API command to execute.<br /> |-<br /> | &lt;tt&gt;owner&lt;/tt&gt;<br /> | string (optional)<br /> | Username of the job owner; must be an administrator.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string (optional)<br /> | The id of the time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;date&lt;/tt&gt;<br /> | string (optional)<br /> | Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.<br /> |-<br /> | &lt;tt&gt;interval&lt;/tt&gt;<br /> | number (optional)<br /> | Interval for running job.<br /> |-<br /> | &lt;tt&gt;time&lt;/tt&gt;<br /> | string (optional)<br /> | Time for running job. Without additional parameter, this means daily execution.<br /> |-<br /> | &lt;tt&gt;dayOfWeek&lt;/tt&gt;<br /> | string (optional)<br /> | Day of week to run job. Parameter &quot;time&quot; also required.<br /> |-<br /> | &lt;tt&gt;dayOfMonth&lt;/tt&gt;<br /> | string (optional)<br /> | Day of month to run job. Parameter &quot;time&quot; also required. dayOfWeek can optionally be used to define further.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> <br /> === Argument Values ===<br /> <br /> ==== dayOfWeek ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;Sunday&lt;/tt&gt;<br /> | Sunday<br /> |-<br /> | &lt;tt&gt;Monday&lt;/tt&gt;<br /> | Monday<br /> |-<br /> | &lt;tt&gt;Tuesday&lt;/tt&gt;<br /> | Tuesday<br /> |-<br /> | &lt;tt&gt;Wednesday&lt;/tt&gt;<br /> | Wednesday<br /> |-<br /> | &lt;tt&gt;Thursday&lt;/tt&gt;<br /> | Thursday<br /> |-<br /> | &lt;tt&gt;Friday&lt;/tt&gt;<br /> | Friday<br /> |-<br /> | &lt;tt&gt;Saturday&lt;/tt&gt;<br /> | Saturday<br /> |}<br /> <br /> ==== dayOfMonth ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;1 to 31&lt;/tt&gt;<br /> | Numeric representation of day of month.<br /> |-<br /> | &lt;tt&gt;Last&lt;/tt&gt;<br /> | Last day of month.<br /> |}<br /> <br /> ==== interval ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;5&lt;/tt&gt;<br /> | Every 5 minutes.<br /> |-<br /> | &lt;tt&gt;10&lt;/tt&gt;<br /> | Every 10 minutes.<br /> |-<br /> | &lt;tt&gt;15&lt;/tt&gt;<br /> | Every 15 minutes.<br /> |-<br /> | &lt;tt&gt;20&lt;/tt&gt;<br /> | Every 20 minutes.<br /> |-<br /> | &lt;tt&gt;30&lt;/tt&gt;<br /> | Every 30 minutes.<br /> |-<br /> | &lt;tt&gt;60&lt;/tt&gt;<br /> | Every hour.<br /> |-<br /> | &lt;tt&gt;120&lt;/tt&gt;<br /> | Every 2 hours.<br /> |-<br /> | &lt;tt&gt;180&lt;/tt&gt;<br /> | Every 3 hours.<br /> |-<br /> | &lt;tt&gt;240&lt;/tt&gt;<br /> | Every 4 hours.<br /> |-<br /> | &lt;tt&gt;360&lt;/tt&gt;<br /> | Every 6 hours.<br /> |-<br /> | &lt;tt&gt;720&lt;/tt&gt;<br /> | Every 12 hours.<br /> |}<br /> <br /> == CreateProfile ==<br /> Create a new archiving or exporting profile.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;properties&lt;/tt&gt;<br /> | json <br /> | Profile properties.<br /> |-<br /> | &lt;tt&gt;raw&lt;/tt&gt;<br /> | bool <br /> | Currently only 'true' is supported.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== properties ====<br /> 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.<br /> <br /> == CreateStore ==<br /> Create and attach a new archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string <br /> | Meaningful name of archive store.<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string (optional)<br /> | Type of archive store.<br /> |-<br /> | &lt;tt&gt;databaseName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of database on Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;databasePath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which database folder information and email meta data are stored.<br /> |-<br /> | &lt;tt&gt;contentPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which email headers and contents are stored.<br /> |-<br /> | &lt;tt&gt;indexPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which full text search indexes are stored.<br /> |-<br /> | &lt;tt&gt;serverName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | User name for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;requestedState&lt;/tt&gt;<br /> | string (optional)<br /> | State of archive store after attaching.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== type ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;FileSystemInternal&lt;/tt&gt;<br /> | Standard archive store.<br /> |-<br /> | &lt;tt&gt;SQLServer&lt;/tt&gt;<br /> | Microsoft SQL Server-based archive store.<br /> |-<br /> | &lt;tt&gt;PostgreSQL&lt;/tt&gt;<br /> | PostgreSQL server-based archive store.<br /> |}<br /> <br /> ==== requestedState ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;current&lt;/tt&gt;<br /> | Same as Normal but new messages will be archived in the archive store that is set to Current.<br /> |-<br /> | &lt;tt&gt;normal&lt;/tt&gt;<br /> | The content of archives store is available to users and can be modified if the user has the appropriate permission.<br /> |-<br /> | &lt;tt&gt;writeProtected&lt;/tt&gt;<br /> | 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)<br /> |-<br /> | &lt;tt&gt;disabled&lt;/tt&gt;<br /> | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.<br /> |}<br /> <br /> == CreateUser ==<br /> Create new MailStore user. Use [[Administration_API_-_Function_Reference#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] to grant that user privileges on the user's own archive.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of new MailStore user.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of privileges.<br /> |-<br /> | &lt;tt&gt;fullName&lt;/tt&gt;<br /> | string (optional)<br /> | Full name of user.<br /> |-<br /> | &lt;tt&gt;distinguishedName&lt;/tt&gt;<br /> | string (optional)<br /> | LDAP DN string.<br /> |-<br /> | &lt;tt&gt;authentication&lt;/tt&gt;<br /> | string (optional)<br /> | Authentication setting for user: 'integrated or 'directoryServices'.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password of new user.<br /> |-<br /> | &lt;tt&gt;loginPrivileges&lt;/tt&gt;<br /> | string (optional)<br /> | Comma separated list of log in privileges. If not given, all login privileges are assigned.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {{Administration_API_User_Privileges}}<br /> <br /> <br /> ==== loginPrivileges ====<br /> {{Administration_API_User_Login_Privileges}}<br /> <br /> == DeleteAppPasswords ==<br /> Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string<br /> | The user name of the user whose app passwords shall be deleted.<br /> |}<br /> <br /> == DeleteEmptyFolders ==<br /> Remove folders from folder tree that do not contain emails.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string (optional)<br /> | Entry point in folder tree.<br /> |}<br /> <br /> == DeleteJob ==<br /> Deletes a job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | string<br /> | The unique identifier of the job to be deleted.<br /> |}<br /> <br /> == DeleteMessage ==<br /> Delete a single message<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | string<br /> | Unique ID of message. Format: &lt;store_id&gt;:&lt;message_num&gt;<br /> |-<br /> | &lt;tt&gt;reason&lt;/tt&gt;<br /> | string<br /> | The reason why that message has to be deleted which will be written into the audit log.<br /> |}<br /> <br /> == DeleteProfile ==<br /> Delete an archiving or exporting profile.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of profile.<br /> |}<br /> <br /> == DeleteUser ==<br /> Delete a MailStore user.<br /> Neither the user's archive nor the user's archive emails are deleted when deleting a user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |}<br /> <br /> == DetachStore ==<br /> Detach an archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == DisableMFA ==<br /> Disables multi-factor authentication of a user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | The user name of the user for whom MFA shall be disabled.<br /> |}<br /> <br /> [[Administration_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a user.<br /> <br /> == GetActiveSessions ==<br /> Get list of current user sessions.<br /> <br /> == GetChildFolders ==<br /> Get child folders.<br /> Depending on compliance settings this method may return only the first folder hierarchy level.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string (optional)<br /> | Parent folder whose child folders should be returned. If omitted, all archives and folder will be returned.<br /> |-<br /> | &lt;tt&gt;maxLevels&lt;/tt&gt;<br /> | number (optional)<br /> | Depth of child folders.<br /> |}<br /> <br /> == GetComplianceConfiguration ==<br /> Get current compliance configuration settings.<br /> <br /> == CreateCredential ==<br /> Create a new credential object that can be used by directory configuration settings or profiles.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string<br /> | Credential type. Supported values are:&lt;br/&gt;<br /> * &lt;tt&gt;Office365_Modern&lt;/tt&gt; – credential for authenticating against Entra ID (Office 365 modern authentication).&lt;br/&gt;<br /> * &lt;tt&gt;SignedEnvelope&lt;/tt&gt; – credential used for an export to MailStore Cloud.<br /> |-<br /> | &lt;tt&gt;description&lt;/tt&gt;<br /> | string<br /> | Human readable description of the credential.<br /> |-<br /> | &lt;tt&gt;tenantId&lt;/tt&gt;<br /> | string (optional)<br /> | Tenant identifier used for Office365_Modern type credentials.<br /> |-<br /> | &lt;tt&gt;applicationId&lt;/tt&gt;<br /> | string (optional)<br /> | Application/client identifier used for Office365_Modern type credentials.<br /> |}<br /> <br /> == DeleteCredential ==<br /> Delete an existing credential object.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | int<br /> | Unique ID of the credential to delete.<br /> |}<br /> <br /> == GetCredential ==<br /> Get details of a single credential object.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | int<br /> | Unique ID of the credential whose details should be returned.<br /> |}<br /> <br /> == GetCredentials ==<br /> Get the list of all credential objects and their details.<br /> <br /> == SetCredentialDescription ==<br /> Set the description of an existing credential object.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | int<br /> | Unique ID of the credential to modify.<br /> |-<br /> | &lt;tt&gt;description&lt;/tt&gt;<br /> | string<br /> | New human readable description of the credential.<br /> |}<br /> <br /> == SetCredentialSettings ==<br /> Change configuration settings of an existing credential object.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | int<br /> | Unique ID of the credential to modify.<br /> |-<br /> | &lt;tt&gt;createNewCertificate&lt;/tt&gt;<br /> | bool (optional)<br /> | Indicates whether a new certificate should be created for this credential (&lt;tt&gt;true&lt;/tt&gt;) or the existing certificate settings should be kept (&lt;tt&gt;false&lt;/tt&gt;).<br /> |-<br /> | &lt;tt&gt;tenantId&lt;/tt&gt;<br /> | string (optional)<br /> | Tenant identifier used for Office365_Modern type credentials.<br /> |-<br /> | &lt;tt&gt;applicationId&lt;/tt&gt;<br /> | string (optional)<br /> | Application/client identifier used for Office365_Modern type credentials.<br /> |}<br /> <br /> == GetDirectoryServicesConfiguration ==<br /> Get current Directory Services configuration settings.<br /> <br /> == GetFolderStatistics ==<br /> Get folder statistics.<br /> <br /> == GetJobResults ==<br /> Retrieves list of finished job executions.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;fromIncluding&lt;/tt&gt;<br /> | string <br /> | Beginning of time range to fetch.<br /> |-<br /> | &lt;tt&gt;toExcluding&lt;/tt&gt;<br /> | string <br /> | End of time range to fetch.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string <br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;jobId&lt;/tt&gt;<br /> | number (optional)<br /> | The job id for which to retrieve results.<br /> |}<br /> <br /> Interactive Management Shell Example: ''GetJobResults --fromIncluding=&quot;2022-12-01T00:00:00&quot; --toExcluding=&quot;2023-01-01T00:00:00&quot; --timeZoneId=&quot;$Local&quot; --jobId=1''<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> <br /> == GetJobs ==<br /> Retrieve list of jobs.<br /> <br /> == GetLicenseInformation ==<br /> Retrieve license information.<br /> <br /> Example license information object:<br /> <br /> {<br /> &quot;productKey&quot;: &quot;YOUR-MAIL-STORE-PRODUCT-KEY&quot;,<br /> &quot;productVersion&quot;: &quot;13.1.0.12345&quot;,<br /> &quot;maxNamedUsers&quot;: 100,<br /> &quot;namedUsers&quot;: 95,<br /> &quot;unusedNamedUsers&quot;: 5,<br /> &quot;supportExpiryDate&quot;: &quot;2023-12-31&quot;,<br /> &quot;supportLevel&quot;: &quot;Premium Service&quot;,<br /> &quot;validFrom&quot;: null,<br /> &quot;validTo&quot;: null,<br /> &quot;licensedTo&quot;: &quot;MailStore Software GmbH&quot;,<br /> &quot;machineName&quot;: &quot;MAILSTORE&quot;<br /> }<br /> <br /> The properties ''validFrom'' and ''validTo'' are only set when Trial or NFR product keys are used.<br /> <br /> == GetMessages ==<br /> Get list of messages from a folder.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string (optional)<br /> | Folder whose content to list.<br /> |}<br /> <br /> == GetProfiles ==<br /> Get list of archiving and exporting profiles.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;raw&lt;/tt&gt;<br /> | bool <br /> | Currently only 'true' is supported.<br /> |}<br /> <br /> == GetRetentionPolicies ==<br /> Get the retention policies.<br /> <br /> Example retention policies object:<br /> <br /> [<br /> {<br /> &quot;name&quot;: &quot;Keep All Mails for 10 Years&quot;,<br /> &quot;order&quot;: 1,<br /> &quot;enabled&quot;: true,<br /> &quot;searchCriteria&quot;: {<br /> &quot;from&quot;: null,<br /> &quot;to&quot;: null,<br /> &quot;query&quot;: null,<br /> &quot;queryAttachmentContents&quot;: false,<br /> &quot;queryAttachments&quot;: false,<br /> &quot;queryMessageBody&quot;: false,<br /> &quot;querySubject&quot;: false,<br /> &quot;includedArchives&quot;: null,<br /> &quot;excludedArchives&quot;: [<br /> &quot;admin&quot;<br /> ]<br /> },<br /> &quot;period&quot;: 10,<br /> &quot;periodInterval&quot;: &quot;year&quot;,<br /> &quot;referenceDateType&quot;: &quot;ArchiveDate&quot;,<br /> &quot;delete&quot;: false<br /> }<br /> ]<br /> <br /> The ''referenceDateType'' can bei either ''ArchiveDate'' or ''MessageDate''.<br /> <br /> == GetServerInfo ==<br /> Get MailStore Server version and machine name.<br /> <br /> == GetServiceConfiguration ==<br /> 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.<br /> <br /> == GetSmtpSettings ==<br /> Get current SMTP configuration.<br /> <br /> == GetStoreAutoCreateConfiguration ==<br /> Get automatic archive store creation settings.<br /> <br /> == GetStoreIndexes ==<br /> Get list of full text indexes.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number (optional)<br /> | Unique ID of archive store.<br /> |}<br /> <br /> == GetStores ==<br /> Get list of archive stores.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;includeSize&lt;/tt&gt;<br /> | bool (optional)<br /> | Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.<br /> |}<br /> <br /> == GetTimeZones ==<br /> Get the list of available time zones and their IDs.<br /> <br /> 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]].<br /> <br /> == GetUserInfo ==<br /> Get detailed information about user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user<br /> |}<br /> <br /> == GetUsers ==<br /> Get list of users.<br /> <br /> == GetWorkerResults ==<br /> Get results of profile executions.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;fromIncluding&lt;/tt&gt;<br /> | string <br /> | Beginning of time range to fetch.<br /> |-<br /> | &lt;tt&gt;toExcluding&lt;/tt&gt;<br /> | string <br /> | End of time range to fetch.<br /> |-<br /> | &lt;tt&gt;timeZoneID&lt;/tt&gt;<br /> | string <br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;profileID&lt;/tt&gt;<br /> | number (optional)<br /> | Filter results by given profile ID.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | If given, must be equal to the current username. Filters results by current user.<br /> |}<br /> <br /> Interactive Management Shell Example: ''GetWorkerResults --fromIncluding=&quot;2022-01-01T00:00:00&quot; --toExcluding=&quot;2023-01-01T00:00:00&quot; --timeZoneID=&quot;$Local&quot; --profileID=1 --userName=&quot;admin&quot;''<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> <br /> Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.<br /> <br /> == GetWorkerResultReport ==<br /> Get the details of a profile execution result.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number<br /> | The ID of the result for which the details should be fetched.<br /> |}<br /> <br /> Use the [[Administration_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.<br /> <br /> == InitializeMFA ==<br /> Initializes multi-factor authentication of a user. During the next login with an MFA-capable client, the user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.<br /> When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | The user name of the user for whom MFA shall be initialized.<br /> |}<br /> <br /> [[Administration_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.<br /> <br /> == MaintainFileSystemDatabases ==<br /> Run database maintenance on all databases of file system based archive stores.<br /> <br /> == MergeStore ==<br /> Merge two archive stores.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of destination archive store.<br /> |-<br /> | &lt;tt&gt;sourceId&lt;/tt&gt;<br /> | number <br /> | Unique ID of source archive store.<br /> |}<br /> <br /> == MoveFolder ==<br /> Move folder.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;fromFolder&lt;/tt&gt;<br /> | string <br /> | Old folder name.<br /> |-<br /> | &lt;tt&gt;toFolder&lt;/tt&gt;<br /> | string <br /> | New folder name.<br /> |}<br /> <br /> == ProcessRetentionPolicies ==<br /> Processes the configured retention policies.<br /> <br /> == RebuildSelectedStoreIndexes ==<br /> Rebuild all full-text indexes selected for rebuild.<br /> <br /> == RebuildStoreIndex ==<br /> Rebuild search index for given archive folder.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string <br /> | Name of folder name.<br /> |}<br /> <br /> == RecoverStore ==<br /> 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.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;encryptionKey&lt;/tt&gt;<br /> | string (optional)<br /> | Encryption key of the archive store. Must be given, when the encryption key cannot be read from the key file of the archive store.<br /> |-<br /> | &lt;tt&gt;recoverDeletedMessages&lt;/tt&gt;<br /> | bool (optional)<br /> | Defines whether to recover deleted messages.<br /> |}<br /> <br /> 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.<br /> <br /> == RecreateRecoveryRecords ==<br /> Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] to verify the state of the Recovery Records. Cannot be used for external archive stores that store their content in the database.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == RefreshAllStoreStatistics ==<br /> Refresh statistics of all archive stores.<br /> <br /> == RenameJob ==<br /> Rename job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number (optional)<br /> | The unique identifier of the job to be renamed.<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string (optional)<br /> | The new job name.<br /> |}<br /> <br /> == RenameStore ==<br /> Rename archive store<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string <br /> | New name of archive store.<br /> |}<br /> <br /> == RenameUser ==<br /> Rename a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;oldUserName&lt;/tt&gt;<br /> | string <br /> | Old user name.<br /> |-<br /> | &lt;tt&gt;newUserName&lt;/tt&gt;<br /> | string <br /> | New user name.<br /> |}<br /> <br /> == RenewMasterKey ==<br /> Renews the master key which is used to encrypt the encryption keys.<br /> <br /> == RepairStoreDatabase ==<br /> Tries to resolve certain issues with archive store databases (e.g. missing database indexes).<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == RetryOpenStores ==<br /> Retry opening stores that failed previously.<br /> <br /> == RunJobAsync ==<br /> Run an existing job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The identifier of the job to be run.<br /> |}<br /> <br /> == RunProfile ==<br /> 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''.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique profile ID.<br /> |}<br /> <br /> == RunTemporaryProfile ==<br /> 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.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;properties&lt;/tt&gt;<br /> | json <br /> | Profile properties.<br /> |-<br /> | &lt;tt&gt;raw&lt;/tt&gt;<br /> | bool <br /> | Currently only 'true' is supported.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== properties ====<br /> To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.<br /> <br /> == SelectAllStoreIndexesForRebuild ==<br /> Select all full-text indexes for rebuild.<br /> <br /> == SendStatusReport ==<br /> Send a status report to the given recipients.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;timespan&lt;/tt&gt;<br /> | string<br /> | Timespan that is covered by the status report.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string<br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;recipients&lt;/tt&gt;<br /> | string<br /> | Comma separated list of recipients that will receive the status report.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> === Argument Values ===<br /> <br /> ==== Timespan ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;today&lt;/tt&gt;<br /> | The day when the status report is sent.<br /> |-<br /> | &lt;tt&gt;yesterday&lt;/tt&gt;<br /> | The day before the status report is sent.<br /> |-<br /> | &lt;tt&gt;thisweek&lt;/tt&gt;<br /> | The week when the status report is sent.<br /> |-<br /> | &lt;tt&gt;lastweek&lt;/tt&gt;<br /> | The week before the status report is sent.<br /> |-<br /> | &lt;tt&gt;thismonth&lt;/tt&gt;<br /> | The month when the status report is sent.<br /> |-<br /> | &lt;tt&gt;lastmonth&lt;/tt&gt;<br /> | The month before the status report is sent.<br /> |}<br /> <br /> == SetComplianceConfiguration ==<br /> Set compliance configuration settings.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json <br /> | Compliance configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== config ====<br /> Use [[Administration_API_-_Function_Reference#GetComplianceConfiguration|GetComplianceConfiguration]] to receive supported values.<br /> <br /> Example settings object:<br /> &lt;source lang=&quot;js&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> {<br /> &quot;adminEmailPreviewEnabled&quot;: true,<br /> &quot;legalHoldEnabled&quot;: false,<br /> &quot;passwordPolicyEnabled&quot;: true,<br /> &quot;logSuccessfulUserActivities&quot;: [<br /> &quot;AdminRestored&quot;,<br /> &quot;ComplianceChangeSettings&quot;,<br /> &quot;FileGroupAttach&quot;,<br /> &quot;FileGroupCreate&quot;,<br /> &quot;FileGroupDetach&quot;,<br /> &quot;FileGroupRename&quot;,<br /> &quot;FileGroupSetProperties&quot;,<br /> &quot;FileGroupSetRequestedState&quot;,<br /> &quot;ProfileChangeUserName&quot;,<br /> &quot;UserAdd&quot;,<br /> &quot;UserDelete&quot;,<br /> &quot;UserRename&quot;,<br /> &quot;UserSetFolderAccess&quot;,<br /> &quot;UserSetMappings&quot;,<br /> &quot;UserUpdate&quot;<br /> ]<br /> }<br /> &lt;/source&gt;<br /> <br /> == SetDirectoryServicesConfiguration ==<br /> Set directory services configuration settings.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json <br /> | Directory services configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== config ====<br /> Use GetDirectoryServicesConfiguration to receive supported value.<br /> <br /> == SetJobEnabled ==<br /> Set enabled status of a job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number (optional)<br /> | The unique identifier of the job to be modified.<br /> |-<br /> | &lt;tt&gt;enabled&lt;/tt&gt;<br /> | bool (optional)<br /> | Boolean value of '''enabled''' attribute.<br /> |}<br /> <br /> == SetJobSchedule ==<br /> Modify the schedule of a job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique identifier of the job to be modified.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string <br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;date&lt;/tt&gt;<br /> | string (optional)<br /> | Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.<br /> |-<br /> | &lt;tt&gt;interval&lt;/tt&gt;<br /> | number (optional)<br /> | Interval for running job.<br /> |-<br /> | &lt;tt&gt;time&lt;/tt&gt;<br /> | string (optional)<br /> | Time for running job. Without additional parameter, this means daily execution.<br /> |-<br /> | &lt;tt&gt;dayOfWeek&lt;/tt&gt;<br /> | string (optional)<br /> | Day of week to run job. Parameter &quot;time&quot; also required.<br /> |-<br /> | &lt;tt&gt;dayOfMonth&lt;/tt&gt;<br /> | string (optional)<br /> | Day of month to run job. Parameter &quot;time&quot; also required. dayOfWeek can optionally be used to define further.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> === Argument Values ===<br /> <br /> ==== dayOfWeek ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;Sunday&lt;/tt&gt;<br /> | Sunday<br /> |-<br /> | &lt;tt&gt;Monday&lt;/tt&gt;<br /> | Monday<br /> |-<br /> | &lt;tt&gt;Tuesday&lt;/tt&gt;<br /> | Tuesday<br /> |-<br /> | &lt;tt&gt;Wednesday&lt;/tt&gt;<br /> | Wednesday<br /> |-<br /> | &lt;tt&gt;Thursday&lt;/tt&gt;<br /> | Thursday<br /> |-<br /> | &lt;tt&gt;Friday&lt;/tt&gt;<br /> | Friday<br /> |-<br /> | &lt;tt&gt;Saturday&lt;/tt&gt;<br /> | Saturday<br /> |}<br /> <br /> ==== dayOfMonth ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;1 to 31&lt;/tt&gt;<br /> | Numeric representation of day of month.<br /> |-<br /> | &lt;tt&gt;Last&lt;/tt&gt;<br /> | Last day of month.<br /> |}<br /> <br /> ==== interval ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;5&lt;/tt&gt;<br /> | Every 5 minutes.<br /> |-<br /> | &lt;tt&gt;10&lt;/tt&gt;<br /> | Every 10 minutes.<br /> |-<br /> | &lt;tt&gt;15&lt;/tt&gt;<br /> | Every 15 minutes.<br /> |-<br /> | &lt;tt&gt;20&lt;/tt&gt;<br /> | Every 20 minutes.<br /> |-<br /> | &lt;tt&gt;30&lt;/tt&gt;<br /> | Every 30 minutes.<br /> |-<br /> | &lt;tt&gt;60&lt;/tt&gt;<br /> | Every hour.<br /> |-<br /> | &lt;tt&gt;120&lt;/tt&gt;<br /> | Every 2 hours.<br /> |-<br /> | &lt;tt&gt;180&lt;/tt&gt;<br /> | Every 3 hours.<br /> |-<br /> | &lt;tt&gt;260&lt;/tt&gt;<br /> | Every 4 hours.<br /> |-<br /> | &lt;tt&gt;360&lt;/tt&gt;<br /> | Every 6 hours.<br /> |-<br /> | &lt;tt&gt;720&lt;/tt&gt;<br /> | Every 12 hours.<br /> |}<br /> <br /> == SetProfileServerSideExecution ==<br /> Disables or enables the automatic server-sided execution with its parameters.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique profile ID of the profile to be modified.<br /> |-<br /> | &lt;tt&gt;automatic&lt;/tt&gt;<br /> | bool<br /> | Enables (true) or disables (false) the profile's server-side automation.<br /> |-<br /> | &lt;tt&gt;automaticPauseBetweenExecutions&lt;/tt&gt;<br /> | number (optional) <br /> | Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.<br /> |-<br /> | &lt;tt&gt;automaticMaintenanceWindows&lt;/tt&gt;<br /> | string (optional)<br /> | 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.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current &quot;serverSideExecution&quot; section details.<br /> <br /> 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.<br /> <br /> == SetRetentionPolicies ==<br /> Set retention policies.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json<br /> | Retention policy configuration.<br /> |}<br /> <br /> 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. &lt;br&gt;<br /> 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.<br /> Due to a more complex distributed permission concept, retention policies can not be edited via the API for the MailStore Service Provider Edition.<br /> <br /> == SetServiceCertificate ==<br /> Set the X509 certificate that is used by MailStore Server for incoming connections.<br /> The certificate must already reside in the computer's local certificate store.<br /> The thumbprint of the currently used certificate can be retrieved with [[Administration_API_-_Function_Reference#GetServiceConfiguration|GetServiceConfiguration]].<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;thumbprint&lt;/tt&gt;<br /> | string<br /> | Thumbprint of X509 certificate.<br /> |}<br /> <br /> == SetSmtpSettings ==<br /> Set SMTP configuration.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;settings&lt;/tt&gt;<br /> | json<br /> | SMTP configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== settings====<br /> Example settings object:<br /> &lt;source lang=&quot;js&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> {<br /> &quot;hostname&quot;: &quot;mail.example.com&quot;,<br /> &quot;port&quot;: 587,<br /> &quot;protocol&quot;: &quot;SMTP-TLS&quot;,<br /> &quot;ignoreSslPolicyErrors&quot;: false,<br /> &quot;authenticationRequired&quot;: true,<br /> &quot;username&quot;: &quot;sending.user@example.com&quot;,<br /> &quot;password&quot;: &quot;userpassword&quot;,<br /> &quot;fromDisplayName&quot;: &quot;Sending User&quot;,<br /> &quot;fromEmailAddress&quot;: &quot;sending.user@example.com&quot;,<br /> &quot;recipientEmailAddresses&quot;: [&quot;administrator@example.com&quot;, &quot;user@example.com&quot;]<br /> }<br /> &lt;/source&gt;<br /> <br /> == SetStoreAutoCreateConfiguration ==<br /> Set configuration for automatic archive store creation.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json <br /> | Archive store automatic creation configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== config ====<br /> &lt;source lang=&quot;js&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> {<br /> &quot;sizeThreshold&quot; : int or null,<br /> &quot;databaseBaseDirectory&quot; : string,<br /> &quot;contentBaseDirectory&quot; : string,<br /> &quot;indexBaseDirectory&quot; : string<br /> }<br /> &lt;/source&gt;<br /> <br /> == SetStoreProperties ==<br /> Set properties of archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Set properties of archive store.<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string (optional)<br /> | <br /> |-<br /> | &lt;tt&gt;databaseName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of database on Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;databasePath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which database folder information and email meta data are stored.<br /> |-<br /> | &lt;tt&gt;contentPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which email headers and contents are stored.<br /> |-<br /> | &lt;tt&gt;indexPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which full text search indexes are stored.<br /> |-<br /> | &lt;tt&gt;serverName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | User name for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password for accessing Microsoft SQL Server or PostgreSQL server.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== type ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;FileSystemInternal&lt;/tt&gt;<br /> | Advanced file system-based archive store.<br /> |-<br /> | &lt;tt&gt;SQLServer&lt;/tt&gt;<br /> | Microsoft SQL Server-based archive store.<br /> |-<br /> | &lt;tt&gt;PostgreSQL&lt;/tt&gt;<br /> | PostgreSQL server-based archive store.<br /> |}<br /> <br /> == SetStoreRequestedState ==<br /> Set state of archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;requestedState&lt;/tt&gt;<br /> | string (optional)<br /> | State of archive store after attaching.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== requestedState ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;current&lt;/tt&gt;<br /> | Same as Normal but new messages will be archived in the archive store that is set to Current.<br /> |-<br /> | &lt;tt&gt;normal&lt;/tt&gt;<br /> | The content of archives store is available to users and can be modified if the user has the appropriate permission.<br /> |-<br /> | &lt;tt&gt;writeProtected&lt;/tt&gt;<br /> | 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)<br /> |-<br /> | &lt;tt&gt;disabled&lt;/tt&gt;<br /> | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.<br /> |}<br /> <br /> == SetUserAuthentication ==<br /> Set authentication settings of a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;authentication&lt;/tt&gt;<br /> | string <br /> | Authentication method. Either 'integrated' or 'directoryServices'.<br /> |}<br /> <br /> == SetUserDistinguishedName ==<br /> Set the LDAP distinguished name of a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;distinguishedName&lt;/tt&gt;<br /> | string (optional)<br /> | LDAP DN string.<br /> |}<br /> <br /> == SetUserEmailAddresses ==<br /> Set email addresses of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;emailAddresses&lt;/tt&gt;<br /> | string (optional)<br /> | List of email addresses.<br /> |}<br /> <br /> == SetUserFullName ==<br /> Set full name of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;fullName&lt;/tt&gt;<br /> | string (optional)<br /> | Full name of MailStore user.<br /> |}<br /> <br /> == SetUserLoginPrivileges ==<br /> Set login privileges of a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;loginPrivileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of login privileges.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== loginPrivileges ====<br /> {{Administration_API_User_Login_Privileges}}<br /> <br /> == SetUserPassword ==<br /> Set password of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string <br /> | Password of MailStore user.<br /> |}<br /> <br /> == SetUserPop3UserNames ==<br /> Set POP3 user name of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;pop3UserNames&lt;/tt&gt;<br /> | string (optional)<br /> | Comma separated list of POP3 user names.<br /> |}<br /> <br /> == SetUserPrivileges ==<br /> Set privileges of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of privileges.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {{Administration_API_User_Privileges}}<br /> <br /> == SetUserPrivilegesOnAllFolders ==<br /> Set privileges on all folders for MailStore user, except for the folders that are excluded<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of folder privileges.<br /> |-<br /> | &lt;tt&gt;excludeFolders&lt;/tt&gt;<br /> | string (optional)<br /> | Comma separated list of folders to exclude.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;read&lt;/tt&gt;<br /> | The user is granted read access to the specified folders.<br /> |-<br /> | &lt;tt&gt;write&lt;/tt&gt;<br /> | The user is granted write access to the specified folders. Messages can be moved within an archive.<br /> |-<br /> | &lt;tt&gt;delete&lt;/tt&gt;<br /> | The user is granted delete access to the specified folders.<br /> |}<br /> <br /> == SetUserPrivilegesOnFolder ==<br /> Set privileges on folder for MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string <br /> | Folder name.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of folder privileges.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;none&lt;/tt&gt;<br /> | 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.<br /> |-<br /> | &lt;tt&gt;read&lt;/tt&gt;<br /> | The user is granted read access to the specified folder.<br /> |-<br /> | &lt;tt&gt;write&lt;/tt&gt;<br /> | The user is granted write access to the specified folder. Messages can be moved within an archive.<br /> |-<br /> | &lt;tt&gt;delete&lt;/tt&gt;<br /> | The user is granted delete access to the specified folder.<br /> |}<br /> <br /> == SyncUsersWithDirectoryServices ==<br /> Sync users of MailStore instance with directory services.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;dryRun&lt;/tt&gt;<br /> | bool (optional)<br /> | Simulate sync only.<br /> |}<br /> <br /> == TestSmtpSettings ==<br /> Test current SMTP configuration.<br /> <br /> == TransferStores ==<br /> Copy the content of one or more archive store into another archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;sourceStores&lt;/tt&gt;<br /> | string<br /> | Comma-separated list of one or more source archive stores.<br /> |-<br /> | &lt;tt&gt;targetStore&lt;/tt&gt;<br /> | number (optional)<br /> | The target store of the messages to be copied. If not given, the archive store in the &quot;current&quot; state will be used.<br /> |-<br /> | &lt;tt&gt;startIndex&lt;/tt&gt;<br /> | string (optional)<br /> | A string in the format &quot;archiveStoreId:messageId&quot;. The transfer process starts with the this message.<br /> |}<br /> <br /> == UnlockStore ==<br /> 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.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store to unlock.<br /> |-<br /> | &lt;tt&gt;passphrase&lt;/tt&gt;<br /> | string<br /> | Product key or recovery key of the foreign MailStore installation.<br /> |}<br /> <br /> == UpgradeStore ==<br /> Upgrade an archive store from an older version to the current format.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == UpgradeStores ==<br /> Upgrade all archive stores from an older version to the current format.<br /> <br /> == VerifyStore ==<br /> Verify archive stores consistency.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique identifier of the archive store to be verified.<br /> |-<br /> | &lt;tt&gt;includeIndexes&lt;/tt&gt;<br /> | bool<br /> | Defines whether to verify the search indexes as well. Default: true. May be slow when running on slow hardware.<br /> |}<br /> <br /> == VerifyStores ==<br /> Verify consistency of all archive stores.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;includeIndexes&lt;/tt&gt;<br /> | bool<br /> | Defines whether to verify the search indexes as well. Default: true. May be slow when running on slow hardware.<br /> |}<br /> <br /> [[de:Administration API - Function Reference]]<br /> [[en:Administration API - Function Reference]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=User:Cstelzmann/Books/Testbook&diff=7897 2025-11-10T09:48:26Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.4 == === Documentation === ;Installation...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === Documentation ===<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|Testbook]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Server_Help:Books/MailStore_Server_25.4&diff=7891 2025-10-01T09:35:45Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.4 == === Documentation === ;Installation...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.4 ==<br /> === Documentation ===<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|MailStore Server 25.4]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=HelpTopicIds&diff=7890 2025-09-30T10:04:26Z

<p>Cstelzmann: </p> <hr /> <div>* accs_export - [[Exporting_Email]]<br /> * accs_extsearch - [[Accessing_the_Archive_with_the_MailStore_Client_software#Advanced_Search]]<br /> * accs_outlook - [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration]]<br /> * accs_outlookapp - [[Accessing_the_Archive_with_the_Microsoft_Outlook_App_integration]]<br /> * accs_preview - [[Accessing_the_Archive_with_the_MailStore_Client_software#Email_Preview]]<br /> * accs_web - [[Accessing_the_Archive_with_MailStore_Web_Access]]<br /> * arch_delete - [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving]]<br /> * arch_filesystem - [[Archiving_Emails_from_External_Systems_(File_Import)]]<br /> * arch_filepst - [[Archiving_Outlook_PST_Files_Directly]]<br /> * arch_gateway - [[Archiving_MailStore_Gateway_Mailbox]]<br /> * arch_nospamproxy - [[Archiving_Emails_from_NoSpamProxy]]<br /> * gateway_introduction - [[Archiving_MailStore_Gateway_Mailbox]]<br /> * arch_googleapps_batch - [[Archiving_Emails_from_Google_Workspace#Archiving_Multiple_Mailboxes_Centrally]]<br /> * arch_googleapps - [[Archiving_Emails_from_Google_Workspace]]<br /> * arch_googleapps_multidrop - [[Archiving_Emails_from_Google_Workspace#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_googlemail_installed_app - [[Archiving_Emails_from_Gmail]]<br /> * arch_outlookcom_modern_auth - [[Archiving_Emails_from_Outlook.com]]<br /> * arch_icewarp - [[Archiving_Emails_from_IceWarp_Server]]<br /> * arch_icewarp_mailbox - [[Archiving_Emails_from_IceWarp_Server#Archiving_Individual_Mailboxes]]<br /> * arch_icewarp_mailboxes - [[Archiving_Emails_from_IceWarp_Server#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_icewarp_multidrop - [[Archiving_Emails_from_IceWarp_Server#Archiving_All_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_imapbatch - [[Batch-archiving_IMAP_Mailboxes]]<br /> * arch_inout - [[MailStore_Proxy]]<br /> * arch_introduction - [[Archiving_Email]]<br /> * arch_kerio - [[Archiving_Emails_from_Kerio_Connect]]<br /> * arch_kerio_mailbox - [[Archiving_Emails_from_Kerio_Connect#Archiving_Individual_Mailboxes]]<br /> * arch_kerio_mailboxes - [[Archiving_Emails_from_Kerio_Connect#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_kerio_multidrop - [[Archiving_Emails_from_Kerio_Connect#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_mailboxes - [[Archiving_Server_Mailboxes]]<br /> * arch_mailclients - [[Archiving_Email_from_Outlook,_Thunderbird_and_others]]<br /> * arch_mdaemon - [[Archiving_Emails_from_MDaemon]]<br /> * arch_mdaemon_mailbox - [[Archiving_Emails_from_MDaemon#Archiving_Individual_Mailboxes]]<br /> * arch_mdaemon_mailboxes - [[Archiving_Emails_from_MDaemon#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_mdaemon_multidrop - [[Archiving_Emails_from_MDaemon#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_multidrop - [[Archiving_IMAP_and_POP3_Multidrop_Mailboxes]]<br /> * arch_profiles - [[Archiving_Email]]<br /> * arch_schedule - [[Email_Archiving_with_MailStore_Basics#Automating_the_Archiving_Process]]<br /> * arch_results - [[Email_Archiving_with_MailStore_Basics]]<br /> * arch_selfolders - [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders]]<br /> * bkup_integrated - [[Backup_and_Restore]]<br /> * comp_auditing - [[Auditing]]<br /> * comp_auditlog - [[Audit_Log]]<br /> * comp_auditlogexport - [[Audit_Log]]<br /> * comp_auditor - [[Compliance_General]]<br /> * comp_forcechangepassword - [[Notes_on_Password_Complexity]]<br /> * comp_general - [[Compliance_General]]<br /> * comp_manage_passwords - [[Accessing_the_Archive_with_the_MailStore_Client_software#Managing_Passwords]]<br /> * comp_password_complexity - [[Notes_on_Password_Complexity]]<br /> * comp_retention - [[Retention_Policies]]<br /> * comp_message_date - [[Message_Date_of_an_Email]]<br /> * expo_googleapps - [[Exporting_Email]]<br /> * gsta_login - [[Accessing_the_Archive_with_the_MailStore_Client_software#Starting_and_Login]]<br /> * job_jobs - [[Jobs]]<br /> * job_scheduling - [[Jobs]]<br /> * job_results - [[Job_Results]]<br /> * mads_sync - [[Administration]]<br /> * tech_config - [[MailStore_Server_Service_Configuration]]<br /> * tech_index - [[Search_Indexes]]<br /> * tech_mscmd - [[MailStore_Server_Management_Shell]]<br /> * tech_proxy - [[MailStore_Proxy]]<br /> * tech_safemode - [[MailStore_Server_Service_Configuration]]<br /> * tech_smtpsettings - [[SMTP_Settings]]<br /> * tech_archives - [[Archives]]<br /> * tech_storageloc - [[Storage_Locations]]<br /> * tech_productupdates - [[Product_Updates]]<br /> * umgm_privileges - [[Users,_Folders_and_Settings#User_Management]]<br /> * umgm_users - [[Users,_Folders_and_Settings#User_Management]]<br /> * xchg_introduction - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_jour_intro - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_mailbox - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_mailboxes - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_archive_mailbox - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_archive_mailboxes - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_public - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * impl_noownserver - [[Archiving_Emails_Without_Your_Own_Emailserver|(No own e-mail server)]]<br /> * impl_exim - [[Archiving_Emails_from_an_Exim_Based_Email_Server|Exim]]<br /> * impl_hmailserver - [[Archiving_Emails_from_hMailServer|hMailServer]]<br /> * impl_intranator - [[Archiving_Emails_from_Intra2net_Systems|Intra2net Appliance Pro / Business Server]]<br /> * impl_kerioconnect - [[Archiving_Emails_from_Kerio_Connect|Kerio Connect (Kerio MailServer)]]<br /> * impl_kolab - [[Archiving_Emails_from_Kolab|Kolab]]<br /> * impl_postfix - [[Archiving_Emails_from_a_Postfix_Based_Email_Server|Postfix]]<br /> * impl_qmail - [[Archiving_Emails_from_a_Qmail_Based_Email_Server|Qmail]]<br /> * impl_scalix - [[Archiving_Emails_from_Scalix|Scalix]]<br /> * impl_sendmail - [[Archiving_Emails_from_a_Sendmail_Based_Email_Server|Sendmail]]<br /> * impl_smartermail - [[Archiving_Emails_from_SmarterMail|SmarterMail]]<br /> * impl_tobitdavid - [[Archiving_Emails_from_Tobit_David.fx|Tobit David.fx]]<br /> * impl_zimbra - [[Archiving_Emails_from_Zimbra|Zimbra Collaboration Suite]]<br /> * implexch_2003 - [[Archiving_Emails_from_Microsoft_Exchange_2003|Exchange 2003]]<br /> * implexch_2007 - [[Archiving_Emails_from_Microsoft_Exchange_2007|Exchange 2007]]<br /> * implexch_2010 - [[Archiving_Emails_from_Microsoft_Exchange_2010|Exchange 2010]]<br /> * implexch_2013 - [[Archiving_Emails_from_Microsoft_Exchange_2013|Exchange 2013]]<br /> * implexch_2016 - [[Archiving_Emails_from_Microsoft_Exchange_2016|Exchange 2016]] <br /> * implexch_2019 - [[Archiving_Emails_from_Microsoft_Exchange_2019|Exchange 2019]]<br /> * implexch_se - [[Archiving_Emails_from_Microsoft_Exchange_SE|Exchange SE]]<br /> * implexch_o365 - [[Archiving_Emails_from_Microsoft_Office_365|Office 365]]<br /> * welc_licensing - [[License_Management]]<br /> * arch_microsoft365 - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)]]<br /> * arch_microsoft365_single - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Individual_Microsoft.C2.A0365_Mailboxes]]<br /> * arch_microsoft365_multiple - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Multiple_Microsoft.C2.A0365_Mailboxes_Centrally]]<br /> * arch_microsoft365_single_archive_mailbox - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Individual_Microsoft.C2.A0365_Archive_Mailboxes]]<br /> * arch_microsoft365_multiple_archive_mailboxes - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Multiple_Microsoft.C2.A0365_Archive_Mailboxes_Centrally]]<br /> * arch_microsoft365_public - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Public_Folders]]<br /> * expo_microsoft365 - [[Exporting_Email]]<br /> * cred_microsoft365 - [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server]]<br /> * expo_mailstorecloudbulk - [[MailStore_Cloud_Help#Migration_from_MailStore_Server_to_MailStore_Cloud]]<br /> <br /> [[de:HelpTopicIds]]<br /> [[en:helpTopicIds]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Cloud_Help&diff=7889 2025-09-30T10:00:56Z

<p>Cstelzmann: Created page with &quot;== Migration from MailStore Server to MailStore Cloud == For help regarding the migration from MailStore Server to MailStore Cloud, please refer to this help article in the de...&quot;</p> <hr /> <div>== Migration from MailStore Server to MailStore Cloud ==<br /> For help regarding the migration from MailStore Server to MailStore Cloud, please refer to this help article in the dedicated MailStore Cloud help: <br /> <br /> [https://www.mailstore.com/en/help/mailstore-cloud/migration-from-mailstore-server-to-mailstore-cloud/ Migration from MailStore Server to MailStore Cloud]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Administration_API_-_Function_Reference&diff=7874 2025-09-22T08:54:59Z

<p>Cstelzmann: /* SetUserPrivilegesOnAllFolders */</p> <hr /> <div>__NOTOC__<br /> <br /> == AttachStore ==<br /> Attach existing archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string <br /> | Meaningful name of archive store.<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string<br /> | Type of archive store.<br /> |-<br /> | &lt;tt&gt;databaseName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of database on Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;databasePath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which database folder information and email meta data are stored.<br /> |-<br /> | &lt;tt&gt;contentPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which email headers and contents are stored.<br /> |-<br /> | &lt;tt&gt;indexPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which full text search indexes are stored.<br /> |-<br /> | &lt;tt&gt;serverName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | User name for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;requestedState&lt;/tt&gt;<br /> | string (optional)<br /> | State of archive store after attaching.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== type ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;FileSystemInternal&lt;/tt&gt;<br /> | Advanced file system-based archive store.<br /> |-<br /> | &lt;tt&gt;SQLServer&lt;/tt&gt;<br /> | Microsoft SQL Server-based archive store.<br /> |-<br /> | &lt;tt&gt;PostgreSQL&lt;/tt&gt;<br /> | PostgreSQL server-based archive store.<br /> |}<br /> <br /> ==== requestedState ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;current&lt;/tt&gt;<br /> | Same as Normal but new messages will be archived in the archive store that is set to Current.<br /> |-<br /> | &lt;tt&gt;normal&lt;/tt&gt;<br /> | The content of archives store is available to users and can be modified if the user has the appropriate permission.<br /> |-<br /> | &lt;tt&gt;writeProtected&lt;/tt&gt;<br /> | 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)<br /> |-<br /> | &lt;tt&gt;disabled&lt;/tt&gt;<br /> | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.<br /> |}<br /> <br /> == CancelJobAsync ==<br /> Cancel a running job asynchronously.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique identifier of the job to be canceled.<br /> |}<br /> <br /> == ClearUserPrivilegesOnFolders ==<br /> Removes all privileges of a user on all archive folders.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |}<br /> <br /> == CompactMasterDatabase ==<br /> Compact master database.<br /> <br /> == CompactStore ==<br /> Compact archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store<br /> |}<br /> <br /> == CreateBackup == <br /> Create a backup of the entire archive.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;path&lt;/tt&gt;<br /> | string<br /> | Path to directory into which the backup should be written.<br /> |-<br /> | &lt;tt&gt;excludeSearchIndexes&lt;/tt&gt;<br /> | bool (optional)<br /> | Indicates whether the search index files should be excluded from the backup.<br /> |}<br /> <br /> == CreateJob ==<br /> Create a new job to execute Management API commands.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string (optional)<br /> | A meaningful name for the job. Example: ''Daily Backup''.<br /> |-<br /> | &lt;tt&gt;action&lt;/tt&gt;<br /> | string (optional)<br /> | Management API command to execute.<br /> |-<br /> | &lt;tt&gt;owner&lt;/tt&gt;<br /> | string (optional)<br /> | Username of the job owner; must be an administrator.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string (optional)<br /> | The id of the time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;date&lt;/tt&gt;<br /> | string (optional)<br /> | Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.<br /> |-<br /> | &lt;tt&gt;interval&lt;/tt&gt;<br /> | number (optional)<br /> | Interval for running job.<br /> |-<br /> | &lt;tt&gt;time&lt;/tt&gt;<br /> | string (optional)<br /> | Time for running job. Without additional parameter, this means daily execution.<br /> |-<br /> | &lt;tt&gt;dayOfWeek&lt;/tt&gt;<br /> | string (optional)<br /> | Day of week to run job. Parameter &quot;time&quot; also required.<br /> |-<br /> | &lt;tt&gt;dayOfMonth&lt;/tt&gt;<br /> | string (optional)<br /> | Day of month to run job. Parameter &quot;time&quot; also required. dayOfWeek can optionally be used to define further.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> <br /> === Argument Values ===<br /> <br /> ==== dayOfWeek ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;Sunday&lt;/tt&gt;<br /> | Sunday<br /> |-<br /> | &lt;tt&gt;Monday&lt;/tt&gt;<br /> | Monday<br /> |-<br /> | &lt;tt&gt;Tuesday&lt;/tt&gt;<br /> | Tuesday<br /> |-<br /> | &lt;tt&gt;Wednesday&lt;/tt&gt;<br /> | Wednesday<br /> |-<br /> | &lt;tt&gt;Thursday&lt;/tt&gt;<br /> | Thursday<br /> |-<br /> | &lt;tt&gt;Friday&lt;/tt&gt;<br /> | Friday<br /> |-<br /> | &lt;tt&gt;Saturday&lt;/tt&gt;<br /> | Saturday<br /> |}<br /> <br /> ==== dayOfMonth ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;1 to 31&lt;/tt&gt;<br /> | Numeric representation of day of month.<br /> |-<br /> | &lt;tt&gt;Last&lt;/tt&gt;<br /> | Last day of month.<br /> |}<br /> <br /> ==== interval ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;5&lt;/tt&gt;<br /> | Every 5 minutes.<br /> |-<br /> | &lt;tt&gt;10&lt;/tt&gt;<br /> | Every 10 minutes.<br /> |-<br /> | &lt;tt&gt;15&lt;/tt&gt;<br /> | Every 15 minutes.<br /> |-<br /> | &lt;tt&gt;20&lt;/tt&gt;<br /> | Every 20 minutes.<br /> |-<br /> | &lt;tt&gt;30&lt;/tt&gt;<br /> | Every 30 minutes.<br /> |-<br /> | &lt;tt&gt;60&lt;/tt&gt;<br /> | Every hour.<br /> |-<br /> | &lt;tt&gt;120&lt;/tt&gt;<br /> | Every 2 hours.<br /> |-<br /> | &lt;tt&gt;180&lt;/tt&gt;<br /> | Every 3 hours.<br /> |-<br /> | &lt;tt&gt;240&lt;/tt&gt;<br /> | Every 4 hours.<br /> |-<br /> | &lt;tt&gt;360&lt;/tt&gt;<br /> | Every 6 hours.<br /> |-<br /> | &lt;tt&gt;720&lt;/tt&gt;<br /> | Every 12 hours.<br /> |}<br /> <br /> == CreateProfile ==<br /> Create a new archiving or exporting profile.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;properties&lt;/tt&gt;<br /> | json <br /> | Profile properties.<br /> |-<br /> | &lt;tt&gt;raw&lt;/tt&gt;<br /> | bool <br /> | Currently only 'true' is supported.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== properties ====<br /> 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.<br /> <br /> == CreateStore ==<br /> Create and attach a new archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string <br /> | Meaningful name of archive store.<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string (optional)<br /> | Type of archive store.<br /> |-<br /> | &lt;tt&gt;databaseName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of database on Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;databasePath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which database folder information and email meta data are stored.<br /> |-<br /> | &lt;tt&gt;contentPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which email headers and contents are stored.<br /> |-<br /> | &lt;tt&gt;indexPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which full text search indexes are stored.<br /> |-<br /> | &lt;tt&gt;serverName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | User name for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;requestedState&lt;/tt&gt;<br /> | string (optional)<br /> | State of archive store after attaching.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== type ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;FileSystemInternal&lt;/tt&gt;<br /> | Standard archive store.<br /> |-<br /> | &lt;tt&gt;SQLServer&lt;/tt&gt;<br /> | Microsoft SQL Server-based archive store.<br /> |-<br /> | &lt;tt&gt;PostgreSQL&lt;/tt&gt;<br /> | PostgreSQL server-based archive store.<br /> |}<br /> <br /> ==== requestedState ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;current&lt;/tt&gt;<br /> | Same as Normal but new messages will be archived in the archive store that is set to Current.<br /> |-<br /> | &lt;tt&gt;normal&lt;/tt&gt;<br /> | The content of archives store is available to users and can be modified if the user has the appropriate permission.<br /> |-<br /> | &lt;tt&gt;writeProtected&lt;/tt&gt;<br /> | 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)<br /> |-<br /> | &lt;tt&gt;disabled&lt;/tt&gt;<br /> | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.<br /> |}<br /> <br /> == CreateUser ==<br /> Create new MailStore user. Use [[Administration_API_-_Function_Reference#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] to grant that user privileges on the user's own archive.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of new MailStore user.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of privileges.<br /> |-<br /> | &lt;tt&gt;fullName&lt;/tt&gt;<br /> | string (optional)<br /> | Full name of user.<br /> |-<br /> | &lt;tt&gt;distinguishedName&lt;/tt&gt;<br /> | string (optional)<br /> | LDAP DN string.<br /> |-<br /> | &lt;tt&gt;authentication&lt;/tt&gt;<br /> | string (optional)<br /> | Authentication setting for user: 'integrated or 'directoryServices'.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password of new user.<br /> |-<br /> | &lt;tt&gt;loginPrivileges&lt;/tt&gt;<br /> | string (optional)<br /> | Comma separated list of log in privileges. If not given, all login privileges are assigned.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {{Administration_API_User_Privileges}}<br /> <br /> <br /> ==== loginPrivileges ====<br /> {{Administration_API_User_Login_Privileges}}<br /> <br /> == DeleteAppPasswords ==<br /> Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string<br /> | The user name of the user whose app passwords shall be deleted.<br /> |}<br /> <br /> == DeleteEmptyFolders ==<br /> Remove folders from folder tree that do not contain emails.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string (optional)<br /> | Entry point in folder tree.<br /> |}<br /> <br /> == DeleteJob ==<br /> Deletes a job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | string<br /> | The unique identifier of the job to be deleted.<br /> |}<br /> <br /> == DeleteMessage ==<br /> Delete a single message<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | string<br /> | Unique ID of message. Format: &lt;store_id&gt;:&lt;message_num&gt;<br /> |-<br /> | &lt;tt&gt;reason&lt;/tt&gt;<br /> | string<br /> | The reason why that message has to be deleted which will be written into the audit log.<br /> |}<br /> <br /> == DeleteProfile ==<br /> Delete an archiving or exporting profile.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of profile.<br /> |}<br /> <br /> == DeleteUser ==<br /> Delete a MailStore user.<br /> Neither the user's archive nor the user's archive emails are deleted when deleting a user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |}<br /> <br /> == DetachStore ==<br /> Detach an archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == DisableMFA ==<br /> Disables multi-factor authentication of a user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | The user name of the user for whom MFA shall be disabled.<br /> |}<br /> <br /> [[Administration_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a user.<br /> <br /> == GetActiveSessions ==<br /> Get list of current user sessions.<br /> <br /> == GetChildFolders ==<br /> Get child folders.<br /> Depending on compliance settings this method may return only the first folder hierarchy level.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string (optional)<br /> | Parent folder whose child folders should be returned. If omitted, all archives and folder will be returned.<br /> |-<br /> | &lt;tt&gt;maxLevels&lt;/tt&gt;<br /> | number (optional)<br /> | Depth of child folders.<br /> |}<br /> <br /> == GetComplianceConfiguration ==<br /> Get current compliance configuration settings.<br /> <br /> == GetCredentials ==<br /> Get the list of credential objects and their details.<br /> <br /> == GetDirectoryServicesConfiguration ==<br /> Get current Directory Services configuration settings.<br /> <br /> == GetFolderStatistics ==<br /> Get folder statistics.<br /> <br /> == GetJobResults ==<br /> Retrieves list of finished job executions.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;fromIncluding&lt;/tt&gt;<br /> | string <br /> | Beginning of time range to fetch.<br /> |-<br /> | &lt;tt&gt;toExcluding&lt;/tt&gt;<br /> | string <br /> | End of time range to fetch.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string <br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;jobId&lt;/tt&gt;<br /> | number (optional)<br /> | The job id for which to retrieve results.<br /> |}<br /> <br /> Interactive Management Shell Example: ''GetJobResults --fromIncluding=&quot;2022-12-01T00:00:00&quot; --toExcluding=&quot;2023-01-01T00:00:00&quot; --timeZoneId=&quot;$Local&quot; --jobId=1''<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> <br /> == GetJobs ==<br /> Retrieve list of jobs.<br /> <br /> == GetLicenseInformation ==<br /> Retrieve license information.<br /> <br /> Example license information object:<br /> <br /> {<br /> &quot;productKey&quot;: &quot;YOUR-MAIL-STORE-PRODUCT-KEY&quot;,<br /> &quot;productVersion&quot;: &quot;13.1.0.12345&quot;,<br /> &quot;maxNamedUsers&quot;: 100,<br /> &quot;namedUsers&quot;: 95,<br /> &quot;unusedNamedUsers&quot;: 5,<br /> &quot;supportExpiryDate&quot;: &quot;2023-12-31&quot;,<br /> &quot;supportLevel&quot;: &quot;Premium Service&quot;,<br /> &quot;validFrom&quot;: null,<br /> &quot;validTo&quot;: null,<br /> &quot;licensedTo&quot;: &quot;MailStore Software GmbH&quot;,<br /> &quot;machineName&quot;: &quot;MAILSTORE&quot;<br /> }<br /> <br /> The properties ''validFrom'' and ''validTo'' are only set when Trial or NFR product keys are used.<br /> <br /> == GetMessages ==<br /> Get list of messages from a folder.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string (optional)<br /> | Folder whose content to list.<br /> |}<br /> <br /> == GetProfiles ==<br /> Get list of archiving and exporting profiles.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;raw&lt;/tt&gt;<br /> | bool <br /> | Currently only 'true' is supported.<br /> |}<br /> <br /> == GetRetentionPolicies ==<br /> Get the retention policies.<br /> <br /> Example retention policies object:<br /> <br /> [<br /> {<br /> &quot;name&quot;: &quot;Keep All Mails for 10 Years&quot;,<br /> &quot;order&quot;: 1,<br /> &quot;enabled&quot;: true,<br /> &quot;searchCriteria&quot;: {<br /> &quot;from&quot;: null,<br /> &quot;to&quot;: null,<br /> &quot;query&quot;: null,<br /> &quot;queryAttachmentContents&quot;: false,<br /> &quot;queryAttachments&quot;: false,<br /> &quot;queryMessageBody&quot;: false,<br /> &quot;querySubject&quot;: false,<br /> &quot;includedArchives&quot;: null,<br /> &quot;excludedArchives&quot;: [<br /> &quot;admin&quot;<br /> ]<br /> },<br /> &quot;period&quot;: 10,<br /> &quot;periodInterval&quot;: &quot;year&quot;,<br /> &quot;referenceDateType&quot;: &quot;ArchiveDate&quot;,<br /> &quot;delete&quot;: false<br /> }<br /> ]<br /> <br /> The ''referenceDateType'' can bei either ''ArchiveDate'' or ''MessageDate''.<br /> <br /> == GetServerInfo ==<br /> Get MailStore Server version and machine name.<br /> <br /> == GetServiceConfiguration ==<br /> 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.<br /> <br /> == GetSmtpSettings ==<br /> Get current SMTP configuration.<br /> <br /> == GetStoreAutoCreateConfiguration ==<br /> Get automatic archive store creation settings.<br /> <br /> == GetStoreIndexes ==<br /> Get list of full text indexes.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number (optional)<br /> | Unique ID of archive store.<br /> |}<br /> <br /> == GetStores ==<br /> Get list of archive stores.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;includeSize&lt;/tt&gt;<br /> | bool (optional)<br /> | Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.<br /> |}<br /> <br /> == GetTimeZones ==<br /> Get the list of available time zones and their IDs.<br /> <br /> 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]].<br /> <br /> == GetUserInfo ==<br /> Get detailed information about user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user<br /> |}<br /> <br /> == GetUsers ==<br /> Get list of users.<br /> <br /> == GetWorkerResults ==<br /> Get results of profile executions.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;fromIncluding&lt;/tt&gt;<br /> | string <br /> | Beginning of time range to fetch.<br /> |-<br /> | &lt;tt&gt;toExcluding&lt;/tt&gt;<br /> | string <br /> | End of time range to fetch.<br /> |-<br /> | &lt;tt&gt;timeZoneID&lt;/tt&gt;<br /> | string <br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;profileID&lt;/tt&gt;<br /> | number (optional)<br /> | Filter results by given profile ID.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | If given, must be equal to the current username. Filters results by current user.<br /> |}<br /> <br /> Interactive Management Shell Example: ''GetWorkerResults --fromIncluding=&quot;2022-01-01T00:00:00&quot; --toExcluding=&quot;2023-01-01T00:00:00&quot; --timeZoneID=&quot;$Local&quot; --profileID=1 --userName=&quot;admin&quot;''<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> <br /> Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.<br /> <br /> == GetWorkerResultReport ==<br /> Get the details of a profile execution result.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number<br /> | The ID of the result for which the details should be fetched.<br /> |}<br /> <br /> Use the [[Administration_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.<br /> <br /> == InitializeMFA ==<br /> Initializes multi-factor authentication of a user. During the next login with an MFA-capable client, the user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.<br /> When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | The user name of the user for whom MFA shall be initialized.<br /> |}<br /> <br /> [[Administration_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.<br /> <br /> == MaintainFileSystemDatabases ==<br /> Run database maintenance on all databases of file system based archive stores.<br /> <br /> == MergeStore ==<br /> Merge two archive stores.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of destination archive store.<br /> |-<br /> | &lt;tt&gt;sourceId&lt;/tt&gt;<br /> | number <br /> | Unique ID of source archive store.<br /> |}<br /> <br /> == MoveFolder ==<br /> Move folder.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;fromFolder&lt;/tt&gt;<br /> | string <br /> | Old folder name.<br /> |-<br /> | &lt;tt&gt;toFolder&lt;/tt&gt;<br /> | string <br /> | New folder name.<br /> |}<br /> <br /> == ProcessRetentionPolicies ==<br /> Processes the configured retention policies.<br /> <br /> == RebuildSelectedStoreIndexes ==<br /> Rebuild all full-text indexes selected for rebuild.<br /> <br /> == RebuildStoreIndex ==<br /> Rebuild search index for given archive folder.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string <br /> | Name of folder name.<br /> |}<br /> <br /> == RecoverStore ==<br /> 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.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;encryptionKey&lt;/tt&gt;<br /> | string (optional)<br /> | Encryption key of the archive store. Must be given, when the encryption key cannot be read from the key file of the archive store.<br /> |-<br /> | &lt;tt&gt;recoverDeletedMessages&lt;/tt&gt;<br /> | bool (optional)<br /> | Defines whether to recover deleted messages.<br /> |}<br /> <br /> 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.<br /> <br /> == RecreateRecoveryRecords ==<br /> Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] to verify the state of the Recovery Records. Cannot be used for external archive stores that store their content in the database.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == RefreshAllStoreStatistics ==<br /> Refresh statistics of all archive stores.<br /> <br /> == RenameJob ==<br /> Rename job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number (optional)<br /> | The unique identifier of the job to be renamed.<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string (optional)<br /> | The new job name.<br /> |}<br /> <br /> == RenameStore ==<br /> Rename archive store<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;name&lt;/tt&gt;<br /> | string <br /> | New name of archive store.<br /> |}<br /> <br /> == RenameUser ==<br /> Rename a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;oldUserName&lt;/tt&gt;<br /> | string <br /> | Old user name.<br /> |-<br /> | &lt;tt&gt;newUserName&lt;/tt&gt;<br /> | string <br /> | New user name.<br /> |}<br /> <br /> == RenewMasterKey ==<br /> Renews the master key which is used to encrypt the encryption keys.<br /> <br /> == RepairStoreDatabase ==<br /> Tries to resolve certain issues with archive store databases (e.g. missing database indexes).<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == RetryOpenStores ==<br /> Retry opening stores that failed previously.<br /> <br /> == RunJobAsync ==<br /> Run an existing job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The identifier of the job to be run.<br /> |}<br /> <br /> == RunProfile ==<br /> 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''.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique profile ID.<br /> |}<br /> <br /> == RunTemporaryProfile ==<br /> 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.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;properties&lt;/tt&gt;<br /> | json <br /> | Profile properties.<br /> |-<br /> | &lt;tt&gt;raw&lt;/tt&gt;<br /> | bool <br /> | Currently only 'true' is supported.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== properties ====<br /> To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.<br /> <br /> == SelectAllStoreIndexesForRebuild ==<br /> Select all full-text indexes for rebuild.<br /> <br /> == SendStatusReport ==<br /> Send a status report to the given recipients.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;timespan&lt;/tt&gt;<br /> | string<br /> | Timespan that is covered by the status report.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string<br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;recipients&lt;/tt&gt;<br /> | string<br /> | Comma separated list of recipients that will receive the status report.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> === Argument Values ===<br /> <br /> ==== Timespan ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;today&lt;/tt&gt;<br /> | The day when the status report is sent.<br /> |-<br /> | &lt;tt&gt;yesterday&lt;/tt&gt;<br /> | The day before the status report is sent.<br /> |-<br /> | &lt;tt&gt;thisweek&lt;/tt&gt;<br /> | The week when the status report is sent.<br /> |-<br /> | &lt;tt&gt;lastweek&lt;/tt&gt;<br /> | The week before the status report is sent.<br /> |-<br /> | &lt;tt&gt;thismonth&lt;/tt&gt;<br /> | The month when the status report is sent.<br /> |-<br /> | &lt;tt&gt;lastmonth&lt;/tt&gt;<br /> | The month before the status report is sent.<br /> |}<br /> <br /> == SetComplianceConfiguration ==<br /> Set compliance configuration settings.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json <br /> | Compliance configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== config ====<br /> Use [[Administration_API_-_Function_Reference#GetComplianceConfiguration|GetComplianceConfiguration]] to receive supported values.<br /> <br /> Example settings object:<br /> &lt;source lang=&quot;js&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> {<br /> &quot;adminEmailPreviewEnabled&quot;: true,<br /> &quot;legalHoldEnabled&quot;: false,<br /> &quot;passwordPolicyEnabled&quot;: true,<br /> &quot;logSuccessfulUserActivities&quot;: [<br /> &quot;AdminRestored&quot;,<br /> &quot;ComplianceChangeSettings&quot;,<br /> &quot;FileGroupAttach&quot;,<br /> &quot;FileGroupCreate&quot;,<br /> &quot;FileGroupDetach&quot;,<br /> &quot;FileGroupRename&quot;,<br /> &quot;FileGroupSetProperties&quot;,<br /> &quot;FileGroupSetRequestedState&quot;,<br /> &quot;ProfileChangeUserName&quot;,<br /> &quot;UserAdd&quot;,<br /> &quot;UserDelete&quot;,<br /> &quot;UserRename&quot;,<br /> &quot;UserSetFolderAccess&quot;,<br /> &quot;UserSetMappings&quot;,<br /> &quot;UserUpdate&quot;<br /> ]<br /> }<br /> &lt;/source&gt;<br /> <br /> == SetDirectoryServicesConfiguration ==<br /> Set directory services configuration settings.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json <br /> | Directory services configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== config ====<br /> Use GetDirectoryServicesConfiguration to receive supported value.<br /> <br /> == SetJobEnabled ==<br /> Set enabled status of a job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number (optional)<br /> | The unique identifier of the job to be modified.<br /> |-<br /> | &lt;tt&gt;enabled&lt;/tt&gt;<br /> | bool (optional)<br /> | Boolean value of '''enabled''' attribute.<br /> |}<br /> <br /> == SetJobSchedule ==<br /> Modify the schedule of a job.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique identifier of the job to be modified.<br /> |-<br /> | &lt;tt&gt;timeZoneId&lt;/tt&gt;<br /> | string <br /> | The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.<br /> |-<br /> | &lt;tt&gt;date&lt;/tt&gt;<br /> | string (optional)<br /> | Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.<br /> |-<br /> | &lt;tt&gt;interval&lt;/tt&gt;<br /> | number (optional)<br /> | Interval for running job.<br /> |-<br /> | &lt;tt&gt;time&lt;/tt&gt;<br /> | string (optional)<br /> | Time for running job. Without additional parameter, this means daily execution.<br /> |-<br /> | &lt;tt&gt;dayOfWeek&lt;/tt&gt;<br /> | string (optional)<br /> | Day of week to run job. Parameter &quot;time&quot; also required.<br /> |-<br /> | &lt;tt&gt;dayOfMonth&lt;/tt&gt;<br /> | string (optional)<br /> | Day of month to run job. Parameter &quot;time&quot; also required. dayOfWeek can optionally be used to define further.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.<br /> === Argument Values ===<br /> <br /> ==== dayOfWeek ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;Sunday&lt;/tt&gt;<br /> | Sunday<br /> |-<br /> | &lt;tt&gt;Monday&lt;/tt&gt;<br /> | Monday<br /> |-<br /> | &lt;tt&gt;Tuesday&lt;/tt&gt;<br /> | Tuesday<br /> |-<br /> | &lt;tt&gt;Wednesday&lt;/tt&gt;<br /> | Wednesday<br /> |-<br /> | &lt;tt&gt;Thursday&lt;/tt&gt;<br /> | Thursday<br /> |-<br /> | &lt;tt&gt;Friday&lt;/tt&gt;<br /> | Friday<br /> |-<br /> | &lt;tt&gt;Saturday&lt;/tt&gt;<br /> | Saturday<br /> |}<br /> <br /> ==== dayOfMonth ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;1 to 31&lt;/tt&gt;<br /> | Numeric representation of day of month.<br /> |-<br /> | &lt;tt&gt;Last&lt;/tt&gt;<br /> | Last day of month.<br /> |}<br /> <br /> ==== interval ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;5&lt;/tt&gt;<br /> | Every 5 minutes.<br /> |-<br /> | &lt;tt&gt;10&lt;/tt&gt;<br /> | Every 10 minutes.<br /> |-<br /> | &lt;tt&gt;15&lt;/tt&gt;<br /> | Every 15 minutes.<br /> |-<br /> | &lt;tt&gt;20&lt;/tt&gt;<br /> | Every 20 minutes.<br /> |-<br /> | &lt;tt&gt;30&lt;/tt&gt;<br /> | Every 30 minutes.<br /> |-<br /> | &lt;tt&gt;60&lt;/tt&gt;<br /> | Every hour.<br /> |-<br /> | &lt;tt&gt;120&lt;/tt&gt;<br /> | Every 2 hours.<br /> |-<br /> | &lt;tt&gt;180&lt;/tt&gt;<br /> | Every 3 hours.<br /> |-<br /> | &lt;tt&gt;260&lt;/tt&gt;<br /> | Every 4 hours.<br /> |-<br /> | &lt;tt&gt;360&lt;/tt&gt;<br /> | Every 6 hours.<br /> |-<br /> | &lt;tt&gt;720&lt;/tt&gt;<br /> | Every 12 hours.<br /> |}<br /> <br /> == SetProfileServerSideExecution ==<br /> Disables or enables the automatic server-sided execution with its parameters.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique profile ID of the profile to be modified.<br /> |-<br /> | &lt;tt&gt;automatic&lt;/tt&gt;<br /> | bool<br /> | Enables (true) or disables (false) the profile's server-side automation.<br /> |-<br /> | &lt;tt&gt;automaticPauseBetweenExecutions&lt;/tt&gt;<br /> | number (optional) <br /> | Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.<br /> |-<br /> | &lt;tt&gt;automaticMaintenanceWindows&lt;/tt&gt;<br /> | string (optional)<br /> | 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.<br /> |}<br /> <br /> Use the API command [[Administration_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current &quot;serverSideExecution&quot; section details.<br /> <br /> 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.<br /> <br /> == SetRetentionPolicies ==<br /> Set retention policies.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json<br /> | Retention policy configuration.<br /> |}<br /> <br /> 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. &lt;br&gt;<br /> 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.<br /> Due to a more complex distributed permission concept, retention policies can not be edited via the API for the MailStore Service Provider Edition.<br /> <br /> == SetServiceCertificate ==<br /> Set the X509 certificate that is used by MailStore Server for incoming connections.<br /> The certificate must already reside in the computer's local certificate store.<br /> The thumbprint of the currently used certificate can be retrieved with [[Administration_API_-_Function_Reference#GetServiceConfiguration|GetServiceConfiguration]].<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;thumbprint&lt;/tt&gt;<br /> | string<br /> | Thumbprint of X509 certificate.<br /> |}<br /> <br /> == SetSmtpSettings ==<br /> Set SMTP configuration.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;settings&lt;/tt&gt;<br /> | json<br /> | SMTP configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== settings====<br /> Example settings object:<br /> &lt;source lang=&quot;js&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> {<br /> &quot;hostname&quot;: &quot;mail.example.com&quot;,<br /> &quot;port&quot;: 587,<br /> &quot;protocol&quot;: &quot;SMTP-TLS&quot;,<br /> &quot;ignoreSslPolicyErrors&quot;: false,<br /> &quot;authenticationRequired&quot;: true,<br /> &quot;username&quot;: &quot;sending.user@example.com&quot;,<br /> &quot;password&quot;: &quot;userpassword&quot;,<br /> &quot;fromDisplayName&quot;: &quot;Sending User&quot;,<br /> &quot;fromEmailAddress&quot;: &quot;sending.user@example.com&quot;,<br /> &quot;recipientEmailAddresses&quot;: [&quot;administrator@example.com&quot;, &quot;user@example.com&quot;]<br /> }<br /> &lt;/source&gt;<br /> <br /> == SetStoreAutoCreateConfiguration ==<br /> Set configuration for automatic archive store creation.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;config&lt;/tt&gt;<br /> | json <br /> | Archive store automatic creation configuration.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== config ====<br /> &lt;source lang=&quot;js&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> {<br /> &quot;sizeThreshold&quot; : int or null,<br /> &quot;databaseBaseDirectory&quot; : string,<br /> &quot;contentBaseDirectory&quot; : string,<br /> &quot;indexBaseDirectory&quot; : string<br /> }<br /> &lt;/source&gt;<br /> <br /> == SetStoreProperties ==<br /> Set properties of archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Set properties of archive store.<br /> |-<br /> | &lt;tt&gt;type&lt;/tt&gt;<br /> | string (optional)<br /> | <br /> |-<br /> | &lt;tt&gt;databaseName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of database on Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;databasePath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which database folder information and email meta data are stored.<br /> |-<br /> | &lt;tt&gt;contentPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which email headers and contents are stored.<br /> |-<br /> | &lt;tt&gt;indexPath&lt;/tt&gt;<br /> | string (optional)<br /> | Path to directory in which full text search indexes are stored.<br /> |-<br /> | &lt;tt&gt;serverName&lt;/tt&gt;<br /> | string (optional)<br /> | Name of Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string (optional)<br /> | User name for accessing Microsoft SQL Server or PostgreSQL server.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string (optional)<br /> | Password for accessing Microsoft SQL Server or PostgreSQL server.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== type ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;FileSystemInternal&lt;/tt&gt;<br /> | Advanced file system-based archive store.<br /> |-<br /> | &lt;tt&gt;SQLServer&lt;/tt&gt;<br /> | Microsoft SQL Server-based archive store.<br /> |-<br /> | &lt;tt&gt;PostgreSQL&lt;/tt&gt;<br /> | PostgreSQL server-based archive store.<br /> |}<br /> <br /> == SetStoreRequestedState ==<br /> Set state of archive store.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |-<br /> | &lt;tt&gt;requestedState&lt;/tt&gt;<br /> | string (optional)<br /> | State of archive store after attaching.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== requestedState ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;current&lt;/tt&gt;<br /> | Same as Normal but new messages will be archived in the archive store that is set to Current.<br /> |-<br /> | &lt;tt&gt;normal&lt;/tt&gt;<br /> | The content of archives store is available to users and can be modified if the user has the appropriate permission.<br /> |-<br /> | &lt;tt&gt;writeProtected&lt;/tt&gt;<br /> | 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)<br /> |-<br /> | &lt;tt&gt;disabled&lt;/tt&gt;<br /> | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.<br /> |}<br /> <br /> == SetUserAuthentication ==<br /> Set authentication settings of a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;authentication&lt;/tt&gt;<br /> | string <br /> | Authentication method. Either 'integrated' or 'directoryServices'.<br /> |}<br /> <br /> == SetUserDistinguishedName ==<br /> Set the LDAP distinguished name of a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;distinguishedName&lt;/tt&gt;<br /> | string (optional)<br /> | LDAP DN string.<br /> |}<br /> <br /> == SetUserEmailAddresses ==<br /> Set email addresses of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;emailAddresses&lt;/tt&gt;<br /> | string (optional)<br /> | List of email addresses.<br /> |}<br /> <br /> == SetUserFullName ==<br /> Set full name of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;fullName&lt;/tt&gt;<br /> | string (optional)<br /> | Full name of MailStore user.<br /> |}<br /> <br /> == SetUserLoginPrivileges ==<br /> Set login privileges of a MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;loginPrivileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of login privileges.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== loginPrivileges ====<br /> {{Administration_API_User_Login_Privileges}}<br /> <br /> == SetUserPassword ==<br /> Set password of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;password&lt;/tt&gt;<br /> | string <br /> | Password of MailStore user.<br /> |}<br /> <br /> == SetUserPop3UserNames ==<br /> Set POP3 user name of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;pop3UserNames&lt;/tt&gt;<br /> | string (optional)<br /> | Comma separated list of POP3 user names.<br /> |}<br /> <br /> == SetUserPrivileges ==<br /> Set privileges of MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of privileges.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {{Administration_API_User_Privileges}}<br /> <br /> == SetUserPrivilegesOnAllFolders ==<br /> Set privileges on all folders for MailStore user, except for the folders that are excluded<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of folder privileges.<br /> |-<br /> | &lt;tt&gt;excludeFolders&lt;/tt&gt;<br /> | string (optional)<br /> | Comma separated list of folders to exclude.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;read&lt;/tt&gt;<br /> | The user is granted read access to the specified folders.<br /> |-<br /> | &lt;tt&gt;write&lt;/tt&gt;<br /> | The user is granted write access to the specified folders. Messages can be moved within an archive.<br /> |-<br /> | &lt;tt&gt;delete&lt;/tt&gt;<br /> | The user is granted delete access to the specified folders.<br /> |}<br /> <br /> == SetUserPrivilegesOnFolder ==<br /> Set privileges on folder for MailStore user.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;userName&lt;/tt&gt;<br /> | string <br /> | User name of MailStore user.<br /> |-<br /> | &lt;tt&gt;folder&lt;/tt&gt;<br /> | string <br /> | Folder name.<br /> |-<br /> | &lt;tt&gt;privileges&lt;/tt&gt;<br /> | string <br /> | Comma separated list of folder privileges.<br /> |}<br /> <br /> === Argument Values ===<br /> <br /> ==== privileges ====<br /> {| class=&quot;wikitable&quot;<br /> ! width=270px | Name<br /> ! Description<br /> |-<br /> | &lt;tt&gt;none&lt;/tt&gt;<br /> | 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.<br /> |-<br /> | &lt;tt&gt;read&lt;/tt&gt;<br /> | The user is granted read access to the specified folder.<br /> |-<br /> | &lt;tt&gt;write&lt;/tt&gt;<br /> | The user is granted write access to the specified folder. Messages can be moved within an archive.<br /> |-<br /> | &lt;tt&gt;delete&lt;/tt&gt;<br /> | The user is granted delete access to the specified folder.<br /> |}<br /> <br /> == SyncUsersWithDirectoryServices ==<br /> Sync users of MailStore instance with directory services.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;dryRun&lt;/tt&gt;<br /> | bool (optional)<br /> | Simulate sync only.<br /> |}<br /> <br /> == TestSmtpSettings ==<br /> Test current SMTP configuration.<br /> <br /> == UnlockStore ==<br /> 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.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store to unlock.<br /> |-<br /> | &lt;tt&gt;passphrase&lt;/tt&gt;<br /> | string<br /> | Product key or recovery key of the foreign MailStore installation.<br /> |}<br /> <br /> == UpgradeStore ==<br /> Upgrade an archive store from an older version to the current format.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | Unique ID of archive store.<br /> |}<br /> <br /> == UpgradeStores ==<br /> Upgrade all archive stores from an older version to the current format.<br /> <br /> == VerifyStore ==<br /> Verify archive stores consistency.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;id&lt;/tt&gt;<br /> | number <br /> | The unique identifier of the archive store to be verified.<br /> |-<br /> | &lt;tt&gt;includeIndexes&lt;/tt&gt;<br /> | bool<br /> | Defines whether to verify the search indexes as well. Default: true. May be slow when running on slow hardware.<br /> |}<br /> <br /> == VerifyStores ==<br /> Verify consistency of all archive stores.<br /> <br /> === Arguments ===<br /> {| class=&quot;wikitable&quot;<br /> ! width=150px | Name<br /> ! width=120px | Type<br /> ! Description<br /> |-<br /> | &lt;tt&gt;includeIndexes&lt;/tt&gt;<br /> | bool<br /> | Defines whether to verify the search indexes as well. Default: true. May be slow when running on slow hardware.<br /> |}<br /> <br /> [[de:Administration API - Function Reference]]<br /> [[en:Administration API - Function Reference]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Arch_MailStore_Gateway_NoSpamProxy_02.png&diff=7873 2025-09-19T14:10:23Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Arch MailStore Gateway NoSpamProxy 02.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Arch_filesystem_05.png&diff=7872 2025-09-19T14:06:24Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Arch filesystem 05.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Archiving_Emails_from_External_Systems_-_File_Import&diff=7871 2025-09-19T14:04:54Z

<p>Cstelzmann: /* Archiving Emails of Multiple Users */</p> <hr /> <div>MailStore Server can also archive the emails from applications that are not directly supported if they are available in a standardized format. With most applications it is necessary to export the emails to one of those formats first.<br /> <br /> Using file import, MailStore Server can archive the following formats:<br /> <br /> *'''EML''' - One file per email. Often called RFC 822 or MIME format.<br /> *'''MSG''' - One file per email. Microsoft Outlook email files.<br /> *'''PST''' - Microsoft Outlook personal folder files.<br /> *'''MBOX''' - This file format is used by Mozilla Thunderbird, for example, although in this case the file ending is omitted. The MBOX file format is also used by many Unix mail servers. <br /> <br /> == Procedure for Archiving PST Files ==<br /> Archiving PST files is described separately in chapter [[Archiving_Outlook_PST_Files_Directly|Archiving Outlook PST Files Directly]].<br /> <br /> == Procedure for Archiving EML and MSG Files ==<br /> Setting up archiving processes for files from the file system is done using archiving profiles. General information about archiving profiles is available in chapter [[Email_Archiving_with_MailStore_Basics#Working_with_Archiving_Profiles|Working with Archiving Profiles]].<br /> <br /> === Archiving Emails of a Single User ===<br /> &lt;p class=&quot;msnote&quot;&gt;'''Please note:''' If you do not want to archive email files in your personal user archive only, you'll have to be logged on to MailStore Client as a MailStore Server administrator. Only a MailStore Server administrator can archive emails for other users.&lt;/p&gt;<br /> <br /> Please proceed as follows:<br /> <br /> *In MailStore Server, click on ''Archive Email''.<br /> *From the ''E-mail Files'' category in the ''Create Profile'' section select ''EML and MSG files''.<br /> *A wizard opens, guiding you through the setup process.<br /> *: [[File:arch_filesystem_00.png|center|350px]]<br /> *Select ''Single User'' and click on ''OK''.<br /> *The dialog window ''Archive EML and MSG files'' appears.<br /> *: [[File:arch_filesystem_01.png|center|350px]]<br /> *Select the folder to be archived. All email files in this folder will be archived. <br /> *If desired, adjust the advanced settings or simply click ''Next''.<br /> :*'''Include Subfolders:'''&lt;br/&gt;In addition to the emails in the selected folder also those located in any subfolders will be archived.<br /> :*'''Read MailStore Headers:'''&lt;br/&gt;RFC 822 (EML) files created by the MailStore Server-specific export process contain additional information about the source archives and folders. This information allows to file emails exported from MailStore Server into the correct user archives and folders when being rearchived. Non-existent archives and folders will be created automatically.<br /> :*'''Verify Signature''': Verifies the signature of a [[Exporting_Email#Email_Files|signed export]]. If successful, the original archiving date of the exported files will be restored in the archive.<br /> :*'''Custom File Extensions:'''&lt;br/&gt;Here you can make appropriate entries if the files to be archived are in EML or MSG format but have a different file extension.<br /> *If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the filter and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. <br /> *:[[File:arch_filesystem_02.png|center|350px]]<br /> *If logged on to MailStore Server as a MailStore Server-administrator, the target archive can be specified in the next step of the wizard. Select the archive of the user for whom the selected files are to be archived.<br /> *: [[File:arch_filesystem_03.png|center|350px]]<br /> *In the final step you can specify a name for the new archiving profile. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately, if desired.<br /> <br /> === Archiving Emails of Multiple Users ===<br /> &lt;p class=&quot;msnote&quot;&gt;'''Please note:''' In order to be able to select this archiving method, you'll have to be logged on to MailStore Client as a MailStore Server administrator. Only a MailStore Server administrator can archive emails for other users.&lt;/p&gt;<br /> <br /> In addition to archiving email files of a single user, MailStore Server can archive email files of multiple users from a single directory; such emails may have been exported from a multidrop mailbox.&lt;br/&gt;<br /> To archive such emails please proceed as follows:<br /> <br /> * In MailStore Server, click on ''Archive Email''.<br /> * From the ''E-mail Files'' category in the ''Create Profile'' section select ''EML and MSG files''.<br /> * A wizard opens, guiding you through the setup process.<br /> *: [[File:arch_filesystem_04.png|center|350px]]<br /> * Select ''Multiple Users'' and click on ''OK''.<br /> *: {{Archiving_Multiple_or_Multidrop_Note|from a source that contains emails of multiple users}}<br /> * The dialog window ''Archive Multidrop Mailbox (Filesystem)'' appears.<br /> *: [[File:arch_filesystem_05.png|center|350px]]<br /> * Select the folder with the email files to be archived.<br /> * Adjust any further settings such as how to handle emails with unknown addresses.<br /> * Click on ''Next''.<br /> * You can specify [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]] for when archived mails should be deleted from the multidrop mailbox. This makes it possible to align the deletion with your MailStore Server backup strategy. For example, in case of a daily backup the deletion can be postponed by a day.<br /> * Click on ''Next''.<br /> * In the final step you can specify a name for the new archiving profile. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately, if desired.<br /> <br /> === Archiving Emails from a MailStore Export ===<br /> &lt;p class=&quot;msnote&quot;&gt;'''Please note:''' In order to be able to select this archiving method, you'll have to be logged on to MailStore Client as a MailStore Server administrator. Only a MailStore Server administrator can archive emails for other users.&lt;/p&gt;<br /> <br /> To archive EML files which have been created by a MailStore Export, the correct options have been pre-selected. This provides an easy way to file emails exported from MailStore Server into the correct user archives and folders again.&lt;br/&gt;<br /> Please proceed as follows:<br /> <br /> *In MailStore Server, click on ''Archive Email''.<br /> *From the ''E-mail Files'' category in the ''Create Profile'' section select ''EML and MSG files''.<br /> *A wizard opens, guiding you through the setup process.<br /> *: [[File:arch_filesystem_06.png|center|350px]]<br /> *Select ''MailStore Export'' and click on ''OK''.<br /> *The dialog window ''Archive EML and MSG files'' appears.<br /> *: [[File:arch_filesystem_07.png|center|350px]]<br /> *Select the folder to be archived. All email files in this folder will be archived. <br /> *If desired, adjust the advanced settings or simply click ''Next''.<br /> :*'''Include Subfolders:'''&lt;br/&gt;In addition to the emails in the selected folder also those located in any subfolders will be archived.<br /> :*'''Read MailStore Headers:'''&lt;br/&gt;RFC 822 (EML) files created by the MailStore Server-specific export process contain additional information about the source archives and folders. This information allows to file emails exported from MailStore Server into the correct user archives and folders when being rearchived. Non-existent archives and folders will be created automatically.<br /> :*'''Verify Signature''': Verifies the signature of a [[Exporting_Email#Email_Files|signed export]]. If successful, the original archiving date of the exported files will be restored in the archive.<br /> :*'''Custom File Extensions:'''&lt;br/&gt;Here you can make appropriate entries if the files to be archived are in EML or MSG format but have a different file extension.<br /> *If needed, adjust the settings for the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|List of Folders to be Archived]], the filter and the [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders|Deletion Rules]]. <br /> *:[[File:arch_filesystem_02.png|center|350px]]<br /> *You can specify the target archive in the next step of the wizard. Select the archive of the user for whom the selected files are to be archived. The target archive will be ignored if the option ''Read MailStore Headers'' has been selected and the email to be archived contains such headers.<br /> *: [[File:arch_filesystem_03.png|center|350px]]<br /> *In the final step you can specify a name for the new archiving profile. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately, if desired.<br /> <br /> == Procedure for Archiving MBOX Files ==<br /> Setting up the archiving process for files from the file system is done using archiving profiles. General information about archiving profiles is available in chapter [[Email_Archiving_with_MailStore_Basics#Working_with_Archiving_Profiles|Working with Archiving Profiles]].<br /> <br /> &lt;p class=&quot;msnote&quot;&gt;'''Please note:''' If you do not want to archive email files in your personal user archive only, you'll have to be logged on to MailStore Client as a MailStore Server administrator. Only a MailStore Server administrator can archive emails for other users.&lt;/p&gt;<br /> <br /> Please proceed as follows:<br /> <br /> * In MailStore Server, click on ''Archive Email''.<br /> * From the ''Email Files'' list in the ''Create Profile'' area of the application window select ''MBOX File''.<br /> * A wizard opens, guiding you through the setup process.<br /> * Select the MBOX file to be archived.<br /> *: [[File:Arch_mbox_01.png|center|350px]]<br /> * If logged on to MailStore Server as administrator, the target archive can be specified. Select the archive of the user for whom the selected file is to be archived.<br /> *: [[File:Arch_mbox_02.png|center|350px]]<br /> * In the final step you can specify a name for the new archiving profile. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately, if desired.<br /> <br /> == Archiving with Drag &amp; Drop ==<br /> <br /> Files can also be archived using Drag &amp; Drop: Simply drag the appropriate folder containing EML files or the appropriate MBOX file into the list of saved settings to create an archiving profile for this process directly.<br /> <br /> {{Starting the Archiving Process}}<br /> <br /> [[de:E-Mails_aus_Fremdsystemen_archivieren_(Dateiimport)]]<br /> [[en:Archiving Emails from External Systems (File Import)]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:IceWarp_catchall_01.png&diff=7870 2025-09-19T13:11:44Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:IceWarp catchall 01.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Kerio_catchall_01.png&diff=7869 2025-09-19T13:08:09Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Kerio catchall 01.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Arch_imap_catch_02.png&diff=7868 2025-09-19T13:03:07Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Arch imap catch 02.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Template:Archiving_Multidrop_Mailbox&diff=7867 2025-09-19T13:00:22Z

<p>Cstelzmann: </p> <hr /> <div>Setting up archiving processes for multidrop mailboxes is done using archiving profiles. General information about archiving profiles is available in chapter [[Email_Archiving_with_MailStore_Basics#Working_with_Archiving_Profiles|Working with Archiving Profiles]].<br /> <br /> Please proceed as follows:<br /> <br /> * Log on as MailStore administrator using MailStore Client.<br /> * In MailStore, click on ''Archive Email''.<br /> * To create a new archiving profile, select ''{{{1|Other Server via IMAP/POP3}}}'' from the ''Email Server'' list in the ''Create Profile'' area of the application window.<br /> * A wizard opens guiding you through the setup process.<br /> *:[[File:{{{2|arch_imap_catch_01.png}}}|center|350px]]<br /> * Select ''Multidrop Mailbox'' and click ''OK''.<br /> *: {{#if:{{{4|}}}|{{Archiving_Multiple_or_Multidrop_Note|a multidrop mailbox|{{{4}}}}}|{{Archiving_Multiple_or_Multidrop_Note|a multidrop mailbox}}}}<br /> * Fill out the fields ''Access via'', ''Host'', ''Username'' and ''Password''. Click on ''Test'' to verify the data entered.&lt;br/&gt;&lt;br/&gt;<br /> *:'''For the TLS and SSL protocols only:''' {{Option_Accept_all_certificates}}<br /> *:[[File:{{{3|Arch_imap_catch_02.png}}}|350px|center]] <br /> * Adjust any further settings such as how to handle emails with unknown addresses.<br /> * The placeholders ''{u-email}'' or ''{h-email}'' can be used under ''Target Folders''. ''{u-email}'' represents a user's primary email address and ''{h-email}'' is the email address found in the email header. Should a user have multiple aliases, using ''{h-email}'' will result in emails sent to different aliases of a user being archived in different folders, while using ''{u-email}'' will file all emails below the primary email address.&lt;br/&gt;&lt;br/&gt;<br /> *; &lt;div class=&quot;msnote&quot;&gt;'''Notice:''' If you are additionally archiving messages from the users mailboxes, you have to set the target folder names here to the folder names that match the names that were created by the user mailbox archiving profiles. Otherwise, additional or similar folders could be created in the users' archives. The folder names are case-sensitive.&lt;/div&gt;<br /> * If the option ''Synchronize with Directory Services before archiving'' 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.<br /> * Click on ''Next''.<br /> * You can specify [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]] for when archived mails should be deleted from the multidrop mailbox. This makes it possible to align the deletion with your MailStore Server backup strategy. For example, in case of a daily backup the deletion can be postponed by a day.<br /> * The timeout value only has to be adjusted on a case-by-case basis (e.g. with very slow servers).<br /> * Click on ''Next''.<br /> * At the last step, select a name for the new archiving profile. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically, if desired.<br /> &lt;noinclude&gt;<br /> [[de:Vorlage:Archivierung Sammelpostfach archivieren]]<br /> [[en:Template:Archiving Multidrop Mailbox]]<br /> &lt;/noinclude&gt;</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Mdaemon_catchall_01.png&diff=7866 2025-09-19T12:56:08Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Mdaemon catchall 01.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Arch_MailStore_Gateway_Office365_02.png&diff=7865 2025-09-19T12:47:17Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Arch MailStore Gateway Office365 02.png</p> <hr /> <div></div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Template:MailStore_Gateway_Mailbox_Settings&diff=7864 2025-09-19T12:45:50Z

<p>Cstelzmann: </p> <hr /> <div>; &lt;p class=msnote&gt;{{#if:{{{DSLink|}}}|{{Archiving_Multiple_or_Multidrop_Note|a MailStore Gateway mailbox|{{{DSLink}}}}}|{{Archiving_Multiple_or_Multidrop_Note|a MailStore Gateway mailbox}}}}&lt;/p&gt;<br /> * Fill out the fields ''Host'', ''Mailbox ID'' and ''Password''. Click on ''Test'' to verify the data entered.<br /> *; &lt;br/&gt;&lt;p class=&quot;msnote&quot;&gt;If MailStore Gateway uses a TLS certificate from a certificate authority that is not trusted by the MailStore Server computer, the option ''Accept all certificates'' must be checked.&lt;/p&gt;<br /> &lt;br&gt;<br /> ; [[File:{{{3|Arch_MailStore_Gateway_Office365_02.png}}}|347px|center]] <br /> * Adjust any further settings such as how to handle emails with unknown addresses.{{#ifeq:{{{TargetFolderHint|Show}}}|Show|*; &lt;br/&gt;&lt;p class=&quot;msnote&quot;&gt;'''Please note:''' If you are additionally archiving messages from the users mailboxes, you have to set the target folder names here to the folder names that match the names that were created by the user mailbox archiving profiles. Otherwise, additional or similar folders could be created in the users' archives. The folder names are case-sensitive.&lt;/p&gt;|}}<br /> * If the option ''Synchronize with Directory Services before archiving'' is enabled, the MailStore Server user list will be synchronized with the configured directory service before the archiving process actually runs. This has the advantage that, for example, new employees will be created as MailStore Server users before archiving which enables MailStore Server to sort their emails into the correct archives.<br /> * Click on ''Next''.<br /> * You can specify [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]] for when archived mails should be deleted from the Gateway mailbox. This makes it possible to align the deletion with your MailStore Server backup strategy. For example, in case of a daily backup the deletion can be postponed by a day.<br /> * The timeout value only has to be adjusted on a case-by-case basis (e.g. with very slow servers or network connections).<br /> * Click on ''Next''.<br /> * At the last step, select a name for the new archiving profile. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically, if desired.</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Template:Archiving_Exchange_Journal_Mailbox&diff=7863 2025-09-19T12:21:02Z

<p>Cstelzmann: </p> <hr /> <div>Please proceed as follows:<br /> <br /> * Log on to MailStore Client as MailStore administrator.<br /> * Click on ''Archive Email''.<br /> * From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.<br /> * A wizard opens to assist in specifying the archiving settings.<br /> * Select ''In- and Outbound Email Automatically''.<br /> *: {{#if:{{{DSLink|}}}|{{Archiving_Multiple_or_Multidrop_Note|from a journal mailbox|{{{DSLink}}}}}|{{Archiving_Multiple_or_Multidrop_Note|from a journal mailbox}}}}<br /> {{#ifeq: {{{1|Exchange}}}|Office 365|*: [[File:Office365_jour_mailstore_01.png|center|347px]]<br /> * 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.<br /> *: '''Please note:''' {{Option Accept all certificates}}<br /> * Under ''Host'', enter the name of the email server that hosts the journal mailbox.<br /> * Under ''User Name'' and ''Password'' enter the credentials for the journal mailbox.<br /> * 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.)''.<br /> |*:[[File:Xchg_jour_mailstore_01.png|center|350px]]<br /> * Under ''Access via'', select the protocol to be used to access the Exchange server. Whenever possible, ''HTTPS'' should be used.<br /> *: '''Please note:''' {{Option Accept all certificates}}<br /> * Under ''Host'' enter the name of the Exchange server.<br /> * Under ''User Name'' and ''Password'' enter the credentials for the Exchange journal mailbox.<br /> * 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.)''.}}<br /> * Click on ''Test'' to verify that MailStore can access the mailbox.<br /> * '''Synchronize with Directory Services before archiving'''&lt;br/&gt;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.<br /> * '''Messages with unknown e-mail addresses'''&lt;br/&gt; 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 (…)''.&lt;br/&gt;Alternatively, you can opt not to archive these emails at all.<br /> * Click on ''Next'' to continue.<br /> * You can specify [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|Deletion Rules]] for when archived mails should be deleted from the journal mailbox. This makes it possible to align the deletion with your MailStore Server backup strategy. For example, in case of a daily backup the deletion can be postponed by a day.<br /> * A ''Timeout'' value can be specified. Change this value only in case of definite need (e.g. with very slow servers). <br /> * Click on ''Next'' to continue.<br /> * 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.<br /> &lt;noinclude&gt;<br /> [[de:Vorlage:Archivierung Exchange Journal-Postfach archivieren]]<br /> [[en:Template:Archiving Exchange Journal Mailbox]]<br /> &lt;/noinclude&gt;</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=File:Xchg_jour_mailstore_01.png&diff=7862 2025-09-19T12:19:57Z

<p>Cstelzmann: Cstelzmann uploaded a new version of File:Xchg jour mailstore 01.png</p> <hr /> <div>Importing image file</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Template:Archiving_Exchange_Single_Mailbox&diff=7861 2025-09-19T11:59:29Z

<p>Cstelzmann: </p> <hr /> <div>For each mailbox, please proceed as follows:<br /> <br /> * 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.<br /> * Click on ''Archive Email''.<br /> * From the ''Email Servers'' list in the ''Create Profile'' area of the window, select ''Microsoft Exchange'' to create a new archiving profile.<br /> * A wizard opens to assist in specifying the archiving settings.<br /> * Select ''Single Mailbox''.<br /> {{#ifeq: {{{1}}}|Office 365|*: [[File:Office365_mailbox_01.png|center|347px]]<br /> * 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]]<br /> * Under ''Access via'', select the protocol to be used to access the Exchange server. Whenever possible, ''HTTPS'' should be used.<br /> *: '''Please note:''' {{Option Accept all certificates}} }}<br /> * {{#ifeq: {{{1}}}|Office 365|Leave the setting of ''Host'' to its default ''(Auto Detect)''.|Under ''Host'', enter the name of your Exchange server.}}<br /> * 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}}).<br /> *: '''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).<br /> * Under ''Password'', enter the user's password.<br /> * 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.<br /> * Click on ''Test'' to verify that MailStore can access the mailbox.<br /> * Click on ''Next''.<br /> * 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#Deleting_Emails_after_Archiving|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). <br /> *:[[File:Xchg_mailbox_03.png|center|347px]]<br /> *: &lt;p class=&quot;msnote&quot;&gt;'''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]].&lt;/p&gt;<br /> * Click on ''Next'' to continue.<br /> * 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''.<br /> *:[[File:Xchg_mailbox_02.png|center|347px]]<br /> * Click on ''Next''.<br /> * 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.<br /> &lt;noinclude&gt;<br /> [[de:Vorlage:Archivierung Einzelnes Exchange-Postfach archivieren]]<br /> [[en:Template:Archiving Exchange Single Mailbox]]<br /> &lt;/noinclude&gt;</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Archiving_Emails_from_Microsoft_365_Hybrid&diff=7856 2025-09-18T14:41:47Z

<p>Cstelzmann: </p> <hr /> <div>__NOTOC__<br /> {{Multiline Notices|Heading=Important Notices|MailStore Server supports archiving emails from a hybrid environment with Microsoft&amp;nbsp;365 (Modern Authentication) and on-premises Exchange Server(s) only with [https://learn.microsoft.com/en-us/exchange/exchange-hybrid Microsoft's Best Practice Guides] and only with the global Microsoft Cloud.|If you have archived emails from an Exchange server and synchronized users from an Active Directory until now, follow the article [[Changing Archiving from Microsoft Exchange Server to Microsoft 365]].<br /> |For better readability, the terms ''Microsoft&amp;nbsp;365'' and ''Exchange&amp;nbsp;Online'' are used interchangeably hereinafter instead of ''Exchange&amp;nbsp;Online / Microsoft&amp;nbsp;365''.<br /> | 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.}}<br /> <br /> == App Registration &amp; User Synchronization ==<br /> You have two options to synchronize users and their information into MailStore Server to make their mailboxes known and to allow them to log in at MailStore Server with their usual login details.<br /> <br /> === Synchronizing with Microsoft 365 (recommended for most scenarios) ===<br /> MailStore Server will only be synchronized with Microsoft Entra ID of your Microsoft 365 tenant. Since your local Active Directory is being synchronized with Microsoft Entra ID via a Microsoft Entra ID Connector, all relevant users details are also present in Microsoft 365.<br /> The advantage is that you can use all modern authentication methods, especially MFA, in MailStore Server.<br /> Proceed as if you solely had a [[Synchronizing User Accounts with Microsoft 365 - Modern Authentication|Microsoft 365 environment]].<br /> <br /> === Synchronizing with the local Active Directory of your company ===<br /> If you want to use Windows Authentication or Microsoft Active Directory Federation Services (ADFS) for logging in at MailStore Server you are able to synchronize MailStore Server with your local Active Directory.&lt;br /&gt;If you want to archive user mailboxes, shared mailboxes or public folder you still have to follow the [[Synchronizing User Accounts with Microsoft 365 - Modern Authentication|user synchronization with Microsoft 365 article]] to provide proper access permissions to your Microsoft 365 tenant.&lt;br /&gt;&lt;br /&gt;<br /> Do not execute these steps:<br /> :* 2.4 Configuring App Authentication in Microsoft Entra ID<br /> :* 2.5 Configuring the Redirect URI in MailStore Server<br /> :* 2.7 User Database Synchronization<br /> :* 4. Running Directory Services Synchronization<br /> The created app will be used later in the process for archiving the mailboxes. To synchronize users from the local Active Directory, follow the [[Active Directory Integration]] article now.<br /> <br /> == Archiving Microsoft&amp;nbsp;365 Mailboxes or Public Folders ==<br /> Use the manual for archiving mailboxes in Microsoft 365 as a guide. On-premise Exchange mailboxes are also being archived using Microsoft 365.<br /> * [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Archiving_Individual_Microsoft_365_Mailboxes|Archiving Individual Mailboxes]]<br /> * [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Archiving_Multiple_Microsoft_365_Mailboxes_Centrally|Archiving Multiple Mailboxes Centrally]]<br /> * [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Including_Microsoft_365_Shared_Mailboxes|Shared Mailboxes]]<br /> * [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Public_Folders|Public Folders]]<br /> * [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Archiving_Individual_Microsoft_365_Archive_Mailboxes|Archiving Individual Archive Mailboxes]]<br /> * [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Archiving_Multiple_Microsoft_365_Archive_Mailboxes_Centrally|Archiving Multiple Archive Mailboxes Centrally]]<br /> <br /> == Archiving Incoming and Outgoing Emails Directly ==<br /> <br /> Both your Microsoft 365 tenant and on-premises Exchange Server need to be configured to send journal reports for incoming and outgoing mails.<br /> <br /> * First configure the Journaling for Microsoft 365 with the MailStore Gateway: [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Archiving_Incoming_and_Outgoing_Emails_Directly|Archiving Incoming and Outgoing Emails Directly - Microsoft 365]]<br /> * Then configure your local Exchange Server to also send their journal reports to the same Gateway mailbox. 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:<br /> ** [[Archiving_Emails_from_Microsoft_Exchange_SE#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange SE]]<br /> ** [[Archiving_Emails_from_Microsoft_Exchange_2019#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2019]]<br /> ** [[Archiving_Emails_from_Microsoft_Exchange_2016#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2016]]<br /> ** [[Archiving_Emails_from_Microsoft_Exchange_2013#Archiving_Incoming_and_Outgoing_Emails_Directly|Exchange 2013 (Legacy System)]]<br /> <br /> <br /> [[de:E-Mail-Archivierung_von_Microsoft_365_Hybrid]]<br /> [[en:Archiving_Emails_from_Microsoft_365_Hybrid]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Implementation&diff=7855 2025-09-18T14:31:32Z

<p>Cstelzmann: </p> <hr /> <div>__NOTOC__<br /> ==== Microsoft 365 &amp; Microsoft Exchange Servers &amp; Outlook.com ====<br /> * [[Archiving Emails from Microsoft 365 (Modern Authentication)|Microsoft Exchange Online / Microsoft 365 (Modern Authentication)]]<br /> * [[Archiving Emails from Microsoft 365 Hybrid|Microsoft Exchange Online / Microsoft 365 Hybrid]]<br /> * [[Archiving Emails from Microsoft Exchange SE|Microsoft Exchange SE]]<br /> * [[Archiving Emails from Microsoft Exchange 2019|Microsoft Exchange 2019]]<br /> * [[Archiving Emails from Microsoft Exchange 2016|Microsoft Exchange 2016]]<br /> * [[Archiving Emails from Outlook.com|Outlook.com (Hotmail, Live, MSN)]]<br /> ==== Google Workspace &amp; Gmail ====<br /> * [[Archiving_Emails_from_Google_Workspace|Google Workspace]]<br /> * [[Archiving_Emails_from_Gmail|Gmail]]<br /> ==== IMAP/POP3-based Email Servers ====<br /> * [[Archiving Emails from MDaemon|MDaemon Email Server]]<br /> * [[Archiving Emails from Kerio Connect|Kerio Connect (Kerio MailServer)]]<br /> * [[Archiving Emails from IceWarp Server|IceWarp Server]]<br /> * [[Archiving Emails from Intra2net Systems|Intra2net Appliance Pro / Business Server]]<br /> * [[Archiving Emails from hMailServer|hMailServer]]<br /> * [[Archiving Emails from Tobit David.fx|Tobit David.fx]]<br /> * [[Archiving Emails from Zimbra|Zimbra Collaboration Suite]]<br /> * [[Archiving Emails from Linux-based Email Servers|Linux-based Email Server]]<br /> * [[Archiving Emails Without Your Own Emailserver]]&lt;br/&gt;(e.g. Hosted Exchange or POP3/IMAP-mailbox provided by an ISP)<br /> ==== Email Gateways ====<br /> * [[Archiving Emails from NoSpamProxy|NoSpamProxy]]<br /> ==== Legacy Implementation Guides ====<br /> {{{1|}}}<br /> * [[Archiving Emails from Microsoft Exchange 2013|Microsoft Exchange 2013]]<br /> * [[Archiving Emails from Microsoft Exchange 2010|Microsoft Exchange 2010]]<br /> * [[Archiving Emails from Microsoft Exchange 2007|Microsoft Exchange 2007]]<br /> * [[Archiving Emails from Kolab|Kolab]]<br /> * [[Archiving Emails from Scalix|Scalix]]<br /> &lt;noinclude&gt;<br /> [[de:Implementation]]<br /> [[en:Implementation]]<br /> &lt;/noinclude&gt;</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=HelpTopicIds&diff=7854 2025-09-18T14:21:22Z

<p>Cstelzmann: </p> <hr /> <div>* accs_export - [[Exporting_Email]]<br /> * accs_extsearch - [[Accessing_the_Archive_with_the_MailStore_Client_software#Advanced_Search]]<br /> * accs_outlook - [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration]]<br /> * accs_outlookapp - [[Accessing_the_Archive_with_the_Microsoft_Outlook_App_integration]]<br /> * accs_preview - [[Accessing_the_Archive_with_the_MailStore_Client_software#Email_Preview]]<br /> * accs_web - [[Accessing_the_Archive_with_MailStore_Web_Access]]<br /> * arch_delete - [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving]]<br /> * arch_filesystem - [[Archiving_Emails_from_External_Systems_(File_Import)]]<br /> * arch_filepst - [[Archiving_Outlook_PST_Files_Directly]]<br /> * arch_gateway - [[Archiving_MailStore_Gateway_Mailbox]]<br /> * arch_nospamproxy - [[Archiving_Emails_from_NoSpamProxy]]<br /> * gateway_introduction - [[Archiving_MailStore_Gateway_Mailbox]]<br /> * arch_googleapps_batch - [[Archiving_Emails_from_Google_Workspace#Archiving_Multiple_Mailboxes_Centrally]]<br /> * arch_googleapps - [[Archiving_Emails_from_Google_Workspace]]<br /> * arch_googleapps_multidrop - [[Archiving_Emails_from_Google_Workspace#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_googlemail_installed_app - [[Archiving_Emails_from_Gmail]]<br /> * arch_outlookcom_modern_auth - [[Archiving_Emails_from_Outlook.com]]<br /> * arch_icewarp - [[Archiving_Emails_from_IceWarp_Server]]<br /> * arch_icewarp_mailbox - [[Archiving_Emails_from_IceWarp_Server#Archiving_Individual_Mailboxes]]<br /> * arch_icewarp_mailboxes - [[Archiving_Emails_from_IceWarp_Server#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_icewarp_multidrop - [[Archiving_Emails_from_IceWarp_Server#Archiving_All_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_imapbatch - [[Batch-archiving_IMAP_Mailboxes]]<br /> * arch_inout - [[MailStore_Proxy]]<br /> * arch_introduction - [[Archiving_Email]]<br /> * arch_kerio - [[Archiving_Emails_from_Kerio_Connect]]<br /> * arch_kerio_mailbox - [[Archiving_Emails_from_Kerio_Connect#Archiving_Individual_Mailboxes]]<br /> * arch_kerio_mailboxes - [[Archiving_Emails_from_Kerio_Connect#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_kerio_multidrop - [[Archiving_Emails_from_Kerio_Connect#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_mailboxes - [[Archiving_Server_Mailboxes]]<br /> * arch_mailclients - [[Archiving_Email_from_Outlook,_Thunderbird_and_others]]<br /> * arch_mdaemon - [[Archiving_Emails_from_MDaemon]]<br /> * arch_mdaemon_mailbox - [[Archiving_Emails_from_MDaemon#Archiving_Individual_Mailboxes]]<br /> * arch_mdaemon_mailboxes - [[Archiving_Emails_from_MDaemon#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_mdaemon_multidrop - [[Archiving_Emails_from_MDaemon#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_multidrop - [[Archiving_IMAP_and_POP3_Multidrop_Mailboxes]]<br /> * arch_profiles - [[Archiving_Email]]<br /> * arch_schedule - [[Email_Archiving_with_MailStore_Basics#Automating_the_Archiving_Process]]<br /> * arch_results - [[Email_Archiving_with_MailStore_Basics]]<br /> * arch_selfolders - [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders]]<br /> * bkup_integrated - [[Backup_and_Restore]]<br /> * comp_auditing - [[Auditing]]<br /> * comp_auditlog - [[Audit_Log]]<br /> * comp_auditor - [[Compliance_General]]<br /> * comp_forcechangepassword - [[Notes_on_Password_Complexity]]<br /> * comp_general - [[Compliance_General]]<br /> * comp_manage_passwords - [[Accessing_the_Archive_with_the_MailStore_Client_software#Managing_Passwords]]<br /> * comp_password_complexity - [[Notes_on_Password_Complexity]]<br /> * comp_retention - [[Retention_Policies]]<br /> * comp_message_date - [[Message_Date_of_an_Email]]<br /> * expo_googleapps - [[Exporting_Email]]<br /> * gsta_login - [[Accessing_the_Archive_with_the_MailStore_Client_software#Starting_and_Login]]<br /> * job_jobs - [[Jobs]]<br /> * job_scheduling - [[Jobs]]<br /> * job_results - [[Job_Results]]<br /> * mads_sync - [[Administration]]<br /> * tech_config - [[MailStore_Server_Service_Configuration]]<br /> * tech_index - [[Search_Indexes]]<br /> * tech_mscmd - [[MailStore_Server_Management_Shell]]<br /> * tech_proxy - [[MailStore_Proxy]]<br /> * tech_safemode - [[MailStore_Server_Service_Configuration]]<br /> * tech_smtpsettings - [[SMTP_Settings]]<br /> * tech_archives - [[Archives]]<br /> * tech_storageloc - [[Storage_Locations]]<br /> * tech_productupdates - [[Product_Updates]]<br /> * umgm_privileges - [[Users,_Folders_and_Settings#User_Management]]<br /> * umgm_users - [[Users,_Folders_and_Settings#User_Management]]<br /> * xchg_introduction - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_jour_intro - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_mailbox - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_mailboxes - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_archive_mailbox - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_archive_mailboxes - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_public - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * impl_noownserver - [[Archiving_Emails_Without_Your_Own_Emailserver|(No own e-mail server)]]<br /> * impl_exim - [[Archiving_Emails_from_an_Exim_Based_Email_Server|Exim]]<br /> * impl_hmailserver - [[Archiving_Emails_from_hMailServer|hMailServer]]<br /> * impl_intranator - [[Archiving_Emails_from_Intra2net_Systems|Intra2net Appliance Pro / Business Server]]<br /> * impl_kerioconnect - [[Archiving_Emails_from_Kerio_Connect|Kerio Connect (Kerio MailServer)]]<br /> * impl_kolab - [[Archiving_Emails_from_Kolab|Kolab]]<br /> * impl_postfix - [[Archiving_Emails_from_a_Postfix_Based_Email_Server|Postfix]]<br /> * impl_qmail - [[Archiving_Emails_from_a_Qmail_Based_Email_Server|Qmail]]<br /> * impl_scalix - [[Archiving_Emails_from_Scalix|Scalix]]<br /> * impl_sendmail - [[Archiving_Emails_from_a_Sendmail_Based_Email_Server|Sendmail]]<br /> * impl_smartermail - [[Archiving_Emails_from_SmarterMail|SmarterMail]]<br /> * impl_tobitdavid - [[Archiving_Emails_from_Tobit_David.fx|Tobit David.fx]]<br /> * impl_zimbra - [[Archiving_Emails_from_Zimbra|Zimbra Collaboration Suite]]<br /> * implexch_2003 - [[Archiving_Emails_from_Microsoft_Exchange_2003|Exchange 2003]]<br /> * implexch_2007 - [[Archiving_Emails_from_Microsoft_Exchange_2007|Exchange 2007]]<br /> * implexch_2010 - [[Archiving_Emails_from_Microsoft_Exchange_2010|Exchange 2010]]<br /> * implexch_2013 - [[Archiving_Emails_from_Microsoft_Exchange_2013|Exchange 2013]]<br /> * implexch_2016 - [[Archiving_Emails_from_Microsoft_Exchange_2016|Exchange 2016]] <br /> * implexch_2019 - [[Archiving_Emails_from_Microsoft_Exchange_2019|Exchange 2019]]<br /> * implexch_se - [[Archiving_Emails_from_Microsoft_Exchange_SE|Exchange SE]]<br /> * implexch_o365 - [[Archiving_Emails_from_Microsoft_Office_365|Office 365]]<br /> * welc_licensing - [[License_Management]]<br /> * arch_microsoft365 - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)]]<br /> * arch_microsoft365_single - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Individual_Microsoft.C2.A0365_Mailboxes]]<br /> * arch_microsoft365_multiple - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Multiple_Microsoft.C2.A0365_Mailboxes_Centrally]]<br /> * arch_microsoft365_single_archive_mailbox - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Individual_Microsoft.C2.A0365_Archive_Mailboxes]]<br /> * arch_microsoft365_multiple_archive_mailboxes - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Multiple_Microsoft.C2.A0365_Archive_Mailboxes_Centrally]]<br /> * arch_microsoft365_public - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Public_Folders]]<br /> * expo_microsoft365 - [[Exporting_Email]]<br /> * cred_microsoft365 - [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server]]<br /> <br /> [[de:HelpTopicIds]]<br /> [[en:helpTopicIds]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Template:Hosted_Exchange_Versions&diff=7853 2025-09-18T14:16:31Z

<p>Cstelzmann: </p> <hr /> <div>* [[Archiving_Emails_from_Microsoft_Exchange_SE#{{{1|}}}|{{{2|Microsoft Exchange}}} SE]]<br /> * [[Archiving_Emails_from_Microsoft_Exchange_2019#{{{1|}}}|{{{2|Microsoft Exchange}}} 2019]]<br /> * [[Archiving_Emails_from_Microsoft_Exchange_2016#{{{1|}}}|{{{2|Microsoft Exchange}}} 2016]]<br /> &lt;noinclude&gt;<br /> [[de:Vorlage:Hosted_Exchange_Versionen]]<br /> [[en:Template:Hosted_Exchange_Versions]]<br /> &lt;noinclude&gt;</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Archiving_Emails_from_Microsoft_Exchange_SE&diff=7852 2025-09-18T14:04:04Z

<p>Cstelzmann: Created page with &quot;{{Implementation Guide Preamble|Microsoft Exchange SE}} == Synchronizing Users == {{Archiving Exchange Synchronizing Users|Microsoft Exchange SE}} == Archiving Individual Ma...&quot;</p> <hr /> <div>{{Implementation Guide Preamble|Microsoft Exchange SE}}<br /> <br /> == Synchronizing Users ==<br /> {{Archiving Exchange Synchronizing Users|Microsoft Exchange SE}}<br /> <br /> == Archiving Individual Mailboxes ==<br /> {{Archiving Single Mailbox Preamble|Microsoft Exchange SE}}<br /> {{Archiving Exchange Single Mailbox}}<br /> <br /> == Archiving Multiple Exchange Mailboxes Centrally ==<br /> {{Archiving Multiple Mailboxes Preamble|Microsoft Exchange SE}}<br /> <br /> === Step 1: Setting up a service account for accessing mailboxes ===<br /> To archive multiple mailboxes at once, a service account with access access to all mailboxes to be archived needs to be created first. To be able to set up such an account, you must be a member of the ''Organization Management'' role group. There are two methods to configure the service account:<br /> <br /> ==== Method 1: Setting up the service account through the ''Exchange admin center'' ====<br /> <br /> * Create an unprivileged domain user (e.g. ''MailStore Server'').<br /> * Log on to the ''Exchange admin center'' of your Microsoft Exchange environment.<br /> * Navigate to ''permissions''.<br /> * Under ''admin roles'' select ''+ (New)''.<br /> *: [[Image:Arch_exchange2013_multi_01.png|center|550px]]<br /> * Enter a meaningful name (e.g. ''MailStore Impersonation'') and description for the new role group.<br /> * Under ''Roles'' add the role ''ApplicationImpersonation''.<br /> * Under ''Members'' add the user you've created above.<br /> * Click on ''Save'' to create the new role group.<br /> * Continue with step 2.<br /> <br /> ==== Method 2: Setting up the service account through the ''Exchange Management Shell'' ====<br /> <br /> * Create an unprivileged domain user (e.g. ''mailstore@example.com'').<br /> * Open a Microsoft Exchange Management Shell session on the Microsoft Exchange SE Server.<br /> * Enter the following command:<br /> &lt;div style=&quot;margin-left: 2.5em;&quot;&gt;<br /> &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> New-ManagementRoleAssignment -Name:&quot;MailStore Impersonation&quot; -Role:ApplicationImpersonation -User:mailstore@example.com<br /> &lt;/source&gt;<br /> &lt;/div&gt;<br /> * ''Optional:'' Enter the following command to check the role assignment:<br /> &lt;div style=&quot;margin-left: 2.5em;&quot;&gt;<br /> &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> Get-ManagementRoleAssignment -Role:ApplicationImpersonation -RoleAssigneeType:User | Format-List *<br /> <br /> Get-ManagementRoleAssignment -Identity:&quot;MailStore Impersonation&quot; | Format-List *<br /> &lt;/source&gt;<br /> &lt;/div&gt;<br /> * ''Optional:'' Enter the following command to remove the role assignment:<br /> &lt;div style=&quot;margin-left: 2.5em;&quot;&gt;<br /> &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;<br /> Remove-ManagementRoleAssignment &quot;MailStore Impersonation&quot;<br /> &lt;/source&gt;<br /> &lt;/div&gt;<br /> <br /> === Step 2: Configuration of MailStore Server ===<br /> {{Archiving Exchange Multiple Mailboxes}}<br /> <br /> == Archiving Incoming and Outgoing Emails Directly ==<br /> {{Archiving Exchange Journal Mailbox Preamble|Microsoft Exchange SE}}<br /> <br /> === Step 1: Creating a Mailbox for Journaling ===<br /> {{Archiving Exchange Create Journal Mailbox|2013}}<br /> === Step 2: Configuring Exchange Journaling ===<br /> {{Configuring Exchange Journaling Preamble|Microsoft Exchange SE}}<br /> ==== Alternative 1: Configure Standard Journaling ====<br /> * Log on to the ''Exchange admin center'' of your Microsoft Exchange environment.<br /> * Select the ''servers'' menu item.<br /> * On the ''databases'' tab, doubleclick on the mailbox database for which you want to set up journaling.<br /> * Select the ''maintenance'' tab.<br /> * Click on ''browse...'' next to the ''Journal recipient:'' box.<br /> * Select the user that was created in step 1 from the recipient list and confirm with ''OK''.<br /> *:[[File:Xchg_jour_2013_02a.png|center|480px]]<br /> * Click on ''save'' to confirm the changes.<br /> <br /> ==== Alternative 2: Configure Premium Journaling ====<br /> * Log on to the ''Exchange admin center'' of your Microsoft Exchange environment.<br /> * Select the ''compliance management'' menu item.<br /> * On the ''journal rules'' tab, click on ''+ (New)''.<br /> * The dialog window ''New Journal Rule'' opens:<br /> *:[[File:Xchg_jour_2013_02b.png|center|480px]]<br /> * Enter a name for the journal rule, e.g. ''Journaling''.<br /> * 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.<br /> * 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.<br /> * In the ''Send journal reports to:'' box, enter the email address of the user created in step 1.<br /> * Click on ''save'' to activate the rule. Please keep in mind that in complex Microsoft Exchange environments it may take several minutes until the new rule becomes effective.<br /> <br /> === Step 3: Configuration of MailStore Server ===<br /> {{Archiving Exchange Journal Mailbox}}<br /> <br /> == Public Folders ==<br /> {{Archiving Exchange Public Folders Preamble|Exchange SE}}<br /> * Log on to the ''Exchange admin center'' of you Microsoft Exchange environment as an Exchange admin.<br /> * Navigate to ''public folders''.<br /> * Click on the ''Ellipsis (…)'' and select ''Root permissions''.<br /> *: [[File:Arch_exchange2013_pf_01.png|center|480px]]<br /> * A new browser window opens. Click on ''+ (Add)''.<br /> * Use ''Browse'' to choose the Exchange user you want to grant permissions.<br /> * Choose ''Custom'' as ''Permission level'' and grant ''Read items'' and ''Delete all'' permissions.<br /> *: [[File:Arch_office365_pf_02.png|center|347px]]<br /> * Click on ''Save''.<br /> * Enable the option ''Apply changes to this public folder and all its subfolders.''<br /> * Click on ''Save''.<br /> * Click on ''Close'' after saving has been completed successfully.<br /> === Step 3: Setting up the Archiving Process ===<br /> {{Archiving Exchange Public Folder}}<br /> <br /> == Shared Mailboxes ==<br /> {{Archiving Exchange Shared Mailbox}}<br /> <br /> == About Archiving Archive Mailboxes ==<br /> {{Archive_Mailbox_Folder_Structure}}<br /> <br /> == Archiving Individual Archive Mailboxes ==<br /> {{Archiving Single Archive Mailbox Preamble|Microsoft Exchange SE}}<br /> {{Archiving Exchange Single Archive Mailbox}}<br /> <br /> == Archiving Multiple Exchange Archive Mailboxes Centrally ==<br /> {{Archiving Multiple Archive Mailboxes Preamble|Microsoft Exchange SE}}<br /> Create a service account that has access on all archive mailboxes as described <br /> [[#Step_1:_Setting_up_a_service_account_for_accessing_mailboxes|here]].<br /> {{Archiving Exchange Multiple Archive Mailboxes}} <br /> <br /> == Throttling in Exchange SE ==<br /> {{Archiving Exchange Throttling|SE}}<br /> <br /> == Weblinks ==<br /> * {{MailStore Support}}<br /> <br /> [[de:E-Mail-Archivierung von Microsoft Exchange SE]]<br /> [[en:Archiving_Emails_from_Microsoft_Exchange_SE]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Server_Help:Books/MailStore_Server_25.3&diff=7815 2025-07-04T09:55:07Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.3 == === Documentation === ;Installation...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.3 ==<br /> === Documentation ===<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|MailStore Server 25.3]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=SMTP_Settings&diff=7808 2025-06-24T15:31:16Z

<p>Cstelzmann: </p> <hr /> <div>__NOTOC__<br /> <br /> To be able to send emails, MailStore Server requires SMTP access data. MailStore sends notifications by email if [[Product Updates|product updates]] are available or if the automatic creation of a new [[Storage_Locations|archive store]] failed. Furthermore, email copies for the [[Accessing_the_Archive_with_MailStore_Web_Access#Restoring_Email|restore from MailStore Web Access]] can be sent via SMTP.<br /> <br /> Under ''Administrative Tools &gt; Miscellaneous &gt; SMTP Settings'' you can specify the SMTP settings.<br /> <br /> You can choose between standard authentication for any SMTP server and OAuth2 for Microsoft 365.<br /> <br /> === Standard authentication ===<br /> <br /> This type is used for SMTP servers that support PLAIN and LOGIN authentication or do not require authentication.<br /> <br /> [[File:tech_smtpsettings_01.png|center|550px]]<br /> <br /> * Select the type ''Standard''.<br /> * Under ''Server'', enter the host name of the SMTP server or its IP address. <br /> * By default, MailStore uses port 587. If you want to use a different port, enter port number in the ''Port'' field.<br /> * In the field ''Protocol'', select ''SMTP'' for an unencrypted connection to the SMTP server. For an encrypted connection, select ''SMTP-TLS'' or ''SMTP-SSL''. {{Option_Accept_all_certificates}}<br /> * Especially SMTP servers which are accessible through the internet require a login (SMTP authentication). Check the corresponding checkbox and enter the appropriate access data. In most cases, the POP3 access data of any user on the email server can be used.<br /> <br /> === Microsoft 365 and Microsoft 365 (21 Vianet) ===<br /> <br /> These types are used by Microsoft 365 SMTP servers and use OAuth2 for authentication.<br /> <br /> [[File:tech_smtpsettings_02.png|center|550px]]<br /> <br /> * Select the type ''Microsoft 365'' or ''Microsoft 365 (21 Vianet)'', depending on where your tenant is hosted.<br /> * Authentication requires an Entra ID app registration, a service principal, and a mailbox.<br /> * Creating the app registration is described in [[Synchronizing_User_Accounts_with_Microsoft_365_-_Modern_Authentication|this article]]. If you're already using directory service synchronization or archiving from Microsoft 365, you already have such an app registration.<br /> * In particular, make sure that you have enabled or activated the SMTP.SendAsApp permission when configuring the API permissions in the SMTP area.<br /> * The PowerShell module ''ExchangeOnlineManagement'' is required to set the permission. The presence of the module can be checked with the following command.<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Get-Module ExchangeOnlineManagement -ListAvailable&lt;/source&gt;<br /> * If the output is empty, the module can be installed with the following command:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Install-Module -Name ExchangeOnlineManagement&lt;/source&gt;<br /> * Then the module can be loaded:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Import-module ExchangeOnlineManagement&lt;/source&gt;<br /> * Connect with your client:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Connect-ExchangeOnline -Organization &lt;tenantID&gt;&lt;/source&gt;<br /> * Creating the app registration also resulted in the creation of an Enterprise App with its ''own ObjectID'' in your tenant. The next step requires the Enterprise App's ObjectID (not from the original app registration) and ApplicationID. Both can be found in the Entra ID Portal at [https://portal.azure.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/~/AppAppsPreview this page].<br /> * Now create a service principal for this Enterprise App:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;New-ServicePrincipal -AppId &lt;appID&gt; -ObjectId &lt;enterpriseAppObjectID&gt; -DisplayName &quot;MailStore Service Principal&quot;&lt;/source&gt;<br /> * The service principal must now be granted permission to send emails on behalf of a user. This user's email address must later be specified as the sender in the MailStore SMTP settings:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Add-MailboxPermission -Identity &quot;emailAddressof@sending.user&quot; -User &lt;enterpriseAppObjectID&gt; -AccessRights FullAccess&lt;/source&gt;<br /> * Additionally, make sure that SMTP is allowed for this user:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Set-CASMailbox -Identity &quot;emailAddressof@sending.user&quot; -SmtpClientAuthenticationDisabled $false&lt;/source&gt;<br /> * Click the &amp;hellip; in the ''Credentials'' section and select your ''Credentials''.<br /> <br /> === General settings ===<br /> * Under ''Sender'', enter the ''Display Name'' and the ''Email Address'' of the email sender. Many SMTP servers require an existing email address to be entered. The display name can be chosen freely; ideally the name indicates that the email was sent by MailStore Server.<br /> * Under ''Recipient for Notifications'', enter the email address of the recipient for administrative notifications of MailStore Server. To specify multiple recipients, enter them comma-separated. <br /> * Once all settings have been specified, MailStore Server can be instructed to send a test email to the email address entered for notifications; simply click on ''Apply and Test''. If an error message appears or the recipient specified does not receive the email, the following hints for troubleshooting may be helpful.<br /> <br /> == Troubleshooting ==<br /> * If no error occurs upon sending but the email does not arrive, please check the spam or junk mail folder of the mailbox. Perhaps the email was filtered out.<br /> * If an error message appears because of an invalid certificate (&quot;Server's certificate was rejected by the verifier because of an unknown certificate authority.&quot;), check ''Accept all certificates'' and try again.<br /> * If an error message appears indicating that ''&quot;One or more recipients rejected&quot;'', the SMTP server probably requires authentication. Enter the appropriate access data as described above.<br /> * If an error message appears because of invalid access data (''&quot;Incorrect authentication data&quot;''or ''&quot;Authentication failed&quot;''), verify the data entered. In most cases, the access data match those of the corresponding POP3 server.<br /> * If further error messages appear or other problems arise, please check your entries for possible mistakes.<br /> <br /> [[de:SMTP-Einstellungen]]<br /> [[en:SMTP Settings]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=SMTP_Settings&diff=7807 2025-06-24T15:09:49Z

<p>Cstelzmann: </p> <hr /> <div>__NOTOC__<br /> <br /> To be able to send emails, MailStore Server requires SMTP access data. MailStore sends notifications by email if [[Product Updates|product updates]] are available or if the automatic creation of a new [[Storage_Locations|archive store]] failed. Furthermore, email copies for the [[Accessing_the_Archive_with_MailStore_Web_Access#Restoring_Email|restore from MailStore Web Access]] can be sent via SMTP.<br /> <br /> Under ''Administrative Tools &gt; Miscellaneous &gt; SMTP Settings'' you can specify the SMTP settings.<br /> <br /> You can choose between standard authentication for any SMTP server and OAuth2 for Microsoft 365.<br /> <br /> === Standard authentication ===<br /> <br /> This type is used for SMTP servers that support PLAIN and LOGIN authentication or do not require authentication.<br /> <br /> [[File:tech_smtpsettings_01.png|center|550px]]<br /> <br /> * Select the type ''Standard''.<br /> * Under ''Server'', enter the host name of the SMTP server or its IP address. <br /> * By default, MailStore uses port 587. If you want to use a different port, enter port number in the ''Port'' field.<br /> * In the field ''Protocol'', select ''SMTP'' for an unencrypted connection to the SMTP server. For an encrypted connection, select ''SMTP-TLS'' or ''SMTP-SSL''. {{Option_Accept_all_certificates}}<br /> * Especially SMTP servers which are accessible through the internet require a login (SMTP authentication). Check the corresponding checkbox and enter the appropriate access data. In most cases, the POP3 access data of any user on the email server can be used.<br /> <br /> === Microsoft 365 and Microsoft 365 (21 Vianet) ===<br /> <br /> These types are used by Microsoft 365 SMTP servers and use OAuth2 for authentication.<br /> <br /> [[File:tech_smtpsettings_02.png|center|550px]]<br /> <br /> * Select the type ''Microsoft 365'' or ''Microsoft 365 (21 Vianet)'', depending on where your tenant is hosted.<br /> * Authentication requires an Entra ID app registration, a service principal, and a mailbox.<br /> * Creating the app registration is described in [[Synchronizing_User_Accounts_with_Microsoft_365_-_Modern_Authentication|this article]]. If you're already using directory service synchronization or archiving from Microsoft 365, you already have such an app registration.<br /> * In particular, make sure that you have enabled or activated the SMTP.SendAsApp permission when configuring the API permissions in the SMTP area.<br /> * The PowerShell module ''ExchangeOnlineManagement'' is required to set the permission. The presence of the module can be checked with the following command.<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Get-Module ExchangeOnlineManagement -ListAvailable&lt;/source&gt;<br /> * If the output is empty, the module can be installed with the following command:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Install-Module -Name ExchangeOnlineManagement&lt;/source&gt;<br /> * Then the module can be loaded:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Import-module ExchangeOnlineManagement&lt;/source&gt;<br /> * Connect with your client:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Connect-ExchangeOnline -Organization &lt;tenantID&gt;&lt;/source&gt;<br /> * Creating the app registration also resulted in the creation of an Enterprise App with its ''own ObjectID'' in your tenant. The next step requires the Enterprise App's ObjectID and ApplicationID (not from the original app registration). Both can be found in the Entra ID Portal at [https://portal.azure.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/~/AppAppsPreview this page].<br /> * Now create a service principal for this Enterprise App:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;New-ServicePrincipal -AppId &lt;appID&gt; -ObjectId &lt;enterpriseAppObjectID&gt; -DisplayName &quot;MailStore Service Principal&quot;&lt;/source&gt;<br /> * The service principal must now be granted permission to send emails on behalf of a user. This user's email address must later be specified as the sender in the MailStore SMTP settings:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Add-MailboxPermission -Identity &quot;emailAddressof@sending.user&quot; -User &lt;enterpriseAppObjectID&gt; -AccessRights FullAccess&lt;/source&gt;<br /> * Additionally, make sure that SMTP is allowed for this user:<br /> *; &lt;source lang=&quot;powershell&quot; smart-tabs=&quot;true&quot; toolbar=&quot;false&quot; gutter=&quot;false&quot;&gt;Set-CASMailbox -Identity &quot;emailAddressof@sending.user&quot; -SmtpClientAuthenticationDisabled $false&lt;/source&gt;<br /> * Click the &amp;hellip; in the ''Credentials'' section and select your ''Credentials''.<br /> <br /> === General settings ===<br /> * Under ''Sender'', enter the ''Display Name'' and the ''Email Address'' of the email sender. Many SMTP servers require an existing email address to be entered. The display name can be chosen freely; ideally the name indicates that the email was sent by MailStore Server.<br /> * Under ''Recipient for Notifications'', enter the email address of the recipient for administrative notifications of MailStore Server. To specify multiple recipients, enter them comma-separated. <br /> * Once all settings have been specified, MailStore Server can be instructed to send a test email to the email address entered for notifications; simply click on ''Apply and Test''. If an error message appears or the recipient specified does not receive the email, the following hints for troubleshooting may be helpful.<br /> <br /> == Troubleshooting ==<br /> * If no error occurs upon sending but the email does not arrive, please check the spam or junk mail folder of the mailbox. Perhaps the email was filtered out.<br /> * If an error message appears because of an invalid certificate (&quot;Server's certificate was rejected by the verifier because of an unknown certificate authority.&quot;), check ''Accept all certificates'' and try again.<br /> * If an error message appears indicating that ''&quot;One or more recipients rejected&quot;'', the SMTP server probably requires authentication. Enter the appropriate access data as described above.<br /> * If an error message appears because of invalid access data (''&quot;Incorrect authentication data&quot;''or ''&quot;Authentication failed&quot;''), verify the data entered. In most cases, the access data match those of the corresponding POP3 server.<br /> * If further error messages appear or other problems arise, please check your entries for possible mistakes.<br /> <br /> [[de:SMTP-Einstellungen]]<br /> [[en:SMTP Settings]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=HelpTopicIds&diff=7770 2025-03-20T16:31:35Z

<p>Cstelzmann: </p> <hr /> <div>* accs_export - [[Exporting_Email]]<br /> * accs_extsearch - [[Accessing_the_Archive_with_the_MailStore_Client_software#Advanced_Search]]<br /> * accs_outlook - [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration]]<br /> * accs_outlookapp - [[Accessing_the_Archive_with_the_Microsoft_Outlook_App_integration]]<br /> * accs_preview - [[Accessing_the_Archive_with_the_MailStore_Client_software#Email_Preview]]<br /> * accs_web - [[Accessing_the_Archive_with_MailStore_Web_Access]]<br /> * arch_delete - [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving]]<br /> * arch_filesystem - [[Archiving_Emails_from_External_Systems_(File_Import)]]<br /> * arch_filepst - [[Archiving_Outlook_PST_Files_Directly]]<br /> * arch_gateway - [[Archiving_MailStore_Gateway_Mailbox]]<br /> * arch_nospamproxy - [[Archiving_NoSpamProxy]]<br /> * gateway_introduction - [[Archiving_MailStore_Gateway_Mailbox]]<br /> * arch_googleapps_batch - [[Archiving_Emails_from_Google_Workspace#Archiving_Multiple_Mailboxes_Centrally]]<br /> * arch_googleapps - [[Archiving_Emails_from_Google_Workspace]]<br /> * arch_googleapps_multidrop - [[Archiving_Emails_from_Google_Workspace#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_googlemail_installed_app - [[Archiving_Emails_from_Gmail]]<br /> * arch_outlookcom_modern_auth - [[Archiving_Emails_from_Outlook.com]]<br /> * arch_icewarp - [[Archiving_Emails_from_IceWarp_Server]]<br /> * arch_icewarp_mailbox - [[Archiving_Emails_from_IceWarp_Server#Archiving_Individual_Mailboxes]]<br /> * arch_icewarp_mailboxes - [[Archiving_Emails_from_IceWarp_Server#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_icewarp_multidrop - [[Archiving_Emails_from_IceWarp_Server#Archiving_All_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_imapbatch - [[Batch-archiving_IMAP_Mailboxes]]<br /> * arch_inout - [[MailStore_Proxy]]<br /> * arch_introduction - [[Archiving_Email]]<br /> * arch_kerio - [[Archiving_Emails_from_Kerio_Connect]]<br /> * arch_kerio_mailbox - [[Archiving_Emails_from_Kerio_Connect#Archiving_Individual_Mailboxes]]<br /> * arch_kerio_mailboxes - [[Archiving_Emails_from_Kerio_Connect#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_kerio_multidrop - [[Archiving_Emails_from_Kerio_Connect#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_mailboxes - [[Archiving_Server_Mailboxes]]<br /> * arch_mailclients - [[Archiving_Email_from_Outlook,_Thunderbird_and_others]]<br /> * arch_mdaemon - [[Archiving_Emails_from_MDaemon]]<br /> * arch_mdaemon_mailbox - [[Archiving_Emails_from_MDaemon#Archiving_Individual_Mailboxes]]<br /> * arch_mdaemon_mailboxes - [[Archiving_Emails_from_MDaemon#Archiving_Multiple_Mailboxes_in_One_Step]]<br /> * arch_mdaemon_multidrop - [[Archiving_Emails_from_MDaemon#Archiving_Incoming_and_Outgoing_Emails_Directly]]<br /> * arch_multidrop - [[Archiving_IMAP_and_POP3_Multidrop_Mailboxes]]<br /> * arch_profiles - [[Archiving_Email]]<br /> * arch_schedule - [[Email_Archiving_with_MailStore_Basics#Automating_the_Archiving_Process]]<br /> * arch_results - [[Email_Archiving_with_MailStore_Basics]]<br /> * arch_selfolders - [[Email_Archiving_with_MailStore_Basics#Archiving_Specific_Folders]]<br /> * bkup_integrated - [[Backup_and_Restore]]<br /> * comp_auditing - [[Auditing]]<br /> * comp_auditlog - [[Audit_Log]]<br /> * comp_auditor - [[Compliance_General]]<br /> * comp_forcechangepassword - [[Notes_on_Password_Complexity]]<br /> * comp_general - [[Compliance_General]]<br /> * comp_manage_passwords - [[Accessing_the_Archive_with_the_MailStore_Client_software#Managing_Passwords]]<br /> * comp_password_complexity - [[Notes_on_Password_Complexity]]<br /> * comp_retention - [[Retention_Policies]]<br /> * comp_message_date - [[Message_Date_of_an_Email]]<br /> * expo_googleapps - [[Exporting_Email]]<br /> * gsta_login - [[Accessing_the_Archive_with_the_MailStore_Client_software#Starting_and_Login]]<br /> * job_jobs - [[Jobs]]<br /> * job_scheduling - [[Jobs]]<br /> * job_results - [[Job_Results]]<br /> * mads_sync - [[Administration]]<br /> * tech_config - [[MailStore_Server_Service_Configuration]]<br /> * tech_index - [[Search_Indexes]]<br /> * tech_mscmd - [[MailStore_Server_Management_Shell]]<br /> * tech_proxy - [[MailStore_Proxy]]<br /> * tech_safemode - [[MailStore_Server_Service_Configuration]]<br /> * tech_smtpsettings - [[SMTP_Settings]]<br /> * tech_archives - [[Archives]]<br /> * tech_storageloc - [[Storage_Locations]]<br /> * tech_productupdates - [[Product_Updates]]<br /> * umgm_privileges - [[Users,_Folders_and_Settings#User_Management]]<br /> * umgm_users - [[Users,_Folders_and_Settings#User_Management]]<br /> * xchg_introduction - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_jour_intro - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_mailbox - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_mailboxes - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_archive_mailbox - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_archive_mailboxes - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * xchg_public - [[Archiving_Emails_from_Microsoft_Exchange]]<br /> * impl_noownserver - [[Archiving_Emails_Without_Your_Own_Emailserver|(No own e-mail server)]]<br /> * impl_exim - [[Archiving_Emails_from_an_Exim_Based_Email_Server|Exim]]<br /> * impl_hmailserver - [[Archiving_Emails_from_hMailServer|hMailServer]]<br /> * impl_intranator - [[Archiving_Emails_from_Intra2net_Systems|Intra2net Appliance Pro / Business Server]]<br /> * impl_kerioconnect - [[Archiving_Emails_from_Kerio_Connect|Kerio Connect (Kerio MailServer)]]<br /> * impl_kolab - [[Archiving_Emails_from_Kolab|Kolab]]<br /> * impl_postfix - [[Archiving_Emails_from_a_Postfix_Based_Email_Server|Postfix]]<br /> * impl_qmail - [[Archiving_Emails_from_a_Qmail_Based_Email_Server|Qmail]]<br /> * impl_scalix - [[Archiving_Emails_from_Scalix|Scalix]]<br /> * impl_sendmail - [[Archiving_Emails_from_a_Sendmail_Based_Email_Server|Sendmail]]<br /> * impl_smartermail - [[Archiving_Emails_from_SmarterMail|SmarterMail]]<br /> * impl_tobitdavid - [[Archiving_Emails_from_Tobit_David.fx|Tobit David.fx]]<br /> * impl_zimbra - [[Archiving_Emails_from_Zimbra|Zimbra Collaboration Suite]]<br /> * implexch_2003 - [[Archiving_Emails_from_Microsoft_Exchange_2003|Exchange 2003]]<br /> * implexch_2007 - [[Archiving_Emails_from_Microsoft_Exchange_2007|Exchange 2007]]<br /> * implexch_2010 - [[Archiving_Emails_from_Microsoft_Exchange_2010|Exchange 2010]]<br /> * implexch_2013 - [[Archiving_Emails_from_Microsoft_Exchange_2013|Exchange 2013]]<br /> * implexch_2016 - [[Archiving_Emails_from_Microsoft_Exchange_2016|Exchange 2016]] <br /> * implexch_2019 - [[Archiving_Emails_from_Microsoft_Exchange_2019|Exchange 2019]]<br /> * implexch_o365 - [[Archiving_Emails_from_Microsoft_Office_365|Office 365]]<br /> * welc_licensing - [[License_Management]]<br /> * arch_microsoft365 - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)]]<br /> * arch_microsoft365_single - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Individual_Microsoft.C2.A0365_Mailboxes]]<br /> * arch_microsoft365_multiple - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Multiple_Microsoft.C2.A0365_Mailboxes_Centrally]]<br /> * arch_microsoft365_single_archive_mailbox - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Individual_Microsoft.C2.A0365_Archive_Mailboxes]]<br /> * arch_microsoft365_multiple_archive_mailboxes - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Archiving_Multiple_Microsoft.C2.A0365_Archive_Mailboxes_Centrally]]<br /> * arch_microsoft365_public - [[Archiving_Emails_from_Microsoft_365_(Modern_Authentication)#Public_Folders]]<br /> * expo_microsoft365 - [[Exporting_Email]]<br /> * cred_microsoft365 - [[Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)#Creating_Credentials_in_MailStore_Server]]<br /> <br /> [[de:HelpTopicIds]]<br /> [[en:helpTopicIds]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Archiving_Emails_from_Outlook.com&diff=7769 2025-03-20T15:49:07Z

<p>Cstelzmann: </p> <hr /> <div>{{Implementation_Guide_Preamble|Outlook.com}}<br /> &lt;p class=&quot;msnote&quot;&gt;'''Please note:''' The following steps describe the setup for archiving a Outlook.com mailbox where the mailbox owner authorizes mailbox access by MailStore Server through OAuth. Archiving mailboxes from other Microsoft domains such as live.com, hotmail.com or msn.com is also possible with this profile. For archiving single Microsoft 365 mailboxes by an administrator, please use the corresponding <br /> [[Archiving_Emails_from_Microsoft_365_-_Modern_Authentication#Archiving_Individual_Microsoft_365_Mailboxes|Microsoft&amp;nbsp;365 profile]].<br /> &lt;/p&gt;<br /> <br /> By following the procedure described here, a single Outlook.com mailbox can be archived for a specific MailStore user. The archiving process can be executed manually or automatically.<br /> <br /> Setting up archiving processes for Outlook.com mailboxes is done using archiving profiles. General information about archiving profiles is available in chapter [[Email_Archiving_with_MailStore_Basics#Working_with_Archiving_Profiles|Working with Archiving Profiles]].<br /> <br /> For each mailbox, please proceed as follows:<br /> * Users can only archive their own mailboxes to their personal user archive. To archive the emails of other users, you have to be logged on to MailStore Client as MailStore administrator. Only MailStore administrators can archive the emails of other users.<br /> * Click on ''Archive Email''.<br /> * To create a new archiving profile, select ''Microsoft Outlook.com'' from the ''Email Servers'' list in the ''Create Profile'' area of the application window.<br /> * A wizard opens guiding you through the setup process.<br /> *:[[File:arch_outlook_com_01.png|center|350px]]<br /> * Enter the ''Email Address'' into the designated field.<br /> * To archive a Outlook.com mailbox, the mailbox owner has to authorize access by MailStore Server to the mailbox. For this, click on ''Authorize''.<br /> * A browser window to grant access to a Outlook.com mailbox to MailStore opens. The mailbox owner might need to log in to Microsoft according to his or her security configuration.<br /> *:[[File:arch_outlook_com_02.png|center|350px]]<br /> * Click on ''Next''.<br /> * Customize the [[Email_Archiving_with_MailStore_Basics#Specifying_Filter_Criteria_for_Archiving|filter]] and the [[Email_Archiving_with_MailStore_Basics#Deleting_Emails_after_Archiving|deletion rules]]. By default, no emails will be deleted from a mailbox. The timeout value only has to be adjusted as needed.<br /> *:[[File:arch_outlook_com_03.png|center|350px]]<br /> * Click on ''Next''.<br /> * If logged on to MailStore Server as administrator, the target archive can be specified at the next step. Select the archive of the user for whom the mailbox is to be archived.<br /> *:[[File:arch_outlook_com_04.png|center|350px]]<br /> * At the last step, a name for the new archiving profile can be specified. After clicking on ''Finish'', the archiving profile will be listed under ''Saved Profiles'' and can be run immediately or automatically.<br /> <br /> == Weblinks ==<br /> Application permissions to your Microsoft account can be configured<br /> [https://account.live.com/consent/Manage here].<br /> <br /> <br /> [[de:E-Mail-Archivierung von Outlook.com]]<br /> [[en:Archiving Emails from Outlook.com]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=MailStore_Server_Help:Books/MailStore_Server_25.1&diff=7741 2025-01-15T10:15:02Z

<p>Cstelzmann: Created page with &quot;{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 | setting-showtoc = 1 }} == MailStore Server 25.1 == === Documentation === ;Installation...&quot;</p> <hr /> <div>{{saved_book<br /> | setting-papersize = a4<br /> | setting-toc = auto<br /> | setting-columns = 1<br /> | setting-showtoc = 1<br /> }}<br /> <br /> == MailStore Server 25.1 ==<br /> === Documentation ===<br /> ;Installation<br /> :[[Installation]]<br /> :[[Update Notices for MailStore Server to version 25.1 or newer]]<br /> ;Archiving Methods<br /> :[[Archiving Email]]<br /> :[[Choosing the Right Archiving Strategy]]<br /> :[[Email Archiving with MailStore Basics]]<br /> :[[Email encryption in Microsoft 365]]<br /> :[[Archiving Email from Outlook, Thunderbird and others]]<br /> :[[Archiving Outlook PST Files Directly]]<br /> :[[Archiving Emails from External Systems (File Import)]]<br /> :[[Archiving Server Mailboxes]]<br /> :[[Batch-archiving IMAP Mailboxes]]<br /> :[[Archiving IMAP and POP3 Multidrop Mailboxes]]<br /> ;Accessing the Archive<br /> :[[Accessing the Archive]]<br /> :[[Accessing the Archive with the MailStore Client software]]<br /> :[[Accessing the Archive with MailStore Web Access]]<br /> :[[Accessing the Archive with the Microsoft Outlook integration]]<br /> :[[Accessing the Archive with the Microsoft Outlook App integration]]<br /> :[[Accessing the Archive via Integrated IMAP Server|Accessing the Archive using other Email Clients]]<br /> ;Export Email<br /> :[[Exporting Email]]<br /> ;Administration<br /> :[[Users, Folders and Settings]]<br /> :[[Archives]]<br /> :[[Active Directory Integration]]<br /> :[[Setup Active Directory Federation Services]]<br /> :[[Application Integration]]<br /> :[[Google Workspace Integration]]<br /> :[[IceWarp Server Integration]]<br /> :[[Kerio Connect Integration]]<br /> :[[Generic LDAP Integration]]<br /> :[[MDaemon Integration]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Modern Authentication)]]<br /> :[[Synchronizing User Accounts with Microsoft 365 (Basic Authentication)]]<br /> :[[Multi-factor Authentication]]<br /> :[[Compliance General]]<br /> :[[Retention Policies]]<br /> :[[Message Date of an Email]]<br /> :[[Auditing]]<br /> :[[Audit Log]]<br /> :[[Storage Locations]]<br /> :[[Search Indexes]]<br /> :[[Jobs]]<br /> :[[Job Results]]<br /> :[[Backup and Restore]]<br /> :[[License Management]]<br /> :[[SMTP Settings]]<br /> :[[Active Sessions]]<br /> :[[Product Updates]]<br /> :[[MailStore Server Management Shell]]<br /> ;Service Configuration<br /> :[[MailStore Server Service Configuration]]<br /> ;MailStore Server Administration API<br /> :[[Administration API - Using the API]]<br /> :[[Administration API - Function Reference]]<br /> <br /> [[Category:Books|MailStore Server 25.1]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Update_Notices_for_MailStore_Server&diff=7732 2024-12-04T10:17:34Z

<p>Cstelzmann: </p> <hr /> <div>== General Information ==<br /> <br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Before you start the installation, please check if your current license really allows to upgrade the software.'''&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Before the installation, read the [https://go.mailstore.com?product=MailStore%20Server&amp;target=changelog&amp;lang=en changelog] for information about all changes in the respective versions.'''&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Make sure you have a recent backup of your archive. Learn more about backing up and restoring MailStore Server [[Backup and Restore|here]]'''.&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Make sure the server where MailStore Server is installed on meets the [[System_Requirements|system requirements]]'''.&lt;/p&gt;<br /> * 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.<br /> * Installations with version 23.4 or older must first be updated to version 24.4 and all archive stores must be updated to Firebird 4. You can then update to the latest version. Please also read the [[Update Notices for MailStore Server to version 25.1 or newer]].<br /> * 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.<br /> * Carefully check the auto-detected settings during the installation process.<br /> * Updating the MailStore Client installations and/or the MailStore Outlook Add-In installations is only necessary if this is specifically stated in the version-specific notes.<br /> *; Further information can be found in the articles [[MailStore Client Deployment]] and [[MailStore Outlook Add-in Deployment]]<br /> * 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.<br /> * For versions that are not explicitly listed here, the upgrade notices for preceding versions apply accordingly.<br /> <br /> == Upgrading to 25.1.0 ==<br /> <br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Only installations with versions 24.2.0 to 24.4.0 can be updated directly.'''&lt;/p&gt;<br /> * &lt;p class=&quot;mswarning&quot;&gt;'''Until all archive stores have been updated, you must not update to version 25.1.0.'''&lt;/p&gt;<br /> * It is '''obligatory''' to also note the [[Update Notices for MailStore Server to version 25.1 or newer]].<br /> <br /> == Upgrading to 24.4.0 ==<br /> There are no notes for this version.<br /> <br /> == Upgrading to 24.3.0 ==<br /> * Saved searches containing search criteria that can be interpreted as [[Accessing_the_Archive_with_the_MailStore_Client_software#Searching_for_Alternatives|search for alternatives]] will return different search results than before the update.<br /> * Retention policies do not support [[Accessing_the_Archive_with_the_MailStore_Client_software#Searching_for_Alternatives|searches for alternatives]]. In case existing retention policies contain search criteria that can be interpreted as searches for alternatives, those have to be changed for retention policies to being able to be processed again.<br /> <br /> == Upgrading to 24.2.2 ==<br /> <br /> There are no notes for this version.<br /> <br /> == Upgrading to 24.2.1 ==<br /> If you are upgrading from a MailStore version before 24.2.0, please also note the instructions for upgrading to version 24.2.0.<br /> <br /> * '''Upgrading Archive Stores''' &lt;br /&gt;If you upgrade from MailStore 24.2.0, the archive stores need to be upgraded. To do this, proceed as follows:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> :&lt;p class=&quot;mswarning&quot;&gt;Until all archive stores have been upgraded, retention policies are not available.&lt;/p&gt;<br /> <br /> == Upgrading to 24.2.0 ==<br /> * '''Upgrade of Master Database'''&lt;br/&gt;The master database is upgraded to Firebird 4 during the first start of the MailStore Server service. This process might extend the time required for the first start of the service by several minutes.<br /> * '''Upgrading Archive Stores''' &lt;br /&gt;For the update to Firebird 4 the databases of the archive stores must be upgraded. Proceed as follows to upgrade:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> :&lt;p class=&quot;mswarning&quot;&gt;Until all archive stores have been upgraded, retention policies are not available.&lt;/p&gt;<br /> * '''System Requirements'''<br /> *; Internet Explorer support has been removed from MailStore in this version. For a current list of supported browsers, please refer to [[System Requirements]].<br /> * ''' Python API Wrapper '''<br /> *; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.<br /> <br /> === Known Issues ===<br /> * As long as an internal, Firebird-based archive store has not been updated, no recovery records will be written for emails in this archive store. This bug was fixed with version 24.2.1.<br /> * Users who have been synchronized from an Active Directory and who have MailStore multi-factor authentication (MFA) activated cannot log in using Windows authentication. To work around the issue, disable multi-factor authentication for those users in MailStore or let them use their username and password to log in. This bug was fixed with version 24.2.2.<br /> <br /> == Upgrading to 23.4.0 ==<br /> * '''System Requirements'''<br /> *; Windows Server 2012 and Windows Server 2012 R2 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].<br /> * ''' Python API Wrapper '''<br /> *; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.<br /> <br /> == Upgrading to 23.3.0 ==<br /> * ''' Microsoft Exchange 2013 Support '''<br /> *; Support for Microsoft Exchange 2013 has been removed from MailStore in this version.<br /> <br /> == Upgrading to 23.2.0 ==<br /> * ''' Outlook Add-in '''<br /> *; Starting with version 23.2.0, MailStore Server supports multi-factor authentication for users with integrated authentication. To support multi-factor authentication an update of the Outlook Add-in is required.<br /> *; The Outlook Add-In 23.2.0 is not backward compatible with older MailStore Server versions. When updating, MailStore Server should be updated first and then the Outlook Add-in.<br /> * ''' Scheduled Tasks, Management API, IMAP Access '''&lt;br /&gt;<br /> *; When multi-factor authentication is enabled for a user and that user wants to schedule client-side archiving profiles, access the Management API or access the IMAP server, an app password has to be used instead of the regular password.<br /> * ''' Python API Wrapper '''<br /> *; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.<br /> <br /> == Upgrading to 23.1.2 ==<br /> * &lt;p class=&quot;mswarning&quot;&gt;&lt;b&gt;Important:&lt;/b&gt; Let's Encrypt has announced to change their production request flow permanently on April 24th 2023. After that date, previous versions of MailStore Server will not be able to successfully request certificates from Let's Encrypt.&lt;/p&gt;<br /> <br /> == Upgrading to 23.1.0 ==<br /> * '''System Requirements'''<br /> *; Windows 7, Windows 8.1, Windows Server 2008 R2 and Windows Small Business Server 2011 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].<br /> <br /> == Upgrading to 22.4.0 ==<br /> There are no notes for this version.<br /> <br /> == Upgrading to 22.3.0 ==<br /> * ''' Outlook Add-in '''<br /> *; 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.<br /> <br /> == Upgrading to 22.2.x ==<br /> * '''System Requirements'''<br /> *; 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]].&lt;br/&gt;&lt;p class=&quot;mswarning&quot;&gt;If the framework is installed by the MailStore setup, the system might reboot without further notice.&lt;/p&gt;<br /> * '''External Archive Stores'''<br /> *; Starting with version 22.2, only versions 10 or newer are supported for PostgreSQL.<br /> <br /> == Upgrading to 13.x ==<br /> * '''Update of MailStore Client and Outlook Add-in'''&lt;br/&gt;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:<br /> ** Unified validation of TLS certificates.<br /> ** Unified evaluation of group policies.<br /> ** Distinct error messages for certain certificate errors.<br /> ** 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.<br /> * '''Unencrypted Connections'''<br /> *; 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.<br /> * '''HTTP-to-HTTPS Redirect'''<br /> *; 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.<br /> * '''Windows Authentication'''<br /> *; 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]].<br /> * '''Microsoft 365 Support'''<br /> *; 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 &amp; 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.&lt;br/&gt;&lt;p class=&quot;mswarning&quot;&gt;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.&lt;/p&gt;<br /> * '''Google Workspace Support'''<br /> *; The [[Google Workspace Integration|Google Workspace directory service synchronization profile]] has been extended with support for modern authentication (OAuth 2.0 &amp; 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.&lt;br/&gt;&lt;p class=&quot;mswarning&quot;&gt;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''.&lt;/p&gt;<br /> * '''IMAP Access to Archive'''<br /> *; 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. <br /> * '''Startup Scripts'''<br /> *; 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.<br /> * '''Mobile Web Access'''<br /> *; 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.<br /> * '''Legacy Web Access'''<br /> *; 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.<br /> * '''Group Policies'''<br /> *; The following group policy settings are no longer supported in MailStore 13:<br /> ** '''MailStore Client: Accept Thumbprint'''<br /> **; 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. <br /> ** '''MailStore Outlook Add-in: Accept Thumbprint'''<br /> **; 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.<br /> ** '''MailStore Outlook Add-in: Enable TLS/SSL encryption'''<br /> **; 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.<br /> <br /> == Upgrading to 12.1 ==<br /> * '''System Requirements'''<br /> *; 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]].<br /> <br /> == Upgrading to 12 ==<br /> * '''Expired Certificates'''<br /> *; 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.<br /> * '''Using Certificates'''<br /> *; 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.<br /> <br /> == Upgrading to 11 ==<br /> * '''Upgrading Archive Stores'''<br /> *; &lt;p class=&quot;mswarning&quot;&gt;'''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.'''&lt;/p&gt;<br /> *; Until the archive stores have been upgraded, not all functionality of the software is available. To facilitate<br /> ** retention policies,<br /> ** the search functionality,<br /> ** the improved recovery records,<br /> *; the databases of the archive stores must be upgraded.<br /> *;Proceed as follows to upgrade:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> * '''Retention Policies'''&lt;br/&gt;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.<br /> * '''Access via Integrated IMAP Server'''&lt;br/&gt;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.<br /> * '''Management API Commands Get-/SetComplianceConfiguration'''&lt;br/&gt;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''.<br /> <br /> == Upgrading to 10.2 ==<br /> * '''Web Access'''&lt;br/&gt;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.<br /> === Known Issues ===<br /> * 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.<br /> <br /> == Upgrading to 10.1 ==<br /> * '''Archiving Emails'''&lt;br/&gt;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. <br /> * '''Status Reports'''&lt;br/&gt;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.<br /> <br /> == Upgrading to Version 10 ==<br /> * '''Encryption Notices'''&lt;br/&gt;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.&lt;p class=&quot;mswarning&quot;&gt;Please make sure to store the product key entered during installation in a safe location.&lt;/p&gt;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.<br /> * '''Upgrade of Master Database'''&lt;br/&gt;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.<br /> * '''Upgrading Archive Stores''' &lt;br /&gt;To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> **: [[File:Fg_upgrade10.png|center]]<br /> * '''Archives of Other Users'''&lt;br/&gt;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 &gt; Users and Archives &gt; Archives]].<br /> * '''Export E-mails'''&lt;br/&gt;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.<br /> * '''Auditing'''&lt;br/&gt;All activities that are exclusively executable by MailStore administrators are displayed as ''Enabled (locked)'' at ''Compliance'' &gt; ''Auditing''. Irrespective of the ''Disabled'' status, all activities of MailStore administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br /> * '''Default Password'''&lt;br/&gt;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.<br /> <br /> == Upgrading to Version 9.7 ==<br /> * '''Search Indexes'''&lt;br/&gt;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.<br /> * '''Archiving from Gmail'''&lt;br/&gt;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 &quot;All Mail&quot; and &quot;Sent Items&quot;. 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 &quot;Google Mail&quot; profiles by this new Gmail profile.<br /> <br /> === Known Issues ===<br /> * 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.<br /> <br /> == Upgrading to Version 9.6 ==<br /> * '''Update of MailStore Client and Outlook Add-in'''&lt;br/&gt;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:<br /> ** Client: Pin to taskbar now possible on Windows 7 and newer.<br /> ** Support for different SSL certificate thumbprint formats in group policies.<br /> ** Group policies allow configuration of client and Outlook Add-in language.<br /> * '''MailStore Proxy'''&lt;br/&gt;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.<br /> <br /> == Upgrading to Version 9.3 ==<br /> * '''Supported SSL certificates''' &lt;br/&gt;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].<br /> <br /> == Upgrading to Version 9.x ==<br /> * '''System Requirements''' &lt;br/&gt;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.<br /> * '''Server-side Execution of E-mail-Server Profiles and Internal Backup'''&lt;br/&gt;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)]]).&lt;br /&gt;&lt;p class=&quot;mswarning&quot;&gt;In either case, verify carefully that all automated tasks are still working properly after updating.&lt;/p&gt;<br /> * '''Scheduling of Profiles''' &lt;br/&gt;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.&lt;br/&gt;&lt;br/&gt;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]]<br /> * '''Group Policies''' &lt;br/&gt;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]].<br /> * '''Automatic Creation of New Archive Stores''' &lt;br/&gt;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]]. <br /> * '''PDF Support of Full Text Search''' &lt;br /&gt;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.<br /> * '''MailStore Server Administration API''' &lt;br /&gt;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.<br /> * '''AVM KEN! Support Removed''' &lt;br /&gt;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.<br /> <br /> === Known Issues ===<br /> * '''Missing Email Headers when Printing from MailStore Web Access''' '''''(resolved in version 9.6)'''''&lt;br /&gt;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.<br /> <br /> == Upgrading to Version 8.x ==<br /> <br /> * '''System Requirements''' &lt;br/&gt;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.<br /> <br /> == Upgrading to Version 7.0 ==<br /> <br /> * '''Management Shell / Batch Scripts''' &lt;br /&gt; The server-side part of the Management Shell command set, which included commands such as &lt;code&gt;user-add&lt;/code&gt; or &lt;code&gt;filegroup-create&lt;/code&gt;, 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]]<br /> <br /> == Upgrading to Version 6.0 ==<br /> <br /> * '''Upgrading File Groups''' &lt;br /&gt; 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:<br /> ** Log in as MailStore administrator (admin).<br /> ** Click on ''Administrative Tools'' &gt; ''Storage'' and then ''Storage Locations''.<br /> ** 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.<br /> **: [[File:Fg_upgrade6.png]]<br /> ** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.<br /> ** 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.<br /> * '''Automatic Creation of New File Groups''' &lt;br /&gt; 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.<br /> * '''Active Directory Integration''' &lt;br /&gt; 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. &lt;br /&gt; '''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''.<br /> * '''Generic LDAP Integration''' &lt;br /&gt; 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.<br /> * '''Firewall Settings''' &lt;br /&gt; 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).<br /> * '''No More Separate Downloads''' &lt;br /&gt; 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-&lt;version&gt;'' sub-folder of your MailStore Server installation directory.<br /> <br /> == Upgrading to Version 5.0 ==<br /> <br /> * '''MailStore Outlook Add-In''' &lt;br/&gt; 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.<br /> <br /> == Upgrading to Version 4.5 ==<br /> <br /> * '''Database Backups''' &lt;br/&gt;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.<br /> * '''Search Indexes''' &lt;br/&gt;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.<br /> <br /> [[de:Hinweise_zum_Update_von_MailStore_Server]]<br /> [[en:Update Notices for MailStore Server]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Update_Notices_for_MailStore_Server_to_version_25.1_or_newer&diff=7731 2024-12-04T09:41:38Z

<p>Cstelzmann: </p> <hr /> <div>With version 25.1, MailStore is, for the first time, not fully backwards compatible with all older versions. In order to be independent of outdated Microsoft C++ runtime libraries, support for Firebird 3 and 2.5 had to be removed. An update to version 25.1 therefore requires that all internal archive stores have previously been updated to Firebird 4.<br /> <br /> Internal [[Storage_Locations|archive stores]] created with version 23.4 or a previous version use Firebird 3 or Firebird 2.5 as the database system. Firebird 4 was introduced with MailStore 24.2. Newly created archive stores have since been automatically created with Firebird 4 databases. Older archive stores must be updated manually.<br /> <br /> All other [[Update_Notices_for_MailStore_Server|update notices for MailStore Server can be found here]].<br /> <br /> = About databases in MailStore =<br /> <br /> MailStore Server uses Firebird Embedded as a database system for [[Storage_Locations|storing]] the configuration and metadata of the archived emails. The configuration is stored in the so-called master database, the email metadata is stored in the archive store databases.<br /> <br /> If a new Firebird version is supported in MailStore, the master database is automatically updated when the new version is started for the first time. This database can be updated in a reasonable amount of time without affecting operation.<br /> <br /> The archive store databases are not updated automatically. Since this process can be lengthy and thus affect operation, the administrator must start it manually.<br /> <br /> To be able to perform these database updates, MailStore must support both the old and the new Firebird version.<br /> <br /> = Firebird's dependencies on C++ =<br /> <br /> Firebird 4 has dependencies on Microsoft's C++ runtime library 2015-2022.&lt;/br&gt;<br /> Firebird 3 has dependencies on Microsoft's C++ runtime library 2013.&lt;/br&gt;<br /> Firebird 2.5 has dependencies on Microsoft's C++ runtime library 2010.&lt;/br&gt;<br /> <br /> All of these runtime libraries were automatically installed with MailStore Server up to version 24.4.<br /> <br /> Microsoft has discontinued support for the C++ runtime libraries of versions 2013 and 2010.<br /> <br /> = Changes in MailStore Server 25.1 =<br /> <br /> This MailStore version, as well as all newer versions, is no longer able to load or update old databases.<br /> <br /> When the service starts, the corresponding error message is stored in the Windows event log.<br /> <br /> If the client tries to connect to a MailStore server that is trying to load an incompatible database, the client displays this error message:<br /> <br /> [[File:Client_Error_Master_Database_Unsupported.png|center]]<br /> <br /> When attaching old archive stores, the following error message appears:<br /> <br /> [[File:Client_Error_Archive_Store_Unsupported.png|center]]<br /> <br /> When loading old archive stores that have already been attached, the following error message appears:<br /> <br /> [[File:Storage_Locations_Archive_Store_Open_Error.png|center]]<br /> &lt;br /&gt;<br /> <br /> = What to do next? =<br /> <br /> Depending on the initial situation, different steps are necessary to become independent of Firebird 3 and 2.5.<br /> <br /> == Update from version 24.x ==<br /> <br /> If you are currently using MailStore Server 24.2 to 24.4, you must have updated the archive stores to Firebird 4 before being able to update to version 25.1 or newer. The dashboard in the MailStore Client and the [[Storage Locations]] will inform you whether this step is necessary.<br /> <br /> [[File:Dashboard_Archive_Store_Upgrade_Hint.png]]<br /> <br /> [[File:Storage_Locations_Archive_Store_Upgrade_Hint.png]]<br /> <br /> * Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.<br /> * Right-click on the disabled archive stores and change the status to ''write protected''.<br /> * Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.<br /> <br /> If a hint is displayed that an upgrade is required, follow these steps:<br /> <br /> * Create a [[Backup_and_Restore|backup]].<br /> * Read the [[Update Notices for MailStore Server]] for version 24.2 (!) and follow the instructions. You can ignore the known problems of this version.<br /> * Update all archive stores.<br /> * Create another [[Backup_and_Restore|backup]].<br /> * Download the current MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server]] for the current version up to version 24.2 and follow the instructions.<br /> * Install the downloaded version of MailStore Server.<br /> <br /> == Update from version 23.x and older ==<br /> <br /> If you have previously used MailStore Server 23.4 or older, you must perform an '''intermediate update''' before updating to the latest version.<br /> <br /> A direct update to the latest version is not possible.<br /> <br /> [[File:Installer_Deny_Pre_242.png|center]]<br /> <br /> * Create a [[Backup and Restore|data backup]].<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads from here].<br /> * Read the [[Update Notices for MailStore Server|update notices]] for version 24.2 (!) and follow the instructions. You can ignore the known problems in this version because you are installing version 24.4, in which these problems have already been resolved.<br /> * Install version 24.4 of MailStore Server.<br /> * Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.<br /> * Right-click on the disabled archive stores and change the status to ''write protected''.<br /> * Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.<br /> * Update all archive stores.<br /> * Create another [[Backup and Restore|data backup]].<br /> * Download the latest MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server]] for the current version up to version 24.2 and follow the instructions.<br /> * Install the downloaded version of MailStore Server.<br /> <br /> == Updating individual archive stores ==<br /> <br /> If you have [[Storage_Locations#Detaching|archive stores detached]] or [[Storage_Locations#Setting_the_Status|disabled]] because you do not need permanent access to their contents, their databases must also be updated to Firebird 4 in order to be able to load them into current MailStore Server versions.<br /> <br /> If your MailStore Server installation is already on version 25.1 or newer, you cannot use this installation to update the archive store databases. You need a second system on which you can perform the interim update.<br /> <br /> * Provide another server.<br /> * Create a [[Backup_and_Restore|backup]] of the archive store to be updated.<br /> * [https://www.mailstore.com/en/products/mailstore-server/mailstore-server-trial-download/ Obtain a trial key] to activate MailStore Server on this server. This trial key will be required again later, so keep it safe.<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads] and install it on the server.<br /> * [[Storage_Locations#Attaching|Attach the archive store]] on the secondary system and update it. To [[Storage_Locations#Unlocking|unlock]] you will need the product key or the [[MailStore_Server_Service_Configuration#Set_Recovery_Key|recovery key]] of the main system.<br /> * [[Storage_Locations#Detaching|Detach the archive store]] and transfer it to your main system.<br /> * [[Storage_Locations#Attaching|Attach the archive store]] on the main system and [[Storage_Locations#Unlocking|unlock it]] with the trial key you used previously. It can now be used as usual.<br /> <br /> == Restoring a backup ==<br /> <br /> Backups that contain Firebird 3 or Firebird 2.5 databases cannot be read by MailStore 25.1 and newer.<br /> <br /> If you want to restore such a backup, you must load it once with MailStore Server 24.4 and update all archive store databases. The backup will then also be compatible with the current MailStore version.<br /> <br /> * Provide another server.<br /> * [https://www.mailstore.com/en/products/mailstore-server/mailstore-server-trial-download/ Obtain a trial key] to activate MailStore Server on this server. This trial key will be needed again later, so keep it safe.<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads] and install it on the server.<br /> * [[Backup_and_Restore#Restoring_Backups|Restore the data backup]] to this server.<br /> * Read the [[Update_Notices_for_MailStore_Server|Update Notices]] of version 24.2 (!) and follow the instructions. You can ignore the known issues of this version, as you are installing version 24.4, in which these issues have already been resolved.<br /> * Update all archive stores.<br /> * Create another [[Backup_and_Restore|backup]].<br /> * The archive can now be [[Moving_the_Archive#Moving_the_Archive_to_a_New_Machine|moved]] to the primary server.<br /> <br /> [[de:Hinweise_zum_Update_von_MailStore_Server_auf_Version_25.1_oder_neuer]]<br /> [[en:Update_Notices_for_MailStore_Server_to_version_25.1_or_newer]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Update_Notices_for_MailStore_Server_to_version_25.1_or_newer&diff=7730 2024-12-04T09:35:36Z

<p>Cstelzmann: /* Update from version 24.x */</p> <hr /> <div>With version 25.1, MailStore is, for the first time, not fully backwards compatible with all older versions. In order to be independent of outdated Microsoft C++ runtime libraries, support for Firebird 3 and 2.5 had to be removed. An update to version 25.1 therefore requires that all internal archive stores have previously been updated to Firebird 4.<br /> <br /> Internal [[Storage_Locations|archive stores]] created with version 23.4 or a previous version use Firebird 3 or Firebird 2.5 as the database system. Firebird 4 was introduced with MailStore 24.2. Newly created archive stores have since been automatically created with Firebird 4 databases. Older archive stores must be updated manually.<br /> <br /> All other [[Update_Notices_for_MailStore_Server|update notices for MailStore Server can be found here]].<br /> <br /> = About databases in MailStore =<br /> <br /> MailStore Server uses Firebird Embedded as a database system for [[Storage_Locations|storing]] the configuration and metadata of the archived emails. The configuration is stored in the so-called master database, the email metadata is stored in the archive store databases.<br /> <br /> If a new Firebird version is supported in MailStore, the master database is automatically updated when the new version is started for the first time. This database can be updated in a reasonable amount of time without affecting operation.<br /> <br /> The archive store databases are not updated automatically. Since this process can be lengthy and thus affect operation, the administrator must start it manually.<br /> <br /> To be able to perform these database updates, MailStore must support both the old and the new Firebird version.<br /> <br /> = Firebird's dependencies on C++ =<br /> <br /> Firebird 4 has dependencies on Microsoft's C++ runtime library 2015-2022.&lt;/br&gt;<br /> Firebird 3 has dependencies on Microsoft's C++ runtime library 2013.&lt;/br&gt;<br /> Firebird 2.5 has dependencies on Microsoft's C++ runtime library 2010.&lt;/br&gt;<br /> <br /> All of these runtime libraries were automatically installed with MailStore Server up to version 24.4.<br /> <br /> Microsoft has discontinued support for the C++ runtime libraries of versions 2013 and 2010.<br /> <br /> = Changes in MailStore Server 25.1 =<br /> <br /> This MailStore version, as well as all newer versions, is no longer able to load or update old databases.<br /> <br /> When the service starts, the corresponding error message is stored in the Windows event log.<br /> <br /> If the client tries to connect to a MailStore server that is trying to load an incompatible database, the client displays this error message:<br /> <br /> [[File:Client_Error_Master_Database_Unsupported.png|center]]<br /> <br /> When attaching old archive stores, the following error message appears:<br /> <br /> [[File:Client_Error_Archive_Store_Unsupported.png|center]]<br /> <br /> When loading old archive stores that have already been attached, the following error message appears:<br /> <br /> [[File:Storage_Locations_Archive_Store_Open_Error.png|center]]<br /> <br /> = What to do next? =<br /> <br /> Depending on the initial situation, different steps are necessary to become independent of Firebird 3 and 2.5.<br /> <br /> == Update from version 24.x ==<br /> <br /> If you are currently using MailStore Server 24.2 to 24.4, you must have updated the archive stores to Firebird 4 before being able to update to version 25.1 or newer. The dashboard in the MailStore Client and the [[Storage Locations]] will inform you whether this step is necessary.<br /> <br /> [[File:Dashboard_Archive_Store_Upgrade_Hint.png]]<br /> <br /> [[File:Storage_Locations_Archive_Store_Upgrade_Hint.png]]<br /> <br /> * Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.<br /> * Right-click on the disabled archive stores and change the status to ''write protected''.<br /> * Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.<br /> <br /> If a hint is displayed that an upgrade is required, follow these steps:<br /> <br /> * Create a [[Backup_and_Restore|backup]].<br /> * Read the [[Update Notices for MailStore Server]] for version 24.2 (!) and follow the instructions. You can ignore the known problems of this version.<br /> * Update all archive stores.<br /> * Create another [[Backup_and_Restore|backup]].<br /> * Download the current MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server]] for the current version up to version 24.2 and follow the instructions.<br /> * Install the downloaded version of MailStore Server.<br /> <br /> == Update from version 23.x and older ==<br /> <br /> If you have previously used MailStore Server 23.4 or older, you must perform an '''intermediate update''' before updating to the latest version.<br /> <br /> A direct update to the latest version is not possible.<br /> <br /> [[File:Installer_Deny_Pre_242.png|center]]<br /> <br /> * Create a [[Backup and Restore|data backup]].<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads from here].<br /> * Read the [[Update Notices for MailStore Server|update notices]] for version 24.2 (!) and follow the instructions. You can ignore the known problems in this version because you are installing version 24.4, in which these problems have already been resolved.<br /> * Install version 24.4 of MailStore Server.<br /> * Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.<br /> * Right-click on the disabled archive stores and change the status to ''write protected''.<br /> * Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.<br /> * Update all archive stores.<br /> * Create another [[Backup and Restore|data backup]].<br /> * Download the latest MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server]] for the current version up to version 24.2 and follow the instructions.<br /> * Install the downloaded version of MailStore Server.<br /> <br /> == Updating individual archive stores ==<br /> <br /> If you have [[Storage_Locations#Detaching|archive stores detached]] or [[Storage_Locations#Setting_the_Status|disabled]] because you do not need permanent access to their contents, their databases must also be updated to Firebird 4 in order to be able to load them into current MailStore Server versions.<br /> <br /> If your MailStore Server installation is already on version 25.1 or newer, you cannot use this installation to update the archive store databases. You need a second system on which you can perform the interim update.<br /> <br /> * Provide another server.<br /> * Create a [[Backup_and_Restore|backup]] of the archive store to be updated.<br /> * [https://www.mailstore.com/en/products/mailstore-server/mailstore-server-trial-download/ Obtain a trial key] to activate MailStore Server on this server. This trial key will be required again later, so keep it safe.<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads] and install it on the server.<br /> * [[Storage_Locations#Attaching|Attach the archive store]] on the secondary system and update it. To [[Storage_Locations#Unlocking|unlock]] you will need the product key or the [[MailStore_Server_Service_Configuration#Set_Recovery_Key|recovery key]] of the main system.<br /> * [[Storage_Locations#Detaching|Detach the archive store]] and transfer it to your main system.<br /> * [[Storage_Locations#Attaching|Attach the archive store]] on the main system and [[Storage_Locations#Unlocking|unlock it]] with the trial key you used previously. It can now be used as usual.<br /> <br /> == Restoring a backup ==<br /> <br /> Backups that contain Firebird 3 or Firebird 2.5 databases cannot be read by MailStore 25.1 and newer.<br /> <br /> If you want to restore such a backup, you must load it once with MailStore Server 24.4 and update all archive store databases. The backup will then also be compatible with the current MailStore version.<br /> <br /> * Provide another server.<br /> * [https://www.mailstore.com/en/products/mailstore-server/mailstore-server-trial-download/ Obtain a trial key] to activate MailStore Server on this server. This trial key will be needed again later, so keep it safe.<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads] and install it on the server.<br /> * [[Backup_and_Restore#Restoring_Backups|Restore the data backup]] to this server.<br /> * Read the [[Update_Notices_for_MailStore_Server|Update Notices]] of version 24.2 (!) and follow the instructions. You can ignore the known issues of this version, as you are installing version 24.4, in which these issues have already been resolved.<br /> * Update all archive stores.<br /> * Create another [[Backup_and_Restore|backup]].<br /> * The archive can now be [[Moving_the_Archive#Moving_the_Archive_to_a_New_Machine|moved]] to the primary server.<br /> <br /> [[de:Hinweise_zum_Update_von_MailStore_Server_auf_Version_25.1_oder_neuer]]<br /> [[en:Update_Notices_for_MailStore_Server_to_version_25.1_or_newer]]</div>

Cstelzmann https://help.mailstore.com/en/server/index.php?title=Update_Notices_for_MailStore_Server_to_version_25.1_or_newer&diff=7727 2024-12-04T08:28:45Z

<p>Cstelzmann: /* Changes in MailStore Sever 25.1 */</p> <hr /> <div>With version 25.1, MailStore is, for the first time, not fully backwards compatible with all older versions. In order to be independent of outdated Microsoft C++ runtime libraries, support for Firebird 3 and 2.5 had to be removed. An update to version 25.1 therefore requires that all internal archive stores have previously been updated to Firebird 4.<br /> <br /> Internal [[Storage_Locations|archive stores]] created with version 23.4 or a previous version use Firebird 3 or Firebird 2.5 as the database system. Firebird 4 was introduced with MailStore 24.2. Newly created archive stores have since been automatically created with Firebird 4 databases. Older archive stores must be updated manually.<br /> <br /> All other [[Update_Notices_for_MailStore_Server|update notices for MailStore Server can be found here]].<br /> <br /> = About databases in MailStore =<br /> <br /> MailStore Server uses Firebird Embedded as a database system for [[Storage_Locations|storing]] the configuration and metadata of the archived emails. The configuration is stored in the so-called master database, the email metadata is stored in the archive store databases.<br /> <br /> If a new Firebird version is supported in MailStore, the master database is automatically updated when the new version is started for the first time. This database can be updated in a reasonable amount of time without affecting operation.<br /> <br /> The archive store databases are not updated automatically. Since this process can be lengthy and thus affect operation, the administrator must start it manually.<br /> <br /> To be able to perform these database updates, MailStore must support both the old and the new Firebird version.<br /> <br /> = Firebird's dependencies on C++ =<br /> <br /> Firebird 4 has dependencies on Microsoft's C++ runtime library 2015-2022.&lt;/br&gt;<br /> Firebird 3 has dependencies on Microsoft's C++ runtime library 2013.&lt;/br&gt;<br /> Firebird 2.5 has dependencies on Microsoft's C++ runtime library 2010.&lt;/br&gt;<br /> <br /> All of these runtime libraries were automatically installed with MailStore Server up to version 24.4.<br /> <br /> Microsoft has discontinued support for the C++ runtime libraries of versions 2013 and 2010.<br /> <br /> = Changes in MailStore Server 25.1 =<br /> <br /> This MailStore version, as well as all newer versions, is no longer able to load or update old databases.<br /> <br /> When the service starts, the corresponding error message is stored in the Windows event log.<br /> <br /> If the client tries to connect to a MailStore server that is trying to load an incompatible database, the client displays this error message:<br /> <br /> [[File:Client_Error_Master_Database_Unsupported.png|center]]<br /> <br /> When attaching old archive stores, the following error message appears:<br /> <br /> [[File:Client_Error_Archive_Store_Unsupported.png|center]]<br /> <br /> When loading old archive stores that have already been attached, the following error message appears:<br /> <br /> [[File:Storage_Locations_Archive_Store_Open_Error.png|center]]<br /> <br /> = What to do next? =<br /> <br /> Depending on the initial situation, different steps are necessary to become independent of Firebird 3 and 2.5.<br /> <br /> == Update from version 24.x ==<br /> <br /> If you are currently using MailStore Server 24.2 to 24.4, you must have updated the archive stores to Firebird 4. The dashboard in the MailStore Client and the [[Storage Locations]] will inform you whether this step is necessary.<br /> <br /> [[File:Dashboard_Archive_Store_Upgrade_Hint.png]]<br /> <br /> [[File:Storage_Locations_Archive_Store_Upgrade_Hint.png]]<br /> <br /> * Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.<br /> * Right-click on the disabled archive stores and change the status to ''write protected''.<br /> * Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.<br /> <br /> If a hint is displayed that an upgrade is required, follow these steps:<br /> <br /> * Create a [[Backup_and_Restore|backup]].<br /> * Read the [[Update Notices for MailStore Server]] for version 24.2 (!) and follow the instructions. You can ignore the known problems of this version.<br /> * Update all archive stores.<br /> * Create another [[Backup_and_Restore|backup]].<br /> * Download the current MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server]] for the current version up to version 24.2 and follow the instructions.<br /> * Install the downloaded version of MailStore Server.<br /> <br /> == Update from version 23.x and older ==<br /> <br /> If you have previously used MailStore Server 23.4 or older, you must perform an '''intermediate update''' before updating to the latest version.<br /> <br /> A direct update to the latest version is not possible.<br /> <br /> [[File:Installer_Deny_Pre_242.png|center]]<br /> <br /> * Create a [[Backup and Restore|data backup]].<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads from here].<br /> * Read the [[Update Notices for MailStore Server|update notices]] for version 24.2 (!) and follow the instructions. You can ignore the known problems in this version because you are installing version 24.4, in which these problems have already been resolved.<br /> * Install version 24.4 of MailStore Server.<br /> * Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.<br /> * Right-click on the disabled archive stores and change the status to ''write protected''.<br /> * Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.<br /> * Update all archive stores.<br /> * Create another [[Backup and Restore|data backup]].<br /> * Download the latest MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server]] for the current version up to version 24.2 and follow the instructions.<br /> * Install the downloaded version of MailStore Server.<br /> <br /> == Updating individual archive stores ==<br /> <br /> If you have [[Storage_Locations#Detaching|archive stores detached]] or [[Storage_Locations#Setting_the_Status|disabled]] because you do not need permanent access to their contents, their databases must also be updated to Firebird 4 in order to be able to load them into current MailStore Server versions.<br /> <br /> If your MailStore Server installation is already on version 25.1 or newer, you cannot use this installation to update the archive store databases. You need a second system on which you can perform the interim update.<br /> <br /> * Provide another server.<br /> * Create a [[Backup_and_Restore|backup]] of the archive store to be updated.<br /> * [https://www.mailstore.com/en/products/mailstore-server/mailstore-server-trial-download/ Obtain a trial key] to activate MailStore Server on this server. This trial key will be required again later, so keep it safe.<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads] and install it on the server.<br /> * [[Storage_Locations#Attaching|Attach the archive store]] on the secondary system and update it. To [[Storage_Locations#Unlocking|unlock]] you will need the product key or the [[MailStore_Server_Service_Configuration#Set_Recovery_Key|recovery key]] of the main system.<br /> * [[Storage_Locations#Detaching|Detach the archive store]] and transfer it to your main system.<br /> * [[Storage_Locations#Attaching|Attach the archive store]] on the main system and [[Storage_Locations#Unlocking|unlock it]] with the trial key you used previously. It can now be used as usual.<br /> <br /> == Restoring a backup ==<br /> <br /> Backups that contain Firebird 3 or Firebird 2.5 databases cannot be read by MailStore 25.1 and newer.<br /> <br /> If you restore such a backup, you must load it once with MailStore Server 24.4 and update all archive store databases. The backup will then also be compatible with the current MailStore version.<br /> <br /> * Restore the [[Backup_and_Restore#Restoring_Backups|data backup]].<br /> * Download MailStore Server 24.4 [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server|Update Notices]] for version 24.2 (!) and follow the instructions. You can ignore the known issues in this version because you are installing version 24.4, in which these issues have already been resolved.<br /> * Update all archive stores.<br /> * Create another [[Backup_and_Restore|data backup]].<br /> * Download the current MailStore Server version [https://my.mailstore.com/downloads].<br /> * Read the [[Update Notices for MailStore Server|Update Notices]] for the current version up to version 24.4 and follow the instructions.<br /> <br /> [[de:Hinweise_zum_Update_von_MailStore_Server_auf_Version_25.1_oder_neuer]]<br /> [[en:Update_Notices_for_MailStore_Server_to_version_25.1_or_newer]]</div>

Cstelzmann