grommunio / grommunio-web

server/includes/modules/class.contactitemmodule.php

<?php

/**
 * Contact ItemModule
 * Module which opens, creates, saves and deletes an item. It
 * extends the Module class.
 */
class ContactItemModule extends ItemModule {
	/**
	 * Constructor.
	 *
	 * @param int   $id   unique id
	 * @param array $data list of all actions
	 */
	public function __construct($id, $data) {
		$this->properties = $GLOBALS['properties']->getContactProperties();

		parent::__construct($id, $data);

		$this->plaintext = true;
	}

	/**
	 * Function which opens an item.
	 *
	 * @param object $store   MAPI Message Store Object
	 * @param string $entryid entryid of the message
	 * @param array  $action  the action data, sent by the client
	 */
	#[Override]
	public function open($store, $entryid, $action) {
		$data = [];
		$orEntryid = $entryid;

		if ($entryid) {
			// Check if OneOff entryid is a local contact
			if ($GLOBALS['entryid']->hasAddressBookOneOff(bin2hex($entryid))) {
				try {
					$oneoff = mapi_parseoneoff($entryid);
					$ab = $GLOBALS['mapisession']->getAddressbook();
					$ab_dir = mapi_ab_openentry($ab);
					$res = $this->searchContactsFolders($ab, $ab_dir, $oneoff['address']);
					if (count($res) > 0) {
						$entryid = $res[0][PR_ENTRYID];
					}
				}
				catch (MAPIException $ex) {
					error_log(sprintf(
						"Unable to open contact because mapi_parseoneoff failed: %s - %s",
						get_mapi_error_name($ex->getCode()),
						$ex->getDisplayMessage()
					));
				}
			}
			/* Check if given entryid is shared folder distlist then
			* get the store of distlist for fetching it's members.
			*/
			$storeData = $this->getStoreParentEntryIdFromEntryId($entryid);
			$store = $storeData["store"];
			$message = $storeData["message"];
		}

		if (empty($message)) {
			return;
		}

		// Open embedded message if requested
		$attachNum = !empty($action['attach_num']) ? $action['attach_num'] : false;
		if ($attachNum) {
			// get message props of sub message
			$parentMessage = $message;

The variable $message does not seem to be defined for all execution paths leading up to this point.

			$message = $GLOBALS['operations']->openMessage($store, $entryid, $attachNum);

			if (empty($message)) {
				return;
			}

			// Check if message is distlist then we need to use different set of properties
			$props = mapi_getprops($message, [PR_MESSAGE_CLASS]);

			if (stripos((string) $props[PR_MESSAGE_CLASS], 'IPM.Distlist') !== false) {
				// for distlist we need to use different set of properties
				$this->properties = $GLOBALS['properties']->getDistListProperties();
			}

			$data['item'] = $GLOBALS['operations']->getEmbeddedMessageProps($store, $message, $this->properties, $parentMessage, $attachNum);
		}
		else {
			// Check if message is distlist then we need to use different set of properties
			$props = mapi_getprops($message, [PR_MESSAGE_CLASS]);

			if (stripos((string) $props[PR_MESSAGE_CLASS], 'IPM.Distlist') !== false) {
				// for distlist we need to use different set of properties
				$this->properties = $GLOBALS['properties']->getDistListProperties();
			}

			// get message props of the message
			$data['item'] = $GLOBALS['operations']->getMessageProps($store, $message, $this->properties, $this->plaintext);
		}

		// By openentry from address book, the entryid will differ, make it same as the origin
		$data['item']['entryid'] = bin2hex($orEntryid);

		// Allowing to hook in just before the data sent away to be sent to the client
		$GLOBALS['PluginManager']->triggerHook('server.module.contactitemmodule.open.after', [
			'moduleObject' => &$this,
			'store' => $store,
			'entryid' => $entryid,
			'action' => $action,
			'message' => &$message,
			'data' => &$data,
		]);

		$this->addActionData('item', $data);
		$GLOBALS['bus']->addData($this->getResponseData());
	}

