MailCore 2 Documentation

To target iOS, you must link against MailCore 2 as a static library:

1. Add libMailCore-ios.a to 'Link Binary With Libraries'.
2. Add CFNetwork.framework and Security.framework to 'Link Binary With Libraries'.
3. In Build Settings, set 'C++ Standard Library' to libc++.
4. In Build Settings, set 'Other Linker Flags' to: -lctemplate-ios -letpan-ios -lxml2 -lsasl2 -liconv -ltidy -lz -lc++ -lresolv -stdlib=libc++ -ObjC
5. In Build Phases, add a Target Dependency of static mailcore2 ios.

To build MailCore 2 on macOS, follow these steps in exact order.

Prerequisites:

• libetpan: Download version 1.9.4 from GitHub. Ensure the path contains no spaces.
• Android NDK: Version 17.
• Android SDK: Versions 16 and 21.
• Environment Variables: Set ANDROID_NDK and ANDROID_SDK to your local root folders.

Important Note: Ensure the mailcore2 repository path contains no spaces to avoid compilation errors.

export ANDROID_NDK=/Users/xxx/Library/Android/sdk/ndk/17.2.4988734
export ANDROID_SDK=/Users/xxx/Library/Android/sdk

If you only require a pre-compiled binary build of MailCore 2, you can download it directly. Note that all provided binaries are compiled in release mode. For debug mode, you must download the source repositories and compile them manually.

Required Dependencies: You must also download the most recent binary builds for the following dependencies:

• CTemplate
• libEtPan
• Cyrus SASL
• LibXML 2
• Tidy HTML5
• zlib
• ICU, OpenSSL and pthread for win32

If you do not wish to build from source, you can download the latest pre-built Android binary from the following location:

http://d.etpan.org/mailcore2-deps/mailcore2-android/

For most use cases, you do not need to set a deviceID explicitly. ActiveSyncSession (C++) and MCOActiveSyncSession (ObjC) will automatically generate a stable default deviceID if none is provided. This ensures that server policy and sync state remain stable across app launches.

If you require deterministic migration, testing, or specific product identifiers, you can manually override the deviceID. Note that deviceType is no longer publicly configurable; the session internally uses MailCore.

To build MailCore 2 on a Debian-based Linux system, you must first install the required development packages using apt-get.

sudo apt-get install libctemplate-dev libicu-dev libsasl2-dev libtidy-dev \
    uuid-dev libxml2-dev libglib2.0-dev autoconf automake libtool

Once the dependencies and libetpan are installed, you can compile MailCore 2 using cmake and make within a build directory inside the MailCore 2 source folder.

cd ~/mailcore2
mkdir build
cd build
cmake ..
make

To reduce the .aar file size by approximately 50%, follow these steps in the directory containing mailcore2-android-4.aar:

1. Unzip the .aar to a temporary directory.
2. Remove the jni folder from the extracted classes.jar.
3. Re-package the classes.jar and the .aar file.

unzip mailcore2-android-4.aar -d mailcore-unzipped
rm mailcore2-android-4.aar
cd mailcore-unzipped
unzip classes.jar -d classes-unzipped
rm -rf classes-unzipped/jni
rm classes.jar
jar cvf classes.jar -C classes-unzipped/ .
rm -rf classes-unzipped
cd ..
jar cvf mailcore2-android-4.aar -C mailcore-unzipped/ .
rm -rf mailcore-unzipped

To use MailCore 2 in a Swift project, you must set up an Objective-C Bridging Header:

1. Create a new header file named [Project-Name]-Bridging-Header.h.
2. Add the following import to the file: #import <MailCore/MailCore.h>
3. In your target settings, locate the Objective-C Bridging Header field and provide the path to your header file.

Once configured, you do not need to manually import MailCore in your Swift classes; it will be available automatically.