MAPIProvider::getPropIdsFromStrings() - Code Metrics - Inspection of "Merge branch 'issue-57-unify-php-mapi' into 'maste..." - grommunio/grommunio-sync - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( bc722f...03cdb2 )

unknown
created 2022-07-27 22:10 UTC
MAPIProvider::getPropIdsFromStrings() A

↳ Parent: MAPIProvider
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0
<?php
/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
 */

class MAPIProvider {
	private $session;
	private $store;
	private $zRFC822;
	private $addressbook;
	private $storeProps;
	private $inboxProps;
	private $rootProps;
	private $specialFoldersData;

	/**
	 * Constructor of the MAPI Provider
	 * Almost all methods of this class require a MAPI session and/or store.
	 *
	 * @param resource $session
	 * @param resource $store
	 */
	public function __construct($session, $store) {
		$this->session = $session;
		$this->store = $store;
	}

	/*----------------------------------------------------------------------------------------------------------
	 * GETTER
	 */

	/**
	 * Reads a message from MAPI
	 * Depending on the message class, a contact, appointment, task or email is read.
	 *
	 * @param mixed             $mapimessage
	 * @param ContentParameters $contentparameters
	 *
	 * @return SyncObject
	 */
	public function GetMessage($mapimessage, $contentparameters) {
		// Gets the Sync object from a MAPI object according to its message class

		$props = mapi_getprops($mapimessage, [PR_MESSAGE_CLASS]);

		if (isset($props[PR_MESSAGE_CLASS])) {
			$messageclass = $props[PR_MESSAGE_CLASS];
		}
		else {
			$messageclass = "IPM";
		}

		if (strpos($messageclass, "IPM.Contact") === 0) {
			return $this->getContact($mapimessage, $contentparameters);
		}
		if (strpos($messageclass, "IPM.Appointment") === 0) {
			return $this->getAppointment($mapimessage, $contentparameters);
		}
		if (strpos($messageclass, "IPM.Task") === 0 && strpos($messageclass, "IPM.TaskRequest") === false) {
			return $this->getTask($mapimessage, $contentparameters);
		}
		if (strpos($messageclass, "IPM.StickyNote") === 0) {
			return $this->getNote($mapimessage, $contentparameters);
		}

		return $this->getEmail($mapimessage, $contentparameters);
	}

	/**
	 * Reads a contact object from MAPI.
	 *
	 * @param mixed             $mapimessage
	 * @param ContentParameters $contentparameters
	 *
	 * @return SyncContact
	 */
	private function getContact($mapimessage, $contentparameters) {
		$message = new SyncContact();

		// Standard one-to-one mappings first
		$this->getPropsFromMAPI($message, $mapimessage, MAPIMapping::GetContactMapping());

		// Contact specific props
		$contactproperties = MAPIMapping::GetContactProperties();
		$messageprops = $this->getProps($mapimessage, $contactproperties);

		// set the body according to contentparameters and supported AS version
		$this->setMessageBody($mapimessage, $contentparameters, $message);

		// check the picture
		if (isset($messageprops[$contactproperties["haspic"]]) && $messageprops[$contactproperties["haspic"]]) {
			// Add attachments
			$attachtable = mapi_message_getattachmenttable($mapimessage);
			mapi_table_restrict($attachtable, MAPIUtils::GetContactPicRestriction());
			$rows = mapi_table_queryallrows($attachtable, [PR_ATTACH_NUM, PR_ATTACH_SIZE]);


			foreach ($rows as $row) {
				if (isset($row[PR_ATTACH_NUM])) {
					$mapiattach = mapi_message_openattach($mapimessage, $row[PR_ATTACH_NUM]);
					$message->picture = base64_encode(mapi_attach_openbin($mapiattach, PR_ATTACH_DATA_BIN));

				}
			}
		}

		return $message;
	}

	/**
	 * Reads a task object from MAPI.
	 *
	 * @param mixed             $mapimessage
	 * @param ContentParameters $contentparameters
	 *
	 * @return SyncTask
	 */
	private function getTask($mapimessage, $contentparameters) {
		$message = new SyncTask();

		// Standard one-to-one mappings first
		$this->getPropsFromMAPI($message, $mapimessage, MAPIMapping::GetTaskMapping());

		// Task specific props
		$taskproperties = MAPIMapping::GetTaskProperties();
		$messageprops = $this->getProps($mapimessage, $taskproperties);

		// set the body according to contentparameters and supported AS version
		$this->setMessageBody($mapimessage, $contentparameters, $message);

		// task with deadoccur is an occurrence of a recurring task and does not need to be handled as recurring
		// webaccess does not set deadoccur for the initial recurring task
		if (isset($messageprops[$taskproperties["isrecurringtag"]]) &&
			$messageprops[$taskproperties["isrecurringtag"]] &&
			(!isset($messageprops[$taskproperties["deadoccur"]]) ||
			(isset($messageprops[$taskproperties["deadoccur"]]) &&
			!$messageprops[$taskproperties["deadoccur"]]))) {
			// Process recurrence
			$message->recurrence = new SyncTaskRecurrence();
			$this->getRecurrence($mapimessage, $messageprops, $message, $message->recurrence, false);
			$this->getRecurrence($mapimessage, $messageprops, $message, $message->recurrence, /** @scrutinizer ignore-type */ false);
		}

		// when set the task to complete using the WebAccess, the dateComplete property is not set correctly
		if ($message->complete == 1 && !isset($message->datecompleted)) {
			$message->datecompleted = time();
		}

		// if no reminder is set, announce that to the mobile
		if (!isset($message->reminderset)) {
			$message->reminderset = 0;
		}

		return $message;
	}

	/**
	 * Reads an appointment object from MAPI.
	 *
	 * @param mixed             $mapimessage
	 * @param ContentParameters $contentparameters
	 *
	 * @return SyncAppointment
	 */
	private function getAppointment($mapimessage, $contentparameters) {
		$message = new SyncAppointment();

		// Standard one-to-one mappings first
		$this->getPropsFromMAPI($message, $mapimessage, MAPIMapping::GetAppointmentMapping());

		// Appointment specific props
		$appointmentprops = MAPIMapping::GetAppointmentProperties();
		$messageprops = $this->getProps($mapimessage, $appointmentprops);

		// set the body according to contentparameters and supported AS version
		$this->setMessageBody($mapimessage, $contentparameters, $message);

		// Set reminder time if reminderset is true
		if (isset($messageprops[$appointmentprops["reminderset"]]) && $messageprops[$appointmentprops["reminderset"]] == true) {
			if ($messageprops[$appointmentprops["remindertime"]] == 0x5AE980E1) {
				$message->reminder = 15;
			}
			else {
				$message->reminder = $messageprops[$appointmentprops["remindertime"]];
			}
		}

		if (!isset($message->uid)) {
			$message->uid = bin2hex($messageprops[$appointmentprops["sourcekey"]]);
		}
		else {
			$message->uid = Utils::GetICalUidFromOLUid($message->uid);
		}

		// Always set organizer information because some devices do not work properly without it
		if (isset($messageprops[$appointmentprops["representingentryid"]], $messageprops[$appointmentprops["representingname"]])
			) {
			$message->organizeremail = w2u($this->getSMTPAddressFromEntryID($messageprops[$appointmentprops["representingentryid"]]));
			// if the email address can't be resolved, fall back to PR_SENT_REPRESENTING_SEARCH_KEY
			if ($message->organizeremail == "" && isset($messageprops[$appointmentprops["sentrepresentinsrchk"]])) {
				$message->organizeremail = $this->getEmailAddressFromSearchKey($messageprops[$appointmentprops["sentrepresentinsrchk"]]);
			}
			$message->organizername = w2u($messageprops[$appointmentprops["representingname"]]);
		}

		$appTz = false; // if the appointment has some timezone information saved on the server
		if (!empty($messageprops[$appointmentprops["timezonetag"]])) {
			$tz = $this->getTZFromMAPIBlob($messageprops[$appointmentprops["timezonetag"]]);
			$appTz = true;
		}
		elseif (!empty($messageprops[$appointmentprops["timezonedesc"]])) {
			// Windows uses UTC in timezone description in opposite to mstzones in TimezoneUtil which uses GMT
			$wintz = str_replace("UTC", "GMT", $messageprops[$appointmentprops["timezonedesc"]]);
			$tz = TimezoneUtil::GetFullTZFromTZName(TimezoneUtil::GetTZNameFromWinTZ($wintz));
			$appTz = true;
		}
		else {
			// set server default timezone (correct timezone should be configured!)
			$tz = TimezoneUtil::GetFullTZ();
		}

		if (isset($messageprops[$appointmentprops["isrecurring"]]) && $messageprops[$appointmentprops["isrecurring"]]) {
			// Process recurrence
			$message->recurrence = new SyncRecurrence();
			$this->getRecurrence($mapimessage, $messageprops, $message, $message->recurrence, $tz);

			if (empty($message->alldayevent)) {
				$message->timezone = base64_encode(TimezoneUtil::GetSyncBlobFromTZ($tz));
			}
		}

		// Do attendees
		$reciptable = mapi_message_getrecipienttable($mapimessage);
		// Only get first 256 recipients, to prevent possible load issues.
		$rows = mapi_table_queryrows($reciptable, [PR_DISPLAY_NAME, PR_EMAIL_ADDRESS, PR_SMTP_ADDRESS, PR_ADDRTYPE, PR_RECIPIENT_TRACKSTATUS, PR_RECIPIENT_TYPE, PR_SEARCH_KEY], 0, 256);


		// Exception: we do not synchronize appointments with more than 250 attendees
		if (count($rows) > 250) {
			$message->id = bin2hex($messageprops[$appointmentprops["sourcekey"]]);
			$mbe = new SyncObjectBrokenException("Appointment has too many attendees");
			$mbe->SetSyncObject($message);

			throw $mbe;
		}

		if (count($rows) > 0) {
			$message->attendees = [];
		}

		foreach ($rows as $row) {
			$attendee = new SyncAttendee();

			$attendee->name = w2u($row[PR_DISPLAY_NAME]);
			// smtp address is always a proper email address
			if (isset($row[PR_SMTP_ADDRESS])) {
				$attendee->email = w2u($row[PR_SMTP_ADDRESS]);
			}
			elseif (isset($row[PR_ADDRTYPE], $row[PR_EMAIL_ADDRESS])) {
				// if address type is SMTP, it's also a proper email address
				if ($row[PR_ADDRTYPE] == "SMTP") {
					$attendee->email = w2u($row[PR_EMAIL_ADDRESS]);
				}
				// if address type is ZARAFA, the PR_EMAIL_ADDRESS contains username
				elseif ($row[PR_ADDRTYPE] == "ZARAFA") {
					$userinfo = @nsp_getuserinfo($row[PR_EMAIL_ADDRESS]);
					if (is_array($userinfo) && isset($userinfo["primary_email"])) {
						$attendee->email = w2u($userinfo["primary_email"]);
					}
					// if the user was not found, do a fallback to PR_SEARCH_KEY
					// @see https://jira.z-hub.io/browse/ZP-1178
					elseif (isset($row[PR_SEARCH_KEY])) {
						$attendee->email = w2u($this->getEmailAddressFromSearchKey($row[PR_SEARCH_KEY]));
					}
					else {
						SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->getAppointment: The attendee '%s' of type ZARAFA can not be resolved. Code: 0x%X", $row[PR_EMAIL_ADDRESS], mapi_last_hresult()));
					}
				}
			}

			// set attendee's status and type if they're available and if we are the organizer
			$storeprops = $this->GetStoreProps();
			if (isset($row[PR_RECIPIENT_TRACKSTATUS], $messageprops[$appointmentprops["representingentryid"]], $storeprops[PR_MAILBOX_OWNER_ENTRYID]) &&

					$messageprops[$appointmentprops["representingentryid"]] == $storeprops[PR_MAILBOX_OWNER_ENTRYID]) {
				$attendee->attendeestatus = $row[PR_RECIPIENT_TRACKSTATUS];
			}
			if (isset($row[PR_RECIPIENT_TYPE])) {
				$attendee->attendeetype = $row[PR_RECIPIENT_TYPE];
			}
			// Some attendees have no email or name (eg resources), and if you
			// don't send one of those fields, the phone will give an error ... so
			// we don't send it in that case.
			// also ignore the "attendee" if the email is equal to the organizers' email
			if (isset($attendee->name, $attendee->email) && $attendee->email != "" && (!isset($message->organizeremail) || (isset($message->organizeremail) && $attendee->email != $message->organizeremail))) {
				array_push($message->attendees, $attendee);
			}
		}

		// Status 0 = no meeting, status 1 = organizer, status 2/3/4/5 = tentative/accepted/declined/notresponded
		if (isset($messageprops[$appointmentprops["meetingstatus"]]) && $messageprops[$appointmentprops["meetingstatus"]] > 1) {
			if (!isset($message->attendees) || !is_array($message->attendees)) {
				$message->attendees = [];
			}
			// Work around iOS6 cancellation issue when there are no attendees for this meeting. Just add ourselves as the sole attendee.
			if (count($message->attendees) == 0) {
				SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->getAppointment: adding ourself as an attendee for iOS6 workaround"));
				$attendee = new SyncAttendee();

				$meinfo = nsp_getuserinfo(Request::GetUser());

				if (is_array($meinfo)) {
					$attendee->email = w2u($meinfo["primary_email"]);
					$attendee->name = w2u($meinfo["fullname"]);
					$attendee->attendeetype = MAPI_TO;

					array_push($message->attendees, $attendee);
				}
			}
			$message->responsetype = $messageprops[$appointmentprops["responsestatus"]];
		}

		// If it's an appointment which doesn't have any attendees, we have to make sure that
		// the user is the owner or it will not work properly with android devices
		// @see https://jira.z-hub.io/browse/ZP-1020
		if (isset($messageprops[$appointmentprops["meetingstatus"]]) && $messageprops[$appointmentprops["meetingstatus"]] == olNonMeeting && empty($message->attendees)) {
			$meinfo = nsp_getuserinfo(Request::GetUser());

			if (is_array($meinfo)) {
				$message->organizeremail = w2u($meinfo["primary_email"]);
				$message->organizername = w2u($meinfo["fullname"]);
				SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->getAppointment(): setting ourself as the organizer for an appointment without attendees.");
			}
		}

		if (!isset($message->nativebodytype)) {
			$message->nativebodytype = MAPIUtils::GetNativeBodyType($messageprops);
		}
		elseif ($message->nativebodytype == SYNC_BODYPREFERENCE_UNDEFINED) {
			$nbt = MAPIUtils::GetNativeBodyType($messageprops);
			SLog::Write(LOGLEVEL_INFO, sprintf("MAPIProvider->getAppointment(): native body type is undefined. Set it to %d.", $nbt));
			$message->nativebodytype = $nbt;
		}

		// If the user is working from a location other than the office the busystatus should be interpreted as free.
		if (isset($message->busystatus) && $message->busystatus == fbWorkingElsewhere) {
			$message->busystatus = fbFree;
		}

		// If the busystatus has the value of -1, we should be interpreted as tentative (1) / ZP-581
		if (isset($message->busystatus) && $message->busystatus == -1) {
			$message->busystatus = fbTentative;
		}

		// All-day events might appear as 24h (or multiple of it) long when they start not exactly at midnight (+/- bias of the timezone)
		if (isset($message->alldayevent) && $message->alldayevent) {
			$localStartTime = localtime($message->starttime, 1);

			// The appointment is all-day but doesn't start at midnight.
			// If it was created in another timezone and we have that information,
			// set the startime to the midnight of the current timezone.
			if ($appTz && ($localStartTime['tm_hour'] || $localStartTime['tm_min'])) {
				SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->getAppointment(): all-day event starting not midnight.");
				$duration = $message->endtime - $message->starttime;
				$serverTz = TimezoneUtil::GetFullTZ();
				$message->starttime = $this->getGMTTimeByTZ($this->getLocaltimeByTZ($message->starttime, $tz), $serverTz);
				$message->endtime = $message->starttime + $duration;
			}
		}

		return $message;
	}