	/**
	 * Function which saves an item. It sets the right properties for a contact
	 * item (address book properties).
	 *
	 * @param object $store         MAPI Message Store Object
	 * @param string $parententryid parent entryid of the message
	 * @param string $entryid       entryid of the message
	 * @param array  $action        the action data, sent by the client
	 */
	#[Override]
	public function save($store, $parententryid, $entryid, $action) {
		$properiesToDelete = []; // create an array of properties which should be deleted
		// this array is passed to $GLOBALS['operations']->saveMessage() function

		if (!$store && !$parententryid) {

$store is of type object, thus it always evaluated to true.

			if (isset($action['props']['message_class'])) {
				$store = $GLOBALS['mapisession']->getDefaultMessageStore();
				$parententryid = $this->getDefaultFolderEntryID($store, $action['props']['message_class']);
			}
			elseif ($entryid) {
				$data = $this->getStoreParentEntryIdFromEntryId($entryid);
				$store = $data["store"];
				$parententryid = $data["parent_entryid"];
			}
		}
		elseif (!$parententryid) {
			if (isset($action['props']['message_class'])) {
				$parententryid = $this->getDefaultFolderEntryID($store, $action['props']['message_class']);
			}
		}

		if ($store && $parententryid && isset($action['props'])) {
			if (isset($action['members'])) {
				// DistList

				// for distlist we need to use different set of properties
				$this->properties = $GLOBALS['properties']->getDistListProperties();

				// do conversion of client data
				$props = Conversion::mapXML2MAPI($this->properties, $action['props']);

				// collect members
				$members = [];
				$oneoff_members = [];

				$items = $action['members'];

				foreach ($items as $item) {
					if (empty($item['email_address'])) {
						// if no email address is given then mapi_parseoneoff fails, so always give
						// email address, OL07 uses Unknown as email address so we do same here
						$item['email_address'] = 'Unknown';
					}

					$oneoff = mapi_createoneoff($item['display_name'], $item['address_type'], $item['email_address']);

					if ($item['distlist_type'] == DL_EXTERNAL_MEMBER) {
						$member = $oneoff;
					}
					else {
						$parts = [];
						$parts['distlist_guid'] = WAB_GUID;
						$parts['distlist_type'] = $item['distlist_type'];
						$parts['entryid'] = hex2bin((string) $item['entryid']);
						$member = pack('VA16CA*', 0, $parts['distlist_guid'], $parts['distlist_type'], $parts['entryid']);
					}

					$oneoff_members[] = $oneoff;
					$members[] = $member;
				}

				if (!empty($members) && !empty($oneoff_members)) {
					$props[$this->properties['members']] = $members;
					$props[$this->properties['oneoff_members']] = $oneoff_members;
				}
				else {
					$properiesToDelete[] = $this->properties['members'];
					$properiesToDelete[] = $this->properties['oneoff_members'];
				}

				unset($action['members']);
			}
			else {
				// Contact

				$isCopyGABToContact = isset($action["message_action"], $action["message_action"]["action_type"]) &&

				$action["message_action"]["action_type"] === "copyToContact";

				if ($isCopyGABToContact) {
					$this->copyGABRecordProps($action);
				}
				// generate one-off entryids for email addresses
				for ($index = 1; $index < 4; ++$index) {
					if (!empty($action['props']['email_address_' . $index]) && !empty($action['props']['email_address_display_name_' . $index])) {
						$action['props']['email_address_entryid_' . $index] = bin2hex(mapi_createoneoff($action['props']['email_address_display_name_' . $index], $action['props']['email_address_type_' . $index], $action['props']['email_address_' . $index]));
					}
				}

				// set properties for primary fax number
				if (isset($action['props']['fax_1_email_address']) && !empty($action['props']['fax_1_email_address'])) {
					$action['props']['fax_1_original_entryid'] = bin2hex(mapi_createoneoff($action['props']['fax_1_original_display_name'], $action['props']['fax_1_address_type'], $action['props']['fax_1_email_address'], MAPI_UNICODE));
				}
				else {
					// delete properties to remove previous values
					$properiesToDelete[] = $this->properties['fax_1_address_type'];
					$properiesToDelete[] = $this->properties['fax_1_original_display_name'];
					$properiesToDelete[] = $this->properties['fax_1_email_address'];
					$properiesToDelete[] = $this->properties['fax_1_original_entryid'];
				}

				// set properties for business fax number
				if (isset($action['props']['fax_2_email_address']) && !empty($action['props']['fax_2_email_address'])) {
					$action['props']['fax_2_original_entryid'] = bin2hex(mapi_createoneoff($action['props']['fax_2_original_display_name'], $action['props']['fax_2_address_type'], $action['props']['fax_2_email_address'], MAPI_UNICODE));
				}
				else {
					$properiesToDelete[] = $this->properties['fax_2_address_type'];
					$properiesToDelete[] = $this->properties['fax_2_original_display_name'];
					$properiesToDelete[] = $this->properties['fax_2_email_address'];
					$properiesToDelete[] = $this->properties['fax_2_original_entryid'];
				}

				// set properties for home fax number
				if (isset($action['props']['fax_3_email_address']) && !empty($action['props']['fax_3_email_address'])) {
					$action['props']['fax_3_original_entryid'] = bin2hex(mapi_createoneoff($action['props']['fax_3_original_display_name'], $action['props']['fax_3_address_type'], $action['props']['fax_3_email_address'], MAPI_UNICODE));
				}
				else {
					$properiesToDelete[] = $this->properties['fax_3_address_type'];
					$properiesToDelete[] = $this->properties['fax_3_original_display_name'];
					$properiesToDelete[] = $this->properties['fax_3_email_address'];
					$properiesToDelete[] = $this->properties['fax_3_original_entryid'];
				}

				// check for properties which should be deleted
				if (isset($action['entryid']) && !empty($action['entryid'])) {
					// check for empty email address properties
					for ($i = 1; $i < 4; ++$i) {
						if (isset($action['props']['email_address_' . $i]) && empty($action['props']['email_address_' . $i])) {
							array_push($properiesToDelete, $this->properties['email_address_entryid_' . $i]);
							array_push($properiesToDelete, $this->properties['email_address_' . $i]);
							array_push($properiesToDelete, $this->properties['email_address_display_name_' . $i]);
							array_push($properiesToDelete, $this->properties['email_address_display_name_email_' . $i]);
							array_push($properiesToDelete, $this->properties['email_address_type_' . $i]);
						}
					}

					// check for empty address_book_mv and address_book_long properties
					if (isset($action['props']['address_book_long']) && $action['props']['address_book_long'] === 0) {
						$properiesToDelete[] = $this->properties['address_book_mv'];
						$properiesToDelete[] = $this->properties['address_book_long'];
					}

					// Check if the birthday and anniversary properties are empty. If so delete them.
					if (array_key_exists('birthday', $action['props']) && empty($action['props']['birthday'])) {
						array_push($properiesToDelete, $this->properties['birthday']);
						array_push($properiesToDelete, $this->properties['birthday_eventid']);
						if (!empty($action['props']['birthday_eventid'])) {
							$this->deleteSpecialDateAppointment($store, $action['props']['birthday_eventid']);
						}
					}

					if (array_key_exists('wedding_anniversary', $action['props']) && empty($action['props']['wedding_anniversary'])) {
						array_push($properiesToDelete, $this->properties['wedding_anniversary']);
						array_push($properiesToDelete, $this->properties['anniversary_eventid']);
						if (!empty($action['props']['anniversary_eventid'])) {
							$this->deleteSpecialDateAppointment($store, $action['props']['anniversary_eventid']);
						}
					}
				}

				/*
				 * convert all line endings(LF) into CRLF
				 * XML parser will normalize all CR, LF and CRLF into LF
				 * but outlook(windows) uses CRLF as line ending
				 */
				if (isset($action['props']['business_address'])) {
					$action['props']['business_address'] = str_replace('\n', '\r\n', $action['props']['business_address']);
				}

				if (isset($action['props']['home_address'])) {
					$action['props']['home_address'] = str_replace('\n', '\r\n', $action['props']['home_address']);
				}

				if (isset($action['props']['other_address'])) {
					$action['props']['other_address'] = str_replace('\n', '\r\n', $action['props']['other_address']);
				}

				// check birthday props to make an appointment
				if (!empty($action['props']['birthday'])) {
					$action['props']['birthday_eventid'] = $this->updateAppointments($store, $action, 'birthday');
				}

				// check anniversary props to make an appointment
				if (!empty($action['props']['wedding_anniversary'])) {
					$action['props']['anniversary_eventid'] = $this->updateAppointments($store, $action, 'wedding_anniversary');
				}

				// do the conversion when all processing has been finished
				$props = Conversion::mapXML2MAPI($this->properties, $action['props']);
			}

			$messageProps = [];

			$result = $GLOBALS['operations']->saveMessage($store, $entryid, $parententryid, $props, $messageProps, [], $action['attachments'] ?? [], $properiesToDelete);

			if ($result) {
				$GLOBALS['bus']->notify(bin2hex($parententryid), TABLE_SAVE, $messageProps);

				if ($isCopyGABToContact) {

The variable $isCopyGABToContact does not seem to be defined for all execution paths leading up to this point.

					$message = mapi_msgstore_openentry($store, $messageProps[PR_ENTRYID]);
					$messageProps = mapi_getprops($message, $this->properties);
				}

				$this->addActionData('update', ['item' => Conversion::mapMAPI2XML($this->properties, $messageProps)]);
				$GLOBALS['bus']->addData($this->getResponseData());
			}
		}
	}

