https://help.mailstore.com/en/spe/api.php?action=feedcontributions&user=Dweuthen&feedformat=atomMailStore SPE Help - User contributions [en]2024-03-28T22:57:56ZUser contributionsMediaWiki 1.35.10https://help.mailstore.com/en/spe/index.php?title=Management_Console_-_General&diff=1888Management Console - General2020-12-08T12:48:34Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
== Dashboard ==<br />
The dashboard of the Management Console is divided into the following parts.<br />
<br />
=== Service Health ===<br />
This sections gives a quick overview of the status of all configured hosts and their roles which are under the control of the Management Server. The root node of the tree always represents the Management Server, the left branch the Instance Hosts and the right branch shows the Client Access Servers. Instance Host nodes also show the number of available and active instances. <br />
<br />
=== Version and License Information ===<br />
Details about the product version in use and the licensee including their customer number are displayed here.<br />
<br />
=== My Resources ===<br />
The ''My Resources'' sections lists all resources created in the MailStore Service Provider Edition. This includes the number of ''Management Server'', ''Instance Hosts'', ''Client Access Server'' and the total number of instances available and running.<br />
<br />
=== Messages ===<br />
System messages that might require further administrative actions are shown in the ''Messages'' section of the dashboard. Typical message may contain warnings about license update failures or necessary search index rebuilds. <br />
<br />
=== Related Links ===<br />
This sections contains links to the most valuable online resources including this online help, Customer Service Center, etc.<br />
<br />
== Instances ==<br />
The main task of each MailStore Service Provider Edition administrator will be the management of instances. General administrative tasks such as creating, configuring, stating, stopping and deleting instances is described in the following.<br />
<br />
Individual instance tasks like managing archive stores and search indexes, managing users and creating setting up archiving is covered in [[Instance Management]].<br />
<br />
=== Creating Instances ===<br />
<br />
{{:Creating Instances }}<br />
<br />
=== Controlling Instances ===<br />
<br />
{{:Controlling Instances}}<br />
<br />
=== Configuring Instances ===<br />
Most configuration settings of existing instances can be modified. The instance to modify must be stopped before its configuration can be changed. To change the configuration proceed as follows:<br />
<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Click on ''General'' > ''Instances''.<br />
* Select the instances to modify.<br />
* Click on ''Configure...''.<br />
* Make the desired configuration changes.<br />
*: [[File:Ms_spe_create_instance_02.png|center]]<br />
*: ''Tab: Base Configuration''<br />
*:: '''URL Alias''' Meaningful unique alias name that can be used as an alternative to the instance ID.<br />
*:: '''Display Name:''' Additional identification information for the instance, e.g. customer name.<br />
*:: '''Instance Host:''' Instance Host on which the new instance gets created.<br />
*:: '''Start Mode:''' Defines how the instance is started. Choose from the following options (Default: ''Automatic''):<br />
*::: ''Disabled:'' The instance can neither be started automatically nor manually.<br />
*::: ''Manual:'' The instance can only be started manually.<br />
*::: ''Automatic:'' The instance will automatically be started with the Instance. Host.<br />
*:: '''Base Directory:''' Directory where instance's data will be stored.<br />
*: ''Tab: Advanced Configuration''<br />
*:: '''Enable VSS Writer:''' Enable support for Volume Shadow Service.<br />
*::: '''Exclude Indexes from VSS Backup:''' Excludes the unencrypted search index files from the backup set reported by the VSS writer.<br />
*:::: '''Please note:''' This option can be set so that administrators which have access to the backup files cannot access the unencrypted search index files. When restoring backups that do not include search index files, the search indexes have to be [[Instance_Management#Search_Indexes|rebuilt]].<br />
*:: '''Enable Debug Log:''' Enable debug logging for the instance.<br />
*:: '''Enable IMAP Server Connection Log:''' Enable IMAP Server connection logging for the instance.<br />
* Click ''OK'' to save the changes.<br />
<br />
'''Important notice:''' Neither changing the ''Instance Host'' nor the ''Base Directory'' will move the archive data to the new location. If necessary this must be done manually before starting the instance again.<br />
<br />
=== Deleting Instances ===<br />
Instances can be deleted at any time as long as they are stopped. Deleting an instance only removes it from the management database of the MailStore Service Provider Edition. All instance data remains on the hard disk and must be removed manually if necessary. To delete an instance follow these instructions:<br />
<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Click on ''General'' > ''Instances''.<br />
* Select the instances to delete.<br />
* Click on ''Command'' > ''Delete''.<br />
* Confirm the security query with ''OK'' to delete the instance, otherwise click ''Cancel'' to abort.<br />
<br />
== License Information ==<br />
Clicking on the ''License Information'' menu item opens an overview of all data that is used by the billing process. <br />
<br />
=== Used Licenses per Instance ===<br />
Displays a list off all instances and their respective amount of used licenses. <br />
<br />
=== Used Resources ===<br />
This is a statistical overview of used resources.<br />
<br />
=== Raw Licensing Request ===<br />
The raw licensing request tab shows how the actual licensing request to our accounting servers looks like. The Management Server sends this information once every 24 hours to renew the local licensing information of the MailStore Service Provider Edition.<br />
<br />
== SMTP Settings ==<br />
Notifications are send by email in the following situations:<br />
<br />
* product updates are available,<br />
* a new Web Access version was installed automatically,<br />
* license renewal requests failed for three consecutive days.<br />
<br />
To send emails to administrators of the Service Provider Edition, the following settings have to be defined:<br />
<br />
* '''Server:''' Enter the host name or IP address of the SMTP server.<br />
* '''Port:''' By default, port 587 is used for email submission. If a different port (i.e. 25) is required by the SMTP server, change it here.<br />
* '''Protocol:''' Select the protocol required by the SMTP server. Select ''SMTP'' for an unencrypted connection to the SMTP server. For an encrypted connection, select ''SMTP-TLS'' (STARTTLS, Explicit SSL) or ''SMTP-SSL'' (Implicit SSL). If the certificate provided by the remote host cannot be verified (e.g. self-signed or signed by an unknown certificate authority), enable the option ''Accept all certificates'' to allow establishing a connection, otherwise the sending process will fail. Be advised that enabling this option leads to an insecure configuration and is not recommended.<br />
* '''Server requires authentication:''' If the SMTP server requires authentication prior to sending, check the corresponding checkbox and enter the appropriate credentials into the ''User Name'' and ''Password'' fields.<br />
* '''Display Name:''' Enter a name that helps to identify the origin of the emails send by the Service Provider Edition.<br />
* '''Email Address:''' Enter the email address of the sender. Some email servers, like Microsoft Exchange, verify that the authenticated users is allowed to use a particular email address.<br />
* '''Recipient for Notifications:''' Select the system administrators who should receive notifications. When none are listed, verify that at least one [[Management_Console_-_Security|system administrator]] has the email address attribute set.<br />
<br />
Once all settings have been specified, the SPE can be instructed to send a test email to the selected system administrators; 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. <br />
* If an error message appears because of an invalid certificate ("Server's certificate was rejected by the verifier because of an unknown certificate authority."), check ''Accept all certificates'' and try again.<br />
* If an error message appears indicating that ''"One or more recipients rejected"'', the SMTP server probably requires authentication. Enter the appropriate credentials as described above.<br />
* If an error message appears because of invalid credentials (e.g. ''"Incorrect authentication data"''or ''"Authentication failed"''), verify the data entered. <br />
* If further error messages appear or other problems arise, please check your input for possible mistakes.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1887Update Notices2020-11-26T11:20:35Z<p>Dweuthen: </p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* After each update check the files in the sample branding folder to identify if new settings or template variables have been introduced.<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
== Upgrading to 13.x ==<br />
* '''Update of MailStore Client and Outlook Add-in'''<br/>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 G Suite, 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 />
* '''Microsoft 365 Support'''<br />
*; A new directory service synchronization profile ''Microsoft 365 (Modern Authentication)'' as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance.<br/><p class="mswarning">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.</p><br />
* '''Google G Suite Support'''<br />
*; The Google ''G Suite'' directory service synchronization profile has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of G Suite 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.<br/><p class="mswarning">Once Google disables support for Less Secure Apps in G Suite, the existing directory service synchronization profile ''G Suite'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.</p><br />
* '''GPO Templates'''<br />
*; GPO templates are now bundled with the application. End customers may download the GPO templates from the default page of the Client Access Server. See the index.html file in the sample branding folder on how to integrate the corresponding link. As the Email Archive Client and Email Archive Outlook Add-in use the same registry keys as MailStore Server and MailStore Outlook Add-in, the GPO templates provided are those bundled with the original MailStore products.<br />
* '''IMAP Access to Archive'''<br />
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google G Suite'' directory service synchronization profile, user that have been added by these profiles, can not access their archive via the integrated IMAP server as a MailStore SPE instance is not able to verify those passwords itself. <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 the Client Access 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 the Client Access Server must be trusted by the client computer and it must not be revoked or expired.<br />
<br />
== Upgrading to 12.1 ==<br />
* '''TLS Compatibility'''<br/>To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1881Instance Administration2020-09-10T15:47:27Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
<p class="mswarning msnote">'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the Client Access Server, and that in URLs the Instance ID needs to be added.<br/><br/>'''Example:''' In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google G Suite <tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1880Instance Administration2020-09-01T15:09:30Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
<p class="mswarning msnote">'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added.<br/><br/>'''Example:''' In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google G Suite <tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1879Instance Administration2020-09-01T15:09:14Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
<p class="mswarning msnote">'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added.<br/><br/>'''Example:''' In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google G Suite '''<tt>https://<fqdn>/oidc/signin</tt>''' needs to become '''<tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>'''.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1878Instance Administration2020-09-01T15:08:53Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
<p class="mswarning msnote">'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added.<br/><br/>For example: In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google G Suite '''<tt>https://<fqdn>/oidc/signin</tt>''' needs to become '''<tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>'''.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1877Instance Administration2020-09-01T15:08:04Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
<p class="mswarning msnote">'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added. For example: In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google G Suite '''<tt>https://<fqdn>/oidc/signin</tt>''' needs to become '''<tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>'''.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1876Instance Administration2020-09-01T15:04:19Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
<p class="mswarning">Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added. For example: <tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1875Instance Administration2020-09-01T15:04:11Z<p>Dweuthen: /* Administrative Tools */</p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies|Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Firewall_Configuration_for_Multi_Server_Mode&diff=1874Firewall Configuration for Multi Server Mode2020-08-25T13:41:37Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
It is highly recommended to protect any MailStore Service Provider Edition service with appropriate firewall rules. This document should help with setting up the required rules. The firewall rules for running the SPE in Single Server Mode can be found in [[Firewall Configuration for Single Server Mode|this document]].<br />
<br />
'''Important Notices:''' <br />
* The communication channels described below MUST NOT be intercepted by any kind of email or web proxies that are provided as part of antivirus software or unified threat management gateways. <br />
* The Windows Advanced Firewall is activated on any Windows Server installation by default. In order to connect to services (e.g. MailStore Management Console) of the MailStore Service Provider Edition, it is required that the appropriate firewall rules are added (see below).<br />
<br />
The below table lists all TCP ports that need to be opened in the firewall when using MailStore Service Provider Edition in multi server mode. The following abbreviations are used in the source and target columns: <br />
<br />
* ANY = Any computer from private or public networks<br />
* ADM = Computer or network used for administration<br />
* CAS = Server hosting Client Access Server role<br />
* IH = Server hosting Instance Host role<br />
* MGMT = Server hosting Management Server role<br />
<br />
{| class="wikitable sortable"<br />
! width="80px" | Port<br />
! width="80px" | Source<br />
! width="80px" | Target<br />
! class="unsortable" | Description<br />
|-<br />
| align="center" | 110<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to email servers for archiving via POP3 (Unencrypted/STARTTLS). <br />
|-<br />
| align="center" | 143<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to email servers for archiving via IMAP (Unencrypted/STARTTLS). <br />
|-<br />
| align="center" | 143<br />
| align="center" | ANY<br />
| align="center" | CAS<br />
| IMAP access to archives secured by TLS (STARTTLS) encryption.<br />
|-<br />
| align="center" | 389<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to LDAP servers (including Microsoft Active Directory) using an unencrypted or STARTTLS-encrypted session.<br />
|-<br />
| align="center" | 443<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to Microsoft Exchange Server for archiving via Exchange Web Services (EWS) secured by SSL encryption. <br />
|-<br />
| align="center" | 443<br />
| align="center" | ANY<br />
| align="center" | CAS<br />
| HTTPS access to instances used by E-mail Archive Client, Outlook Add-in, and MailStore Web Access.<br />
|-<br />
| align="center" | 443<br />
| align="center" | MGMT<br />
| align="center" | my.mailstore.com<br />
| Usage reporting and license update.<br/><span class="mswarning">'''Important:''' DNS hostname MUST be used in firewall rules due to periodically changing IP addresses of my.mailstore.com.</span><br />
|-<br />
| align="center" | 636<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to LDAP servers (including Microsoft Active Directory) using a SSL encrypted connection.<br />
|-<br />
| align="center" | 993 <br />
| align="center" | ANY<br />
| align="center" | CAS<br />
| IMAP access to archives secured by TLS (SSL) encryption.<br />
|-<br />
| align="center" | 993<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to email servers for archiving via IMAP (SSL). <br />
|-<br />
| align="center" | 995<br />
| align="center" | IH<br />
| align="center" | ANY<br />
| Access to email servers for archiving via POP3 (SSL). <br />
|-<br />
| align="center" | 8470<br />
| align="center" | ADM<br />
| align="center" | MGMT<br />
| Web-based access to the MailStore Management Console.<br />
|-<br />
| align="center" | 8471<br />
| align="center" | CAS, IH<br />
| align="center" | MGMT<br />
| Internal communication with Management Server<br />
|-<br />
| align="center" | 8472<br />
| align="center" | MGMT, CAS<br />
| align="center" | IH<br />
| Internal communication with Instance Hosts<br />
|-<br />
| align="center" | 8473<br />
| align="center" | MGMT<br />
| align="center" | CAS<br />
| Internal communication with Client Access Servers<br />
|-<br />
| align="center" | 8474<br />
| align="center" | ADM<br />
| align="center" | MGMT<br />
| Access to the MailStore Management API.<br />
|-<br />
| align="center" | 8474<br />
| align="center" | IH, CAS<br />
| align="center" | MGMT<br />
| Optional: Required for initial pairing with Management Server in Multi Server Mode. If not available, manual registration of Instance Hosts and Client Access Servers in Management Server is required.<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Firewall_Configuration_for_Single_Server_Mode&diff=1873Firewall Configuration for Single Server Mode2020-08-25T13:40:39Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
It is highly recommended to protect any MailStore Service Provider Edition service with appropriate firewall rules. This document should help with setting up the required rules. The firewall rules for running the SPE in Multi Server Mode can be found in [[Firewall Configuration for Multi Server Mode|this document]].<br />
<br />
'''Important Notices:''' <br />
* The communication channels described below MUST NOT be intercepted by any kind of email or web proxies that are provided as part of antivirus software or unified threat management gateways. <br />
* The Windows Advanced Firewall is activated on any Windows Server installation by default. In order to connect to services (e.g. MailStore Management Console) of the MailStore Service Provider Edition, it is required that the appropriate firewall rules are added (see below).<br />
<br />
The table below lists all TCP ports that need to be opened in the firewall when using MailStore Service Provider Edition in single server mode. The following abbreviations are used in the source and target columns of that table:<br />
<br />
* ANY = Any computer from private or public networks <br />
* ADM = Computer or network used for administration<br />
* SERVER = Server that hosts MailStore Service Provider Edition<br />
<br />
{| class="wikitable sortable"<br />
! width="80px" | Port<br />
! width="80px" | Source <br />
! width="80px" | Target<br />
! class="unsortable"| Description<br />
|-<br />
| align="center" | 110<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to email servers for archiving via POP3 (Unencrypted/STARTTLS). <br />
|-<br />
| align="center" | 143<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to email servers for archiving via IMAP (Unencrypted/STARTTLS). <br />
|-<br />
| align="center" | 143<br />
| align="center" | ANY<br />
| align="center" | SERVER<br />
| IMAP access to archives secured by TLS (STARTTLS) encryption. <br />
|-<br />
| align="center" | 389<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to LDAP servers (including Microsoft Active Directory) using an unencrypted or STARTTLS-encrypted session.<br />
|-<br />
| align="center" | 443<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to Microsoft Exchange servers for archiving via Exchange Web Services (EWS) secured by SSL encryption.<br />
|-<br />
| align="center" | 443<br />
| align="center" | SERVER<br />
| align="center" | my.mailstore.com<br />
| Usage reporting and license update.<br/><span class="mswarning">'''Important:''' DNS hostname MUST be used in firewall rules due to periodically changing IP addresses of my.mailstore.com.</span><br />
|-<br />
| align="center" | 443<br />
| align="center" | ANY<br />
| align="center" | SERVER<br />
| HTTPS access to instances used by E-mail Archive Client, Outlook Add-in, and Web Access.<br />
|-<br />
| align="center" | 636<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to LDAP servers (including Microsoft Active Directory) using a SSL encrypted connection.<br />
|-<br />
| align="center" | 993<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to email servers for archiving via IMAP (SSL). <br />
|-<br />
| align="center" | 993 <br />
| align="center" | ANY<br />
| align="center" | SERVER<br />
| IMAP access to archives secured by TLS (SSL) encryption. <br />
|-<br />
| align="center" | 995<br />
| align="center" | SERVER<br />
| align="center" | ANY<br />
| Access to email servers for archiving via POP3 (SSL). <br />
|-<br />
| align="center" | 8470<br />
| align="center" | ADM<br />
| align="center" | SERVER<br />
| Web-based access to the MailStore Management Console.<br />
|-<br />
| align="center" | 8474<br />
| align="center" | ADM<br />
| align="center" | SERVER<br />
| Access to the MailStore Management API.<br />
|}<br />
<br />
=== Windows Advanced Firewall ===<br />
The Windows Advanced Firewall can easily be re-configured for Single Server Mode. By executing the following commands in the Windows PowerShell command prompt, the required TCP ports are opened for inbound connections. Outbound connections to any destination are allowed by default. <br />
<br />
<source lang="powershell" toolbar="false" gutter="false"><br />
# Allow access to CAS ports from everwhere<br />
netsh advfirewall firewall add rule name="MailStore Service Provider Edition (CAS)" `<br />
action=ALLOW dir=IN protocol=TCP localport="143,443,993" profile=ANY<br />
<br />
# Allow access to MailStore Service Provider Management Console from adminstrator network 192.0.2.0/24<br />
netsh advfirewall firewall add rule name="MailStore Service Provider Edition (MGMT)" `<br />
action=ALLOW dir=IN protocol=TCP localport="8470" remoteip="192.0.2.0/24" profile=ANY<br />
<br />
# Allow access to MailStore Management API from adminstrator network 192.0.2.0/24<br />
netsh advfirewall firewall add rule name="MailStore Service Provider Edition (MGMT)" `<br />
action=ALLOW dir=IN protocol=TCP localport="8474" remoteip="192.0.2.0/24" profile=ANY<br />
</source></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1871Instance Administration2020-07-23T15:02:15Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
<p class="mswarning">Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added. For example: <tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.</p><br />
<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1870Instance Administration2020-07-23T14:52:23Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.<br />
<p class="mswarning">Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the the Client Access Server, and that in URLs the Instance ID needs to be added.<br/><br/><b>Example</b><br/><tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.</p><br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1869Instance Administration2020-07-23T14:34:27Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help. <br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]<br />
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:G Suite Integration|G Suite]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
** [[msserver:Retention Policies]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1868Branding2020-07-16T12:48:53Z<p>Dweuthen: /* Limitations */</p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
While the limited supported parameters allow to quickly create a decent branding without having to deal with CSS at all, not all color schemes are suitable to be used. Thus, a general recommendation is to use darker colors for backgrounds as certain non-brandable text color are white.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1867Branding2020-07-16T12:41:58Z<p>Dweuthen: /* Client Branding */</p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1866Branding2020-07-16T12:41:42Z<p>Dweuthen: /* Web Branding */</p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header and hover color of button, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1865Branding2020-07-16T12:39:51Z<p>Dweuthen: /* Web Branding */</p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header and hover color of button, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header and hover color of button, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1864Branding2020-07-16T12:39:26Z<p>Dweuthen: /* Client Branding */</p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header and hover color of button, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1863Branding2020-07-16T12:37:36Z<p>Dweuthen: /* Web Branding */</p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header, e.g. "#126d9c"<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=File:MailStore_ADMX.zip&diff=1862File:MailStore ADMX.zip2020-07-15T09:43:03Z<p>Dweuthen: </p>
<hr />
<div></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Main_Page&diff=1861Main Page2020-07-15T09:42:53Z<p>Dweuthen: /* Downloads */</p>
<hr />
<div>__NOTOC__<br />
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}<br />
<br />
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.<br />
<br />
== Getting Started ==<br />
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.<br />
<br />
=== Before You Start ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Overview]] <br />
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios. <br />
|-<br />
| [[System Requirements]]<br />
| Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.<br />
|-<br />
| [[Frequently Asked Questions]]<br />
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.<br />
|}<br />
<br />
=== Installation and Setup ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]<br />
| Irrespective of the projected scenario, it all begins with the installation of the software itself.<br />
|-<br />
| [[Single Server Mode Setup|Initial Configuration]]<br />
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.<br />
|-<br />
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]<br />
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up. <br />
|}<br />
<br />
=== Using MailStore Service Provider Edition ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]] <br />
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.<br />
|-<br />
| [[Creating Instances]]<br />
| Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.<br />
|-<br />
| [[Accessing Instances]]<br />
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.<br />
|}<br />
<br />
=== Archiving Email ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Instance Administration]]<br />
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.<br />
|-<br />
|}<br />
<br />
=== Post Installation Tasks ===<br />
{|<br />
| [[End User Access]]<br />
| This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.<br />
|-<br />
| style="vertical-align: top; width: 200px" | [[Branding]]<br />
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.<br />
|-<br />
| [[Replace Self-signed SSL Certificates]]<br />
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information. <br />
|-<br />
| [[Backup and Restore]]<br />
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.<br />
|-<br />
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]<br />
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings. <br />
|-<br />
| [[Monitoring]]<br />
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.<br />
|-<br />
| [[Enhancing SSL Security]]<br />
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.<br />
|}<br />
<br />
{|<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management Console ==<br />
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.<br />
<br />
* [[Management_Console_-_Logging On|Logging On]]<br />
* [[Management_Console_-_General|General]]<br />
** [[Instance Management]]<br />
** [[Instance Administration]]<br />
* [[Management_Console_-_Infrastructure|Infrastructure]]<br />
* [[Management_Console_-_Security|Security]]<br />
* [[Management_Console_-_Developer|Developer]]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management API ==<br />
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.<br />
<br />
* [[Management API - Using the API|Using the API]]<br />
* [[Management API - Function Reference|Function Reference]]<br />
* [[Management API - Command Line Client|Command Line Client]]<br />
'''Example Implementation of API Libraries'''<br />
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]<br />
* [[Python API Wrapper Tutorial|Python]]<br />
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]<br />
|-<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Related Articles ==<br />
* [[Application Integration|Directory Service: Application Integration]]<br />
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]<br />
* [[MailStore Server to MailStore SPE Migration]]<br />
* [[Moving Roles]]<br />
* '''Multi Server Mode'''<br />
** [[Multi Server Mode Setup|Setup]]<br />
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]<br />
* [[Renaming Servers]]<br />
* [[Moving Instances]]<br />
* [[Security Advisories]]<br />
* [[Startup Scripts]]<br />
* [[Update Notices]]<br />
* [[Working with SSL Certificates]]<br />
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Downloads ==<br />
* [http://help.mailstore.com/manual/spe13-manual-en.pdf MailStore SPE 13 Manual]<br />
'''Active Directory Group Policy Templates'''<br />
* [[Media:MailStore_ADMX.zip|ADMX-Template]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Template:Saved_book&diff=1860Template:Saved book2020-07-15T09:19:51Z<p>Dweuthen: Created page with "[ [{{fullurl:Special:Collection/load_collection/|colltitle={{FULLPAGENAMEE}}}} Load Book] ]&nbsp;&nbsp;[ [{{fullurl:Special:Collection/render_collection/|colltitle={{FULLPAGEN..."</p>
<hr />
<div>[ [{{fullurl:Special:Collection/load_collection/|colltitle={{FULLPAGENAMEE}}}} Load Book] ]&nbsp;&nbsp;[ [{{fullurl:Special:Collection/render_collection/|colltitle={{FULLPAGENAMEE}}|writer=rl}} PDF] ]<br />
<br />
<noinclude><br />
Diese Vorlage wird automatisch am Anfang aller gespeicherten Bücher eingebunden, kann aber auch nachträglich ergänzt werden. <br />
</noinclude></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1859Update Notices2020-07-14T14:07:25Z<p>Dweuthen: /* Upgrading to 13.x */</p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* After each update check the files in the sample branding folder to identify if new settings or template variables have been introduced.<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
== Upgrading to 13.x ==<br />
* '''Microsoft 365 Support'''<br />
*; A new directory service synchronization profile ''Microsoft 365 (Modern Authentication)'' as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance.<br/><p class="mswarning">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.</p><br />
* '''Google G Suite Support'''<br />
*; The Google ''G Suite'' directory service synchronization profile has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of G Suite 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.<br/><p class="mswarning">Once Google disables support for Less Secure Apps in G Suite, the existing directory service synchronization profile ''G Suite'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.</p><br />
* '''Outlook Add-in'''<br />
*; Due to the required changes of the login process to support modern authentication with Microsoft 365 and Google G Suite, the Outlook Add-in must be updated to version 13 to be able to connect to a MailStore SPE 13.x instance. Connecting to an older version of a MailStore SPE instance is no longer possible after the update.<br />
* '''GPO Templates'''<br />
*; GPO templates are now bundled with the application. End customers may download the GPO templates from the default page of the Client Access Server. See the index.html file in the sample branding folder on how to integrate the corresponding link. As the Email Archive Client and Email Archive Outlook Add-in use the same registry keys as MailStore Server and MailStore Outlook Add-in, the GPO templates provided are those bundled with the original MailStore products.<br />
* '''IMAP Access to Archive'''<br />
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google G Suite'' directory service synchronization profile, user that have been added by these profiles, can not access their archive via the integrated IMAP server as a MailStore SPE instance is not able to verify those passwords itself. <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 the Client Access 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 the Client Access Server must be trusted by the client computer and it must not be revoked or expired.<br />
<br />
== Upgrading to 12.1 ==<br />
* '''TLS Compatibility'''<br/>To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1858Update Notices2020-07-14T13:58:02Z<p>Dweuthen: /* General Information */</p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* After each update check the files in the sample branding folder to identify if new settings or template variables have been introduced.<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
== Upgrading to 13.x ==<br />
* '''Microsoft 365 Support'''<br />
*; A new directory service synchronization profile ''Microsoft 365 (Modern Authentication)'' as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance.<br/><p class="mswarning">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.</p><br />
* '''Google G Suite Support'''<br />
*; The Google ''G Suite'' directory service synchronization profile has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of G Suite 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.<br/><p class="mswarning">Once Google disables support for Less Secure Apps in G Suite, the existing directory service synchronization profile ''G Suite'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.</p><br />
* '''Outlook Add-in'''<br />
*; Due to the required changes of the login process to support modern authentication with Microsoft 365 and Google G Suite, the Outlook Add-in must be updated to version 13 to be able to connect to a MailStore SPE 13.x instance. Connecting to an older version of a MailStore SPE instance is no longer possible after the update.<br />
* '''IMAP Access to Archive'''<br />
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google G Suite'' directory service synchronization profile, user that have been added by these profiles, can not access their archive via the integrated IMAP server as a MailStore SPE instance is not able to verify those passwords itself. <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 the Client Access 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 the Client Access Server must be trusted by the client computer and it must not be revoked or expired.<br />
<br />
== Upgrading to 12.1 ==<br />
* '''TLS Compatibility'''<br/>To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Main_Page&diff=1857Main Page2020-07-13T09:28:16Z<p>Dweuthen: /* Downloads */</p>
<hr />
<div>__NOTOC__<br />
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}<br />
<br />
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.<br />
<br />
== Getting Started ==<br />
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.<br />
<br />
=== Before You Start ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Overview]] <br />
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios. <br />
|-<br />
| [[System Requirements]]<br />
| Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.<br />
|-<br />
| [[Frequently Asked Questions]]<br />
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.<br />
|}<br />
<br />
=== Installation and Setup ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]<br />
| Irrespective of the projected scenario, it all begins with the installation of the software itself.<br />
|-<br />
| [[Single Server Mode Setup|Initial Configuration]]<br />
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.<br />
|-<br />
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]<br />
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up. <br />
|}<br />
<br />
=== Using MailStore Service Provider Edition ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]] <br />
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.<br />
|-<br />
| [[Creating Instances]]<br />
| Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.<br />
|-<br />
| [[Accessing Instances]]<br />
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.<br />
|}<br />
<br />
=== Archiving Email ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Instance Administration]]<br />
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.<br />
|-<br />
|}<br />
<br />
=== Post Installation Tasks ===<br />
{|<br />
| [[End User Access]]<br />
| This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.<br />
|-<br />
| style="vertical-align: top; width: 200px" | [[Branding]]<br />
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.<br />
|-<br />
| [[Replace Self-signed SSL Certificates]]<br />
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information. <br />
|-<br />
| [[Backup and Restore]]<br />
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.<br />
|-<br />
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]<br />
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings. <br />
|-<br />
| [[Monitoring]]<br />
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.<br />
|-<br />
| [[Enhancing SSL Security]]<br />
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.<br />
|}<br />
<br />
{|<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management Console ==<br />
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.<br />
<br />
* [[Management_Console_-_Logging On|Logging On]]<br />
* [[Management_Console_-_General|General]]<br />
** [[Instance Management]]<br />
** [[Instance Administration]]<br />
* [[Management_Console_-_Infrastructure|Infrastructure]]<br />
* [[Management_Console_-_Security|Security]]<br />
* [[Management_Console_-_Developer|Developer]]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management API ==<br />
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.<br />
<br />
* [[Management API - Using the API|Using the API]]<br />
* [[Management API - Function Reference|Function Reference]]<br />
* [[Management API - Command Line Client|Command Line Client]]<br />
'''Example Implementation of API Libraries'''<br />
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]<br />
* [[Python API Wrapper Tutorial|Python]]<br />
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]<br />
|-<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Related Articles ==<br />
* [[Application Integration|Directory Service: Application Integration]]<br />
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]<br />
* [[MailStore Server to MailStore SPE Migration]]<br />
* [[Moving Roles]]<br />
* '''Multi Server Mode'''<br />
** [[Multi Server Mode Setup|Setup]]<br />
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]<br />
* [[Renaming Servers]]<br />
* [[Moving Instances]]<br />
* [[Security Advisories]]<br />
* [[Startup Scripts]]<br />
* [[Update Notices]]<br />
* [[Working with SSL Certificates]]<br />
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Downloads ==<br />
* [http://help.mailstore.com/manual/spe13-manual-en.pdf MailStore SPE 13 Manual]<br />
'''Active Directory Group Policy Templates'''<br />
* [[Media:MailStoreSPE_ADMX.zip|ADMX-Template]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=MailStore_SPE_Help:Books/spe13-manual-en&diff=1856MailStore SPE Help:Books/spe13-manual-en2020-07-13T09:26:58Z<p>Dweuthen: </p>
<hr />
<div>{{saved_book<br />
| setting-papersize = a4<br />
| setting-toc = auto<br />
| setting-columns = 1<br />
}}<br />
<br />
== MailStore SPE 13 ==<br />
=== Documentation ===<br />
;Before You Start<br />
:[[Overview]]<br />
:[[System Requirements]]<br />
:[[Frequently Asked Questions]]<br />
;Installation and Setup<br />
:[[Installing MailStore Service Provider Edition]]<br />
:[[Single Server Mode Setup]]<br />
:[[Firewall Configuration for Single Server Mode]]<br />
:[[Multi Server Mode Setup]]<br />
:[[Firewall Configuration for Multi Server Mode]]<br />
;Using MailStore Service Provider Edition<br />
:[[Management Console - Logging On]]<br />
:[[Management Console - General]]<br />
:[[Instance Management]]<br />
:[[Instance Administration]]<br />
:[[Management Console - Infrastructure]]<br />
:[[Management Console - Security]]<br />
:[[Management Console - Developer]]<br />
:[[Accessing Instances]]<br />
;Post Installation Tasks<br />
:[[End User Access]]<br />
:[[Branding]]<br />
:[[Replace Self-signed SSL Certificates]]<br />
:[[Backup and Restore]]<br />
:[[Monitoring]]<br />
:[[Enhancing SSL Security]]<br />
<br />
[[Category:Books|spe13-manual-en]]</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Main_Page&diff=1855Main Page2020-07-13T09:25:44Z<p>Dweuthen: /* Downloads */</p>
<hr />
<div>__NOTOC__<br />
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}<br />
<br />
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.<br />
<br />
== Getting Started ==<br />
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.<br />
<br />
=== Before You Start ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Overview]] <br />
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios. <br />
|-<br />
| [[System Requirements]]<br />
| Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.<br />
|-<br />
| [[Frequently Asked Questions]]<br />
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.<br />
|}<br />
<br />
=== Installation and Setup ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]<br />
| Irrespective of the projected scenario, it all begins with the installation of the software itself.<br />
|-<br />
| [[Single Server Mode Setup|Initial Configuration]]<br />
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.<br />
|-<br />
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]<br />
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up. <br />
|}<br />
<br />
=== Using MailStore Service Provider Edition ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]] <br />
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.<br />
|-<br />
| [[Creating Instances]]<br />
| Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.<br />
|-<br />
| [[Accessing Instances]]<br />
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.<br />
|}<br />
<br />
=== Archiving Email ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Instance Administration]]<br />
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.<br />
|-<br />
|}<br />
<br />
=== Post Installation Tasks ===<br />
{|<br />
| [[End User Access]]<br />
| This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.<br />
|-<br />
| style="vertical-align: top; width: 200px" | [[Branding]]<br />
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.<br />
|-<br />
| [[Replace Self-signed SSL Certificates]]<br />
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information. <br />
|-<br />
| [[Backup and Restore]]<br />
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.<br />
|-<br />
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]<br />
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings. <br />
|-<br />
| [[Monitoring]]<br />
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.<br />
|-<br />
| [[Enhancing SSL Security]]<br />
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.<br />
|}<br />
<br />
{|<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management Console ==<br />
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.<br />
<br />
* [[Management_Console_-_Logging On|Logging On]]<br />
* [[Management_Console_-_General|General]]<br />
** [[Instance Management]]<br />
** [[Instance Administration]]<br />
* [[Management_Console_-_Infrastructure|Infrastructure]]<br />
* [[Management_Console_-_Security|Security]]<br />
* [[Management_Console_-_Developer|Developer]]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management API ==<br />
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.<br />
<br />
* [[Management API - Using the API|Using the API]]<br />
* [[Management API - Function Reference|Function Reference]]<br />
* [[Management API - Command Line Client|Command Line Client]]<br />
'''Example Implementation of API Libraries'''<br />
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]<br />
* [[Python API Wrapper Tutorial|Python]]<br />
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]<br />
|-<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Related Articles ==<br />
* [[Application Integration|Directory Service: Application Integration]]<br />
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]<br />
* [[MailStore Server to MailStore SPE Migration]]<br />
* [[Moving Roles]]<br />
* '''Multi Server Mode'''<br />
** [[Multi Server Mode Setup|Setup]]<br />
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]<br />
* [[Renaming Servers]]<br />
* [[Moving Instances]]<br />
* [[Security Advisories]]<br />
* [[Startup Scripts]]<br />
* [[Update Notices]]<br />
* [[Working with SSL Certificates]]<br />
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Downloads ==<br />
'''Active Directory Group Policy Templates'''<br />
* [[Media:MailStoreSPE_ADMX.zip|ADMX-Template]]<br />
* [http://help.mailstore.com/manual/spe13-manual-en.pdf MailStore SPE 13 Manual]<br />
<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=MailStore_SPE_Help:Books/spe13-manual-en&diff=1854MailStore SPE Help:Books/spe13-manual-en2020-07-13T09:13:39Z<p>Dweuthen: </p>
<hr />
<div>{{saved_book<br />
| setting-papersize = a4<br />
| setting-toc = auto<br />
| setting-columns = 1<br />
}}<br />
<br />
== MailStore Service Provider Edition 13 ==<br />
=== Documentation ===<br />
;Before You Start<br />
:[[Overview]]<br />
:[[System Requirements]]<br />
:[[Frequently Asked Questions]]<br />
;Installation and Setup<br />
:[[Installing MailStore Service Provider Edition]]<br />
:[[Single Server Mode Setup]]<br />
:[[Firewall Configuration for Single Server Mode]]<br />
:[[Multi Server Mode Setup]]<br />
:[[Firewall Configuration for Multi Server Mode]]<br />
;Using MailStore Service Provider Edition<br />
:[[Management Console - Logging On]]<br />
:[[Management Console - General]]<br />
:[[Instance Management]]<br />
:[[Instance Administration]]<br />
:[[Management Console - Infrastructure]]<br />
:[[Management Console - Security]]<br />
:[[Management Console - Developer]]<br />
:[[Accessing Instances]]<br />
;Post Installation Tasks<br />
:[[End User Access]]<br />
:[[Branding]]<br />
:[[Replace Self-signed SSL Certificates]]<br />
:[[Backup and Restore]]<br />
:[[Monitoring]]<br />
:[[Enhancing SSL Security]]<br />
<br />
[[Category:Books|spe13-manual-en]]</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=MailStore_SPE_Help:Books/spe13-manual-en&diff=1853MailStore SPE Help:Books/spe13-manual-en2020-07-13T09:11:31Z<p>Dweuthen: Created page with "{{saved_book | setting-papersize = a4 | setting-toc = auto | setting-columns = 1 }} == MailStore Service Provider Edition == ;Before You Start :Overview :System Requ..."</p>
<hr />
<div>{{saved_book<br />
| setting-papersize = a4<br />
| setting-toc = auto<br />
| setting-columns = 1<br />
}}<br />
<br />
== MailStore Service Provider Edition ==<br />
;Before You Start<br />
:[[Overview]]<br />
:[[System Requirements]]<br />
:[[Frequently Asked Questions]]<br />
;Installation and Setup<br />
:[[Installing MailStore Service Provider Edition]]<br />
:[[Single Server Mode Setup]]<br />
:[[Firewall Configuration for Single Server Mode]]<br />
:[[Multi Server Mode Setup]]<br />
:[[Firewall Configuration for Multi Server Mode]]<br />
;Using MailStore Service Provider Edition<br />
:[[Management Console - Logging On]]<br />
:[[Management Console - General]]<br />
:[[Instance Management]]<br />
:[[Instance Administration]]<br />
:[[Management Console - Infrastructure]]<br />
:[[Management Console - Security]]<br />
:[[Management Console - Developer]]<br />
:[[Accessing Instances]]<br />
;Post Installation Tasks<br />
:[[End User Access]]<br />
:[[Branding]]<br />
:[[Replace Self-signed SSL Certificates]]<br />
:[[Backup and Restore]]<br />
:[[Monitoring]]<br />
:[[Enhancing SSL Security]]<br />
<br />
[[Category:Books|spe13-manual-en]]</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Replace_Self-signed_SSL_Certificates&diff=1852Replace Self-signed SSL Certificates2020-07-13T09:09:36Z<p>Dweuthen: /* Installing New Certificates */</p>
<hr />
<div>MailStore Service Provider Edition automatically creates self-signed certificates when adding a new role to a server. While these certificates are suitable for authenticating MailStore Service Provider Edition's own services against each other by storing and verifying the unique fingerprints of the used certificates, self-signed certificates are not suitable for public internet services like email or web servers.<br />
<br />
Therefore it is recommended to replace the SSL certificates used by the Client Access Servers for offering IMAP and web based access to the archives with certificates signed by an official certificate authority. Information on requesting, renewing and working with such certificates can be found in this [[Working_with_SSL_Certificates|article]].<br />
<br />
== Prerequisites ==<br />
Before a certificate can be used by the Client Access Server service, the certificate and its private key must be stored in the computer's personal/MY certificate store ('''not''' Administrator's or any other user's).<br />
<br />
== Installing New Certificates ==<br />
* Start the MailStore Service Provider Edition Configuration tool on a server that is a Client Access Server by double-clicking it's desktop icon. On Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.<br />
* Stop the ''Client Access Server''.<br />
* Click ''Configure..''.<br />
* For each endpoint in the ''Features'' section (HTTP, IMAP, IMAPS) click on the button behind the '''Certificate'' field to select the new certificate from the Windows certificate store.<br />
*; [[File:Ms_spe_replace_self_signed_cert_01.png]]<br />
*; '''Please note:''' It is not required to replace the ''Certificate'' under the ''Client Access Server Settings''. If you would change this certificate, you also have to [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|pair]] your ''CAS'' with the ''Management Server'' to gain trust again.<br />
* Click ''OK'' to save changes or ''Cancel'' to discard.<br />
* Start the Client Access Server.<br />
<br />
Repeat the above on each Client Access Server in your MailStore Service Provider Edition infrastructure.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Instance_Administration&diff=1850Instance Administration2020-07-13T08:20:56Z<p>Dweuthen: </p>
<hr />
<div>The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help. <br />
<br />
== Archive Email ==<br />
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.<br />
<br />
If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].<br />
<br />
In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.<br />
<br />
=== Email Servers ===<br />
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:<br />
<br />
<p class="msnote">'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.</p><br />
<br />
{{msserver::Implementation}}<br />
<br />
For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:<br />
<br />
* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]<br />
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]<br />
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]<br />
<br />
=== Email Clients ===<br />
<br />
==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====<br />
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].<br />
<br />
=== Email Files ===<br />
==== Archiving Outlook PST Files ====<br />
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].<br />
<br />
==== Archiving EML or MBOX Files ====<br />
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].<br />
<br />
== Export Email ==<br />
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.<br />
<br />
Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.<br />
<br />
'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].<br />
<br />
== Administrative Tools ==<br />
The ''Administrative Tools'' provides access to the following settings:<br />
<br />
{| width="100%" cellspacing="3" cellpadding="4"<br />
| valign="top" width="50%"|<br />
=== Users and Privileges ===<br />
* [[msserver:Users, Folders and Settings|Users]]<br />
* '''Directory Services'''<br />
** [[msserver:Active Directory Integration|Active Directory]]<br />
** [[msserver:Application Integration|Application Integration]]<br />
** [[msserver:Google Apps Integration|Google Apps]]<br />
** [[msserver:IceWarp Server Integration|IceWarp Server]]<br />
** [[msserver:Kerio Connect Integration|Kerio Connect]]<br />
** [[msserver:Generic LDAP Integration|LDAP Generic]]<br />
** [[msserver:Office 365 Integration|Office 365]]<br />
* [[msserver:Users, Folders and Settings|Privileges]]<br />
* [[msserver:Archives|Archives]]<br />
| valign="top" width="50%"|<br />
<br />
=== Compliance ===<br />
* [[msserver:Compliance General|Compliance General]]<br />
* [[msserver:Auditing|Auditing]]<br />
* [[msserver:Audit Log|Audit Log]]<br />
=== Management API ===<br />
* [[msserver:MailStore Server Management Shell|Command Prompt]]<br />
* [[msserver:Jobs|Jobs]]<br />
* [[msserver:Job Results|Job Results]]<br />
=== Miscellaneous ===<br />
* [[msserver:SMTP Settings|SMTP Settings]]<br />
* [[msserver:Active Sessions|Active Sessions]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1849Update Notices2020-07-10T11:48:40Z<p>Dweuthen: </p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
<br />
== Upgrading to 13.x ==<br />
* '''Microsoft 365 Support'''<br />
*; A new directory service synchronization profile ''Microsoft 365 (Modern Authentication)'' as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance.<br/><p class="mswarning">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.</p><br />
* '''Google G Suite Support'''<br />
*; The Google ''G Suite'' directory service synchronization profile has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of G Suite 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.<br/><p class="mswarning">Once Google disables support for Less Secure Apps in G Suite, the existing directory service synchronization profile ''G Suite'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.</p><br />
* '''Outlook Add-in'''<br />
*; Due to the required changes of the login process to support modern authentication with Microsoft 365 and Google G Suite, the Outlook Add-in must be updated to version 13 to be able to connect to a MailStore SPE 13.x instance. Connecting to an older version of a MailStore SPE instance is no longer possible after the update.<br />
* '''IMAP Access to Archive'''<br />
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google G Suite'' directory service synchronization profile, user that have been added by these profiles, can not access their archive via the integrated IMAP server as a MailStore SPE instance is not able to verify those passwords itself. <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 the Client Access 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 the Client Access Server must be trusted by the client computer and it must not be revoked or expired.<br />
<br />
== Upgrading to 12.1 ==<br />
* '''TLS Compatibility'''<br/>To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Branding&diff=1848Branding2020-06-15T13:18:40Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design. <br />
<br />
== Modify and Activate Branding ==<br />
Follow the instructions below to apply your own branding:<br />
<br />
* Open Windows Explorer on the Management Server.<br />
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).<br />
* Create a new folder named <tt>Branding</tt>.<br />
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.<br />
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.<br />
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.<br />
* Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.<br />
<br />
=== Limitations ===<br />
Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the ''Connect to E-mail Archive dialog''.<br />
<br />
=== Client Branding ===<br />
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>clientName</tt><br />
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"<br />
|-<br />
| <tt>helpUrl</tt><br />
| URL to be opened when clicking on help in client.<br />
|-<br />
| <tt>loginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>headerBackgroundColor</tt><br />
| Background color of header, e.g. "#126d9c"<br />
|-<br />
| <tt>headerLeftImage_autox95_png</tt><br />
| Left header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>headerRightImage_autox95_png</tt><br />
| Right header image. Required dimension: width: auto; height: 95px<br />
|-<br />
| <tt>about_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>gatewayName</tt><br />
| Custom name that the MailStore Gateway archiving profile is listed under.<br />
|}<br />
<br />
=== Web Branding ===<br />
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.<br />
<br />
{| class="wikitable"<br />
! width=250px | Name<br />
! Description<br />
|-<br />
| <tt>webName</tt><br />
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"<br />
|-<br />
| <tt>webAbout_html</tt><br />
| HTML file containing the about site.<br />
|-<br />
| <tt>webRoot_html</tt><br />
| HTML file to be used when no in instance was given in the URL.<br />
|-<br />
| <tt>webHelpUrl</tt><br />
| URL to be opened when clicking on help in web access.<br />
|-<br />
| <tt>webLoginHeaderImage_410x81_png</tt><br />
| Header image for login dialog. Required dimension: width: 410px; height: 81px<br />
|-<br />
| <tt>webHeaderBackgroundColor</tt><br />
| Background color of header, e.g. "#126d9c"<br />
|-<br />
| <tt>webHeaderBackgroundImage_autox36_png</tt><br />
| Header header image. Required dimension: width: auto; height: 36px<br />
|-<br />
| <tt>outlookAddinName</tt><br />
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".<br />
|-<br />
| <tt>outlookAddinHelpUrl</tt><br />
| URL to be opened when clicking on help in Outlook Add-in.<br />
|-<br />
| <tt>watermarkImage_300x150_png</tt><br />
| Watermark image. Required dimension: width: 300px; height: 150px<br />
|-<br />
| <tt>favicon_ico</tt><br />
| Favicon in 16x16, 32x32, 64x64 pixel.<br />
|-<br />
| <tt>favicon_png</tt><br />
| Favicon in 196x196 pixel in PNG format.<br />
|-<br />
| <tt>highlightColor</tt><br />
| Color used for section titles, buttons and other controls, e.g. "#6aabce".<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=End_User_Access&diff=1847End User Access2020-06-15T13:08:52Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
<br />
The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.<br />
<br />
Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.<br />
<br />
As both applications are identical to MailStore Client and MailStore Outlook Add-in, their <span class="plainlinks">[https://help.mailstore.com/en/server/System_Requirements system requirements]<span> can be found in the MailStore Server help.<br />
<br />
== E-mail Archive Client ==<br />
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:<br />
<br />
* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.<br />
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>. <br />
*:[[File:Ms_spe_access_client_01.png|center]]<br />
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.<br />
* Click ''Connect'' to connect.<br />
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.<br />
* Enter your username.<br />
*:[[File:Ms_spe_access_client_02.png|center]]<br />
* Click ''Next'' to continue.<br />
* The MailStore Instance now determines how the user is to be authenticated.<br />
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''<br />
*:[[File:Ms_spe_access_client_03.png|center]]<br />
** If the user has been synchronized from Microsoft 365 or Google G Suite, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.<br />
<br />
== E-mail Archive Add-in for Outlook ==<br />
* Open Microsoft Outlook.<br />
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook. <br />
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>. <br />
* Click ''Connect'' to continue.<br />
* Enter your username in the ''User Name'' field and click ''Next'' to continue.<br />
* The MailStore Instance now determines how the user is to be authenticated.<br />
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''<br />
** If the user has been synchronized from Microsoft 365 or Google G Suite, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.<br />
<br />
== Web Access ==<br />
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.<br />
Mobile devices are supported.<br />
<br />
* Open a web browser.<br />
* Navigate to Web Access. The URL is <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.<br />
* Enter your username in the ''User Name'' field and click ''Next'' to continue.<br />
* The MailStore Instance now determines how the user is to be authenticated.<br />
** If the instance is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''<br />
** If the user has been synchronized from Microsoft 365 or Google G Suite, the web browser will be redirected to allow authentication through Microsoft's or Google's authentication service.<br />
<br />
== IMAP Client ==<br />
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings.<br />
<br />
<p class=""msnote">When using Microsoft or Google to authenticate users at login, accessing the archive via IMAP is not possible for technical reasons.</p><br />
<br />
* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server<br />
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.<br />
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.<br />
* '''Password''' - Password which is required for accessing the MailStore instance.<br />
<br />
'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=End_User_Access&diff=1846End User Access2020-06-15T13:04:12Z<p>Dweuthen: /* E-mail Archive Add-in for Outlook */</p>
<hr />
<div>__NOTOC__<br />
<br />
The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.<br />
<br />
Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.<br />
<br />
As both applications are identical to MailStore Client and MailStore Outlook Add-in, their <span class="plainlinks">[https://help.mailstore.com/en/server/System_Requirements system requirements]<span> can be found in the MailStore Server help.<br />
<br />
== E-mail Archive Client ==<br />
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:<br />
<br />
* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.<br />
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>. <br />
*:[[File:Ms_spe_access_client_01.png|center]]<br />
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.<br />
* Click ''Connect'' to connect.<br />
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.<br />
* Enter your username.<br />
*:[[File:Ms_spe_access_client_02.png|center]]<br />
* Click ''Next'' to continue.<br />
* The SPE instance now determines how the user is to be authenticated.<br />
** If MailStore Server is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''<br />
*:[[File:Ms_spe_access_client_03.png|center]]<br />
** If the user has been synchronized from Microsoft 365 or Google G Suite, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.<br />
<br />
== E-mail Archive Add-in for Outlook ==<br />
* Open Microsoft Outlook.<br />
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook. <br />
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>. <br />
* Click ''Connect'' to continue.<br />
* Enter your username and password.<br />
* Click ''OK'' to log on.<br />
<br />
== Web Access ==<br />
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.<br />
Mobile devices are supported.<br />
<br />
* Open a web browser.<br />
* Navigate to Web Access. The URL is <tt><nowiki>https://<ip_or_hostname_of_cas>/<instance_id_or_alias></nowiki></tt><br />
* Enter your username and password.<br />
* Click ''Log on''.<br />
<br />
== IMAP Client ==<br />
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings:<br />
<br />
* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server<br />
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.<br />
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.<br />
* '''Password''' - Password which is required for accessing the MailStore instance.<br />
<br />
'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=End_User_Access&diff=1845End User Access2020-06-15T12:54:54Z<p>Dweuthen: /* E-mail Archive Client */</p>
<hr />
<div>__NOTOC__<br />
<br />
The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.<br />
<br />
Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.<br />
<br />
As both applications are identical to MailStore Client and MailStore Outlook Add-in, their <span class="plainlinks">[https://help.mailstore.com/en/server/System_Requirements system requirements]<span> can be found in the MailStore Server help.<br />
<br />
== E-mail Archive Client ==<br />
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:<br />
<br />
* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.<br />
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>. <br />
*:[[File:Ms_spe_access_client_01.png|center]]<br />
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.<br />
* Click ''Connect'' to connect.<br />
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.<br />
* Enter your username.<br />
*:[[File:Ms_spe_access_client_02.png|center]]<br />
* Click ''Next'' to continue.<br />
* The SPE instance now determines how the user is to be authenticated.<br />
** If MailStore Server is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''<br />
*:[[File:Ms_spe_access_client_03.png|center]]<br />
** If the user has been synchronized from Microsoft 365 or Google G Suite, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.<br />
<br />
== E-mail Archive Add-in for Outlook ==<br />
* Open Microsoft Outlook.<br />
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook. <br />
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt><nowiki>https://<ip_or_hostname_of_cas>/<instance_id_or_alias></nowiki></tt>. <br />
* Enter your username and password.<br />
* Click ''OK'' to log on.<br />
<br />
== Web Access ==<br />
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.<br />
Mobile devices are supported.<br />
<br />
* Open a web browser.<br />
* Navigate to Web Access. The URL is <tt><nowiki>https://<ip_or_hostname_of_cas>/<instance_id_or_alias></nowiki></tt><br />
* Enter your username and password.<br />
* Click ''Log on''.<br />
<br />
== IMAP Client ==<br />
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings:<br />
<br />
* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server<br />
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.<br />
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.<br />
* '''Password''' - Password which is required for accessing the MailStore instance.<br />
<br />
'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=File:Ms_spe_access_client_02.png&diff=1844File:Ms spe access client 02.png2020-06-15T12:53:20Z<p>Dweuthen: Dweuthen uploaded a new version of File:Ms spe access client 02.png</p>
<hr />
<div></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=File:Ms_spe_access_client_03.png&diff=1843File:Ms spe access client 03.png2020-06-15T12:38:50Z<p>Dweuthen: </p>
<hr />
<div></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=End_User_Access&diff=1842End User Access2020-06-15T11:55:41Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
<br />
The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.<br />
<br />
Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.<br />
<br />
As both applications are identical to MailStore Client and MailStore Outlook Add-in, their <span class="plainlinks">[https://help.mailstore.com/en/server/System_Requirements system requirements]<span> can be found in the MailStore Server help.<br />
<br />
== E-mail Archive Client ==<br />
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:<br />
<br />
* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.<br />
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>. <br />
*:[[File:Ms_spe_access_client_01.png|center]]<br />
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.<br />
* Click ''Connect'' to connect.<br />
* E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.<br />
* Enter your username and password.<br />
*:[[File:Ms_spe_access_client_02.png|center]]<br />
* Click ''OK'' to log on.<br />
<br />
== E-mail Archive Add-in for Outlook ==<br />
* Open Microsoft Outlook.<br />
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook. <br />
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt><nowiki>https://<ip_or_hostname_of_cas>/<instance_id_or_alias></nowiki></tt>. <br />
* Enter your username and password.<br />
* Click ''OK'' to log on.<br />
<br />
== Web Access ==<br />
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.<br />
Mobile devices are supported.<br />
<br />
* Open a web browser.<br />
* Navigate to Web Access. The URL is <tt><nowiki>https://<ip_or_hostname_of_cas>/<instance_id_or_alias></nowiki></tt><br />
* Enter your username and password.<br />
* Click ''Log on''.<br />
<br />
== IMAP Client ==<br />
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings:<br />
<br />
* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server<br />
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.<br />
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.<br />
* '''Password''' - Password which is required for accessing the MailStore instance.<br />
<br />
'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=File:Ms_spe_access_client_01.png&diff=1841File:Ms spe access client 01.png2020-06-15T11:50:45Z<p>Dweuthen: Dweuthen uploaded a new version of File:Ms spe access client 01.png</p>
<hr />
<div></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=File:Ms_spe_access_client_01.png&diff=1840File:Ms spe access client 01.png2020-06-15T11:40:09Z<p>Dweuthen: Dweuthen uploaded a new version of File:Ms spe access client 01.png</p>
<hr />
<div></div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Main_Page&diff=1838Main Page2020-04-29T14:05:35Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}<br />
<br />
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.<br />
<br />
== Getting Started ==<br />
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.<br />
<br />
=== Before You Start ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Overview]] <br />
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios. <br />
|-<br />
| [[System Requirements]]<br />
| Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.<br />
|-<br />
| [[Frequently Asked Questions]]<br />
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.<br />
|}<br />
<br />
=== Installation and Setup ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]<br />
| Irrespective of the projected scenario, it all begins with the installation of the software itself.<br />
|-<br />
| [[Single Server Mode Setup|Initial Configuration]]<br />
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.<br />
|-<br />
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]<br />
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up. <br />
|}<br />
<br />
=== Using MailStore Service Provider Edition ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]] <br />
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.<br />
|-<br />
| [[Creating Instances]]<br />
| Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.<br />
|-<br />
| [[Accessing Instances]]<br />
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.<br />
|}<br />
<br />
=== Archiving Email ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Instance Administration]]<br />
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.<br />
|-<br />
|}<br />
<br />
=== Post Installation Tasks ===<br />
{|<br />
| [[End User Access]]<br />
| This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.<br />
|-<br />
| style="vertical-align: top; width: 200px" | [[Branding]]<br />
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.<br />
|-<br />
| [[Replace Self-signed SSL Certificates]]<br />
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information. <br />
|-<br />
| [[Backup and Restore]]<br />
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.<br />
|-<br />
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]<br />
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings. <br />
|-<br />
| [[Monitoring]]<br />
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.<br />
|-<br />
| [[Enhancing SSL Security]]<br />
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.<br />
|}<br />
<br />
{|<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management Console ==<br />
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.<br />
<br />
* [[Management_Console_-_Logging On|Logging On]]<br />
* [[Management_Console_-_General|General]]<br />
** [[Instance Management]]<br />
** [[Instance Administration]]<br />
* [[Management_Console_-_Infrastructure|Infrastructure]]<br />
* [[Management_Console_-_Security|Security]]<br />
* [[Management_Console_-_Developer|Developer]]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management API ==<br />
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.<br />
<br />
* [[Management API - Using the API|Using the API]]<br />
* [[Management API - Function Reference|Function Reference]]<br />
* [[Management API - Command Line Client|Command Line Client]]<br />
'''Example Implementation of API Libraries'''<br />
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]<br />
* [[Python API Wrapper Tutorial|Python]]<br />
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]<br />
|-<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Related Articles ==<br />
* [[Application Integration|Directory Service: Application Integration]]<br />
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]<br />
* [[MailStore Server to MailStore SPE Migration]]<br />
* [[Moving Roles]]<br />
* '''Multi Server Mode'''<br />
** [[Multi Server Mode Setup|Setup]]<br />
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]<br />
* [[Renaming Servers]]<br />
* [[Moving Instances]]<br />
* [[Security Advisories]]<br />
* [[Startup Scripts]]<br />
* [[Update Notices]]<br />
* [[Working with SSL Certificates]]<br />
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Downloads ==<br />
'''Active Directory Group Policy Templates'''<br />
* [[Media:MailStoreSPE_ADMX.zip|ADMX-Template]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Main_Page&diff=1837Main Page2020-04-29T14:05:26Z<p>Dweuthen: </p>
<hr />
<div>__NOTOC__<br />
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}<br />
<br />
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.<br />
<br />
== Getting Started ==<br />
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.<br />
<br />
=== Before You Start ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Overview]] <br />
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios. <br />
|-<br />
| [[System Requirements]]<br />
| Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.<br />
|-<br />
| [[Frequently Asked Questions]]<br />
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.<br />
|}<br />
<br />
=== Installation and Setup ===<br />
{| <br />
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]<br />
| Irrespective of the projected scenario, it all begins with the installation of the software itself.<br />
|-<br />
| [[Single Server Mode Setup|Initial Configuration]]<br />
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.<br />
|-<br />
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]<br />
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up. <br />
|}<br />
<br />
=== Using MailStore Service Provider Edition ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]] <br />
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.<br />
|-<br />
| [[Creating Instances]]<br />
| Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.<br />
|-<br />
| [[Accessing Instances]]<br />
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.<br />
|}<br />
<br />
=== Archiving Email ===<br />
{|<br />
| style="vertical-align: top; width: 200px" | [[Instance Administration]]<br />
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.<br />
|-<br />
|}<br />
<br />
=== Post Installation Tasks ===<br />
{|<br />
| [[End User Access]]<br />
| This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.<br />
|-<br />
| style="vertical-align: top; width: 200px" | [[Branding]]<br />
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.<br />
|-<br />
| [[Replace Self-signed SSL Certificates]]<br />
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information. <br />
|-<br />
| [[Backup and Restore]]<br />
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.<br />
|-<br />
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]<br />
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings. <br />
|-<br />
| [[Monitoring]]<br />
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.<br />
|-<br />
| [[Enhancing SSL Security]]<br />
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.<br />
|}<br />
<br />
{|<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management Console ==<br />
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.<br />
<br />
* [[Management_Console_-_Logging On|Logging On]]<br />
* [[Management_Console_-_General|General]]<br />
** [[Instance Management]]<br />
** [[Instance Administration]]<br />
* [[Management_Console_-_Infrastructure|Infrastructure]]<br />
* [[Management_Console_-_Security|Security]]<br />
* [[Management_Console_-_Developer|Developer]]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Management API ==<br />
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.<br />
<br />
* [[Management API - Using the API|Using the API]]<br />
* [[Management API - Function Reference|Function Reference]]<br />
* [[Management API - Command Line Client|Command Line Client]]<br />
'''Example Implementation of API Libraries'''<br />
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]<br />
* [[Python API Wrapper Tutorial|Python]]<br />
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]<br />
|-<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Related Articles ==<br />
* [[Application Integration|Directory Service: Application Integration]]<br />
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]<br />
* [[MailStore Server to MailStore SPE Migration]]<br />
* [[Moving Roles]]<br />
* '''Multi Server Mode'''<br />
** [[Multi Server Mode Setup|Setup]]<br />
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]<br />
* [[Renaming Servers]]<br />
* [[Moving Instances]]<br />
* [[Security Advisories]]<br />
* [[Startup Scripts]]<br />
* [[Update Notices]]<br />
* [[Working with SSL Certificates]]<br />
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]<br />
| style="vertical-align: top; width: 50%" |<br />
<br />
== Downloads ==<br />
'''Active Directory Group Policy Templates'''<br />
* [[File:MailStoreSPE_ADMX.zip|ADMX-Template]]<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Security_Advisories&diff=1836Security Advisories2020-04-23T09:54:16Z<p>Dweuthen: </p>
<hr />
<div>{|class="wikitable"<br />
! style="white-space: nowrap;" | Advisory ID<br />
! style="white-space: nowrap;" | Title<br />
! style="white-space: nowrap;" | Risk Level<br />
! style="white-space: nowrap;" | Release Date<br />
|-<br />
|style="white-space: nowrap;"| [https://go.mailstore.com/?target=sa&context=MAILSTORE-SA-2020-01 MAILSTORE-SA-2020-01]<br />
| Missing TLS/SSL Certificate Validation in Outlook Add-in (CVE-2020-11806)<br />
|high<br />
|2020-04-23<br />
|-<br />
|style="white-space: nowrap;"| [https://go.mailstore.com/?target=sa&context=MAILSTORE-SA-2019-01 MAILSTORE-SA-2019-01]<br />
|Improper Authentication in Generic LDAP Directory Service Synchronization (CVE-2019-10229)<br />
|high<br />
|2019-05-23<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1829Update Notices2020-02-04T13:42:23Z<p>Dweuthen: /* Upgrading to 12.1 */</p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
== Upgrading to 12.1 ==<br />
* '''TLS Compatibility'''<br/>To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1828Update Notices2020-01-28T13:30:09Z<p>Dweuthen: /* Upgrading to 12.1 */</p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
== Upgrading to 12.1 ==<br />
* To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Update_Notices&diff=1827Update Notices2020-01-28T13:23:54Z<p>Dweuthen: </p>
<hr />
<div>== General Information ==<br />
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.<br />
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.<br />
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server<br />
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.<br />
<br />
== Upgrading to 12.1 ==<br />
* To connect to Instances in environments that support TLS version 1.2 only with the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.<br />
<br />
== Upgrading to 12 ==<br />
* '''Expired Certificates'''<br />
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.<br />
<br />
== Upgrading to Version 11 ==<br />
* '''Upgrading Archive Stores'''<br />
*; <p class="mswarning">'''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.'''</p><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 to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Retention Policies'''<br/>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. Please notice that only end customers are allowed to manage retention policies.<br />
* '''Jobs'''<br/>With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.<br />
* '''Access via Integrated IMAP Server'''<br/>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 />
* '''SMTP Settings'''<br/>In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator. <br />
* '''Management API Commands Get-/SetComplianceConfiguration'''<br/>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 />
* '''Branding'''<br/>For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.<br />
<br />
== Upgrading to 10.1 ==<br />
* '''Archiving Emails'''<br/>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 />
<br />
== Upgrading to Version 10 ==<br />
* '''Upgrade of Master Database'''<br/>To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.<br />
* '''Upgrading Archive Stores''' <br />To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:<br />
** Log in to the Management Console.<br />
** Click on ''Instances''<br />
** Select the instance to upgrade<br />
** Open the ''Storage'' tab <br />
** 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 />
* '''Archives of Other Users'''<br/>These are no longer visible for instance 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 ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.<br />
* '''Export E-mails'''<br/>The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.<br />
* '''Auditing'''<br/>All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.<br />
<br />
== Upgrading to Version 9.x ==<br />
* '''System Requirements''' <br/>Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.<br />
* '''E-mail Archive Client Compatibility'''<br/>Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.<br />
* '''PDF Support of Full Text Search''' <br />PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.<br />
* '''MailStore Management API''' <br />The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Management_API_-_Function_Reference&diff=1822Management API - Function Reference2019-12-04T17:35:36Z<p>Dweuthen: /* RetryOpenStores */</p>
<hr />
<div><!-- DO NOT EDIT THIS ARTICLE--><br />
<!-- The content is generated from get-metadata2mediawiki.py --><br />
__NOTOC__<br />
<br />
== AttachStore ==<br />
Attach existing archive store.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>name</tt><br />
| string <br />
| Meaningful name of archive store.<br />
|-<br />
| <tt>path</tt><br />
| string <br />
| Path of directory containing archive store data.<br />
|-<br />
| <tt>requestedState</tt><br />
| string (optional)<br />
| State of archive store after attaching.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== requestedState ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>current</tt><br />
| Same as Normal but new messages will be archived in the archive store that is set to Current.<br />
|-<br />
| <tt>normal</tt><br />
| The content of archives store is available to users and can be modified if the user has the appropriate permission.<br />
|-<br />
| <tt>writeProtected</tt><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 />
| <tt>disabled</tt><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 />
== CompactStore ==<br />
Compact archive store.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store<br />
|}<br />
<br />
== CreateClientAccessServer ==<br />
Register new client access server.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Configuration of new Client Access Server.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"serverName" : string,<br />
"port" : number,<br />
"serverCertificate" : {<br />
"thumbprint" : string<br />
}<br />
}<br />
</source><br />
<br />
== CreateClientOneTimeUrlForArchiveAdmin ==<br />
Create URL including OTP for $archiveadmin access.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>instanceUrl</tt><br />
| string (optional)<br />
| Base URL for accessing instance.<br />
|}<br />
<br />
== CreateDirectoryOnInstanceHost ==<br />
Create a directory on an Instance Host<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverName</tt><br />
| string <br />
| Name of Instance Host.<br />
|-<br />
| <tt>path</tt><br />
| string <br />
| Path of directory to create.<br />
|}<br />
<br />
== CreateInstance ==<br />
Create new MailStore instance.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Configuration of new instance.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"instanceID" : string,<br />
"alias" : string,<br />
"displayName" : string,<br />
"instanceHost" : string,<br />
"startMode" : string,<br />
"baseDirectory" : string,<br />
"debugLogEnabled" : bool,<br />
"vssWriterEnabled" : bool<br />
}<br />
</source><br />
<br />
== CreateInstanceHost ==<br />
Create a new Instance Host.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Configuration of new Instance Host.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"serverName" : string,<br />
"port" : number,<br />
"serverCertificate" : {<br />
"thumbprint" : string<br />
}<br />
}<br />
</source><br />
<br />
== CreateLicenseRequest ==<br />
Create and return data of a license request.<br />
<br />
== CreateStore ==<br />
Create and attach a new archive store.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>name</tt><br />
| string <br />
| Meaningful name of archive store.<br />
|-<br />
| <tt>path</tt><br />
| string <br />
| Path of directory containing archive store data.<br />
|-<br />
| <tt>requestedState</tt><br />
| string (optional)<br />
| State of archive store after attaching.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== requestedState ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>current</tt><br />
| Same as Normal but new messages will be archived in the archive store that is set to Current.<br />
|-<br />
| <tt>normal</tt><br />
| The content of archives store is available to users and can be modified if the user has the appropriate permission.<br />
|-<br />
| <tt>writeProtected</tt><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 />
| <tt>disabled</tt><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 />
== CreateSystemAdministrator ==<br />
Create a new SPE system administrator.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Configuration of new SPE system administrator.<br />
|-<br />
| <tt>password</tt><br />
| string <br />
| Password of new SPE system administrator.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"userName" : string,<br />
"fullName" : string,<br />
"emailAddress" : string<br />
}<br />
</source><br />
<br />
== DeleteClientAccessServer ==<br />
Delete Client Access Server from management database.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverName</tt><br />
| string <br />
| Name of Client Access Server.<br />
|}<br />
<br />
== DeleteInstanceHost ==<br />
Delete Instance Host from management database.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverName</tt><br />
| string <br />
| Name of Instance Host.<br />
|}<br />
<br />
== DeleteInstances ==<br />
Delete one or multiple MailStore Instances<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== DeleteSystemAdministrator ==<br />
Delete SPE system administrator.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of SPE system administrator.<br />
|}<br />
<br />
== DetachStore ==<br />
Detach archive store<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|}<br />
<br />
== FreezeInstances ==<br />
Freeze a MailStore Instance<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== GetArchiveAdminEnabled ==<br />
Get current state of archive admin access.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetClientAccessServers ==<br />
Get list of Client Access Servers.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverNameFilter</tt><br />
| string (optional)<br />
| Server name filter string.<br />
|-<br />
| <tt>withServiceStatus</tt><br />
| bool <br />
| Include service status or not.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== serverNameFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>null</tt><br />
| All servers<br />
|-<br />
| <tt>serverName</tt><br />
| Only the given serverName. Must match exactly.<br />
|}<br />
<br />
== GetDirectoriesOnInstanceHost ==<br />
Get file system directory structure from Instance Host.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverName</tt><br />
| string <br />
| Name of Instance Host.<br />
|-<br />
| <tt>path</tt><br />
| string (optional)<br />
| Path of directory to obtain subdirectories from.<br />
|}<br />
<br />
== GetEnvironmentInfo ==<br />
Return general information about SPE environment.<br />
<br />
== GetIndexConfiguration ==<br />
Get list of attachment file types to index.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetInstanceConfiguration ==<br />
Get configuration of MailStore Instance.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetInstanceHosts ==<br />
Get list of Instance Hosts.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverNameFilter</tt><br />
| string (optional)<br />
| Server name filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== serverNameFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>null</tt><br />
| All servers<br />
|-<br />
| <tt>serverName</tt><br />
| Only the given serverName. Must match exactly.<br />
|}<br />
<br />
== GetInstanceProcessLiveStatistics ==<br />
Get live statistics from instance process.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetInstances ==<br />
Get list of instances.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== GetInstanceStatistics ==<br />
Get archive statistics from instance.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetServiceStatus ==<br />
Get current status of all SPE services.<br />
<br />
== GetStoreAutoCreateConfiguration ==<br />
Get automatic archive store creation settings.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetSystemSmtpConfiguration ==<br />
Get current system wide SMTP configuration.<br />
<br />
== GetStores ==<br />
Get list of archive stores.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetSystemAdministrators ==<br />
Get list of system administrators.<br />
<br />
== MaintainFileSystemDatabases ==<br />
Execute maintenance task on archive store databases.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== MergeStore ==<br />
Merge two archive stores.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of destination archive store.<br />
|-<br />
| <tt>sourceId</tt><br />
| number <br />
| Unique ID of source archive store.<br />
|}<br />
<br />
== PairWithManagementServer ==<br />
Pair server role with Management Server.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>serverType</tt><br />
| string <br />
| Type of server role.<br />
|-<br />
| <tt>serverName</tt><br />
| string <br />
| Name of server that hosts 'serverType' role.<br />
|-<br />
| <tt>port</tt><br />
| number <br />
| TCP port on which 'serverType' role on 'serverName' accepts connections.<br />
|-<br />
| <tt>thumbprint</tt><br />
| string <br />
| Thumbprint of SSL certificate used by serverType' role on 'serverName'<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== serverType ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>instanceHost</tt><br />
| Pairing an Instance Host.<br />
|-<br />
| <tt>clientAccessServer</tt><br />
| Pairing a Client Access Server.<br />
|}<br />
<br />
== Ping ==<br />
Send a keep alive packet.<br />
<br />
== RebuildSelectedStoreIndexes ==<br />
Rebuild search indexes of selected archive stores.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string<br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|-<br />
| <tt>encryptionKey</tt><br />
| string (optional)<br />
| Encryption key of the archive store.<br />
|}<br />
<br />
== RecreateRecoveryRecords ==<br />
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string<br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|}<br />
<br />
== RefreshAllStoreStatistics ==<br />
Refresh archive store statistics.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== ReloadBranding ==<br />
Reloads the SPE branding information from the filesystem. Newly connected clients are getting the updated branding.<br />
<br />
== RenameStore ==<br />
Rename archive store<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|-<br />
| <tt>name</tt><br />
| string <br />
| New name of archive store.<br />
|}<br />
<br />
== RestartInstances ==<br />
Restart one or multiple instances.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== RepairStoreDatabase ==<br />
Tries to resolve certain issue with archive store databases (e.g. missing database indexes).<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|}<br />
<br />
== RetryOpenStores ==<br />
Retry opening stores that failed previously<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== SelectAllStoreIndexesForRebuild ==<br />
Select all archive store for rebuild.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== SetArchiveAdminEnabled ==<br />
Enable or disable archive admin access.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>enabled</tt><br />
| bool <br />
| Enable or disable flag.<br />
|}<br />
<br />
== SetClientAccessServerConfiguration ==<br />
Set the configuration of a Client Access Server.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Client Access Server configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"serverName" : string,<br />
"port" : number,<br />
"serverCertificate" : {<br />
"thumbprint" : string<br />
}<br />
}<br />
</source><br />
<br />
== SetIndexConfiguration ==<br />
Set full text search index configuration.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Full text search index configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
Use GetIndexConfiguration to receive supported value.<br />
<br />
== SetInstanceConfiguration ==<br />
Set configuration of MailStore Instance.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Instance configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"instanceID" : string,<br />
"alias" : string,<br />
"displayName" : string,<br />
"instanceHost" : string,<br />
"startMode" : string,<br />
"baseDirectory" : string,<br />
"debugLogEnabled" : bool,<br />
"vssWriterEnabled" : bool<br />
}<br />
</source><br />
<br />
== SetInstanceHostConfiguration ==<br />
Set configuration of Instance Host.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Instance Host configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"serverName" : string,<br />
"port" : number,<br />
"serverCertificate" : {<br />
"thumbprint" : string<br />
},<br />
"baseDirectory" : string<br />
}<br />
</source><br />
<br />
== SetStoreAutoCreateConfiguration ==<br />
Set configuration for automatic archive store creation.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Archive store automatic creation configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"enabled" : bool,<br />
"interval" : string,<br />
"sizeThreshold" : string,<br />
"numberOfMessagesThreshold" : number,<br />
"baseDirectory" : string<br />
}<br />
</source><br />
<br />
== SetStorePath ==<br />
Set the path to archive store data.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|-<br />
| <tt>path</tt><br />
| string <br />
| Path to archive store data.<br />
|}<br />
<br />
== SetStoreRequestedState ==<br />
Set state of archive store.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|-<br />
| <tt>requestedState</tt><br />
| string <br />
| State of archive store.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== requestedState ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>current</tt><br />
| Same as Normal but new messages will be archived in the archive store that is set to Current.<br />
|-<br />
| <tt>normal</tt><br />
| The content of archives store is available to users and can be modified if the user has the appropriate permission.<br />
|-<br />
| <tt>writeProtected</tt><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 />
| <tt>disabled</tt><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 />
== SetSystemAdministratorConfiguration ==<br />
Set SPE system administrator configuration.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| SPE system administrator configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"userName" : string,<br />
"fullName" : string,<br />
"emailAddress" : string<br />
}<br />
</source><br />
<br />
== SetSystemAdministratorPassword ==<br />
Set password for SPE system administrator.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of SPE system administrator.<br />
|-<br />
| <tt>password</tt><br />
| string <br />
| New password for SPE system administrator.<br />
|}<br />
<br />
== SetSystemSmtpConfiguration ==<br />
Set system wide SMTP configuration.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>config</tt><br />
| json<br />
| SMTP configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
Example config object:<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"hostname": "mail.example.com",<br />
"port": 587,<br />
"protocol": "SMTP-TLS",<br />
"ignoreSslPolicyErrors": false,<br />
"authenticationRequired": true,<br />
"username": "sending.user@example.com",<br />
"password": "userpassword",<br />
"fromDisplayName": "Sending User",<br />
"fromEmailAddress": "sending.user@example.com",<br />
"recipientSystemAdministrator": ["admin", "johndoe"]<br />
}<br />
</source><br />
<br />
== StartInstances ==<br />
Start one or multiple MailStore Instances.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|-<br />
| <tt>safeMode</tt><br />
| bool (optional)<br />
| Start instances in Safe Mode to perform maintenance.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== StopInstances ==<br />
Stop one or multiple MailStore Instances.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== TestSystemSmtpConfiguration ==<br />
Test current system wide SMTP configuration.<br />
<br />
== ThawInstances ==<br />
Thaw one or multiple MailStore Instances.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceFilter</tt><br />
| string <br />
| Instance filter string.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== instanceFilter ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>*</tt><br />
| All instances<br />
|-<br />
| <tt>instance01 instance02 instance03</tt><br />
| instance01, instance02 and instance03<br />
|-<br />
| <tt>*instancehost01 *instancehost02</tt><br />
| All instances on instancehost1 and instancehost2<br />
|-<br />
| <tt>* .running</tt><br />
| All running instances<br />
|-<br />
| <tt>* .stopped</tt><br />
| All stopped instances<br />
|}<br />
<br />
== UpgradeStore ==<br />
Upgrade archive store from MailStore Server 5 or older to current format.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|}<br />
<br />
== VerifyStore ==<br />
Verify archive stores consistency.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of archive store.<br />
|-<br />
| <tt>includeIndexes</tt><br />
| bool<br />
| Defines whether to verify the search indexes as well.<br />
|}<br />
<br />
== VerifyStores ==<br />
Verify consistency of all archive stores.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>includeIndexes</tt><br />
| bool<br />
| Defines whether to verify the search indexes as well.<br />
|}<br />
<br />
== CancelJobAsync ==<br />
Cancel a running job asynchronously.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|}<br />
<br />
== CreateJob ==<br />
Create a new job to execute Management API commands.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>name</tt><br />
| string (optional)<br />
| A meaningful name for the job. Example: ''Daily Backup''.<br />
|-<br />
| <tt>action</tt><br />
| string (optional)<br />
| Management API command to execute.<br />
|-<br />
| <tt>owner</tt><br />
| string (optional)<br />
| Username of the job owner; must be an administrator.<br />
|-<br />
| <tt>timeZoneId</tt><br />
| string (optional)<br />
| The time zone 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 />
| <tt>date</tt><br />
| string (optional)<br />
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.<br />
|-<br />
| <tt>interval</tt><br />
| number (optional)<br />
| Interval for running job.<br />
|-<br />
| <tt>time</tt><br />
| string (optional)<br />
| Time for running job. Without additional parameter, this means daily execution.<br />
|-<br />
| <tt>dayOfWeek</tt><br />
| string (optional)<br />
| Day of week to run job. Parameter "time" also required.<br />
|-<br />
| <tt>dayOfMonth</tt><br />
| string (optional)<br />
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.<br />
|}<br />
<br />
Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.<br />
=== Argument Values ===<br />
<br />
==== interval ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>5</tt><br />
| Every 5 minutes.<br />
|-<br />
| <tt>10</tt><br />
| Every 10 minutes.<br />
|-<br />
| <tt>15</tt><br />
| Every 15 minutes.<br />
|-<br />
| <tt>20</tt><br />
| Every 20 minutes.<br />
|-<br />
| <tt>30</tt><br />
| Every 30 minutes.<br />
|-<br />
| <tt>60</tt><br />
| Every hour.<br />
|-<br />
| <tt>120</tt><br />
| Every 2 hours.<br />
|-<br />
| <tt>180</tt><br />
| Every 3 hours.<br />
|-<br />
| <tt>240</tt><br />
| Every 4 hours.<br />
|-<br />
| <tt>360</tt><br />
| Every 6 hours.<br />
|-<br />
| <tt>720</tt><br />
| Every 12 hours.<br />
|}<br />
<br />
==== dayOfWeek ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>Sunday</tt><br />
| Sunday<br />
|-<br />
| <tt>Monday</tt><br />
| Monday<br />
|-<br />
| <tt>Tuesday</tt><br />
| Tuesday<br />
|-<br />
| <tt>Wednesday</tt><br />
| Wednesday<br />
|-<br />
| <tt>Thursday</tt><br />
| Thursday<br />
|-<br />
| <tt>Friday</tt><br />
| Friday<br />
|-<br />
| <tt>Saturday</tt><br />
| Saturday<br />
|}<br />
<br />
==== dayOfMonth ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>1 to 31</tt><br />
| Numeric representation of day of month.<br />
|-<br />
| <tt>Last</tt><br />
| Last day of month.<br />
|}<br />
<br />
== CreateProfile ==<br />
Create a new archiving or exporting profile.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>properties</tt><br />
| json <br />
| Profile properties.<br />
|-<br />
| <tt>raw</tt><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 the Email Archive 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 />
== CreateUser ==<br />
Create new MailStore user. Use ''SetPrivilegesOnFolder'' to grant that user privileges on the own archive.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of new MailStore user.<br />
|-<br />
| <tt>privileges</tt><br />
| string <br />
| Comma separated list of privileges.<br />
|-<br />
| <tt>fullName</tt><br />
| string (optional)<br />
| Full name of user.<br />
|-<br />
| <tt>distinguishedName</tt><br />
| string (optional)<br />
| LDAP DN string.<br />
|-<br />
| <tt>authentication</tt><br />
| string (optional)<br />
| Authentication setting for user: 'integrated' or 'directoryServices'.<br />
|-<br />
| <tt>password</tt><br />
| string (optional)<br />
| Password of new user.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== privileges ====<br />
{{Template:Management_API_User_Privileges}}<br />
<br />
== DeleteEmptyFolders ==<br />
Remove folders from folder tree that do not contain emails.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>folder</tt><br />
| string (optional)<br />
| Entry point in folder tree.<br />
|}<br />
<br />
== DeleteJob ==<br />
Deletes a job.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| string (optional)<br />
| The unique identifier of the job to be deleted.<br />
|}<br />
<br />
== DeleteProfile ==<br />
Delete an archiving or exporting profile.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| Unique ID of profile.<br />
|}<br />
<br />
== DeleteUser ==<br />
Delete a MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|}<br />
<br />
== GetChildFolders ==<br />
Get child folders.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>folder</tt><br />
| string (optional)<br />
| Parent folder.<br />
|-<br />
| <tt>maxLevels</tt><br />
| number (optional)<br />
| Depth of child folders.<br />
|}<br />
<br />
== GetComplianceConfiguration ==<br />
Get current compliance configuration settings.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetDirectoryServicesConfiguration ==<br />
Get current Directory Services configuration settings.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetFolderStatistics ==<br />
Get folder statistics.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetJobResults ==<br />
Retrieves list of finished job executions.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>fromIncluding</tt><br />
| string <br />
| Beginning of time range to fetch.<br />
|-<br />
| <tt>toExcluding</tt><br />
| string <br />
| End of time range to fetch.<br />
|-<br />
| <tt>timeZoneId</tt><br />
| string <br />
| The time zone 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 />
| <tt>jobId</tt><br />
| number (optional)<br />
| The job id for which to retrieve results.<br />
|}<br />
<br />
Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''<br />
<br />
Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.<br />
<br />
== GetJobs ==<br />
Retrieve list of jobs<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetProfiles ==<br />
Get list of archiving and exporting profiles.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>raw</tt><br />
| bool <br />
| Currently only 'true' is supported.<br />
|}<br />
<br />
== GetSmtpSettings ==<br />
Get current SMTP configuration.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetTimeZones ==<br />
Get list of available time zones.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetUserInfo ==<br />
Get detailed information about user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user<br />
|}<br />
<br />
== GetUsers ==<br />
Get list of users.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}<br />
<br />
== GetWorkerResults ==<br />
Get results of profile executions.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>fromIncluding</tt><br />
| string <br />
| Beginning of time range to fetch.<br />
|-<br />
| <tt>toExcluding</tt><br />
| string <br />
| End of time range to fetch.<br />
|-<br />
| <tt>timeZoneID</tt><br />
| string <br />
| The time zone 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 />
| <tt>profileID</tt><br />
| number (optional)<br />
| Filter results by given profile ID.<br />
|-<br />
| <tt>userName</tt><br />
| string (optional)<br />
| Filter results by given user name.<br />
|}<br />
<br />
Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''<br />
<br />
Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.<br />
<br />
== MoveFolder ==<br />
Move folder.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>fromFolder</tt><br />
| string <br />
| Old folder name.<br />
|-<br />
| <tt>toFolder</tt><br />
| string <br />
| New folder name.<br />
|}<br />
<br />
== RenameJob ==<br />
Rename job.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number (optional)<br />
| The unique identifier of the job to be renamed.<br />
|-<br />
| <tt>name</tt><br />
| string (optional)<br />
| The new job name.<br />
|}<br />
<br />
== RenameUser ==<br />
Rename a MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>oldUserName</tt><br />
| string <br />
| Old user name.<br />
|-<br />
| <tt>newUserName</tt><br />
| string <br />
| New user name.<br />
|}<br />
<br />
== RunJobAsync ==<br />
Run an existing job.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><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 E-Mail-Archive Client. Client side profiles can be started by using the ''MailStoreCmd'' and the commands ''import-execute'' and ''export-execute''.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><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 E-Mail-Archive Client.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>properties</tt><br />
| json <br />
| Profile properties.<br />
|-<br />
| <tt>raw</tt><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. ''Id'' and ''Version'' attributes must not be set.<br />
<br />
== SetComplianceConfiguration ==<br />
Set compliance configuration settings.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>config</tt><br />
| json <br />
| Compliance configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== config ====<br />
Use GetComplianceConfiguration to receive supported value.<br />
<br />
Example settings object:<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"adminEmailPreviewEnabled": true,<br />
"legalHoldEnabled": false,<br />
"logSuccessfulUserActivities": [<br />
"AdminRestored",<br />
"ComplianceChangeSettings",<br />
"FileGroupAttach",<br />
"FileGroupCreate",<br />
"FileGroupDetach",<br />
"FileGroupRename",<br />
"FileGroupSetProperties",<br />
"FileGroupSetRequestedState",<br />
"ProfileChangeUserName",<br />
"UserAdd",<br />
"UserDelete",<br />
"UserRename",<br />
"UserSetFolderAccess",<br />
"UserSetMappings",<br />
"UserUpdate"<br />
]<br />
}<br />
</source><br />
<br />
== SetDirectoryServicesConfiguration ==<br />
Set directory services configuration settings.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>config</tt><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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>id</tt><br />
| number (optional)<br />
| The unique identifier of the job to be modified.<br />
|-<br />
| <tt>enabled</tt><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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>id</tt><br />
| number <br />
| The unique identifier of the job to be modified.<br />
|-<br />
| <tt>timeZoneId</tt><br />
| string <br />
| The time zone 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 />
| <tt>date</tt><br />
| string (optional)<br />
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.<br />
|-<br />
| <tt>interval</tt><br />
| number (optional)<br />
| Interval for running job.<br />
|-<br />
| <tt>time</tt><br />
| string (optional)<br />
| Time for running job. Without additional parameter, this means daily execution.<br />
|-<br />
| <tt>dayOfWeek</tt><br />
| string (optional)<br />
| Day of week to run job. Parameter "time" also required.<br />
|-<br />
| <tt>dayOfMonth</tt><br />
| string (optional)<br />
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.<br />
|}<br />
<br />
Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.<br />
=== Argument Values ===<br />
<br />
==== interval ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>5</tt><br />
| Every 5 minutes.<br />
|-<br />
| <tt>10</tt><br />
| Every 10 minutes.<br />
|-<br />
| <tt>15</tt><br />
| Every 15 minutes.<br />
|-<br />
| <tt>20</tt><br />
| Every 20 minutes.<br />
|-<br />
| <tt>30</tt><br />
| Every 30 minutes.<br />
|-<br />
| <tt>60</tt><br />
| Every hour.<br />
|-<br />
| <tt>120</tt><br />
| Every 2 hours.<br />
|-<br />
| <tt>180</tt><br />
| Every 3 hours.<br />
|-<br />
| <tt>260</tt><br />
| Every 4 hours.<br />
|-<br />
| <tt>360</tt><br />
| Every 6 hours.<br />
|-<br />
| <tt>720</tt><br />
| Every 12 hours.<br />
|}<br />
<br />
==== dayOfWeek ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>Sunday</tt><br />
| Sunday<br />
|-<br />
| <tt>Monday</tt><br />
| Monday<br />
|-<br />
| <tt>Tuesday</tt><br />
| Tuesday<br />
|-<br />
| <tt>Wednesday</tt><br />
| Wednesday<br />
|-<br />
| <tt>Thursday</tt><br />
| Thursday<br />
|-<br />
| <tt>Friday</tt><br />
| Friday<br />
|-<br />
| <tt>Saturday</tt><br />
| Saturday<br />
|}<br />
<br />
==== dayOfMonth ====<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>1 to 31</tt><br />
| Numeric representation of day of month.<br />
|-<br />
| <tt>Last</tt><br />
| Last day of month.<br />
|}<br />
<br />
== SetSmtpSettings ==<br />
Set SMTP configuration.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>settings</tt><br />
| json<br />
| SMTP configuration.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== settings====<br />
Example settings object:<br />
<source lang="js" smart-tabs="true" toolbar="false" gutter="false"><br />
{<br />
"hostname": "mail.example.com",<br />
"port": 587,<br />
"protocol": "SMTP-TLS",<br />
"ignoreSslPolicyErrors": false,<br />
"authenticationRequired": true,<br />
"username": "sending.user@example.com",<br />
"password": "userpassword",<br />
"fromDisplayName": "Sending User",<br />
"fromEmailAddress": "sending.user@example.com",<br />
"recipientEmailAddress": "administrator@example.com"<br />
}<br />
</source><br />
<br />
<br />
== SetUserAuthentication ==<br />
Set authentication settings of a MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>authentication</tt><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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>distinguishedName</tt><br />
| string (optional)<br />
| LDAP DN string.<br />
|}<br />
<br />
== SetUserEmailAddresses ==<br />
Set email addresses of MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>emailAddresses</tt><br />
| string (optional)<br />
| List of email addresses.<br />
|}<br />
<br />
== SetUserFullName ==<br />
Set full name of MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>fullName</tt><br />
| string (optional)<br />
| Full name of MailStore user.<br />
|}<br />
<br />
== SetUserPassword ==<br />
Set password of MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>password</tt><br />
| string <br />
| Password of MailStore user.<br />
|}<br />
<br />
== SetUserPop3UserNames ==<br />
Set POP3 user name of MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>pop3UserNames</tt><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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>privileges</tt><br />
| string <br />
| Comma separated list of privileges.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== privileges ====<br />
{{Template:Management_API_User_Privileges}}<br />
<br />
== SetUserPrivilegesOnFolder ==<br />
Set privileges on folder for MailStore user.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>userName</tt><br />
| string <br />
| User name of MailStore user.<br />
|-<br />
| <tt>folder</tt><br />
| string <br />
| Folder name.<br />
|-<br />
| <tt>privileges</tt><br />
| string <br />
| Comma separated list of folder privileges.<br />
|}<br />
<br />
=== Argument Values ===<br />
<br />
==== privileges ====<br />
<br />
{| class="wikitable"<br />
! width=270px | Name<br />
! Description<br />
|-<br />
| <tt>none</tt><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 />
| <tt>read</tt><br />
| The user is granted read access to the specified folder.<br />
|-<br />
| <tt>write</tt><br />
| The user is granted write access to the specified folder. Messages can be moved within an archive.<br />
|-<br />
| <tt>delete</tt><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="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|-<br />
| <tt>dryRun</tt><br />
| bool (optional)<br />
| Simulate sync only.<br />
|}<br />
<br />
== TestSmtpSettings ==<br />
Test current SMTP configuration.<br />
<br />
=== Arguments ===<br />
{| class="wikitable"<br />
! width=150px | Name<br />
! width=120px | Type<br />
! Description<br />
|-<br />
| <tt>instanceID</tt><br />
| string <br />
| Unique ID of MailStore instance in which this command is invoked.<br />
|}</div>Dweuthenhttps://help.mailstore.com/en/spe/index.php?title=Security_Advisories&diff=1806Security Advisories2019-05-22T14:53:23Z<p>Dweuthen: Created page with "{|class="wikitable" ! style="white-space: nowrap;" | Advisory ID ! style="white-space: nowrap;" | Title ! style="white-space: nowrap;" | Risk Level ! style="white-space: nowra..."</p>
<hr />
<div>{|class="wikitable"<br />
! style="white-space: nowrap;" | Advisory ID<br />
! style="white-space: nowrap;" | Title<br />
! style="white-space: nowrap;" | Risk Level<br />
! style="white-space: nowrap;" | Release Date<br />
|-<br />
|style="white-space: nowrap;"| [https://go.mailstore.com/?target=sa&context=MAILSTORE-SA-2019-01 MAILSTORE-SA-2019-01]<br />
|Improper Authentication in Generic LDAP Directory Service Synchronization (CVE-2019-10229)<br />
|high<br />
|2019-05-23<br />
|}</div>Dweuthen