	/**
	 * Reads recurrence information from MAPI.
	 *
	 * @param mixed      $mapimessage
	 * @param array      $recurprops
	 * @param SyncObject &$syncMessage    the message
	 * @param SyncObject &$syncRecurrence the  recurrence message
	 * @param array      $tz              timezone information
	 *
	 * @return
	 */
	private function getRecurrence($mapimessage, $recurprops, &$syncMessage, &$syncRecurrence, $tz) {
		if ($syncRecurrence instanceof SyncTaskRecurrence) {
			$recurrence = new TaskRecurrence($this->store, $mapimessage);
		}
		else {
			$recurrence = new Recurrence($this->store, $mapimessage);
		}

		switch ($recurrence->recur["type"]) {
			case 10: // daily
				switch ($recurrence->recur["subtype"]) {
					default:
						$syncRecurrence->type = 0;
						break;

					case 1:
						$syncRecurrence->type = 0;
						$syncRecurrence->dayofweek = 62; // mon-fri
						$syncRecurrence->interval = 1;
						break;
				}
				break;

			case 11: // weekly
				$syncRecurrence->type = 1;
				break;

			case 12: // monthly
				switch ($recurrence->recur["subtype"]) {
					default:
						$syncRecurrence->type = 2;
						break;

					case 3:
						$syncRecurrence->type = 3;
						break;
				}
				break;

			case 13: // yearly
				switch ($recurrence->recur["subtype"]) {
					default:
						$syncRecurrence->type = 4;
						break;

					case 2:
						$syncRecurrence->type = 5;
						break;

					case 3:
						$syncRecurrence->type = 6;
						break;
				}
		}
		// Termination
		switch ($recurrence->recur["term"]) {
			case 0x21:
				$syncRecurrence->until = $recurrence->recur["end"];
				// fixes Mantis #350 : recur-end does not consider timezones - use ClipEnd if available
				if (isset($recurprops[$recurrence->proptags["enddate_recurring"]])) {
					$syncRecurrence->until = $recurprops[$recurrence->proptags["enddate_recurring"]];
				}
				// add one day (minus 1 sec) to the end time to make sure the last occurrence is covered
				$syncRecurrence->until += 86399;
				break;

			case 0x22:
				$syncRecurrence->occurrences = $recurrence->recur["numoccur"];
				break;

			case 0x23:
				// never ends
				break;
		}

		// Correct 'alldayevent' because outlook fails to set it on recurring items of 24 hours or longer
		if (isset($recurrence->recur["endocc"], $recurrence->recur["startocc"]) && ($recurrence->recur["endocc"] - $recurrence->recur["startocc"] >= 1440)) {
			$syncMessage->alldayevent = true;
		}

		// Interval is different according to the type/subtype
		switch ($recurrence->recur["type"]) {
			case 10:
				if ($recurrence->recur["subtype"] == 0) {
					$syncRecurrence->interval = (int) ($recurrence->recur["everyn"] / 1440);
				}  // minutes
				break;

			case 11:
			case 12:
				$syncRecurrence->interval = $recurrence->recur["everyn"];
				break; // months / weeks

			case 13:
				$syncRecurrence->interval = (int) ($recurrence->recur["everyn"] / 12);
				break; // months
		}

		if (isset($recurrence->recur["weekdays"])) {
			$syncRecurrence->dayofweek = $recurrence->recur["weekdays"];
		} // bitmask of days (1 == sunday, 128 == saturday
		if (isset($recurrence->recur["nday"])) {
			$syncRecurrence->weekofmonth = $recurrence->recur["nday"];
		} // N'th {DAY} of {X} (0-5)
		if (isset($recurrence->recur["month"])) {
			$syncRecurrence->monthofyear = (int) ($recurrence->recur["month"] / (60 * 24 * 29)) + 1;
		} // works ok due to rounding. see also $monthminutes below (1-12)
		if (isset($recurrence->recur["monthday"])) {
			$syncRecurrence->dayofmonth = $recurrence->recur["monthday"];
		} // day of month (1-31)

		// All changed exceptions are appointments within the 'exceptions' array. They contain the same items as a normal appointment
		foreach ($recurrence->recur["changed_occurrences"] as $change) {
			$exception = new SyncAppointmentException();

			// start, end, basedate, subject, remind_before, reminderset, location, busystatus, alldayevent, label
			if (isset($change["start"])) {
				$exception->starttime = $this->getGMTTimeByTZ($change["start"], $tz);
			}
			if (isset($change["end"])) {
				$exception->endtime = $this->getGMTTimeByTZ($change["end"], $tz);
			}
			if (isset($change["basedate"])) {
				$exception->exceptionstarttime = $this->getGMTTimeByTZ($this->getDayStartOfTimestamp($change["basedate"]) + $recurrence->recur["startocc"] * 60, $tz);
				$exception->exceptionstarttime = $this->getGMTTimeByTZ(/** @scrutinizer ignore-type */ $this->getDayStartOfTimestamp($change["basedate"]) + $recurrence->recur["startocc"] * 60, $tz);

				// open body because getting only property might not work because of memory limit
				$exceptionatt = $recurrence->getExceptionAttachment($change["basedate"]);
    $exceptionatt = $recurrence->getExceptionAttachment($change["basedate"]);
				if ($exceptionatt) {
					$exceptionobj = mapi_attach_openobj($exceptionatt, 0);
					$this->setMessageBodyForType($exceptionobj, SYNC_BODYPREFERENCE_PLAIN, $exception);
				}
			}
			if (isset($change["subject"])) {
				$exception->subject = w2u($change["subject"]);
			}
			if (isset($change["reminder_before"]) && $change["reminder_before"]) {
				$exception->reminder = $change["remind_before"];
			}
			if (isset($change["location"])) {
				$exception->location = w2u($change["location"]);
			}
			if (isset($change["busystatus"])) {
				$exception->busystatus = $change["busystatus"];
			}
			if (isset($change["alldayevent"])) {
				$exception->alldayevent = $change["alldayevent"];
			}

			// set some data from the original appointment
			if (isset($syncMessage->uid)) {
				$exception->uid = $syncMessage->uid;
			}
			if (isset($syncMessage->organizername)) {
				$exception->organizername = $syncMessage->organizername;
			}
			if (isset($syncMessage->organizeremail)) {
				$exception->organizeremail = $syncMessage->organizeremail;
			}

			if (!isset($syncMessage->exceptions)) {
				$syncMessage->exceptions = [];
			}

			// If the user is working from a location other than the office the busystatus should be interpreted as free.
			if (isset($exception->busystatus) && $exception->busystatus == fbWorkingElsewhere) {
				$exception->busystatus = fbFree;
			}

			// If the busystatus has the value of -1, we should be interpreted as tentative (1) / ZP-581
			if (isset($exception->busystatus) && $exception->busystatus == -1) {
				$exception->busystatus = fbTentative;
			}

			// if an exception lasts 24 hours and the series are an allday events, set also the exception to allday event,
			// otherwise it will be a 24 hour long event on some mobiles.
			// @see https://jira.z-hub.io/browse/ZP-980
			if (isset($exception->starttime, $exception->endtime) && ($exception->endtime - $exception->starttime == 86400) && $syncMessage->alldayevent) {
				$exception->alldayevent = 1;
			}
			array_push($syncMessage->exceptions, $exception);
		}

		// Deleted appointments contain only the original date (basedate) and a 'deleted' tag
		foreach ($recurrence->recur["deleted_occurrences"] as $deleted) {
			$exception = new SyncAppointmentException();

			$exception->exceptionstarttime = $this->getGMTTimeByTZ($this->getDayStartOfTimestamp($deleted) + $recurrence->recur["startocc"] * 60, $tz);
			$exception->deleted = "1";

			if (!isset($syncMessage->exceptions)) {
				$syncMessage->exceptions = [];
			}

			array_push($syncMessage->exceptions, $exception);
		}

		if (isset($syncMessage->complete) && $syncMessage->complete) {
			$syncRecurrence->complete = $syncMessage->complete;
		}
	}