	/**
	 * Function copy the some property from address book record to contact props.
	 *
	 * @param array $action the action data, sent by the client
	 */
	public function copyGABRecordProps(&$action) {
		$addrbook = $GLOBALS["mapisession"]->getAddressbook();
		$abitem = mapi_ab_openentry($addrbook, hex2bin((string) $action["message_action"]["source_entryid"]));
		$abItemProps = mapi_getprops($abitem, [
			PR_COMPANY_NAME,
			PR_ASSISTANT,
			PR_BUSINESS_TELEPHONE_NUMBER,
			PR_BUSINESS2_TELEPHONE_NUMBER,
			PR_HOME2_TELEPHONE_NUMBER,
			PR_STREET_ADDRESS,
			PR_LOCALITY,
			PR_STATE_OR_PROVINCE,
			PR_POSTAL_CODE,
			PR_COUNTRY,
			PR_MOBILE_TELEPHONE_NUMBER,
		]);
		$action["props"]["company_name"] = $abItemProps[PR_COMPANY_NAME] ?? '';
		$action["props"]["assistant"] = $abItemProps[PR_ASSISTANT] ?? '';
		$action["props"]["business_telephone_number"] = $abItemProps[PR_BUSINESS_TELEPHONE_NUMBER] ?? '';
		$action["props"]["business2_telephone_number"] = $abItemProps[PR_BUSINESS2_TELEPHONE_NUMBER] ?? '';
		$action["props"]["home2_telephone_number"] = $abItemProps[PR_HOME2_TELEPHONE_NUMBER] ?? '';
		$action["props"]["home_address_street"] = $abItemProps[PR_STREET_ADDRESS] ?? '';
		$action["props"]["home_address_city"] = $abItemProps[PR_LOCALITY] ?? '';
		$action["props"]["home_address_state"] = $abItemProps[PR_STATE_OR_PROVINCE] ?? '';
		$action["props"]["home_address_postal_code"] = $abItemProps[PR_POSTAL_CODE] ?? '';
		$action["props"]["home_address_country"] = $abItemProps[PR_COUNTRY] ?? '';

		$action["props"]["cellular_telephone_number"] = $abItemProps[PR_MOBILE_TELEPHONE_NUMBER] ?? '';

		// Set the home_address property value
		$props = ["street", "city", "state", "postal_code", "country"];
		$homeAddress = "";
		foreach ($props as $index => $prop) {
			if (isset($action["props"]["home_address_" . $prop]) && !empty($action["props"]["home_address_" . $prop])) {
				$homeAddress .= $action["props"]["home_address_" . $prop] . " ";
				if ($prop == "street" || $prop == "postal_code") {
					$homeAddress .= PHP_EOL;
				}
			}
		}

		$action["props"]["home_address"] = $homeAddress;
	}

