Difference between revisions of "AppSuite:OX Mail App"

(Created page with "= OX Mail v2 = The OX Mail v2 is a companion app for OX App Suite, and brings the power of OX App Suite web-based email to your customers' mobile devices. The OX Mail v2 is a...")
 
 
(76 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= OX Mail v2 =
+
= OX Mail =
  
The OX Mail v2 is a companion app for OX App Suite, and brings the power of OX App Suite web-based email to your customers' mobile devices. The OX Mail v2 is a native app designed specifically for Android and iOS smartphones and tablets.
+
The OX Mail is a companion app for OX App Suite, and brings the power of OX App Suite web-based email to your customers' mobile devices. The OX Mail is a native app designed specifically for Android and iOS smartphones and tablets.
  
With a focus on security and user-experience, OX Mail v2 serves all your email needs on the go. Most notably you can answer and process mails even when you are offline, mails are synced when you go online. For completing addresses, OX Mail v2 uses the address book of the device along with all received and sent mails. When you have deleted an email by accident, you can easily undo that. Furthermore OX Mail v2 provides a list of known features such as pushing new emails onto your device, supporting mail folders, handling attachments, showing the number of unread email, and so on.
+
With a focus on security and user-experience, OX Mail serves all your email needs on the go. Most notably you can answer and process mails even when you are offline, mails are synced when you go online. For completing addresses, OX Mail uses the address book of the device along with all received and sent mails. When you have deleted an email by accident, you can easily undo that. Furthermore OX Mail provides a list of known features such as pushing new emails onto your device, supporting mail folders, handling attachments, showing the number of unread email, and so on.
  
 
== Key Benefits ==
 
== Key Benefits ==
  
* Quick and easy to install
+
* Additional privacy and integration with OX Abuse Shield
* Incoming emails are instantly displayed on the mobile device
+
* Offline availability
* User-friendly due to native design and integration
+
* Grouping notifications on Android
* Available for iOS and Android mobile and tablet devices
+
* Mobile API facade to connect to OX App Suite
* Offline capable – Answer and manage your mails even when you are offline - your work will be synced once you get online again
 
* Privacy features like Certificated Pinning (Android only for now), securely stored credentials, securely stored mail bodies, securely stored attachments and integration with Dovecot Anti-Abuse Shield
 
  
This app is brought to you by Open-Xchange. You can choose between using our OX-branded app as part of your OX App Suite license or to order a version that is adapted to your brand and published under your name.
+
Open-Xchange now provides more detailed overviews and Feature Overview documents relating to new product releases. These can be found at https://www.open-xchange.com/portfolio/whats-new/
 +
 
 +
<!-- This app is brought to you by Open-Xchange. You can choose between using our OX-branded app as part of your OX App Suite license or to order a version that is adapted to your brand and published under your name. -->
  
 
== Requirements ==
 
== Requirements ==
  
=== OX App Suite v7.8.4 ===
+
{|border="2" rules="all" align="left">
 +
  |'''Requirement'''
 +
  |'''System / Platform / User Interface'''
 +
|-
 +
  |&nbsp;
 +
  |&nbsp;
 +
|-
 +
  |[http://oxpedia.org/wiki/index.php?title=AppSuite:Main_Page_Quickinstall#Quick_Installation_Guide OX App Suite]
 +
  |OX App Suite v7.10.3, 7.10.4
 +
|-
 +
  |[http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade Mobile API Facade]
 +
  |Mobile API Facade v1.8.x or later (from OX App Suite v7.10.3)
 +
|-
 +
  |Push Notification Package
 +
  |Package "open-xchange-mobile-api-facade-push-certificates" (available to App Suite licensees only)
 +
|-
 +
  |OX Mail App for iOS
 +
  |iOS 13 / iOS 14 / iPad OS <br>Server reachable via TLS 1.2
 +
|-
 +
  |OX Mail App for Android
 +
  |Android 5.0 (Lollipop) or higher<br>Server reachable via TLS 1.2
 +
|-
 +
|}
 +
 
 +
=== OX App Suite ===
  
 
OX App Suite is a modular platform designed for Telcos, Hosters, and other Service Providers and delivers a wide range of cloud-based services. These include email, file sharing, collaborative document editing, document management, time management, cloud storage and metrics for monitoring end-user behavior. More information can be found at https://www.open-xchange.com/portfolio/whats-new/
 
OX App Suite is a modular platform designed for Telcos, Hosters, and other Service Providers and delivers a wide range of cloud-based services. These include email, file sharing, collaborative document editing, document management, time management, cloud storage and metrics for monitoring end-user behavior. More information can be found at https://www.open-xchange.com/portfolio/whats-new/
 
The OX Mail v2 app requires at least OX App Suite version 7.8.4-rev22.
 
  
 
=== Mobile API Facade ===
 
=== Mobile API Facade ===
  
The Mobile API Facade is a server component that brings the new native mobile mail apps together with the OX App Suite. We’ve built the façade based on the technology used and proven in the OX App Suite middleware. The facade is developed in Java, utilizing the OSGIFramework. Further information can be found at: http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade.
+
The Mobile API Facade is a server component that brings the new native mobile mail apps together with the OX App Suite. We’ve built the facade based on the technology used and proven in the OX App Suite middleware. The facade is developed in Java, utilizing the OSGIFramework. Further information can be found at: http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade.
  
 
=== TLS 1.2 ===
 
=== TLS 1.2 ===
  
The communication between the OX Mail v2 app and its end points needs to be secured with TLS 1.2. Please make sure that your infrastructure is capable of handling TLS 1.2 HTTP requests without downgrading the connection.
+
The communication between the OX Mail app and its end points needs to be secured with TLS 1.2. Please make sure that your infrastructure is capable of handling TLS 1.2 HTTP requests without downgrading the connection.
  
= Pricing & Availability =
+
= OX Mail Availability =
  
This email app is available for both iOS and Android and can be downloaded for free from the corresponding App Stores. Availability will be confirmed by Open-Xchange via the usual communication channels.
+
Users will be able to download their respective client for their device from the corresponding app store free of charge. The availability of the various clients depends on the approval process of the store provider. Clients for iOS and Android will be made available from the App Store and Google Play. The availability of the various clients will be confirmed by Open-Xchange via the usual communication channels.  
  
Please contact your Open-Xchange account manager for further information and pricing details.
+
<!-- Please message oxmailapp@open-xchange.com, or contact Open-Xchange Sales, for more information and pricing details about OX Mail. -->
  
== OX Mail v1 Availability ==
+
<!-- == Branding for Partners and Customers ==
  
In accordance with the supported platform policy, Open-Xchange will discontinue maintenance and support for OX Mail v1.0 by end of Q1 2018. Existing customers with OX Mail v1.0 in their portfolio, please contact Open-Xchange Sales or send a mail to oxmailapp@open-xchange.com for further information.
+
With OX Mail it is possible for customers and partners to request the addition, and change, of a variety of branding elements in the app. This includes changing colors, graphical assets and icons.
  
== OX Mail v2 Availability ==
+
For more information about branding, the cost of this service and what can be done please message oxmailapp@open-xchange.com, or contact Open-Xchange Sales.
  
The exact date when the clients become available depends on the approval process of the respective app stores.
+
== Auto Discovery Service ==
  
=== Migration from OX Mail v1 to OX Mail v2 ===
+
The OX Mail app uses a central Auto Discovery Service to help new users to onboard to the app more easily.
  
There is currently no direct upgrade path for end users from the previous version of OX Mail to the latest.
+
=== Prerequisits ===
Upgrading to OX Mail v2
 
  
The OX Mail v2 appears as new app in the app stores. When the end user installs the new version, the old version stays untouched on the device. As both apps have the same name, it is strongly advised to deinstall the old version before installing the new verison.The user should also deinstall the previous version to prevent the display of notifications for the old app.
+
Every provider that fulfills the following requirements may be added to the service to give their end users a better onboarding experience.
  
=== Migrating Data to OX Mail v2 ===
+
* The OX App Suite v7.8.4 or higher
 +
* The OX Mobile Facade v1.0.9 or higher.
 +
* A working push configuration.
 +
* One or more MX records on the domains of all supported email addresses.
  
The OX Mail v1 is an online client and does not store anything locally. Therefore all email data is stored in App Suite and is immediately available in the OX Mail v2.
+
=== Required Information ===
  
One exception is the custom signature. It is stored in the App Suite but is not used by the OX Mail v2. The custom signature is therefore not lost, but also not accessible anymore.
+
The provider has to submit the following information:
  
=== Migrating Settings to OX Mail v2 ===
+
* The MX-record that the used email domains will use.
 +
* The URL to the OX App Suite. The URL has to be publicly reachable.
 +
* A test account to successfully log into the app.
 +
* An associated test email address. The domain of the test email address should use the same domain mapping to the MX records as the regular email addresses.
  
Non of the app settings of the OX Mail v1 will be used after the upgrade.
+
Please send the required information to your Open-Xchange sales representative or oxmailapp@open-xchange.com. -->
 
 
= Branding for Partners and Customers =
 
 
 
With OX Mail v2 it is possible for customers and partners to request the addition, and change, of a variety of branding elements in the app. This includes changing colors, graphical assets and icons.
 
 
 
For more information about branding, the cost of this service and what can be done please message oxmailapp@open-xchange.com, or contact Open-Xchange Sales.
 
  
 
= Download & Installation =
 
= Download & Installation =
Line 73: Line 94:
 
== Installation of the Clients ==
 
== Installation of the Clients ==
  
The OX Mail v2 is available via the different App Stores for iOS and Android:
+
The OX Mail is available via the different App Stores for iOS and Android:
 +
 
 +
* [https://itunes.apple.com/us/app/ox-mail-v2/id1385582725 OX Mail in Apple App Store]
 +
* [https://play.google.com/store/apps/details?id=com.openxchange.mobile.oxmail OX Mail in GooglePlay]
  
* OX Mail v2 in Apple App Store
+
OX Mail App is also available inside the OX App Suite user interface via the Client onboarding wizard. Further information can be found at: http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding
* OX Mail v2 in GooglePlay
 
  
 
== Installation of Mobile API Facade ==
 
== Installation of Mobile API Facade ==
Line 82: Line 105:
 
Installation Guide and configuration options can be found under: http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade
 
Installation Guide and configuration options can be found under: http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade
  
== Load Balancer Setup ==
+
== Download & Installation of Packages ==
  
See http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade#Proxy_configuration
+
OX Mail is available with the following backend packages:
  
== TLS Configuration ==
+
* open-xchange-mobile-api-facade-push-certificates
  
See http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade#Configuration_Mobile_API_Facade
+
To find the correct version of the package to be installed, please refer to http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade#Version_Matrix
 
 
== Push Setup ==
 
 
 
The push setup requires a working OX App Suite and the Mobile API Facade.
 
 
 
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either APN or GCM.
 
 
 
== Download & Installation of Packages ==
 
 
 
OX Mail v2 is available with the following backend packages:
 
 
 
* open-xchange-mobile-api-facade-push-certificates - Certificates for cloud-based push notifications
 
* open-xchange-pns-mobile-api-facade - The Mobile Api Facade bundle for Push Notification Service
 
  
 
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.
 
Installation on the server varies depending on the underlying distribution, details are available in the following chapters.
  
=== Redhat Enterprise Linux 6 or CentOS 6 ===
+
=== Redhat Enterprise Linux 6 or CentOS 6 (valid until 7.10.3) ===
  
 
Add the following repositories to your Open-Xchange yum configuration:
 
Add the following repositories to your Open-Xchange yum configuration:
  {{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
+
  {{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mobile-api-facade/VERSION|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=CUSTOMERID:PASSWORD|mobile-api-facade-restricted}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 
 
   
 
   
 
and run
 
and run
 
   
 
   
  $ yum install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
+
  $ yum install open-xchange-mobile-api-facade-push-certificates
  
 
=== Redhat Enterprise Linux 7 or CentOS 7 ===
 
=== Redhat Enterprise Linux 7 or CentOS 7 ===
  
 
Add the following repositories to your Open-Xchange yum configuration:
 
Add the following repositories to your Open-Xchange yum configuration:
  {{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
+
  {{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mobile-api-facade/VERSION|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=CUSTOMERID:PASSWORD|mobile-api-facade-restricted}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 
 
   
 
   
and run
+
and run
 
   
 
   
  $ yum install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
+
  $ yum install open-xchange-mobile-api-facade-push-certificates
  
=== Debian GNU/Linux 8.0 (Jessie) ===
+
=== Debian GNU/Linux 9.0 ===
  
 
Add the following repositories to your Open-Xchange apt configuration:
 
Add the following repositories to your Open-Xchange apt configuration:
  {{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
+
  {{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mobile-api-facade/VERSION|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=CUSTOMERID:PASSWORD|mobile-api-facade-restricted}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
+
 
+
and run
and run
 
 
   
 
   
 
  $ apt-get update
 
  $ apt-get update
  $ apt-get install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
+
  $ apt-get install open-xchange-mobile-api-facade-push-certificates
 +
 
 +
=== Debian GNU/Linux 10.0 ===
  
=== SUSE Linux Enterprise Server 12 ===
+
Add the following repositories to your Open-Xchange apt configuration:
  {{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates}}
+
  {{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mobile-api-facade/VERSION|pc2n=debianname|pc2v=DebianBuster|pc3n=ldbaccount|pc3v=CUSTOMERID:PASSWORD|mobile-api-facade-restricted}}
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLE_12|mail|mailapp}}
 
 
$ zypper ref
 
$ zypper install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
 
  
Redhat Enterprise Linux 6 or CentOS 6
 
Add the following repositories to your Open-Xchange yum configuration:
 
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
 
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 
 
 
and run
 
and run
 
   
 
   
$ yum install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
+
$ apt-get update
Redhat Enterprise Linux 7 or CentOS 7
+
$ apt-get install open-xchange-mobile-api-facade-push-certificates
Add the following repositories to your Open-Xchange yum configuration:
+
 
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
+
=== SUSE Linux Enterprise Server 12 (valid until 7.10.3)===
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
 
 
and run
 
 
$ yum install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
 
Debian GNU/Linux 8.0 (Jessie)
 
 
Add the following repositories to your Open-Xchange apt configuration:
 
Add the following repositories to your Open-Xchange apt configuration:
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3v=[CUSTOMERID:PASSWORD]|backend/updates}}
+
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mobile-api-facade/VERSION|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=CUSTOMERID:PASSWORD|mobile-api-facade-restricted}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|mail|mailapp}}
+
 
 
 
and run
 
and run
   
+
 
$ apt-get update
+
  $ zypper ref
$ apt-get install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
+
$ zypper install open-xchange-mobile-api-facade-push-certificates
SUSE Linux Enterprise Server 12
+
 
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|backend/updates}}
+
=== Univention Corporate Server ===
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/mail/stable|pc2n=susename|pc2v=SLE_12|mail|mailapp}}
+
 
+
If you have purchased the OX App Suite for UCS, the OX Mail App support is part of the offering. For installation of the OX Mail App push functionality please refer to the following steps:
$ zypper ref
+
 
$ zypper install open-xchange-mobile-api-facade-push-certificates open-xchange-pns-mobile-api-facade
+
* Please make sure that the OX Customer Id has been entered in the UMC module "OX License Management" (Category "System").
 +
* Open the UMC module "Repository Settings" (Category "Software"), activate the checkbox "mobileapirestricted200" resp. (depends on the installed OX version) and click on "Install".
 +
* The module shows a confirmation dialog that shows which packages will be installed if the installation of the push packages for OX Mail App is continued.
 +
* After installation open the UMC module "Domain Join" (Category "Domain") and execute all pending join scripts to complete installation.
 +
 
 +
[[Image:Screenshot_mobileapriestricted_UCS.png|800px]]
 +
 
 +
= Setup and Configuration =
 +
 
 +
== Setup Middleware Notifications ==
 +
 
 +
'''Please find the up-to-date version of this section [https://documentation.open-xchange.com/latest/middleware/components/mailpush/mailpush.html#enable-permanent-mail-push-listeners here]'''
 +
 
 +
== Push Setup ==
 +
 
 +
The push setup requires a working OX App Suite and the Mobile API Facade.
 +
 
 +
Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either APN or GCM.
 +
 
 +
== Setup Dovecot Push ==
 +
 
 +
'''Please find the up-to-date version of that section [https://documentation.open-xchange.com/latest/middleware/mail/dovecot/dovecot_push.html here]'''
 +
 
 +
== Setup App Notifications ==
 +
 
 +
'''Please find the up-to-date version of this section [https://documentation.open-xchange.com/latest/middleware/mail/mail_push.html#setup-new-mail-notifications-to-ox-mail-v2-0 here]'''
 +
 
 +
= Known Limitations =
 +
 
 +
== Flagging ==
 +
 
 +
Starting with version v7.8.4 the OX App Suite supports flagging modes described here: https://documentation.open-xchange.com/7.8.4/middleware/components/mail_flagging.html. There are four different modes defined. These modes describe the handling of the IMAP FLAGGED flag and color flagging and how both work together. The OX Mail support only two modes, "Flagged only" and "Flagged implicit". All users using the OX Mail should be provisioned with one of these modes. The other two modes, "Color only" and "Flagged and color" are not supported currently and might cause bad user experience when the app is used in conjunction with other mail user agents.
 +
 
 +
== Settings ==
 +
 
 +
The settings from the OX App Suite are not used by the OX Mail app. This includes the signature so that it has to be maintained manually both in the OX App Suite and the OX Mail app. Settings are also only available locally and not synced when using the app on multiple devices.
 +
 
 +
== Threading ==
 +
 
 +
The used backend should support RFC 5256 in order for the app to show threads correctly. Dovecot is supporting this RFC out of the box. If the backend doesn't support RCF 5256 its possible to disable to disable threading support in the Mobile API Facade by configuring the following property in facade.properties:
 +
 
 +
com.openexchange.mobile.api.facade.threading=disabled
 +
 
 +
== Multifactor Authentication  ==
 +
 
 +
Version v7.10.3 of the OX App Suite introduced optional multifactor authentication, see https://documentation.open-xchange.com/7.10.3/middleware/security_and_encryption/multifactor_authentication.html. The OX Mail app does not support this yet. If activated on the server, you will not be able to connect with the app anymore.

Latest revision as of 10:08, 5 November 2020

OX Mail

The OX Mail is a companion app for OX App Suite, and brings the power of OX App Suite web-based email to your customers' mobile devices. The OX Mail is a native app designed specifically for Android and iOS smartphones and tablets.

With a focus on security and user-experience, OX Mail serves all your email needs on the go. Most notably you can answer and process mails even when you are offline, mails are synced when you go online. For completing addresses, OX Mail uses the address book of the device along with all received and sent mails. When you have deleted an email by accident, you can easily undo that. Furthermore OX Mail provides a list of known features such as pushing new emails onto your device, supporting mail folders, handling attachments, showing the number of unread email, and so on.

Key Benefits

  • Additional privacy and integration with OX Abuse Shield
  • Offline availability
  • Grouping notifications on Android
  • Mobile API facade to connect to OX App Suite

Open-Xchange now provides more detailed overviews and Feature Overview documents relating to new product releases. These can be found at https://www.open-xchange.com/portfolio/whats-new/


Requirements

Requirement System / Platform / User Interface
   
OX App Suite OX App Suite v7.10.3, 7.10.4
Mobile API Facade Mobile API Facade v1.8.x or later (from OX App Suite v7.10.3)
Push Notification Package Package "open-xchange-mobile-api-facade-push-certificates" (available to App Suite licensees only)
OX Mail App for iOS iOS 13 / iOS 14 / iPad OS
Server reachable via TLS 1.2
OX Mail App for Android Android 5.0 (Lollipop) or higher
Server reachable via TLS 1.2

OX App Suite

OX App Suite is a modular platform designed for Telcos, Hosters, and other Service Providers and delivers a wide range of cloud-based services. These include email, file sharing, collaborative document editing, document management, time management, cloud storage and metrics for monitoring end-user behavior. More information can be found at https://www.open-xchange.com/portfolio/whats-new/

Mobile API Facade

The Mobile API Facade is a server component that brings the new native mobile mail apps together with the OX App Suite. We’ve built the facade based on the technology used and proven in the OX App Suite middleware. The facade is developed in Java, utilizing the OSGIFramework. Further information can be found at: http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade.

TLS 1.2

The communication between the OX Mail app and its end points needs to be secured with TLS 1.2. Please make sure that your infrastructure is capable of handling TLS 1.2 HTTP requests without downgrading the connection.

OX Mail Availability

Users will be able to download their respective client for their device from the corresponding app store free of charge. The availability of the various clients depends on the approval process of the store provider. Clients for iOS and Android will be made available from the App Store and Google Play. The availability of the various clients will be confirmed by Open-Xchange via the usual communication channels.


Download & Installation

Installation of the Clients

The OX Mail is available via the different App Stores for iOS and Android:

OX Mail App is also available inside the OX App Suite user interface via the Client onboarding wizard. Further information can be found at: http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding

Installation of Mobile API Facade

Installation Guide and configuration options can be found under: http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade

Download & Installation of Packages

OX Mail is available with the following backend packages:

  • open-xchange-mobile-api-facade-push-certificates

To find the correct version of the package to be installed, please refer to http://oxpedia.org/wiki/index.php?title=AppSuite:Mobile_API_Facade#Version_Matrix

Installation on the server varies depending on the underlying distribution, details are available in the following chapters.

Redhat Enterprise Linux 6 or CentOS 6 (valid until 7.10.3)

Add the following repositories to your Open-Xchange yum configuration:

 [open-xchange-mobile-api-facade-restricted]
name=Open-Xchange-mobile-api-facade-restricted
baseurl=https://CUSTOMERID:PASSWORD@software.open-xchange.com/products/mobile-api-facade/VERSION/mobile-api-facade-restricted/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum install open-xchange-mobile-api-facade-push-certificates

Redhat Enterprise Linux 7 or CentOS 7

Add the following repositories to your Open-Xchange yum configuration:

 [open-xchange-mobile-api-facade-restricted]
name=Open-Xchange-mobile-api-facade-restricted
baseurl=https://CUSTOMERID:PASSWORD@software.open-xchange.com/products/mobile-api-facade/VERSION/mobile-api-facade-restricted/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum install open-xchange-mobile-api-facade-push-certificates

Debian GNU/Linux 9.0

Add the following repositories to your Open-Xchange apt configuration:

deb https://CUSTOMERID:PASSWORD@software.open-xchange.com/products/mobile-api-facade/VERSION/mobile-api-facade-restricted/DebianStretch /

and run

$ apt-get update
$ apt-get install open-xchange-mobile-api-facade-push-certificates

Debian GNU/Linux 10.0

Add the following repositories to your Open-Xchange apt configuration:

deb https://CUSTOMERID:PASSWORD@software.open-xchange.com/products/mobile-api-facade/VERSION/mobile-api-facade-restricted/DebianBuster /

and run

$ apt-get update
$ apt-get install open-xchange-mobile-api-facade-push-certificates

SUSE Linux Enterprise Server 12 (valid until 7.10.3)

Add the following repositories to your Open-Xchange apt configuration:

$ zypper ar https://CUSTOMERID:PASSWORD@software.open-xchange.com/products/mobile-api-facade/VERSION/mobile-api-facade-restricted/SLE_12 mobile-api-facade-restricted

and run

$ zypper ref
$ zypper install open-xchange-mobile-api-facade-push-certificates

Univention Corporate Server

If you have purchased the OX App Suite for UCS, the OX Mail App support is part of the offering. For installation of the OX Mail App push functionality please refer to the following steps:

  • Please make sure that the OX Customer Id has been entered in the UMC module "OX License Management" (Category "System").
  • Open the UMC module "Repository Settings" (Category "Software"), activate the checkbox "mobileapirestricted200" resp. (depends on the installed OX version) and click on "Install".
  • The module shows a confirmation dialog that shows which packages will be installed if the installation of the push packages for OX Mail App is continued.
  • After installation open the UMC module "Domain Join" (Category "Domain") and execute all pending join scripts to complete installation.

Screenshot mobileapriestricted UCS.png

Setup and Configuration

Setup Middleware Notifications

Please find the up-to-date version of this section here

Push Setup

The push setup requires a working OX App Suite and the Mobile API Facade.

Simply said the main purpose of the Mobile Push functionality is to register an OSGi event handler converting an incoming OSGi event with topic "com/openexchange/push" to an appropriate native push reaching the mobile device using either APN or GCM.

Setup Dovecot Push

Please find the up-to-date version of that section here

Setup App Notifications

Please find the up-to-date version of this section here

Known Limitations

Flagging

Starting with version v7.8.4 the OX App Suite supports flagging modes described here: https://documentation.open-xchange.com/7.8.4/middleware/components/mail_flagging.html. There are four different modes defined. These modes describe the handling of the IMAP FLAGGED flag and color flagging and how both work together. The OX Mail support only two modes, "Flagged only" and "Flagged implicit". All users using the OX Mail should be provisioned with one of these modes. The other two modes, "Color only" and "Flagged and color" are not supported currently and might cause bad user experience when the app is used in conjunction with other mail user agents.

Settings

The settings from the OX App Suite are not used by the OX Mail app. This includes the signature so that it has to be maintained manually both in the OX App Suite and the OX Mail app. Settings are also only available locally and not synced when using the app on multiple devices.

Threading

The used backend should support RFC 5256 in order for the app to show threads correctly. Dovecot is supporting this RFC out of the box. If the backend doesn't support RCF 5256 its possible to disable to disable threading support in the Mobile API Facade by configuring the following property in facade.properties:

com.openexchange.mobile.api.facade.threading=disabled

Multifactor Authentication

Version v7.10.3 of the OX App Suite introduced optional multifactor authentication, see https://documentation.open-xchange.com/7.10.3/middleware/security_and_encryption/multifactor_authentication.html. The OX Mail app does not support this yet. If activated on the server, you will not be able to connect with the app anymore.