	/**
	 * Reads an email object from MAPI.
	 *
	 * @param mixed             $mapimessage
	 * @param ContentParameters $contentparameters
	 *
	 * @return SyncEmail
	 */
	private function getEmail($mapimessage, $contentparameters) {
		// This workaround fixes ZP-729 and still works with Outlook.
		// FIXME: It should be properly fixed when refactoring.
		$bpReturnType = Utils::GetBodyPreferenceBestMatch($contentparameters->GetBodyPreference());
		$bpReturnType = Utils::GetBodyPreferenceBestMatch(/** @scrutinizer ignore-type */ $contentparameters->GetBodyPreference());
		if (($contentparameters->GetMimeSupport() == SYNC_MIMESUPPORT_NEVER) ||
		if (($contentparameters->/** @scrutinizer ignore-call */ GetMimeSupport() == SYNC_MIMESUPPORT_NEVER) ||
				($key = array_search(SYNC_BODYPREFERENCE_MIME, $contentparameters->GetBodyPreference()) === false) ||
				($key = array_search(SYNC_BODYPREFERENCE_MIME, /** @scrutinizer ignore-type */ $contentparameters->GetBodyPreference()) === false) ||
				$bpReturnType != SYNC_BODYPREFERENCE_MIME) {
			MAPIUtils::ParseSmime($this->session, $this->store, $this->getAddressbook(), $mapimessage);
			MAPIUtils::ParseSmime(/** @scrutinizer ignore-type */ $this->session, $this->store, $this->getAddressbook(), $mapimessage);
		}

		$message = new SyncMail();

		$this->getPropsFromMAPI($message, $mapimessage, MAPIMapping::GetEmailMapping());

		$emailproperties = MAPIMapping::GetEmailProperties();
		$messageprops = $this->getProps($mapimessage, $emailproperties);

		if (isset($messageprops[PR_SOURCE_KEY])) {

			$sourcekey = $messageprops[PR_SOURCE_KEY];

		}
		else {
			$mbe = new SyncObjectBrokenException("The message doesn't have a sourcekey");
			$mbe->SetSyncObject($message);

			throw $mbe;
		}

		// set the body according to contentparameters and supported AS version
		$this->setMessageBody($mapimessage, $contentparameters, $message);

		$fromname = $fromaddr = "";

		if (isset($messageprops[$emailproperties["representingname"]])) {
			// remove encapsulating double quotes from the representingname
			$fromname = preg_replace('/^\"(.*)\"$/', "\${1}", $messageprops[$emailproperties["representingname"]]);
		}
		if (isset($messageprops[$emailproperties["representingentryid"]])) {
			$fromaddr = $this->getSMTPAddressFromEntryID($messageprops[$emailproperties["representingentryid"]]);
		}

		// if the email address can't be resolved, fall back to PR_SENT_REPRESENTING_SEARCH_KEY
		if ($fromaddr == "" && isset($messageprops[$emailproperties["representingsearchkey"]])) {
			$fromaddr = $this->getEmailAddressFromSearchKey($messageprops[$emailproperties["representingsearchkey"]]);
		}

		if ($fromname == $fromaddr) {
			$fromname = "";
		}

		if ($fromname) {
			$from = "\"" . w2u($fromname) . "\" <" . w2u($fromaddr) . ">";
			$from = "\"" . w2u($fromname) . "\" <" . /** @scrutinizer ignore-type */ w2u($fromaddr) . ">";
		}
		else { // START CHANGED dw2412 HTC shows "error" if sender name is unknown
			$from = "\"" . w2u($fromaddr) . "\" <" . w2u($fromaddr) . ">";
		}
		// END CHANGED dw2412 HTC shows "error" if sender name is unknown

		$message->from = $from;

		// process Meeting Requests
		if (isset($message->messageclass) && strpos($message->messageclass, "IPM.Schedule.Meeting") === 0) {
			$message->meetingrequest = new SyncMeetingRequest();
			$this->getPropsFromMAPI($message->meetingrequest, $mapimessage, MAPIMapping::GetMeetingRequestMapping());

			$meetingrequestproperties = MAPIMapping::GetMeetingRequestProperties();
			$props = $this->getProps($mapimessage, $meetingrequestproperties);

			// Get the GOID
			if (isset($props[$meetingrequestproperties["goidtag"]])) {
				$message->meetingrequest->globalobjid = base64_encode($props[$meetingrequestproperties["goidtag"]]);
			}

			// Set Timezone
			if (isset($props[$meetingrequestproperties["timezonetag"]])) {
				$tz = $this->getTZFromMAPIBlob($props[$meetingrequestproperties["timezonetag"]]);
			}
			else {
				$tz = TimezoneUtil::GetFullTZ();
			}

			$message->meetingrequest->timezone = base64_encode(TimezoneUtil::GetSyncBlobFromTZ($tz));

			// send basedate if exception
			if (isset($props[$meetingrequestproperties["recReplTime"]]) ||
				(isset($props[$meetingrequestproperties["lidIsException"]]) && $props[$meetingrequestproperties["lidIsException"]] == true)) {
				if (isset($props[$meetingrequestproperties["recReplTime"]])) {
					$basedate = $props[$meetingrequestproperties["recReplTime"]];
					$message->meetingrequest->recurrenceid = $this->getGMTTimeByTZ($basedate, $this->getGMTTZ());
				}
				else {
					if (!isset($props[$meetingrequestproperties["goidtag"]]) || !isset($props[$meetingrequestproperties["recurStartTime"]]) || !isset($props[$meetingrequestproperties["timezonetag"]])) {
						SLog::Write(LOGLEVEL_WARN, "Missing property to set correct basedate for exception");
					}
					else {
						$basedate = Utils::ExtractBaseDate($props[$meetingrequestproperties["goidtag"]], $props[$meetingrequestproperties["recurStartTime"]]);
						$message->meetingrequest->recurrenceid = $this->getGMTTimeByTZ($basedate, $tz);
					}
				}
			}

			// Organizer is the sender
			if (strpos($message->messageclass, "IPM.Schedule.Meeting.Resp") === 0) {
				$message->meetingrequest->organizer = $message->to;
			}
			else {
				$message->meetingrequest->organizer = $message->from;
			}

			// Process recurrence
			if (isset($props[$meetingrequestproperties["isrecurringtag"]]) && $props[$meetingrequestproperties["isrecurringtag"]]) {
				$myrec = new SyncMeetingRequestRecurrence();
				// get recurrence -> put $message->meetingrequest as message so the 'alldayevent' is set correctly
				$this->getRecurrence($mapimessage, $props, $message->meetingrequest, $myrec, $tz);
				$message->meetingrequest->recurrences = [$myrec];
			}

			// Force the 'alldayevent' in the object at all times. (non-existent == 0)
			if (!isset($message->meetingrequest->alldayevent) || $message->meetingrequest->alldayevent == "") {
				$message->meetingrequest->alldayevent = 0;
			}

			// Instancetype
			// 0 = single appointment
			// 1 = master recurring appointment
			// 2 = single instance of recurring appointment
			// 3 = exception of recurring appointment
			$message->meetingrequest->instancetype = 0;
			if (isset($props[$meetingrequestproperties["isrecurringtag"]]) && $props[$meetingrequestproperties["isrecurringtag"]] == 1) {
				$message->meetingrequest->instancetype = 1;
			}
			elseif ((!isset($props[$meetingrequestproperties["isrecurringtag"]]) || $props[$meetingrequestproperties["isrecurringtag"]] == 0) && isset($message->meetingrequest->recurrenceid)) {
				if (isset($props[$meetingrequestproperties["appSeqNr"]]) && $props[$meetingrequestproperties["appSeqNr"]] == 0) {
					$message->meetingrequest->instancetype = 2;
				}
				else {
					$message->meetingrequest->instancetype = 3;
				}
			}

			// Disable reminder if it is off
			if (!isset($props[$meetingrequestproperties["reminderset"]]) || $props[$meetingrequestproperties["reminderset"]] == false) {
				$message->meetingrequest->reminder = "";
			}
			// the property saves reminder in minutes, but we need it in secs
			else {
				// /set the default reminder time to seconds
				if ($props[$meetingrequestproperties["remindertime"]] == 0x5AE980E1) {
					$message->meetingrequest->reminder = 900;
				}
				else {
					$message->meetingrequest->reminder = $props[$meetingrequestproperties["remindertime"]] * 60;
				}
			}

			// Set sensitivity to 0 if missing
			if (!isset($message->meetingrequest->sensitivity)) {
				$message->meetingrequest->sensitivity = 0;
			}

			// If the user is working from a location other than the office the busystatus should be interpreted as free.
			if (isset($message->meetingrequest->busystatus) && $message->meetingrequest->busystatus == fbWorkingElsewhere) {
				$message->meetingrequest->busystatus = fbFree;
			}

			// If the busystatus has the value of -1, we should be interpreted as tentative (1) / ZP-581
			if (isset($message->meetingrequest->busystatus) && $message->meetingrequest->busystatus == -1) {
				$message->meetingrequest->busystatus = fbTentative;
			}

			// if a meeting request response hasn't been processed yet,
			// do it so that the attendee status is updated on the mobile
			if (!isset($messageprops[$emailproperties["processed"]])) {
				// check if we are not sending the MR so we can process it - ZP-581
				$cuser = GSync::GetBackend()->GetUserDetails(GSync::GetBackend()->GetCurrentUsername());
				if (isset($cuser["emailaddress"]) && $cuser["emailaddress"] != $fromaddr) {
					if (!isset($req)) {

						$req = new Meetingrequest($this->store, $mapimessage, $this->session);
					}
					if ($req->isMeetingRequest() && !$req->isLocalOrganiser() && !$req->isMeetingOutOfDate()) {
						$req->doAccept(true, false, false);
					}
					if ($req->isMeetingRequestResponse()) {
						$req->processMeetingRequestResponse();
					}
					if ($req->isMeetingCancellation()) {
						$req->processMeetingCancellation();
					}
				}
			}
			$message->contentclass = DEFAULT_CALENDAR_CONTENTCLASS;

			// MeetingMessageType values
			// 0 = A silent update was performed, or the message type is unspecified.
			// 1 = Initial meeting request.
			// 2 = Full update.
			// 3 = Informational update.
			// 4 = Outdated. A newer meeting request or meeting update was received after this message.
			// 5 = Identifies the delegator's copy of the meeting request.
			// 6 = Identifies that the meeting request has been delegated and the meeting request cannot be responded to.
			$message->meetingrequest->meetingmessagetype = mtgEmpty;

			if (isset($props[$meetingrequestproperties["meetingType"]])) {
				switch ($props[$meetingrequestproperties["meetingType"]]) {
					case mtgRequest:
						$message->meetingrequest->meetingmessagetype = 1;
						break;

					case mtgFull:
						$message->meetingrequest->meetingmessagetype = 2;
						break;

					case mtgInfo:
						$message->meetingrequest->meetingmessagetype = 3;
						break;

					case mtgOutOfDate:
						$message->meetingrequest->meetingmessagetype = 4;
						break;

					case mtgDelegatorCopy:
						$message->meetingrequest->meetingmessagetype = 5;
						break;
				}
			}
		}

		// Add attachments
		$attachtable = mapi_message_getattachmenttable($mapimessage);
		$rows = mapi_table_queryallrows($attachtable, [PR_ATTACH_NUM]);

		$entryid = bin2hex($messageprops[$emailproperties["entryid"]]);
		$parentSourcekey = bin2hex($messageprops[$emailproperties["parentsourcekey"]]);

		foreach ($rows as $row) {
			if (isset($row[PR_ATTACH_NUM])) {
				if (Request::GetProtocolVersion() >= 12.0) {
					$attach = new SyncBaseAttachment();
				}
				else {
					$attach = new SyncAttachment();
				}

				$mapiattach = mapi_message_openattach($mapimessage, $row[PR_ATTACH_NUM]);
				$attachprops = mapi_getprops($mapiattach, [PR_ATTACH_LONG_FILENAME, PR_ATTACH_FILENAME, PR_ATTACHMENT_HIDDEN, PR_ATTACH_CONTENT_ID, PR_ATTACH_CONTENT_ID_A, PR_ATTACH_MIME_TAG, PR_ATTACH_METHOD, PR_DISPLAY_NAME, PR_ATTACH_SIZE, PR_ATTACH_FLAGS]);

				if ((isset($attachprops[PR_ATTACH_MIME_TAG]) && strpos(strtolower($attachprops[PR_ATTACH_MIME_TAG]), 'signed') !== false)) {
					continue;
				}

				// the displayname is handled equally for all AS versions
				$attach->displayname = w2u((isset($attachprops[PR_ATTACH_LONG_FILENAME])) ? $attachprops[PR_ATTACH_LONG_FILENAME] : ((isset($attachprops[PR_ATTACH_FILENAME])) ? $attachprops[PR_ATTACH_FILENAME] : ((isset($attachprops[PR_DISPLAY_NAME])) ? $attachprops[PR_DISPLAY_NAME] : "attachment.bin")));
				// fix attachment name in case of inline images
				if (($attach->displayname == "inline.txt" && isset($attachprops[PR_ATTACH_MIME_TAG])) ||
						(substr_compare($attach->displayname, "attachment", 0, 10, true) === 0 && substr_compare($attach->displayname, ".dat", -4, 4, true) === 0)) {
						(substr_compare(/** @scrutinizer ignore-type */ $attach->displayname, "attachment", 0, 10, true) === 0 && substr_compare($attach->displayname, ".dat", -4, 4, true) === 0)) {
					$mimetype = $attachprops[PR_ATTACH_MIME_TAG] ?? 'application/octet-stream';
					$mime = explode("/", $mimetype);

					if (count($mime) == 2 && $mime[0] == "image") {
						$attach->displayname = "inline." . $mime[1];
					}
				}

				// set AS version specific parameters
				if (Request::GetProtocolVersion() >= 12.0) {
					$attach->filereference = sprintf("%s:%s:%s", $entryid, $row[PR_ATTACH_NUM], $parentSourcekey);

					$attach->method = (isset($attachprops[PR_ATTACH_METHOD])) ? $attachprops[PR_ATTACH_METHOD] : ATTACH_BY_VALUE;


					// if displayname does not have the eml extension for embedde messages, android and WP devices won't open it
					if ($attach->method == ATTACH_EMBEDDED_MSG) {
						if (strtolower(substr($attach->displayname, -4)) != '.eml') {
							$attach->displayname .= '.eml';
						}
					}
					// android devices require attachment size in order to display an attachment properly
					if (!isset($attachprops[PR_ATTACH_SIZE])) {
						$stream = mapi_openproperty($mapiattach, PR_ATTACH_DATA_BIN, IID_IStream, 0, 0);

						// It's not possible to open some (embedded only?) messages, so we need to open the attachment object itself to get the data
						if (mapi_last_hresult()) {
							$embMessage = mapi_attach_openobj($mapiattach);
							$addrbook = $this->getAddressbook();
							$stream = mapi_inetmapi_imtoinet($this->session, $addrbook, $embMessage, ['use_tnef' => -1]);
						}
						$stat = mapi_stream_stat($stream);
						$attach->estimatedDataSize = $stat['cb'];

					}
					else {
						$attach->estimatedDataSize = $attachprops[PR_ATTACH_SIZE];
					}

					if (isset($attachprops[PR_ATTACH_CONTENT_ID]) && $attachprops[PR_ATTACH_CONTENT_ID]) {
						$attach->contentid = $attachprops[PR_ATTACH_CONTENT_ID];

					}

					if (!isset($attach->contentid) && isset($attachprops[PR_ATTACH_CONTENT_ID_A]) && $attachprops[PR_ATTACH_CONTENT_ID_A]) {
						$attach->contentid = $attachprops[PR_ATTACH_CONTENT_ID_A];
					}

					if (isset($attachprops[PR_ATTACHMENT_HIDDEN]) && $attachprops[PR_ATTACHMENT_HIDDEN]) {
						$attach->isinline = 1;

					}

					if (isset($attach->contentid, $attachprops[PR_ATTACH_FLAGS]) && $attachprops[PR_ATTACH_FLAGS] & 4) {
						$attach->isinline = 1;
					}

					if (!isset($message->asattachments)) {
						$message->asattachments = [];
					}

					array_push($message->asattachments, $attach);
				}
				else {
					$attach->attsize = $attachprops[PR_ATTACH_SIZE];

					$attach->attname = sprintf("%s:%s:%s", $entryid, $row[PR_ATTACH_NUM], $parentSourcekey);

					if (!isset($message->attachments)) {
						$message->attachments = [];
					}

					array_push($message->attachments, $attach);
				}
			}
		}

		// Get To/Cc as SMTP addresses (this is different from displayto and displaycc because we are putting
		// in the SMTP addresses as well, while displayto and displaycc could just contain the display names
		$message->to = [];
		$message->cc = [];

		$reciptable = mapi_message_getrecipienttable($mapimessage);
		$rows = mapi_table_queryallrows($reciptable, [PR_RECIPIENT_TYPE, PR_DISPLAY_NAME, PR_ADDRTYPE, PR_EMAIL_ADDRESS, PR_SMTP_ADDRESS, PR_ENTRYID, PR_SEARCH_KEY]);


		foreach ($rows as $row) {
			$address = "";
			$fulladdr = "";

			$addrtype = isset($row[PR_ADDRTYPE]) ? $row[PR_ADDRTYPE] : "";

			if (isset($row[PR_SMTP_ADDRESS])) {
				$address = $row[PR_SMTP_ADDRESS];
			}
			elseif ($addrtype == "SMTP" && isset($row[PR_EMAIL_ADDRESS])) {
				$address = $row[PR_EMAIL_ADDRESS];
			}
			elseif ($addrtype == "ZARAFA" && isset($row[PR_ENTRYID])) {
				$address = $this->getSMTPAddressFromEntryID($row[PR_ENTRYID]);
			}

			// if the user was not found, do a fallback to PR_SEARCH_KEY
			// @see https://jira.z-hub.io/browse/ZP-1178
			if (empty($address) && isset($row[PR_SEARCH_KEY])) {
				$address = $this->getEmailAddressFromSearchKey($row[PR_SEARCH_KEY]);
			}

			$name = isset($row[PR_DISPLAY_NAME]) ? $row[PR_DISPLAY_NAME] : "";

			if ($name == "" || $name == $address) {
				$fulladdr = w2u($address);
			}
			else {
				if (substr($name, 0, 1) != '"' && substr($name, -1) != '"') {
					$fulladdr = "\"" . w2u($name) . "\" <" . w2u($address) . ">";
					$fulladdr = "\"" . /** @scrutinizer ignore-type */ w2u($name) . "\" <" . w2u($address) . ">";
				}
				else {
					$fulladdr = w2u($name) . "<" . w2u($address) . ">";
				}
			}

			if ($row[PR_RECIPIENT_TYPE] == MAPI_TO) {
				array_push($message->to, $fulladdr);
			}
			elseif ($row[PR_RECIPIENT_TYPE] == MAPI_CC) {
				array_push($message->cc, $fulladdr);
			}
		}

		if (is_array($message->to) && !empty($message->to)) {
			$message->to = implode(", ", $message->to);
		}
		if (is_array($message->cc) && !empty($message->cc)) {
			$message->cc = implode(", ", $message->cc);
		}

		// without importance some mobiles assume "0" (low) - Mantis #439
		if (!isset($message->importance)) {
			$message->importance = IMPORTANCE_NORMAL;
		}

		if (!isset($message->internetcpid)) {
			$message->internetcpid = (defined('STORE_INTERNET_CPID')) ? constant('STORE_INTERNET_CPID') : INTERNET_CPID_WINDOWS1252;
		}
		$this->setFlag($mapimessage, $message);
		// TODO checkcontentclass
		if (!isset($message->contentclass)) {
			$message->contentclass = DEFAULT_EMAIL_CONTENTCLASS;
		}

		if (!isset($message->nativebodytype)) {
			$message->nativebodytype = MAPIUtils::GetNativeBodyType($messageprops);
		}
		elseif ($message->nativebodytype == SYNC_BODYPREFERENCE_UNDEFINED) {
			$nbt = MAPIUtils::GetNativeBodyType($messageprops);
			SLog::Write(LOGLEVEL_INFO, sprintf("MAPIProvider->getEmail(): native body type is undefined. Set it to %d.", $nbt));
			$message->nativebodytype = $nbt;
		}

		// reply, reply to all, forward flags
		if (isset($message->lastverbexecuted) && $message->lastverbexecuted) {
			$message->lastverbexecuted = Utils::GetLastVerbExecuted($message->lastverbexecuted);
		}

		return $message;
	}

	/**
	 * Reads a note object from MAPI.
	 *
	 * @param mixed             $mapimessage
	 * @param ContentParameters $contentparameters
	 *
	 * @return SyncNote
	 */
	private function getNote($mapimessage, $contentparameters) {
		$message = new SyncNote();

		// Standard one-to-one mappings first
		$this->getPropsFromMAPI($message, $mapimessage, MAPIMapping::GetNoteMapping());

		// set the body according to contentparameters and supported AS version
		$this->setMessageBody($mapimessage, $contentparameters, $message);

		return $message;
	}

	/**
	 * Creates a SyncFolder from MAPI properties.
	 *
	 * @param mixed $folderprops
	 *
	 * @return SyncFolder
	 */
	public function GetFolder($folderprops) {
		$folder = new SyncFolder();

		$storeprops = $this->GetStoreProps();

		// For ZCP 7.0.x we need to retrieve more properties explicitly, see ZP-780
		if (isset($folderprops[PR_SOURCE_KEY]) && !isset($folderprops[PR_ENTRYID]) && !isset($folderprops[PR_CONTAINER_CLASS])) {

			$entryid = mapi_msgstore_entryidfromsourcekey($this->store, $folderprops[PR_SOURCE_KEY]);
			$mapifolder = mapi_msgstore_openentry($this->store, $entryid);
			$folderprops = mapi_getprops($mapifolder, [PR_DISPLAY_NAME, PR_PARENT_ENTRYID, PR_ENTRYID, PR_SOURCE_KEY, PR_PARENT_SOURCE_KEY, PR_CONTAINER_CLASS, PR_ATTR_HIDDEN, PR_EXTENDED_FOLDER_FLAGS]);

			SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->GetFolder(): received insufficient of data from ICS. Fetching required data.");
		}

		if (!isset(
				$folderprops[PR_DISPLAY_NAME],
				$folderprops[PR_PARENT_ENTRYID],
				$folderprops[PR_SOURCE_KEY],
				$folderprops[PR_ENTRYID],
				$folderprops[PR_PARENT_SOURCE_KEY],
				$storeprops[PR_IPM_SUBTREE_ENTRYID])) {

			SLog::Write(LOGLEVEL_ERROR, "MAPIProvider->GetFolder(): invalid folder. Missing properties");

			return false;

		}

		// ignore hidden folders
		if (isset($folderprops[PR_ATTR_HIDDEN]) && $folderprops[PR_ATTR_HIDDEN] != false) {
			SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->GetFolder(): invalid folder '%s' as it is a hidden folder (PR_ATTR_HIDDEN)", $folderprops[PR_DISPLAY_NAME]));

			return false;

		}

		// ignore certain undesired folders, like "RSS Feeds" and "Suggested contacts"
		if ((isset($folderprops[PR_CONTAINER_CLASS]) && $folderprops[PR_CONTAINER_CLASS] == "IPF.Note.OutlookHomepage") ||
				in_array($folderprops[PR_ENTRYID], $this->getSpecialFoldersData())) {
			SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->GetFolder(): folder '%s' should not be synchronized", $folderprops[PR_DISPLAY_NAME]));

			return false;

		}

		$folder->BackendId = bin2hex($folderprops[PR_SOURCE_KEY]);
		$folderOrigin = DeviceManager::FLD_ORIGIN_USER;
		if (GSync::GetBackend()->GetImpersonatedUser()) {
			$folderOrigin = DeviceManager::FLD_ORIGIN_IMPERSONATED;
		}
		$folder->serverid = GSync::GetDeviceManager()->GetFolderIdForBackendId($folder->BackendId, true, $folderOrigin, $folderprops[PR_DISPLAY_NAME]);
		if ($folderprops[PR_PARENT_ENTRYID] == $storeprops[PR_IPM_SUBTREE_ENTRYID] || $folderprops[PR_PARENT_ENTRYID] == $storeprops[PR_IPM_PUBLIC_FOLDERS_ENTRYID]) {

			$folder->parentid = "0";
		}
		else {
			$folder->parentid = GSync::GetDeviceManager()->GetFolderIdForBackendId(bin2hex($folderprops[PR_PARENT_SOURCE_KEY]));
		}
		$folder->displayname = w2u($folderprops[PR_DISPLAY_NAME]);
		$folder->type = $this->GetFolderType($folderprops[PR_ENTRYID], isset($folderprops[PR_CONTAINER_CLASS]) ? $folderprops[PR_CONTAINER_CLASS] : false);
		$folder->type = $this->GetFolderType($folderprops[PR_ENTRYID], /** @scrutinizer ignore-type */ isset($folderprops[PR_CONTAINER_CLASS]) ? $folderprops[PR_CONTAINER_CLASS] : false);

		return $folder;
	}

	/**
	 * Returns the foldertype for an entryid
	 * Gets the folder type by checking the default folders in MAPI.
	 *
	 * @param string $entryid
	 * @param string $class   (opt)
	 *
	 * @return long
filter:
    dependency_paths: ["lib/*"]
	 */
	public function GetFolderType($entryid, $class = false) {
		$storeprops = $this->GetStoreProps();
		$inboxprops = $this->GetInboxProps();

		if ($entryid == $storeprops[PR_IPM_WASTEBASKET_ENTRYID]) {

			return SYNC_FOLDER_TYPE_WASTEBASKET;

		}
		if ($entryid == $storeprops[PR_IPM_SENTMAIL_ENTRYID]) {

			return SYNC_FOLDER_TYPE_SENTMAIL;

		}
		if ($entryid == $storeprops[PR_IPM_OUTBOX_ENTRYID]) {

			return SYNC_FOLDER_TYPE_OUTBOX;

		}

		// Public folders do not have inboxprops
		// @see https://jira.z-hub.io/browse/ZP-995
		if (!empty($inboxprops)) {
			if ($entryid == $inboxprops[PR_ENTRYID]) {
				return SYNC_FOLDER_TYPE_INBOX;

			}
			if ($entryid == $inboxprops[PR_IPM_DRAFTS_ENTRYID]) {

				return SYNC_FOLDER_TYPE_DRAFTS;

			}
			if ($entryid == $inboxprops[PR_IPM_TASK_ENTRYID]) {

				return SYNC_FOLDER_TYPE_TASK;

			}
			if ($entryid == $inboxprops[PR_IPM_APPOINTMENT_ENTRYID]) {

				return SYNC_FOLDER_TYPE_APPOINTMENT;

			}
			if ($entryid == $inboxprops[PR_IPM_CONTACT_ENTRYID]) {

				return SYNC_FOLDER_TYPE_CONTACT;

			}
			if ($entryid == $inboxprops[PR_IPM_NOTE_ENTRYID]) {

				return SYNC_FOLDER_TYPE_NOTE;

			}
			if ($entryid == $inboxprops[PR_IPM_JOURNAL_ENTRYID]) {

				return SYNC_FOLDER_TYPE_JOURNAL;

			}
		}

		// user created folders
		if ($class == "IPF.Note") {
			return SYNC_FOLDER_TYPE_USER_MAIL;

		}
		if ($class == "IPF.Task") {
			return SYNC_FOLDER_TYPE_USER_TASK;

		}
		if ($class == "IPF.Appointment") {
			return SYNC_FOLDER_TYPE_USER_APPOINTMENT;

		}
		if ($class == "IPF.Contact") {
			return SYNC_FOLDER_TYPE_USER_CONTACT;

		}
		if ($class == "IPF.StickyNote") {
			return SYNC_FOLDER_TYPE_USER_NOTE;

		}
		if ($class == "IPF.Journal") {
			return SYNC_FOLDER_TYPE_USER_JOURNAL;

		}

		return SYNC_FOLDER_TYPE_OTHER;

	}

	/**
	 * Indicates if the entry id is a default MAPI folder.
	 *
	 * @param string $entryid
	 *
	 * @return bool
	 */
	public function IsMAPIDefaultFolder($entryid) {
		$msgstore_props = mapi_getprops($this->store, [PR_ENTRYID, PR_DISPLAY_NAME, PR_IPM_SUBTREE_ENTRYID, PR_IPM_OUTBOX_ENTRYID, PR_IPM_SENTMAIL_ENTRYID, PR_IPM_WASTEBASKET_ENTRYID, PR_MDB_PROVIDER, PR_IPM_PUBLIC_FOLDERS_ENTRYID, PR_IPM_FAVORITES_ENTRYID, PR_MAILBOX_OWNER_ENTRYID]);


		$inboxProps = [];
		$inbox = mapi_msgstore_getreceivefolder($this->store);
		if (!mapi_last_hresult()) {
			$inboxProps = mapi_getprops($inbox, [PR_ENTRYID]);
		}

		$root = mapi_msgstore_openentry($this->store, null); // TODO use getRootProps()
		$rootProps = mapi_getprops($root, [PR_IPM_APPOINTMENT_ENTRYID, PR_IPM_CONTACT_ENTRYID, PR_IPM_DRAFTS_ENTRYID, PR_IPM_JOURNAL_ENTRYID, PR_IPM_NOTE_ENTRYID, PR_IPM_TASK_ENTRYID, PR_ADDITIONAL_REN_ENTRYIDS]);


		$additional_ren_entryids = [];
		if (isset($rootProps[PR_ADDITIONAL_REN_ENTRYIDS])) {
			$additional_ren_entryids = $rootProps[PR_ADDITIONAL_REN_ENTRYIDS];
		}

		$defaultfolders = [
			"inbox" => ["inbox" => PR_ENTRYID],
			"outbox" => ["store" => PR_IPM_OUTBOX_ENTRYID],
			"sent" => ["store" => PR_IPM_SENTMAIL_ENTRYID],
			"wastebasket" => ["store" => PR_IPM_WASTEBASKET_ENTRYID],
			"favorites" => ["store" => PR_IPM_FAVORITES_ENTRYID],
			"publicfolders" => ["store" => PR_IPM_PUBLIC_FOLDERS_ENTRYID],
			"calendar" => ["root" => PR_IPM_APPOINTMENT_ENTRYID],
			"contact" => ["root" => PR_IPM_CONTACT_ENTRYID],
			"drafts" => ["root" => PR_IPM_DRAFTS_ENTRYID],
			"journal" => ["root" => PR_IPM_JOURNAL_ENTRYID],
			"note" => ["root" => PR_IPM_NOTE_ENTRYID],
			"task" => ["root" => PR_IPM_TASK_ENTRYID],
			"junk" => ["additional" => 4],
			"syncissues" => ["additional" => 1],
			"conflicts" => ["additional" => 0],
			"localfailures" => ["additional" => 2],
			"serverfailures" => ["additional" => 3],
		];

		foreach ($defaultfolders as $key => $prop) {
			$tag = reset($prop);
			$from = key($prop);

			switch ($from) {
				case "inbox":
					if (isset($inboxProps[$tag]) && $entryid == $inboxProps[$tag]) {
						SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->IsMAPIFolder(): Inbox found, key '%s'", $key));

						return true;
					}
					break;

				case "store":
					if (isset($msgstore_props[$tag]) && $entryid == $msgstore_props[$tag]) {
						SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->IsMAPIFolder(): Store folder found, key '%s'", $key));

						return true;
					}
					break;

				case "root":
					if (isset($rootProps[$tag]) && $entryid == $rootProps[$tag]) {
						SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->IsMAPIFolder(): Root folder found, key '%s'", $key));

						return true;
					}
					break;

				case "additional":
					if (isset($additional_ren_entryids[$tag]) && $entryid == $additional_ren_entryids[$tag]) {
						SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->IsMAPIFolder(): Additional folder found, key '%s'", $key));

						return true;
					}
					break;
			}
		}

		return false;
	}

	/*----------------------------------------------------------------------------------------------------------
	 * SETTER
	 */

	/**
	 * Writes a SyncObject to MAPI
	 * Depending on the message class, a contact, appointment, task or email is written.
	 *
	 * @param mixed      $mapimessage
	 * @param SyncObject $message
	 *
	 * @return bool
	 */
	public function SetMessage($mapimessage, $message) {
		// TODO check with instanceof
		switch (strtolower(get_class($message))) {
			case "synccontact":
				return $this->setContact($mapimessage, $message);

			case "syncappointment":
				return $this->setAppointment($mapimessage, $message);

			case "synctask":
				return $this->setTask($mapimessage, $message);

			case "syncnote":
				return $this->setNote($mapimessage, $message);

			default:
				// for emails only flag (read and todo) changes are possible
				return $this->setEmail($mapimessage, $message);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
		}
	}

	/**
	 * Writes SyncMail to MAPI (actually flags only).
	 *
	 * @param mixed    $mapimessage
	 * @param SyncMail $message
	 */
	private function setEmail($mapimessage, $message) {
		// update categories
		if (!isset($message->categories)) {
			$message->categories = [];
		}
		$emailmap = MAPIMapping::GetEmailMapping();
		$this->setPropsInMAPI($mapimessage, $message, ["categories" => $emailmap["categories"]]);

		$flagmapping = MAPIMapping::GetMailFlagsMapping();
		$flagprops = MAPIMapping::GetMailFlagsProperties();
		$flagprops = array_merge($this->getPropIdsFromStrings($flagmapping), $this->getPropIdsFromStrings($flagprops));
		// flag specific properties to be set
		$props = $delprops = [];
		// unset message flags if:
		// flag is not set
		if (empty($message->flag) ||
			// flag status is not set
			!isset($message->flag->flagstatus) ||
			// flag status is 0 or empty
			(isset($message->flag->flagstatus) && ($message->flag->flagstatus == 0 || $message->flag->flagstatus == ""))) {
			// if message flag is empty, some properties need to be deleted
			// and some set to 0 or false

			$props[$flagprops["todoitemsflags"]] = 0;
			$props[$flagprops["status"]] = 0;
			$props[$flagprops["completion"]] = 0.0;
			$props[$flagprops["flagtype"]] = "";
			$props[$flagprops["ordinaldate"]] = 0x7FFFFFFF; // ordinal date is 12am 1.1.4501, set it to max possible value
			$props[$flagprops["subordinaldate"]] = "";
			$props[$flagprops["replyrequested"]] = false;
			$props[$flagprops["responserequested"]] = false;
			$props[$flagprops["reminderset"]] = false;
			$props[$flagprops["complete"]] = false;

			$delprops[] = $flagprops["todotitle"];
			$delprops[] = $flagprops["duedate"];
			$delprops[] = $flagprops["startdate"];
			$delprops[] = $flagprops["datecompleted"];
			$delprops[] = $flagprops["utcstartdate"];
			$delprops[] = $flagprops["utcduedate"];
			$delprops[] = $flagprops["completetime"];
			$delprops[] = $flagprops["flagstatus"];
			$delprops[] = $flagprops["flagicon"];
		}
		else {
			$this->setPropsInMAPI($mapimessage, $message->flag, $flagmapping);
			$props[$flagprops["todoitemsflags"]] = 1;
			if (isset($message->subject) && strlen($message->subject) > 0) {
				$props[$flagprops["todotitle"]] = $message->subject;
			}
			// ordinal date is utc current time
			if (!isset($message->flag->ordinaldate) || empty($message->flag->ordinaldate)) {
				$props[$flagprops["ordinaldate"]] = time();
			}
			// the default value
			if (!isset($message->flag->subordinaldate) || empty($message->flag->subordinaldate)) {
				$props[$flagprops["subordinaldate"]] = "5555555";
			}
			$props[$flagprops["flagicon"]] = 6; // red flag icon
			$props[$flagprops["replyrequested"]] = true;
			$props[$flagprops["responserequested"]] = true;

			if ($message->flag->flagstatus == SYNC_FLAGSTATUS_COMPLETE) {
				$props[$flagprops["status"]] = olTaskComplete;
				$props[$flagprops["completion"]] = 1.0;
				$props[$flagprops["complete"]] = true;
				$props[$flagprops["replyrequested"]] = false;
				$props[$flagprops["responserequested"]] = false;
				unset($props[$flagprops["flagicon"]]);
				$delprops[] = $flagprops["flagicon"];
			}
		}

		if (!empty($props)) {
			mapi_setprops($mapimessage, $props);
		}
		if (!empty($delprops)) {
			mapi_deleteprops($mapimessage, $delprops);
		}
	}

	/**
	 * Writes a SyncAppointment to MAPI.
	 *
	 * @param mixed           $mapimessage
	 * @param SyncAppointment $message
	 * @param mixed           $appointment
	 *
	 * @return bool
	 */
	private function setAppointment($mapimessage, $appointment) {
		// Get timezone info
		if (isset($appointment->timezone)) {
			$tz = $this->getTZFromSyncBlob(base64_decode($appointment->timezone));
		}
		else {
			$tz = false;
		}

		// start and end time may not be set - try to get them from the existing appointment for further calculation - see https://jira.z-hub.io/browse/ZP-983
		if (!isset($appointment->starttime) || !isset($appointment->endtime)) {
			$amapping = MAPIMapping::GetAppointmentMapping();
			$amapping = $this->getPropIdsFromStrings($amapping);
			$existingstartendpropsmap = [$amapping["starttime"], $amapping["endtime"]];
			$existingstartendprops = $this->getProps($mapimessage, $existingstartendpropsmap);

			if (isset($existingstartendprops[$amapping["starttime"]]) && !isset($appointment->starttime)) {
				$appointment->starttime = $existingstartendprops[$amapping["starttime"]];
				SLog::Write(LOGLEVEL_WBXML, sprintf("MAPIProvider->setAppointment(): Parameter 'starttime' was not set, using value from MAPI %d (%s).", $appointment->starttime, gmstrftime("%Y%m%dT%H%M%SZ", $appointment->starttime)));
			}
			if (isset($existingstartendprops[$amapping["endtime"]]) && !isset($appointment->endtime)) {
				$appointment->endtime = $existingstartendprops[$amapping["endtime"]];
				SLog::Write(LOGLEVEL_WBXML, sprintf("MAPIProvider->setAppointment(): Parameter 'endtime' was not set, using value from MAPI %d (%s).", $appointment->endtime, gmstrftime("%Y%m%dT%H%M%SZ", $appointment->endtime)));
			}
		}
		if (!isset($appointment->starttime) || !isset($appointment->endtime)) {
			throw new StatusException("MAPIProvider->setAppointment(): Error, start and/or end time not set and can not be retrieved from MAPI.", SYNC_STATUS_SYNCCANNOTBECOMPLETED);
		}

		// calculate duration because without it some webaccess views are broken. duration is in min
		$localstart = $this->getLocaltimeByTZ($appointment->starttime, $tz);
		$localstart = $this->getLocaltimeByTZ($appointment->starttime, /** @scrutinizer ignore-type */ $tz);
		$localend = $this->getLocaltimeByTZ($appointment->endtime, $tz);
		$duration = ($localend - $localstart) / 60;

		// nokia sends an yearly event with 0 mins duration but as all day event,
		// so make it end next day
		if ($appointment->starttime == $appointment->endtime && isset($appointment->alldayevent) && $appointment->alldayevent) {
			$duration = 1440;
			$appointment->endtime = $appointment->starttime + 24 * 60 * 60;
			$localend = $localstart + 24 * 60 * 60;
		}

		// is the transmitted UID OL compatible?
		// if not, encapsulate the transmitted uid
		$appointment->uid = Utils::GetOLUidFromICalUid($appointment->uid);

		mapi_setprops($mapimessage, [PR_MESSAGE_CLASS => "IPM.Appointment"]);


		$appointmentmapping = MAPIMapping::GetAppointmentMapping();
		$this->setPropsInMAPI($mapimessage, $appointment, $appointmentmapping);
		$appointmentprops = MAPIMapping::GetAppointmentProperties();
		$appointmentprops = array_merge($this->getPropIdsFromStrings($appointmentmapping), $this->getPropIdsFromStrings($appointmentprops));
		// appointment specific properties to be set
		$props = [];

		// sensitivity is not enough to mark an appointment as private, so we use another mapi tag
		$private = (isset($appointment->sensitivity) && $appointment->sensitivity >= SENSITIVITY_PRIVATE) ? true : false;

		// Set commonstart/commonend to start/end and remindertime to start, duration, private and cleanGlobalObjectId
		$props[$appointmentprops["commonstart"]] = $appointment->starttime;
		$props[$appointmentprops["commonend"]] = $appointment->endtime;
		$props[$appointmentprops["reminderstart"]] = $appointment->starttime;
		// Set reminder boolean to 'true' if reminder is set
		$props[$appointmentprops["reminderset"]] = isset($appointment->reminder) ? true : false;
		$props[$appointmentprops["duration"]] = $duration;
		$props[$appointmentprops["private"]] = $private;
		$props[$appointmentprops["uid"]] = $appointment->uid;
		// Set named prop 8510, unknown property, but enables deleting a single occurrence of a recurring
		// type in OLK2003.
		$props[$appointmentprops["sideeffects"]] = 369;

		if (isset($appointment->reminder) && $appointment->reminder >= 0) {
			// Set 'flagdueby' to correct value (start - reminderminutes)
			$props[$appointmentprops["flagdueby"]] = $appointment->starttime - $appointment->reminder * 60;
			$props[$appointmentprops["remindertime"]] = $appointment->reminder;
		}
		// unset the reminder
		else {
			$props[$appointmentprops["reminderset"]] = false;
		}

		if (isset($appointment->asbody)) {
			$this->setASbody($appointment->asbody, $props, $appointmentprops);
		}

		if ($tz !== false) {
			$props[$appointmentprops["timezonetag"]] = $this->getMAPIBlobFromTZ($tz);
		}

		if (isset($appointment->recurrence)) {
			// Set PR_ICON_INDEX to 1025 to show correct icon in category view
			$props[$appointmentprops["icon"]] = 1025;

			// if there aren't any exceptions, use the 'old style' set recurrence
			$noexceptions = true;

			$recurrence = new Recurrence($this->store, $mapimessage);
			$recur = [];
			$this->setRecurrence($appointment, $recur);

			// set the recurrence type to that of the MAPI
			$props[$appointmentprops["recurrencetype"]] = $recur["recurrencetype"];

			$starttime = $this->gmtime($localstart);
			$endtime = $this->gmtime($localend);
			$endtime = $this->gmtime(/** @scrutinizer ignore-type */ $localend);

			// set recurrence start here because it's calculated differently for tasks and appointments
			$recur["start"] = $this->getDayStartOfTimestamp($this->getGMTTimeByTZ($localstart, $tz));
			$recur["start"] = $this->getDayStartOfTimestamp($this->getGMTTimeByTZ($localstart, /** @scrutinizer ignore-type */ $tz));

			$recur["startocc"] = $starttime["tm_hour"] * 60 + $starttime["tm_min"];
			$recur["endocc"] = $recur["startocc"] + $duration; // Note that this may be > 24*60 if multi-day

			// only tasks can regenerate
			$recur["regen"] = false;

			// Process exceptions. The PDA will send all exceptions for this recurring item.
			if (isset($appointment->exceptions)) {
				foreach ($appointment->exceptions as $exception) {
					// we always need the base date
					if (!isset($exception->exceptionstarttime)) {
						continue;
					}

					$basedate = $this->getDayStartOfTimestamp($exception->exceptionstarttime);
					if (isset($exception->deleted) && $exception->deleted) {
						$noexceptions = false;
						// Delete exception
						$recurrence->createException([], $basedate, true);
					}
					else {
						// Change exception
						$mapiexception = ["basedate" => $basedate];
						// other exception properties which are not handled in recurrence
						$exceptionprops = [];

						if (isset($exception->starttime)) {
							$mapiexception["start"] = $this->getLocaltimeByTZ($exception->starttime, $tz);
							$exceptionprops[$appointmentprops["starttime"]] = $exception->starttime;
						}
						if (isset($exception->endtime)) {
							$mapiexception["end"] = $this->getLocaltimeByTZ($exception->endtime, $tz);
							$exceptionprops[$appointmentprops["endtime"]] = $exception->endtime;
						}
						if (isset($exception->subject)) {
							$exceptionprops[$appointmentprops["subject"]] = $mapiexception["subject"] = u2w($exception->subject);
						}
						if (isset($exception->location)) {
							$exceptionprops[$appointmentprops["location"]] = $mapiexception["location"] = u2w($exception->location);
						}
						if (isset($exception->busystatus)) {
							$exceptionprops[$appointmentprops["busystatus"]] = $mapiexception["busystatus"] = $exception->busystatus;
						}
						if (isset($exception->reminder)) {
							$exceptionprops[$appointmentprops["reminderset"]] = $mapiexception["reminder_set"] = 1;
							$exceptionprops[$appointmentprops["remindertime"]] = $mapiexception["remind_before"] = $exception->reminder;
						}
						if (isset($exception->alldayevent)) {
							$exceptionprops[$appointmentprops["alldayevent"]] = $mapiexception["alldayevent"] = $exception->alldayevent;
						}

						if (!isset($recur["changed_occurrences"])) {
							$recur["changed_occurrences"] = [];
						}

						if (isset($exception->body)) {
							$exceptionprops[$appointmentprops["body"]] = u2w($exception->body);
						}

						if (isset($exception->asbody)) {
							$this->setASbody($exception->asbody, $exceptionprops, $appointmentprops);
							$mapiexception["body"] = $exceptionprops[$appointmentprops["body"]] =
								(isset($exceptionprops[$appointmentprops["body"]])) ? $exceptionprops[$appointmentprops["body"]] :
								((isset($exceptionprops[$appointmentprops["html"]])) ? $exceptionprops[$appointmentprops["html"]] : "");
						}

						array_push($recur["changed_occurrences"], $mapiexception);

						if (!empty($exceptionprops)) {
							$noexceptions = false;
							if ($recurrence->isException($basedate)) {
								$recurrence->modifyException($exceptionprops, $basedate);
							}
							else {
								$recurrence->createException($exceptionprops, $basedate);
							}
						}
					}
				}
			}

			// setRecurrence deletes the attachments from an appointment
			if ($noexceptions) {
				$recurrence->setRecurrence($tz, $recur);
			}
		}
		else {
			$props[$appointmentprops["isrecurring"]] = false;
		}

		// always set the PR_SENT_REPRESENTING_* props so that the attendee status update also works with the webaccess
		$p = [$appointmentprops["representingentryid"], $appointmentprops["representingname"], $appointmentprops["sentrepresentingaddt"],
			$appointmentprops["sentrepresentingemail"], $appointmentprops["sentrepresentinsrchk"], $appointmentprops["responsestatus"], ];
		$representingprops = $this->getProps($mapimessage, $p);

		if (!isset($representingprops[$appointmentprops["representingentryid"]])) {
			// TODO use GetStoreProps
			$storeProps = mapi_getprops($this->store, [PR_MAILBOX_OWNER_ENTRYID]);

			$props[$appointmentprops["representingentryid"]] = $storeProps[PR_MAILBOX_OWNER_ENTRYID];
			$displayname = $this->getFullnameFromEntryID($storeProps[PR_MAILBOX_OWNER_ENTRYID]);

			$props[$appointmentprops["representingname"]] = ($displayname !== false) ? $displayname : Request::GetUser();

			$props[$appointmentprops["sentrepresentingemail"]] = Request::GetUser();
			$props[$appointmentprops["sentrepresentingaddt"]] = "ZARAFA";
			$props[$appointmentprops["sentrepresentinsrchk"]] = $props[$appointmentprops["sentrepresentingaddt"]] . ":" . $props[$appointmentprops["sentrepresentingemail"]];

			if (isset($appointment->attendees) && is_array($appointment->attendees) && !empty($appointment->attendees)) {
				$props[$appointmentprops["icon"]] = 1026;
				// the user is the organizer
				// set these properties to show tracking tab in webapp

				$props[$appointmentprops["mrwassent"]] = true;
				$props[$appointmentprops["responsestatus"]] = olResponseOrganized;
				$props[$appointmentprops["meetingstatus"]] = olMeeting;
			}
		}
		// we also have to set the responsestatus and not only meetingstatus, so we use another mapi tag
		if (!isset($props[$appointmentprops["responsestatus"]])) {
			if (isset($appointment->responsetype)) {
				$props[$appointmentprops["responsestatus"]] = $appointment->responsetype;
			}
			// only set responsestatus to none if it is not set on the server
			elseif (!isset($representingprops[$appointmentprops["responsestatus"]])) {
				$props[$appointmentprops["responsestatus"]] = olResponseNone;
			}
		}

		// Do attendees
		if (isset($appointment->attendees) && is_array($appointment->attendees)) {
			$recips = [];

			// Outlook XP requires organizer in the attendee list as well
			$org = [];
			$org[PR_ENTRYID] = isset($representingprops[$appointmentprops["representingentryid"]]) ? $representingprops[$appointmentprops["representingentryid"]] : $props[$appointmentprops["representingentryid"]];
			$org[PR_DISPLAY_NAME] = isset($representingprops[$appointmentprops["representingname"]]) ? $representingprops[$appointmentprops["representingname"]] : $props[$appointmentprops["representingname"]];

			$org[PR_ADDRTYPE] = isset($representingprops[$appointmentprops["sentrepresentingaddt"]]) ? $representingprops[$appointmentprops["sentrepresentingaddt"]] : $props[$appointmentprops["sentrepresentingaddt"]];

			$org[PR_SMTP_ADDRESS] = $org[PR_EMAIL_ADDRESS] = isset($representingprops[$appointmentprops["sentrepresentingemail"]]) ? $representingprops[$appointmentprops["sentrepresentingemail"]] : $props[$appointmentprops["sentrepresentingemail"]];

			$org[PR_SEARCH_KEY] = isset($representingprops[$appointmentprops["sentrepresentinsrchk"]]) ? $representingprops[$appointmentprops["sentrepresentinsrchk"]] : $props[$appointmentprops["sentrepresentinsrchk"]];

			$org[PR_RECIPIENT_FLAGS] = recipOrganizer | recipSendable;

			$org[PR_RECIPIENT_TYPE] = MAPI_ORIG;


			array_push($recips, $org);

			// Open address book for user resolve
			$addrbook = $this->getAddressbook();
			foreach ($appointment->attendees as $attendee) {
				$recip = [];
				$recip[PR_EMAIL_ADDRESS] = u2w($attendee->email);
				$recip[PR_SMTP_ADDRESS] = u2w($attendee->email);

				// lookup information in GAB if possible so we have up-to-date name for given address
				$userinfo = [[PR_DISPLAY_NAME => $recip[PR_EMAIL_ADDRESS]]];
				$userinfo = mapi_ab_resolvename($addrbook, $userinfo, EMS_AB_ADDRESS_LOOKUP);
				if (mapi_last_hresult() == NOERROR) {
					$recip[PR_DISPLAY_NAME] = $userinfo[0][PR_DISPLAY_NAME];
					$recip[PR_EMAIL_ADDRESS] = $userinfo[0][PR_EMAIL_ADDRESS];
					$recip[PR_SEARCH_KEY] = $userinfo[0][PR_SEARCH_KEY];
					$recip[PR_ADDRTYPE] = $userinfo[0][PR_ADDRTYPE];
					$recip[PR_ENTRYID] = $userinfo[0][PR_ENTRYID];
					$recip[PR_RECIPIENT_TYPE] = isset($attendee->attendeetype) ? $attendee->attendeetype : MAPI_TO;
					$recip[PR_RECIPIENT_FLAGS] = recipSendable;
					$recip[PR_RECIPIENT_TRACKSTATUS] = isset($attendee->attendeestatus) ? $attendee->attendeestatus : olResponseNone;

				}
				else {
					$recip[PR_DISPLAY_NAME] = u2w($attendee->name);
					$recip[PR_SEARCH_KEY] = "SMTP:" . $recip[PR_EMAIL_ADDRESS] . "\0";
					$recip[PR_ADDRTYPE] = "SMTP";
					$recip[PR_RECIPIENT_TYPE] = isset($attendee->attendeetype) ? $attendee->attendeetype : MAPI_TO;
					$recip[PR_ENTRYID] = mapi_createoneoff($recip[PR_DISPLAY_NAME], $recip[PR_ADDRTYPE], $recip[PR_EMAIL_ADDRESS]);
				}

				array_push($recips, $recip);
			}

			mapi_message_modifyrecipients($mapimessage, 0, $recips);
		}
		mapi_setprops($mapimessage, $props);

		return true;
	}

	/**
	 * Writes a SyncContact to MAPI.
	 *
	 * @param mixed       $mapimessage
	 * @param SyncContact $contact
	 *
	 * @return bool
	 */
	private function setContact($mapimessage, $contact) {
		mapi_setprops($mapimessage, [PR_MESSAGE_CLASS => "IPM.Contact"]);


		// normalize email addresses
		if (isset($contact->email1address) && (($contact->email1address = $this->extractEmailAddress($contact->email1address)) === false)) {

			unset($contact->email1address);
		}

		if (isset($contact->email2address) && (($contact->email2address = $this->extractEmailAddress($contact->email2address)) === false)) {

			unset($contact->email2address);
		}

		if (isset($contact->email3address) && (($contact->email3address = $this->extractEmailAddress($contact->email3address)) === false)) {

			unset($contact->email3address);
		}

		$contactmapping = MAPIMapping::GetContactMapping();
		$contactprops = MAPIMapping::GetContactProperties();
		$this->setPropsInMAPI($mapimessage, $contact, $contactmapping);

		// /set display name from contact's properties
		$cname = $this->composeDisplayName($contact);

		// get contact specific mapi properties and merge them with the AS properties
		$contactprops = array_merge($this->getPropIdsFromStrings($contactmapping), $this->getPropIdsFromStrings($contactprops));

		// contact specific properties to be set
		$props = [];

		// need to be set in order to show contacts properly in outlook and wa
		$nremails = [];
		$abprovidertype = 0;

		if (isset($contact->email1address)) {
			$this->setEmailAddress($contact->email1address, $cname, 1, $props, $contactprops, $nremails, $abprovidertype);
		}
		if (isset($contact->email2address)) {
			$this->setEmailAddress($contact->email2address, $cname, 2, $props, $contactprops, $nremails, $abprovidertype);
		}
		if (isset($contact->email3address)) {
			$this->setEmailAddress($contact->email3address, $cname, 3, $props, $contactprops, $nremails, $abprovidertype);
		}

		$props[$contactprops["addressbooklong"]] = $abprovidertype;
		$props[$contactprops["displayname"]] = $props[$contactprops["subject"]] = $cname;

		// pda multiple e-mail addresses bug fix for the contact
		if (!empty($nremails)) {
			$props[$contactprops["addressbookmv"]] = $nremails;
		}

		// set addresses
		$this->setAddress("home", $contact->homecity, $contact->homecountry, $contact->homepostalcode, $contact->homestate, $contact->homestreet, $props, $contactprops);
		$this->setAddress("business", $contact->businesscity, $contact->businesscountry, $contact->businesspostalcode, $contact->businessstate, $contact->businessstreet, $props, $contactprops);
		$this->setAddress("other", $contact->othercity, $contact->othercountry, $contact->otherpostalcode, $contact->otherstate, $contact->otherstreet, $props, $contactprops);

		// set the mailing address and its type
		if (isset($props[$contactprops["businessaddress"]])) {
			$props[$contactprops["mailingaddress"]] = 2;
			$this->setMailingAddress($contact->businesscity, $contact->businesscountry, $contact->businesspostalcode, $contact->businessstate, $contact->businessstreet, $props[$contactprops["businessaddress"]], $props, $contactprops);
		}
		elseif (isset($props[$contactprops["homeaddress"]])) {
			$props[$contactprops["mailingaddress"]] = 1;
			$this->setMailingAddress($contact->homecity, $contact->homecountry, $contact->homepostalcode, $contact->homestate, $contact->homestreet, $props[$contactprops["homeaddress"]], $props, $contactprops);
		}
		elseif (isset($props[$contactprops["otheraddress"]])) {
			$props[$contactprops["mailingaddress"]] = 3;
			$this->setMailingAddress($contact->othercity, $contact->othercountry, $contact->otherpostalcode, $contact->otherstate, $contact->otherstreet, $props[$contactprops["otheraddress"]], $props, $contactprops);
		}

		if (isset($contact->picture)) {
			$picbinary = base64_decode($contact->picture);
			$picsize = strlen($picbinary);
			$props[$contactprops["haspic"]] = false;

			// TODO contact picture handling
			// check if contact has already got a picture. delete it first in that case
			// delete it also if it was removed on a mobile
			$picprops = mapi_getprops($mapimessage, [$contactprops["haspic"]]);
			if (isset($picprops[$contactprops["haspic"]]) && $picprops[$contactprops["haspic"]]) {
				SLog::Write(LOGLEVEL_DEBUG, "Contact already has a picture. Delete it");

				$attachtable = mapi_message_getattachmenttable($mapimessage);
				mapi_table_restrict($attachtable, MAPIUtils::GetContactPicRestriction());
				$rows = mapi_table_queryallrows($attachtable, [PR_ATTACH_NUM]);

				if (isset($rows) && is_array($rows)) {
					foreach ($rows as $row) {
						mapi_message_deleteattach($mapimessage, $row[PR_ATTACH_NUM]);
					}
				}
			}

			// only set picture if there's data in the request
			if ($picbinary !== false && $picsize > 0) {
				$props[$contactprops["haspic"]] = true;
				$pic = mapi_message_createattach($mapimessage);
				// Set properties of the attachment
				$picprops = [
					PR_ATTACH_LONG_FILENAME => "ContactPicture.jpg",

					PR_DISPLAY_NAME => "ContactPicture.jpg",

					0x7FFF000B => true,
					PR_ATTACHMENT_HIDDEN => false,

					PR_ATTACHMENT_FLAGS => 1,

					PR_ATTACH_METHOD => ATTACH_BY_VALUE,

					PR_ATTACH_EXTENSION => ".jpg",

					PR_ATTACH_NUM => 1,
					PR_ATTACH_SIZE => $picsize,

					PR_ATTACH_DATA_BIN => $picbinary,

				];

				mapi_setprops($pic, $picprops);
				mapi_savechanges($pic);
			}
		}

		if (isset($contact->asbody)) {
			$this->setASbody($contact->asbody, $props, $contactprops);
		}

		// set fileas
		if (defined('FILEAS_ORDER')) {
			$lastname = (isset($contact->lastname)) ? $contact->lastname : "";
			$firstname = (isset($contact->firstname)) ? $contact->firstname : "";
			$middlename = (isset($contact->middlename)) ? $contact->middlename : "";
			$company = (isset($contact->companyname)) ? $contact->companyname : "";
			$props[$contactprops["fileas"]] = Utils::BuildFileAs($lastname, $firstname, $middlename, $company);
		}
		else {
			SLog::Write(LOGLEVEL_DEBUG, "FILEAS_ORDER not defined");
		}

		mapi_setprops($mapimessage, $props);

		return true;
	}

	/**
	 * Writes a SyncTask to MAPI.
	 *
	 * @param mixed    $mapimessage
	 * @param SyncTask $task
	 *
	 * @return bool
	 */
	private function setTask($mapimessage, $task) {
		mapi_setprops($mapimessage, [PR_MESSAGE_CLASS => "IPM.Task"]);


		$taskmapping = MAPIMapping::GetTaskMapping();
		$taskprops = MAPIMapping::GetTaskProperties();
		$this->setPropsInMAPI($mapimessage, $task, $taskmapping);
		$taskprops = array_merge($this->getPropIdsFromStrings($taskmapping), $this->getPropIdsFromStrings($taskprops));

		// task specific properties to be set
		$props = [];

		if (isset($task->asbody)) {
			$this->setASbody($task->asbody, $props, $taskprops);
		}

		if (isset($task->complete)) {
			if ($task->complete) {
				// Set completion to 100%
				// Set status to 'complete'
				$props[$taskprops["completion"]] = 1.0;
				$props[$taskprops["status"]] = 2;
				$props[$taskprops["reminderset"]] = false;
			}
			else {
				// Set completion to 0%
				// Set status to 'not started'
				$props[$taskprops["completion"]] = 0.0;
				$props[$taskprops["status"]] = 0;
			}
		}
		if (isset($task->recurrence) && class_exists('TaskRecurrence')) {
			$deadoccur = false;
			if ((isset($task->recurrence->occurrences) && $task->recurrence->occurrences == 1) ||
				(isset($task->recurrence->deadoccur) && $task->recurrence->deadoccur == 1)) { // ios5 sends deadoccur inside the recurrence
				$deadoccur = true;
			}

			// Set PR_ICON_INDEX to 1281 to show correct icon in category view
			$props[$taskprops["icon"]] = 1281;
			// dead occur - false if new occurrences should be generated from the task
			// true - if it is the last occurrence of the task
			$props[$taskprops["deadoccur"]] = $deadoccur;
			$props[$taskprops["isrecurringtag"]] = true;

			$recurrence = new TaskRecurrence($this->store, $mapimessage);
			$recur = [];
			$this->setRecurrence($task, $recur);

			// task specific recurrence properties which we need to set here
			// "start" and "end" are in GMT when passing to class.recurrence
			// set recurrence start here because it's calculated differently for tasks and appointments
			$recur["start"] = $task->recurrence->start;
			$recur["regen"] = (isset($task->recurrence->regenerate) && $task->recurrence->regenerate) ? 1 : 0;
			// OL regenerates recurring task itself, but setting deleteOccurrence is required so that PHP-MAPI doesn't regenerate
			// completed occurrence of a task.
			if ($recur["regen"] == 0) {
				$recur["deleteOccurrence"] = 0;
			}
			// Also add dates to $recur
			$recur["duedate"] = $task->duedate;
			$recur["complete"] = (isset($task->complete) && $task->complete) ? 1 : 0;
			if (isset($task->datecompleted)) {
				$recur["datecompleted"] = $task->datecompleted;
			}
			$recurrence->setRecurrence($recur);
		}

		$props[$taskprops["private"]] = (isset($task->sensitivity) && $task->sensitivity >= SENSITIVITY_PRIVATE) ? true : false;

		// Open address book for user resolve to set the owner
		$addrbook = $this->getAddressbook();


		// check if there is already an owner for the task, set current user if not
		$p = [$taskprops["owner"]];
		$owner = $this->getProps($mapimessage, $p);
		if (!isset($owner[$taskprops["owner"]])) {
			$userinfo = nsp_getuserinfo(Request::GetUser());
			if (mapi_last_hresult() == NOERROR && isset($userinfo["fullname"])) {
				$props[$taskprops["owner"]] = $userinfo["fullname"];
			}
		}
		mapi_setprops($mapimessage, $props);

		return true;
	}

	/**
	 * Writes a SyncNote to MAPI.
	 *
	 * @param mixed    $mapimessage
	 * @param SyncNote $note
	 *
	 * @return bool
	 */
	private function setNote($mapimessage, $note) {
		// Touchdown does not send categories if all are unset or there is none.
		// Setting it to an empty array will unset the property in KC as well
		if (!isset($note->categories)) {
			$note->categories = [];
		}

		// update icon index to correspond to the color
		if (isset($note->Color) && $note->Color > -1 && $note->Color < 5) {
			$note->Iconindex = 768 + $note->Color;

		}

		$this->setPropsInMAPI($mapimessage, $note, MAPIMapping::GetNoteMapping());

		$noteprops = MAPIMapping::GetNoteProperties();
		$noteprops = $this->getPropIdsFromStrings($noteprops);

		// note specific properties to be set
		$props = [];
		$props[$noteprops["messageclass"]] = "IPM.StickyNote";
		// set body otherwise the note will be "broken" when editing it in outlook
		if (isset($note->asbody)) {
			$this->setASbody($note->asbody, $props, $noteprops);
		}

		$props[$noteprops["internetcpid"]] = INTERNET_CPID_UTF8;
		mapi_setprops($mapimessage, $props);

		return true;
	}

	/*----------------------------------------------------------------------------------------------------------
	 * HELPER
	 */

	/**
	 * Returns the timestamp offset.
	 *
	 * @param string $ts
	 *
	 * @return long
	 */
	private function GetTZOffset($ts) {
		$Offset = date("O", $ts);
		$Offset = date("O", /** @scrutinizer ignore-type */ $ts);

		$Parity = $Offset < 0 ? -1 : 1;
		$Offset = $Parity * $Offset;
		$Offset = ($Offset - ($Offset % 100)) / 100 * 60 + $Offset % 100;

		return $Parity * $Offset;

	}

	/**
	 * Localtime of the timestamp.
	 *
	 * @param long $time
	 *
	 * @return array
	 */
	private function gmtime($time) {
		$TZOffset = $this->GetTZOffset($time);

		$t_time = $time - $TZOffset * 60; # Counter adjust for localtime()

		return localtime($t_time, 1);
	}

	/**
	 * Sets the properties in a MAPI object according to an Sync object and a property mapping.
	 *
	 * @param mixed      $mapimessage
	 * @param SyncObject $message
	 * @param array      $mapping
	 *
	 * @return
	 */
	private function setPropsInMAPI($mapimessage, $message, $mapping) {
		$mapiprops = $this->getPropIdsFromStrings($mapping);
		$unsetVars = $message->getUnsetVars();
		$propsToDelete = [];
		$propsToSet = [];

		foreach ($mapiprops as $asprop => $mapiprop) {
			if (isset($message->{$asprop})) {
				// UTF8->windows1252.. this is ok for all numerical values
				if (mapi_prop_type($mapiprop) != PT_BINARY && mapi_prop_type($mapiprop) != PT_MV_BINARY) {
					if (is_array($message->{$asprop})) {
						$value = array_map("u2wi", $message->{$asprop});
					}
					else {
						$value = u2wi($message->{$asprop});
					}
				}
				else {
					$value = $message->{$asprop};
				}

				// Make sure the php values are the correct type
				switch (mapi_prop_type($mapiprop)) {
					case PT_BINARY:
					case PT_STRING8:
						settype($value, "string");
						break;

					case PT_BOOLEAN:
						settype($value, "boolean");
						break;

					case PT_SYSTIME:
					case PT_LONG:
						settype($value, "integer");
						break;
				}

				// decode base64 value
				if ($mapiprop == PR_RTF_COMPRESSED) {

					$value = base64_decode($value);
					if (strlen($value) == 0) {
						continue;
					} // PDA will sometimes give us an empty RTF, which we'll ignore.

					// Note that you can still remove notes because when you remove notes it gives
					// a valid compressed RTF with nothing in it.
				}
				// if an "empty array" is to be saved, it the mvprop should be deleted - fixes Mantis #468
				if (is_array($value) && empty($value)) {
					$propsToDelete[] = $mapiprop;
					SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->setPropsInMAPI(): Property '%s' to be deleted as it is an empty array", $asprop));
				}
				else {
					// all properties will be set at once
					$propsToSet[$mapiprop] = $value;
				}
			}
			elseif (in_array($asprop, $unsetVars)) {
				$propsToDelete[] = $mapiprop;
			}
		}

		mapi_setprops($mapimessage, $propsToSet);
		if (mapi_last_hresult()) {
			SLog::Write(LOGLEVEL_WARN, sprintf("Failed to set properties, trying to set them separately. Error code was:%x", mapi_last_hresult()));
			$this->setPropsIndividually($mapimessage, $propsToSet, $mapiprops);
		}

		mapi_deleteprops($mapimessage, $propsToDelete);

		// clean up
		unset($unsetVars, $propsToDelete);
	}

	/**
	 * Sets the properties one by one in a MAPI object.
	 *
	 * @param mixed &$mapimessage
	 * @param array &$propsToSet
	 * @param array &$mapiprops
	 *
	 * @return
	 */
	private function setPropsIndividually(&$mapimessage, &$propsToSet, &$mapiprops) {
		foreach ($propsToSet as $prop => $value) {
			mapi_setprops($mapimessage, [$prop => $value]);
			if (mapi_last_hresult()) {
				SLog::Write(LOGLEVEL_ERROR, sprintf("Failed setting property [%s] with value [%s], error code was:%x", array_search($prop, $mapiprops), $value, mapi_last_hresult()));
			}
		}
	}

	/**
	 * Gets the properties from a MAPI object and sets them in the Sync object according to mapping.
	 *
	 * @param SyncObject &$message
	 * @param mixed      $mapimessage
	 * @param array      $mapping
	 *
	 * @return
	 */
	private function getPropsFromMAPI(&$message, $mapimessage, $mapping) {
		$messageprops = $this->getProps($mapimessage, $mapping);
		foreach ($mapping as $asprop => $mapiprop) {
			// Get long strings via openproperty
			if (isset($messageprops[mapi_prop_tag(PT_ERROR, mapi_prop_id($mapiprop))])) {
				if ($messageprops[mapi_prop_tag(PT_ERROR, mapi_prop_id($mapiprop))] == MAPI_E_NOT_ENOUGH_MEMORY_32BIT ||
					$messageprops[mapi_prop_tag(PT_ERROR, mapi_prop_id($mapiprop))] == MAPI_E_NOT_ENOUGH_MEMORY_64BIT) {
					$messageprops[$mapiprop] = MAPIUtils::readPropStream($mapimessage, $mapiprop);
				}
			}

			if (isset($messageprops[$mapiprop])) {
				if (mapi_prop_type($mapiprop) == PT_BOOLEAN) {
					// Force to actual '0' or '1'
					if ($messageprops[$mapiprop]) {
						$message->{$asprop} = 1;
					}
					else {
						$message->{$asprop} = 0;
					}
				}
				else {
					// Special handling for PR_MESSAGE_FLAGS
					if ($mapiprop == PR_MESSAGE_FLAGS) {

						$message->{$asprop} = $messageprops[$mapiprop] & 1;
					} // only look at 'read' flag
					elseif ($mapiprop == PR_RTF_COMPRESSED) {

						// do not send rtf to the mobile
						continue;
					}
					elseif (is_array($messageprops[$mapiprop])) {
						$message->{$asprop} = array_map("w2u", $messageprops[$mapiprop]);
					}
					else {
						if (mapi_prop_type($mapiprop) != PT_BINARY && mapi_prop_type($mapiprop) != PT_MV_BINARY) {
							$message->{$asprop} = w2u($messageprops[$mapiprop]);
						}
						else {
							$message->{$asprop} = $messageprops[$mapiprop];
						}
					}
				}
			}
		}
	}

	/**
	 * Wraps getPropIdsFromStrings() calls.
	 *
	 * @param mixed &$mapiprops
	 *
	 * @return
	 */
	private function getPropIdsFromStrings(&$mapiprops) {
		return getPropIdsFromStrings($this->store, $mapiprops);
	}

	/**
	 * Wraps mapi_getprops() calls.
	 *
	 * @param mixed &$mapiprops
	 * @param mixed $mapimessage
	 * @param mixed $mapiproperties
	 *
	 * @return
	 */
	protected function getProps($mapimessage, &$mapiproperties) {
		$mapiproperties = $this->getPropIdsFromStrings($mapiproperties);

		return mapi_getprops($mapimessage, $mapiproperties);
	}

	/**
	 * Returns an GMT timezone array.
	 *
	 * @return array
	 */
	private function getGMTTZ() {
		return [
			"bias" => 0,
			"tzname" => "",
			"dstendyear" => 0,
			"dstendmonth" => 10,
			"dstendday" => 0,
			"dstendweek" => 5,
			"dstendhour" => 2,
			"dstendminute" => 0,
			"dstendsecond" => 0,
			"dstendmillis" => 0,
			"stdbias" => 0,
			"tznamedst" => "",
			"dststartyear" => 0,
			"dststartmonth" => 3,
			"dststartday" => 0,
			"dststartweek" => 5,
			"dststarthour" => 1,
			"dststartminute" => 0,
			"dststartsecond" => 0,
			"dststartmillis" => 0,
			"dstbias" => -60,
		];
	}

	/**
	 * Unpack timezone info from MAPI.
	 *
	 * @param string $data
	 *
	 * @return array
	 */
	private function getTZFromMAPIBlob($data) {
		return unpack("lbias/lstdbias/ldstbias/" .
						   "vconst1/vdstendyear/vdstendmonth/vdstendday/vdstendweek/vdstendhour/vdstendminute/vdstendsecond/vdstendmillis/" .
						   "vconst2/vdststartyear/vdststartmonth/vdststartday/vdststartweek/vdststarthour/vdststartminute/vdststartsecond/vdststartmillis", $data);
	}

	/**
	 * Unpack timezone info from Sync.
	 *
	 * @param string $data
	 *
	 * @return array
	 */
	private function getTZFromSyncBlob($data) {
		$tz = unpack("lbias/a64tzname/vdstendyear/vdstendmonth/vdstendday/vdstendweek/vdstendhour/vdstendminute/vdstendsecond/vdstendmillis/" .
						"lstdbias/a64tznamedst/vdststartyear/vdststartmonth/vdststartday/vdststartweek/vdststarthour/vdststartminute/vdststartsecond/vdststartmillis/" .
						"ldstbias", $data);

		// Make the structure compatible with class.recurrence.php
		$tz["timezone"] = $tz["bias"];
		$tz["timezonedst"] = $tz["dstbias"];

		return $tz;
	}

	/**
	 * Pack timezone info for MAPI.
	 *
	 * @param array $tz
	 *
	 * @return string
	 */
	private function getMAPIBlobFromTZ($tz) {
		return pack(
			"lll" . "vvvvvvvvv" . "vvvvvvvvv",
			$tz["bias"],
			$tz["stdbias"],
			$tz["dstbias"],
			0,
			0,
			$tz["dstendmonth"],
			$tz["dstendday"],
			$tz["dstendweek"],
			$tz["dstendhour"],
			$tz["dstendminute"],
			$tz["dstendsecond"],
			$tz["dstendmillis"],
			0,
			0,
			$tz["dststartmonth"],
			$tz["dststartday"],
			$tz["dststartweek"],
			$tz["dststarthour"],
			$tz["dststartminute"],
			$tz["dststartsecond"],
			$tz["dststartmillis"]
		);
	}

	/**
	 * Checks the date to see if it is in DST, and returns correct GMT date accordingly.
	 *
	 * @param long  $localtime
	 * @param array $tz
	 *
	 * @return long
	 */
	private function getGMTTimeByTZ($localtime, $tz) {
		if (!isset($tz) || !is_array($tz)) {
			return $localtime;
		}

		if ($this->isDST($localtime, $tz)) {
			return $localtime + $tz["bias"] * 60 + $tz["dstbias"] * 60;

		}

		return $localtime + $tz["bias"] * 60;

	}

	/**
	 * Returns the local time for the given GMT time, taking account of the given timezone.
	 *
	 * @param long  $gmttime
	 * @param array $tz
	 *
	 * @return long
	 */
	private function getLocaltimeByTZ($gmttime, $tz) {
		if (!isset($tz) || !is_array($tz)) {
			return $gmttime;
		}

		if ($this->isDST($gmttime - $tz["bias"] * 60, $tz)) { // may bug around the switch time because it may have to be 'gmttime - bias - dstbias'
		if ($this->isDST(/** @scrutinizer ignore-type */ $gmttime - $tz["bias"] * 60, $tz)) { // may bug around the switch time because it may have to be 'gmttime - bias - dstbias'
			return $gmttime - $tz["bias"] * 60 - $tz["dstbias"] * 60;

		}

		return $gmttime - $tz["bias"] * 60;

	}

	/**
	 * Returns TRUE if it is the summer and therefore DST is in effect.
	 *
	 * @param long  $localtime
	 * @param array $tz
	 *
	 * @return bool
	 */
	private function isDST($localtime, $tz) {
		if (!isset($tz) || !is_array($tz) ||
			!isset($tz["dstbias"]) || $tz["dstbias"] == 0 ||
			!isset($tz["dststartmonth"]) || $tz["dststartmonth"] == 0 ||
			!isset($tz["dstendmonth"]) || $tz["dstendmonth"] == 0) {
			return false;
		}

		$year = gmdate("Y", $localtime);
		$year = gmdate("Y", /** @scrutinizer ignore-type */ $localtime);
		$start = $this->getTimestampOfWeek($year, $tz["dststartmonth"], $tz["dststartweek"], $tz["dststartday"], $tz["dststarthour"], $tz["dststartminute"], $tz["dststartsecond"]);
		$start = $this->getTimestampOfWeek(/** @scrutinizer ignore-type */ $year, $tz["dststartmonth"], $tz["dststartweek"], $tz["dststartday"], $tz["dststarthour"], $tz["dststartminute"], $tz["dststartsecond"]);
		$end = $this->getTimestampOfWeek($year, $tz["dstendmonth"], $tz["dstendweek"], $tz["dstendday"], $tz["dstendhour"], $tz["dstendminute"], $tz["dstendsecond"]);

		if ($start < $end) {
			// northern hemisphere (july = dst)
			if ($localtime >= $start && $localtime < $end) {
				$dst = true;
			}
			else {
				$dst = false;
			}
		}
		else {
			// southern hemisphere (january = dst)
			if ($localtime >= $end && $localtime < $start) {
				$dst = false;
			}
			else {
				$dst = true;
			}
		}

		return $dst;
	}

	/**
	 * Returns the local timestamp for the $week'th $wday of $month in $year at $hour:$minute:$second.
	 *
	 * @param int $year
	 * @param int $month
	 * @param int $week
	 * @param int $wday
	 * @param int $hour
	 * @param int $minute
	 * @param int $second
	 *
	 * @return long
	 */
	private function getTimestampOfWeek($year, $month, $week, $wday, $hour, $minute, $second) {
		if ($month == 0) {
			return;
		}

		$date = gmmktime($hour, $minute, $second, $month, 1, $year);

		// Find first day in month which matches day of the week
		while (1) {
			$wdaynow = gmdate("w", $date);
			if ($wdaynow == $wday) {
				break;
			}
			$date += 24 * 60 * 60;
		}

		// Forward $week weeks (may 'overflow' into the next month)
		$date = $date + $week * (24 * 60 * 60 * 7);

		// Reverse 'overflow'. Eg week '10' will always be the last week of the month in which the
		// specified weekday exists
		while (1) {
			$monthnow = gmdate("n", $date); // gmdate returns 1-12
			if ($monthnow > $month) {
				$date = $date - (24 * 7 * 60 * 60);
			}
			else {
				break;
			}
		}

		return $date;

	}

	/**
	 * Normalize the given timestamp to the start of the day.
	 *
	 * @param long $timestamp
	 *
	 * @return long
	 */
	private function getDayStartOfTimestamp($timestamp) {
		return $timestamp - ($timestamp % (60 * 60 * 24));

	}

	/**
	 * Returns an SMTP address from an entry id.
	 *
	 * @param string $entryid
	 *
	 * @return string
	 */
	private function getSMTPAddressFromEntryID($entryid) {
		$addrbook = $this->getAddressbook();

		$mailuser = mapi_ab_openentry($addrbook, $entryid);
		if (!$mailuser) {
			return "";
		}

		$props = mapi_getprops($mailuser, [PR_ADDRTYPE, PR_SMTP_ADDRESS, PR_EMAIL_ADDRESS]);


		$addrtype = isset($props[PR_ADDRTYPE]) ? $props[PR_ADDRTYPE] : "";

		if (isset($props[PR_SMTP_ADDRESS])) {
			return $props[PR_SMTP_ADDRESS];
		}

		if ($addrtype == "SMTP" && isset($props[PR_EMAIL_ADDRESS])) {
			return $props[PR_EMAIL_ADDRESS];
		}
		if ($addrtype == "ZARAFA" && isset($props[PR_EMAIL_ADDRESS])) {
			$userinfo = nsp_getuserinfo($props[PR_EMAIL_ADDRESS]);
			if (is_array($userinfo) && isset($userinfo["primary_email"])) {
				return $userinfo["primary_email"];
			}
		}

		return "";
	}

	/**
	 * Returns fullname from an entryid.
	 *
	 * @param binary $entryid
filter:
    dependency_paths: ["lib/*"]
	 *
	 * @return string fullname or false on error
	 */
	private function getFullnameFromEntryID($entryid) {
		$addrbook = $this->getAddressbook();
		$mailuser = mapi_ab_openentry($addrbook, $entryid);
		if (!$mailuser) {
			SLog::Write(LOGLEVEL_ERROR, sprintf("Unable to get mailuser for getFullnameFromEntryID (0x%X)", mapi_last_hresult()));

			return false;

		}

		$props = mapi_getprops($mailuser, [PR_DISPLAY_NAME]);

		if (isset($props[PR_DISPLAY_NAME])) {
			return $props[PR_DISPLAY_NAME];
		}
		SLog::Write(LOGLEVEL_ERROR, sprintf("Unable to get fullname for getFullnameFromEntryID (0x%X)", mapi_last_hresult()));

		return false;

	}

	/**
	 * Builds a displayname from several separated values.
	 *
	 * @param SyncContact $contact
	 *
	 * @return string
	 */
	private function composeDisplayName(&$contact) {
		// Set display name and subject to a combined value of firstname and lastname
		$cname = (isset($contact->prefix)) ? u2w($contact->prefix) . " " : "";
		$cname = (isset($contact->prefix)) ? /** @scrutinizer ignore-type */ u2w($contact->prefix) . " " : "";
		$cname .= u2w($contact->firstname);
		$cname .= (isset($contact->middlename)) ? " " . u2w($contact->middlename) : "";
		$cname .= (isset($contact->middlename)) ? " " . /** @scrutinizer ignore-type */ u2w($contact->middlename) : "";
		$cname .= " " . u2w($contact->lastname);
		$cname .= " " . /** @scrutinizer ignore-type */ u2w($contact->lastname);
		$cname .= (isset($contact->suffix)) ? " " . u2w($contact->suffix) : "";
		$cname .= (isset($contact->suffix)) ? " " . /** @scrutinizer ignore-type */ u2w($contact->suffix) : "";

		return trim($cname);
	}

	/**
	 * Sets all dependent properties for an email address.
	 *
	 * @param string $emailAddress
	 * @param string $displayName
	 * @param int    $cnt
	 * @param array  &$props
	 * @param array  &$properties
	 * @param array  &$nremails
	 * @param int    &$abprovidertype
	 *
	 * @return
	 */
	private function setEmailAddress($emailAddress, $displayName, $cnt, &$props, &$properties, &$nremails, &$abprovidertype) {
		if (isset($emailAddress)) {
			$name = (isset($displayName)) ? $displayName : $emailAddress;

			$props[$properties["emailaddress{$cnt}"]] = $emailAddress;
			$props[$properties["emailaddressdemail{$cnt}"]] = $emailAddress;
			$props[$properties["emailaddressdname{$cnt}"]] = $name;
			$props[$properties["emailaddresstype{$cnt}"]] = "SMTP";
			$props[$properties["emailaddressentryid{$cnt}"]] = mapi_createoneoff($name, "SMTP", $emailAddress);
			$nremails[] = $cnt - 1;
			$abprovidertype |= 2 ^ ($cnt - 1);
		}
	}

	/**
	 * Sets the properties for an address string.
	 *
	 * @param string $type        which address is being set
	 * @param string $city
	 * @param string $country
	 * @param string $postalcode
	 * @param string $state
	 * @param string $street
	 * @param array  &$props
	 * @param array  &$properties
	 *
	 * @return
	 */
	private function setAddress($type, &$city, &$country, &$postalcode, &$state, &$street, &$props, &$properties) {
		if (isset($city)) {
			$props[$properties[$type . "city"]] = $city = u2w($city);
		}

		if (isset($country)) {
			$props[$properties[$type . "country"]] = $country = u2w($country);
		}

		if (isset($postalcode)) {
			$props[$properties[$type . "postalcode"]] = $postalcode = u2w($postalcode);
		}

		if (isset($state)) {
			$props[$properties[$type . "state"]] = $state = u2w($state);
		}

		if (isset($street)) {
			$props[$properties[$type . "street"]] = $street = u2w($street);
		}

		// set composed address
		$address = Utils::BuildAddressString($street, $postalcode, $city, $state, $country);
		if ($address) {
			$props[$properties[$type . "address"]] = $address;
		}
	}

	/**
	 * Sets the properties for a mailing address.
	 *
	 * @param string $city
	 * @param string $country
	 * @param string $postalcode
	 * @param string $state
	 * @param string $street
	 * @param string $address
	 * @param array  &$props
	 * @param array  &$properties
	 *
	 * @return
	 */
	private function setMailingAddress($city, $country, $postalcode, $state, $street, $address, &$props, &$properties) {
		if (isset($city)) {
			$props[$properties["city"]] = $city;
		}
		if (isset($country)) {
			$props[$properties["country"]] = $country;
		}
		if (isset($postalcode)) {
			$props[$properties["postalcode"]] = $postalcode;
		}
		if (isset($state)) {
			$props[$properties["state"]] = $state;
		}
		if (isset($street)) {
			$props[$properties["street"]] = $street;
		}
		if (isset($address)) {
			$props[$properties["postaladdress"]] = $address;
		}
	}

	/**
	 * Sets data in a recurrence array.
	 *
	 * @param SyncObject $message
	 * @param array      &$recur
	 *
	 * @return
	 */
	private function setRecurrence($message, &$recur) {
		if (isset($message->complete)) {
			$recur["complete"] = $message->complete;
		}

		if (!isset($message->recurrence->interval)) {
			$message->recurrence->interval = 1;
		}

		// set the default value of numoccur
		$recur["numoccur"] = 0;
		// a place holder for recurrencetype property
		$recur["recurrencetype"] = 0;

		switch ($message->recurrence->type) {
			case 0:
				$recur["type"] = 10;
				if (isset($message->recurrence->dayofweek)) {
					$recur["subtype"] = 1;
				}
				else {
					$recur["subtype"] = 0;
				}

				$recur["everyn"] = $message->recurrence->interval * (60 * 24);
				$recur["recurrencetype"] = 1;
				break;

			case 1:
				$recur["type"] = 11;
				$recur["subtype"] = 1;
				$recur["everyn"] = $message->recurrence->interval;
				$recur["recurrencetype"] = 2;
				break;

			case 2:
				$recur["type"] = 12;
				$recur["subtype"] = 2;
				$recur["everyn"] = $message->recurrence->interval;
				$recur["recurrencetype"] = 3;
				break;

			case 3:
				$recur["type"] = 12;
				$recur["subtype"] = 3;
				$recur["everyn"] = $message->recurrence->interval;
				$recur["recurrencetype"] = 3;
				break;

			case 4:
				$recur["type"] = 13;
				$recur["subtype"] = 1;
				$recur["everyn"] = $message->recurrence->interval * 12;
				$recur["recurrencetype"] = 4;
				break;

			case 5:
				$recur["type"] = 13;
				$recur["subtype"] = 2;
				$recur["everyn"] = $message->recurrence->interval * 12;
				$recur["recurrencetype"] = 4;
				break;

			case 6:
				$recur["type"] = 13;
				$recur["subtype"] = 3;
				$recur["everyn"] = $message->recurrence->interval * 12;
				$recur["recurrencetype"] = 4;
				break;
		}

		// "start" and "end" are in GMT when passing to class.recurrence
		$recur["end"] = $this->getDayStartOfTimestamp(0x7FFFFFFF); // Maximum GMT value for end by default
		$recur["end"] = $this->getDayStartOfTimestamp(/** @scrutinizer ignore-type */ 0x7FFFFFFF); // Maximum GMT value for end by default

		if (isset($message->recurrence->until)) {
			$recur["term"] = 0x21;
			$recur["end"] = $message->recurrence->until;
		}
		elseif (isset($message->recurrence->occurrences)) {
			$recur["term"] = 0x22;
			$recur["numoccur"] = $message->recurrence->occurrences;
		}
		else {
			$recur["term"] = 0x23;
		}

		if (isset($message->recurrence->dayofweek)) {
			$recur["weekdays"] = $message->recurrence->dayofweek;
		}
		if (isset($message->recurrence->weekofmonth)) {
			$recur["nday"] = $message->recurrence->weekofmonth;
		}
		if (isset($message->recurrence->monthofyear)) {
			// MAPI stores months as the amount of minutes until the beginning of the month in a
			// non-leapyear. Why this is, is totally unclear.
			$monthminutes = [0, 44640, 84960, 129600, 172800, 217440, 260640, 305280, 348480, 393120, 437760, 480960];
			$recur["month"] = $monthminutes[$message->recurrence->monthofyear - 1];
		}
		if (isset($message->recurrence->dayofmonth)) {
			$recur["monthday"] = $message->recurrence->dayofmonth;
		}
	}

	/**
	 * Extracts the email address (mailbox@host) from an email address because
	 * some devices send email address as "Firstname Lastname" <[email protected]>.
	 *
	 *  @see http://developer.berlios.de/mantis/view.php?id=486
	 *
	 *  @param string           $email
	 *
	 *  @return string or false on error
	 */
	private function extractEmailAddress($email) {
		if (!isset($this->zRFC822)) {
			$this->zRFC822 = new Mail_RFC822();
		}
		$parsedAddress = $this->zRFC822->parseAddressList($email);
		if (!isset($parsedAddress[0]->mailbox) || !isset($parsedAddress[0]->host)) {
			return false;

		}

		return $parsedAddress[0]->mailbox . '@' . $parsedAddress[0]->host;
	}

	/**
	 * Returns the message body for a required format.
	 *
	 * @param MAPIMessage $mapimessage
filter:
    dependency_paths: ["lib/*"]
	 * @param int         $bpReturnType
	 * @param SyncObject  $message
	 *
	 * @return bool
	 */
	private function setMessageBodyForType($mapimessage, $bpReturnType, &$message) {
		$truncateHtmlSafe = false;
		// default value is PR_BODY
		$property = PR_BODY;


		switch ($bpReturnType) {
			case SYNC_BODYPREFERENCE_HTML:
				$property = PR_HTML;

				$truncateHtmlSafe = true;
				break;

			case SYNC_BODYPREFERENCE_RTF:
				$property = PR_RTF_COMPRESSED;

				break;

			case SYNC_BODYPREFERENCE_MIME:
				$stat = $this->imtoinet($mapimessage, $message);
				if (isset($message->asbody)) {
					$message->asbody->type = $bpReturnType;
				}

				return $stat;
		}

		$stream = mapi_openproperty($mapimessage, $property, IID_IStream, 0, 0);
		if ($stream) {
			$stat = mapi_stream_stat($stream);
			$streamsize = $stat['cb'];
		}
		else {
			$streamsize = 0;
		}

		// set the properties according to supported AS version
		if (Request::GetProtocolVersion() >= 12.0) {
			$message->asbody = new SyncBaseBody();
			$message->asbody->type = $bpReturnType;
			if ($bpReturnType == SYNC_BODYPREFERENCE_RTF) {
				$body = $this->mapiReadStream($stream, $streamsize);
				$message->asbody->data = StringStreamWrapper::Open(base64_encode($body));
			}
			elseif (isset($message->internetcpid) && $bpReturnType == SYNC_BODYPREFERENCE_HTML) {
				// if PR_HTML is UTF-8 we can stream it directly, else we have to convert to UTF-8 & wrap it
				if ($message->internetcpid == INTERNET_CPID_UTF8) {
					$message->asbody->data = MAPIStreamWrapper::Open($stream, $truncateHtmlSafe);
				}
				else {
					$body = $this->mapiReadStream($stream, $streamsize);
					$message->asbody->data = StringStreamWrapper::Open(Utils::ConvertCodepageStringToUtf8($message->internetcpid, $body), $truncateHtmlSafe);
					$message->internetcpid = INTERNET_CPID_UTF8;
				}
			}
			else {
				$message->asbody->data = MAPIStreamWrapper::Open($stream);
			}
			$message->asbody->estimatedDataSize = $streamsize;
		}
		else {
			$body = $this->mapiReadStream($stream, $streamsize);
			$message->body = str_replace("\n", "\r\n", w2u(str_replace("\r", "", $body)));
			$message->bodysize = $streamsize;
			$message->bodytruncated = 0;
		}

		return true;
	}

	/**
	 * Reads from a mapi stream, if it's set. If not, returns an empty string.
	 *
	 * @param resource $stream
	 * @param int      $size
	 *
	 * @return string
	 */
	private function mapiReadStream($stream, $size) {
		if (!$stream || $size == 0) {

			return "";
		}

		return mapi_stream_read($stream, $size);
	}

	/**
	 * A wrapper for mapi_inetmapi_imtoinet function.
	 *
	 * @param MAPIMessage $mapimessage
	 * @param SyncObject  $message
	 *
	 * @return bool
	 */
	private function imtoinet($mapimessage, &$message) {
		$addrbook = $this->getAddressbook();
		$stream = mapi_inetmapi_imtoinet($this->session, $addrbook, $mapimessage, ['use_tnef' => -1, 'ignore_missing_attachments' => 1]);
		if (is_resource($stream)) {
			$mstreamstat = mapi_stream_stat($stream);
			$streamsize = $mstreamstat["cb"];
			if (isset($streamsize)) {
				if (Request::GetProtocolVersion() >= 12.0) {
					if (!isset($message->asbody)) {
						$message->asbody = new SyncBaseBody();
					}
					$message->asbody->data = MAPIStreamWrapper::Open($stream);
					$message->asbody->data = MAPIStreamWrapper::Open(/** @scrutinizer ignore-type */ $stream);
					$message->asbody->estimatedDataSize = $streamsize;
					$message->asbody->truncated = 0;
				}
				else {
					$message->mimedata = MAPIStreamWrapper::Open($stream);
					$message->mimesize = $streamsize;
					$message->mimetruncated = 0;
				}
				unset($message->body, $message->bodytruncated);

				return true;
			}
		}
		SLog::Write(LOGLEVEL_ERROR, "MAPIProvider->imtoinet(): got no stream or content from mapi_inetmapi_imtoinet()");

		return false;
	}

	/**
	 * Sets the message body.
	 *
	 * @param MAPIMessage       $mapimessage
	 * @param ContentParameters $contentparameters
	 * @param SyncObject        $message
	 */
	private function setMessageBody($mapimessage, $contentparameters, &$message) {
		// get the available body preference types
		$bpTypes = $contentparameters->GetBodyPreference();
		if ($bpTypes !== false) {
			SLog::Write(LOGLEVEL_DEBUG, sprintf("BodyPreference types: %s", implode(', ', $bpTypes)));
			// do not send mime data if the client requests it
			if (($contentparameters->GetMimeSupport() == SYNC_MIMESUPPORT_NEVER) && ($key = array_search(SYNC_BODYPREFERENCE_MIME, $bpTypes) !== false)) {
				unset($bpTypes[$key]);
				SLog::Write(LOGLEVEL_DEBUG, sprintf("Remove mime body preference type because the device required no mime support. BodyPreference types: %s", implode(', ', $bpTypes)));
			}
			// get the best fitting preference type
			$bpReturnType = Utils::GetBodyPreferenceBestMatch($bpTypes);
			SLog::Write(LOGLEVEL_DEBUG, sprintf("GetBodyPreferenceBestMatch: %d", $bpReturnType));
			$bpo = $contentparameters->BodyPreference($bpReturnType);
			SLog::Write(LOGLEVEL_DEBUG, sprintf("bpo: truncation size:'%d', allornone:'%d', preview:'%d'", $bpo->GetTruncationSize(), $bpo->GetAllOrNone(), $bpo->GetPreview()));

			// Android Blackberry expects a full mime message for signed emails
			// @see https://jira.z-hub.io/projects/ZP/issues/ZP-1154
			// @TODO change this when refactoring
			$props = mapi_getprops($mapimessage, [PR_MESSAGE_CLASS]);

			if (isset($props[PR_MESSAGE_CLASS]) &&
					stripos($props[PR_MESSAGE_CLASS], 'IPM.Note.SMIME.MultipartSigned') !== false &&
					($key = array_search(SYNC_BODYPREFERENCE_MIME, $bpTypes) !== false)) {

				SLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIProvider->setMessageBody(): enforcing SYNC_BODYPREFERENCE_MIME type for a signed message"));
				$bpReturnType = SYNC_BODYPREFERENCE_MIME;
			}

			$this->setMessageBodyForType($mapimessage, $bpReturnType, $message);
			// only set the truncation size data if device set it in request
			if ($bpo->GetTruncationSize() != false &&
					$bpReturnType != SYNC_BODYPREFERENCE_MIME &&
					$message->asbody->estimatedDataSize > $bpo->GetTruncationSize()
				) {
				// Truncated plaintext requests are used on iOS for the preview in the email list. All images and links should be removed - see https://jira.z-hub.io/browse/ZP-1025
				if ($bpReturnType == SYNC_BODYPREFERENCE_PLAIN) {
					SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->setMessageBody(): truncated plain-text body requested, stripping all links and images");
					// Get more data because of the filtering it's most probably going down in size. It's going to be truncated to the correct size below.
					$plainbody = stream_get_contents($message->asbody->data, $bpo->GetTruncationSize() * 5);
					$message->asbody->data = StringStreamWrapper::Open(preg_replace('/<http(s){0,1}:\/\/.*?>/i', '', $plainbody));
				}

				// truncate data stream
				ftruncate($message->asbody->data, $bpo->GetTruncationSize());
				$message->asbody->truncated = 1;
			}
			// set the preview or windows phones won't show the preview of an email
			if (Request::GetProtocolVersion() >= 14.0 && $bpo->GetPreview()) {
				$message->asbody->preview = Utils::Utf8_truncate(MAPIUtils::readPropStream($mapimessage, PR_BODY), $bpo->GetPreview());

			}
		}
		else {
			// Override 'body' for truncation
			$truncsize = Utils::GetTruncSize($contentparameters->GetTruncation());
			$truncsize = Utils::GetTruncSize($contentparameters->/** @scrutinizer ignore-call */ GetTruncation());
			$this->setMessageBodyForType($mapimessage, SYNC_BODYPREFERENCE_PLAIN, $message);

			if ($message->bodysize > $truncsize) {
				$message->body = Utils::Utf8_truncate($message->body, $truncsize);
				$message->bodytruncated = 1;
			}

			if (!isset($message->body) || strlen($message->body) == 0) {
				$message->body = " ";
			}

			if ($contentparameters->GetMimeSupport() == SYNC_MIMESUPPORT_ALWAYS) {
				// set the html body for iphone in AS 2.5 version
				$this->imtoinet($mapimessage, $message);
			}
		}
	}

	/**
	 * Sets properties for an email message.
	 *
	 * @param mixed    $mapimessage
	 * @param SyncMail $message
	 */
	private function setFlag($mapimessage, &$message) {
		// do nothing if protocol version is lower than 12.0 as flags haven't been defined before
		if (Request::GetProtocolVersion() < 12.0) {
			return;
		}

		$message->flag = new SyncMailFlags();

		$this->getPropsFromMAPI($message->flag, $mapimessage, MAPIMapping::GetMailFlagsMapping());
	}

	/**
	 * Sets information from SyncBaseBody type for a MAPI message.
	 *
	 * @param SyncBaseBody $asbody
	 * @param array        $props
	 * @param array        $appointmentprops
	 */
	private function setASbody($asbody, &$props, $appointmentprops) {
		// TODO: fix checking for the length
		if (isset($asbody->type, $asbody->data)   /* && strlen($asbody->data) > 0 */) {
			switch ($asbody->type) {
				case SYNC_BODYPREFERENCE_PLAIN:
				default:
				// set plain body if the type is not in valid range
					$props[$appointmentprops["body"]] = stream_get_contents($asbody->data);
					break;

				case SYNC_BODYPREFERENCE_HTML:
					$props[$appointmentprops["html"]] = stream_get_contents($asbody->data);
					break;

				case SYNC_BODYPREFERENCE_RTF:
					break;

				case SYNC_BODYPREFERENCE_MIME:
					break;
			}
		}
		else {
			SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->setASbody either type or data are not set. Setting to empty body");
			$props[$appointmentprops["body"]] = "";
		}
	}

	/**
	 * Get MAPI addressbook object.
	 *
	 * @return MAPIAddressbook object to be used with mapi_ab_* or false on failure
filter:
    dependency_paths: ["lib/*"]
	 */
	private function getAddressbook() {
		if (isset($this->addressbook) && $this->addressbook) {
			return $this->addressbook;
		}
		$this->addressbook = mapi_openaddressbook($this->session);
		$result = mapi_last_hresult();
		if ($result && $this->addressbook === false) {
			SLog::Write(LOGLEVEL_ERROR, sprintf("MAPIProvider->getAddressbook error opening addressbook 0x%X", $result));

			return false;

		}

		return $this->addressbook;
	}

	/**
	 * Gets the required store properties.
	 *
	 * @return array
	 */
	public function GetStoreProps() {
		if (!isset($this->storeProps) || empty($this->storeProps)) {
			SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->GetStoreProps(): Getting store properties.");
			$this->storeProps = mapi_getprops($this->store, [PR_IPM_SUBTREE_ENTRYID, PR_IPM_OUTBOX_ENTRYID, PR_IPM_WASTEBASKET_ENTRYID, PR_IPM_SENTMAIL_ENTRYID, PR_ENTRYID, PR_IPM_PUBLIC_FOLDERS_ENTRYID, PR_IPM_FAVORITES_ENTRYID, PR_MAILBOX_OWNER_ENTRYID]);

			// make sure all properties are set
			if (!isset($this->storeProps[PR_IPM_WASTEBASKET_ENTRYID])) {
				$this->storeProps[PR_IPM_WASTEBASKET_ENTRYID] = false;
			}
			if (!isset($this->storeProps[PR_IPM_SENTMAIL_ENTRYID])) {
				$this->storeProps[PR_IPM_SENTMAIL_ENTRYID] = false;
			}
			if (!isset($this->storeProps[PR_IPM_OUTBOX_ENTRYID])) {
				$this->storeProps[PR_IPM_OUTBOX_ENTRYID] = false;
			}
			if (!isset($this->storeProps[PR_IPM_PUBLIC_FOLDERS_ENTRYID])) {
				$this->storeProps[PR_IPM_PUBLIC_FOLDERS_ENTRYID] = false;
			}
		}

		return $this->storeProps;
	}

	/**
	 * Gets the required inbox properties.
	 *
	 * @return array
	 */
	public function GetInboxProps() {
		if (!isset($this->inboxProps) || empty($this->inboxProps)) {
			SLog::Write(LOGLEVEL_DEBUG, "MAPIProvider->GetInboxProps(): Getting inbox properties.");
			$this->inboxProps = [];
			$inbox = mapi_msgstore_getreceivefolder($this->store);
			if ($inbox) {
				$this->inboxProps = mapi_getprops($inbox, [PR_ENTRYID, PR_IPM_DRAFTS_ENTRYID, PR_IPM_TASK_ENTRYID, PR_IPM_APPOINTMENT_ENTRYID, PR_IPM_CONTACT_ENTRYID, PR_IPM_NOTE_ENTRYID, PR_IPM_JOURNAL_ENTRYID]);

				// make sure all properties are set
				if (!isset($this->inboxProps[PR_ENTRYID])) {
					$this->inboxProps[PR_ENTRYID] = false;
				}
				if (!isset($this->inboxProps[PR_IPM_DRAFTS_ENTRYID])) {
					$this->inboxProps[PR_IPM_DRAFTS_ENTRYID] = false;
				}
				if (!isset($this->inboxProps[PR_IPM_TASK_ENTRYID])) {
					$this->inboxProps[PR_IPM_TASK_ENTRYID] = false;
				}
				if (!isset($this->inboxProps[PR_IPM_APPOINTMENT_ENTRYID])) {
					$this->inboxProps[PR_IPM_APPOINTMENT_ENTRYID] = false;
				}
				if (!isset($this->inboxProps[PR_IPM_CONTACT_ENTRYID])) {
					$this->inboxProps[PR_IPM_CONTACT_ENTRYID] = false;
				}
				if (!isset($this->inboxProps[PR_IPM_NOTE_ENTRYID])) {
					$this->inboxProps[PR_IPM_NOTE_ENTRYID] = false;
				}
				if (!isset($this->inboxProps[PR_IPM_JOURNAL_ENTRYID])) {
					$this->inboxProps[PR_IPM_JOURNAL_ENTRYID] = false;
				}
			}
		}

		return $this->inboxProps;
	}

	/**
	 * Gets the required store root properties.
	 *
	 * @return array
	 */
	private function getRootProps() {
		if (!isset($this->rootProps)) {
			$root = mapi_msgstore_openentry($this->store, null);
			$this->rootProps = mapi_getprops($root, [PR_ADDITIONAL_REN_ENTRYIDS_EX]);

		}

		return $this->rootProps;
	}

	/**
	 * Returns an array with entryids of some special folders.
	 *
	 * @return array
	 */
	private function getSpecialFoldersData() {
		// The persist data of an entry in PR_ADDITIONAL_REN_ENTRYIDS_EX consists of:
		//      PersistId - e.g. RSF_PID_SUGGESTED_CONTACTS (2 bytes)
		//      DataElementsSize - size of DataElements field (2 bytes)
		//      DataElements - array of PersistElement structures (variable size)
		//          PersistElement Structure consists of
		//              ElementID - e.g. RSF_ELID_ENTRYID (2 bytes)
		//              ElementDataSize - size of ElementData (2 bytes)
		//              ElementData - The data for the special folder identified by the PersistID (variable size)
		if (empty($this->specialFoldersData)) {
			$this->specialFoldersData = [];
			$rootProps = $this->getRootProps();
			if (isset($rootProps[PR_ADDITIONAL_REN_ENTRYIDS_EX])) {

				$persistData = $rootProps[PR_ADDITIONAL_REN_ENTRYIDS_EX];
				while (strlen($persistData) > 0) {
					// PERSIST_SENTINEL marks the end of the persist data
					if (strlen($persistData) == 4 && $persistData == PERSIST_SENTINEL) {
						break;
					}
					$unpackedData = unpack("vdataSize/velementID/velDataSize", substr($persistData, 2, 6));
					if (isset($unpackedData['dataSize'], $unpackedData['elementID']) && $unpackedData['elementID'] == RSF_ELID_ENTRYID && isset($unpackedData['elDataSize'])) {
						$this->specialFoldersData[] = substr($persistData, 8, $unpackedData['elDataSize']);
						// Add PersistId and DataElementsSize lengths to the data size as they're not part of it
						$persistData = substr($persistData, $unpackedData['dataSize'] + 4);
					}
					else {
						SLog::Write(LOGLEVEL_INFO, "MAPIProvider->getSpecialFoldersData(): persistent data is not valid");
						break;
					}
				}
			}
		}

		return $this->specialFoldersData;
	}

	/**
	 * Extracts email address from PR_SEARCH_KEY property if possible.
	 *
	 * @param string $searchKey
	 *
	 * @see https://jira.z-hub.io/browse/ZP-1178
	 *
	 * @return string
	 */
	private function getEmailAddressFromSearchKey($searchKey) {
		if (strpos($searchKey, ':') !== false && strpos($searchKey, '@') !== false) {
			SLog::Write(LOGLEVEL_INFO, "MAPIProvider->getEmailAddressFromSearchKey(): fall back to PR_SEARCH_KEY or PR_SENT_REPRESENTING_SEARCH_KEY to resolve user and get email address");

			return trim(strtolower(explode(':', $searchKey)[1]));
		}

		return "";
	}

	/**
	 * Returns categories for a message.
	 *
	 * @param binary $parentsourcekey
	 * @param binary $sourcekey
	 *
	 * @return array or false on failure
	 */
	public function GetMessageCategories($parentsourcekey, $sourcekey) {
		$entryid = mapi_msgstore_entryidfromsourcekey($this->store, $parentsourcekey, $sourcekey);
		if (!$entryid) {
			SLog::Write(LOGLEVEL_INFO, sprintf("MAPIProvider->GetMessageCategories(): Couldn't retrieve message, sourcekey: '%s', parentsourcekey: '%s'", bin2hex($sourcekey), bin2hex($parentsourcekey)));

			return false;

		}
		$mapimessage = mapi_msgstore_openentry($this->store, $entryid);
		$emailMapping = MAPIMapping::GetEmailMapping();
		$emailMapping = ["categories" => $emailMapping["categories"]];
		$messageCategories = $this->getProps($mapimessage, $emailMapping);
		if (isset($messageCategories[$emailMapping["categories"]]) && is_array($messageCategories[$emailMapping["categories"]])) {
			return $messageCategories[$emailMapping["categories"]];
		}

		return false;

	}
}

grommunio / grommunio-sync

Push — master ( bc722f...03cdb2 )

MAPIProvider::getPropIdsFromStrings() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