	/**
	 * Function which deletes an item. Extended here to also delete corresponding birthday/anniversary
	 * appointments from calendar.
	 *
	 * @param object $store         MAPI Message Store Object
	 * @param string $parententryid parent entryid of the message
	 * @param string $entryid       entryid of the message
	 * @param array  $action        the action data, sent by the client
	 */
	#[Override]
	public function delete($store, $parententryid, $entryid, $action) {
		$message = false;
		if (!$store && !$parententryid && $entryid) {

$store is of type object, thus it always evaluated to true.

			$data = $this->getStoreParentEntryIdFromEntryId($entryid);
			$store = $data["store"];
			$message = $data["message"];
			$parententryid = $data["parent_entryid"];
		}

		if ($store && $entryid) {
			try {
				if ($message === false) {

The condition $message === false is always true.

					$message = $GLOBALS["operations"]->openMessage($store, $entryid);
				}

				$props = mapi_getprops($message, [$this->properties['anniversary_eventid'], $this->properties['birthday_eventid']]);

				// if any of the appointment entryid exists then delete it
				if (!empty($props[$this->properties['birthday_eventid']])) {
					$this->deleteSpecialDateAppointment($store, bin2hex((string) $props[$this->properties['birthday_eventid']]));
				}

				if (!empty($props[$this->properties['anniversary_eventid']])) {
					$this->deleteSpecialDateAppointment($store, bin2hex((string) $props[$this->properties['anniversary_eventid']]));
				}
			}
			catch (MAPIException $e) {
				// if any error occurs in deleting appointments then we shouldn't block deletion of contact item
				// so ignore errors now
				$e->setHandled();
			}

			parent::delete($store, $parententryid, $entryid, $action);
		}
	}

	/**
	 * Function which retrieve the store, parent_entryid from record entryid.
	 *
	 * @param $entryid entryid of the message
	 *
	 * @return array which contains store and message object and parent entryid of that message
	 */
	public function getStoreParentEntryIdFromEntryId($entryid) {
		$message = $GLOBALS['mapisession']->openMessage($entryid);
		$messageStoreInfo = mapi_getprops($message, [PR_STORE_ENTRYID, PR_PARENT_ENTRYID]);
		$store = $GLOBALS['mapisession']->openMessageStore($messageStoreInfo[PR_STORE_ENTRYID]);
		$parentEntryid = $messageStoreInfo[PR_PARENT_ENTRYID];

		return ["message" => $message, "store" => $store, "parent_entryid" => $parentEntryid];
	}

	/**
	 * Function will create/update a yearly recurring appointment on the respective date of birthday or anniversary in user's calendar.
	 *
	 * @param object $store  MAPI Message Store Object
	 * @param array  $action the action data, sent by the client
	 * @param string $type   type of appointment that should be created/updated, valid values are 'birthday' and 'wedding_anniversary'
	 *
	 * @return HexString entryid of the newly created appointment in hex format

The type HexString was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	public function updateAppointments($store, $action, $type) {
		$result = false;

		$root = mapi_msgstore_openentry($store);
		$rootProps = mapi_getprops($root, [PR_IPM_APPOINTMENT_ENTRYID, PR_STORE_ENTRYID]);
		$parentEntryId = bin2hex((string) $rootProps[PR_IPM_APPOINTMENT_ENTRYID]);
		$storeEntryId = bin2hex((string) $rootProps[PR_STORE_ENTRYID]);

		$actionProps = $action['props'];
		$subject = !empty($actionProps['subject']) ? $actionProps['subject'] : _('Untitled');
		$subject = ($type === 'birthday' ? sprintf(_('%s\'s Birthday'), $subject) : sprintf(_('%s\'s Anniversary'), $subject));

		// UTC time
		$startDateUTC = $actionProps[$type];
		$dueDateUTC = $actionProps[$type] + (24 * 60 * 60); // ONE DAY is added to set duedate of item.

		// get local time from UTC time
		$recur = new Recurrence($store, []);

The type Recurrence was not found. Maybe you did not declare it correctly or list all dependencies?

		$startDate = $recur->fromGMT($actionProps, $startDateUTC);
		$dueDate = $recur->fromGMT($actionProps, $dueDateUTC);

		// Find the number of minutes since the start of the year to the given month,
		// taking leap years into account.
		$month = date('m', $startDate);
		$year = date('y', $startDate);

		$d1 = new DateTime();
		$d1->setDate($year, 1, 1);

$year of type string is incompatible with the type integer expected by parameter $year of DateTime::setDate().

		$d2 = new DateTime();
		$d2->setDate($year, $month, 1);

$month of type string is incompatible with the type integer expected by parameter $month of DateTime::setDate().

		$diff = $d2->diff($d1);
		$month = $diff->days * 24 * 60;

		$props = [
			'message_class' => 'IPM.Appointment',
			'icon_index' => 1025,
			'busystatus' => fbFree,
			'meeting' => olNonMeeting,
			'object_type' => MAPI_MESSAGE,
			'message_flags' => MSGFLAG_READ | MSGFLAG_UNSENT,
			'subject' => $subject,

			'startdate' => $startDateUTC,
			'duedate' => $dueDateUTC,
			'commonstart' => $startDateUTC,
			'commonend' => $dueDateUTC,
			'alldayevent' => true,
			'duration' => 1440,
			'reminder' => true,
			'reminder_minutes' => 1080,
			'reminder_time' => $startDateUTC,
			'flagdueby' => $startDateUTC - (1080 * 60),

			'recurring' => true,
			'recurring_reset' => true,
			'startocc' => 0,
			'endocc' => 1440,
			'start' => $startDate,
			'end' => $dueDate,
			'term' => 35,
			'everyn' => 12,
			'subtype' => 2,
			'type' => 13,
			'regen' => 0,
			'month' => $month,
			'monthday' => date('j', $startDate),
			'timezone' => $actionProps['timezone'],
			'timezonedst' => $actionProps['timezonedst'],
			'dststartmonth' => $actionProps['dststartmonth'],
			'dststartweek' => $actionProps['dststartweek'],
			'dststartday' => $actionProps['dststartday'],
			'dststarthour' => $actionProps['dststarthour'],
			'dstendmonth' => $actionProps['dstendmonth'],
			'dstendweek' => $actionProps['dstendweek'],
			'dstendday' => $actionProps['dstendday'],
			'dstendhour' => $actionProps['dstendhour'],
		];

		$data = [];
		$data['store'] = $storeEntryId;
		$data['parententryid'] = $parentEntryId;

		$entryid = false;
		// if entryid is provided then update existing appointment, else create new one
		if ($type === 'birthday' && !empty($actionProps['birthday_eventid'])) {
			$entryid = $actionProps['birthday_eventid'];
		}
		elseif ($type === 'wedding_anniversary' && !empty($actionProps['anniversary_eventid'])) {
			$entryid = $actionProps['anniversary_eventid'];
		}

		if ($entryid !== false) {
			$data['entryid'] = $entryid;
		}

		if (isset($action['timezone_iana'])) {
			$props['timezone_iana'] = $action['timezone_iana'];
		}

		$data['props'] = $props;

		// Save appointment (saveAppointment takes care of creating/modifying exceptions to recurring
		// items if necessary)
		try {
			$messageProps = $GLOBALS['operations']->saveAppointment($store, hex2bin((string) $entryid), hex2bin($parentEntryId), $data);
		}
		catch (MAPIException $e) {
			// if the appointment is deleted then create a new one
			if ($e->getCode() == MAPI_E_NOT_FOUND) {
				$e->setHandled();
				$messageProps = $GLOBALS['operations']->saveAppointment($store, false, hex2bin($parentEntryId), $data);
			}
		}

		// Notify the bus if the save was OK
		if ($messageProps && !(is_array($messageProps) && isset($messageProps['error']))) {
			$GLOBALS['bus']->notify($parentEntryId, TABLE_SAVE, $messageProps);
			$result = bin2hex((string) $messageProps[PR_ENTRYID]);
		}

		return $result;

The expression return $result returns the type false|string which is incompatible with the documented return type HexString.

	}

	/**
	 * Function will delete the appointment on the respective date of birthday or anniversary in user's calendar.
	 *
	 * @param object $store   MAPI Message Store Object
	 * @param        $entryid of the message with will be deleted,sent by the client

The type of was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	public function deleteSpecialDateAppointment($store, $entryid) {
		$root = mapi_msgstore_openentry($store);
		$rootProps = mapi_getprops($root, [PR_IPM_APPOINTMENT_ENTRYID, PR_STORE_ENTRYID]);
		$parentEntryId = $rootProps[PR_IPM_APPOINTMENT_ENTRYID];
		$storeEntryId = $rootProps[PR_STORE_ENTRYID];

		$props = [];
		$props[PR_PARENT_ENTRYID] = $parentEntryId;
		$props[PR_ENTRYID] = hex2bin((string) $entryid);
		$props[PR_STORE_ENTRYID] = $storeEntryId;

		$result = $GLOBALS['operations']->deleteMessages($store, $parentEntryId, $props[PR_ENTRYID]);

		if ($result) {
			$GLOBALS['bus']->notify(bin2hex((string) $parentEntryId), TABLE_DELETE, $props);
		}
	}

	/**
	 * This function searches the private contact folders for users and returns an array with data.
	 * Please note that the returning array must be UTF8.
	 *
	 * @param resource $ab        The addressbook
	 * @param resource $ab_dir    The addressbook container
	 * @param string   $searchstr The search query, case is ignored
	 */
	public function searchContactsFolders($ab, $ab_dir, $searchstr) {
		$r = [];
		$abhtable = mapi_folder_gethierarchytable($ab_dir, MAPI_DEFERRED_ERRORS | CONVENIENT_DEPTH);
		$abcntfolders = mapi_table_queryallrows($abhtable, [PR_ENTRYID, PR_AB_PROVIDER_ID, PR_DISPLAY_NAME]);
		$restriction = [
			RES_CONTENT,
			[
				FUZZYLEVEL => FL_SUBSTRING | FL_IGNORECASE,
				ULPROPTAG => PR_SMTP_ADDRESS,
				VALUE => [PR_SMTP_ADDRESS => $searchstr],
			],
		];
		// restriction on hierarchy table for PR_AB_PROVIDER_ID
		// seems not to work, just loop through
		foreach ($abcntfolders as $abcntfolder) {
			if ($abcntfolder[PR_AB_PROVIDER_ID] == ZARAFA_CONTACTS_GUID) {
				$abfldentry = mapi_ab_openentry($ab, $abcntfolder[PR_ENTRYID]);
				$abfldcontents = mapi_folder_getcontentstable($abfldentry);
				mapi_table_restrict($abfldcontents, $restriction);
				$r = mapi_table_queryallrows($abfldcontents, [PR_ENTRYID]);
				if (is_array($r) && !empty($r)) {
					return $r;
				}
			}
		}

		return $r;
	}
}