Clean up searching for messages (#2058)

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>

1 files changed, 43 insertions, 0 deletions

diff --git a/lib/Contracts/IMailSearch.php b/lib/Contracts/IMailSearch.php
new file mode 100644
index 000000000..43299907c
--- /dev/null
+++ b/lib/Contracts/IMailSearch.php
@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+
+/**
+ * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCA\Mail\Contracts;
+
+use OCA\Mail\Account;
+use OCA\Mail\Exception\ServiceException;
+use OCA\Mail\Model\IMAPMessage;
+
+interface IMailSearch {
+
+	/**
+	 * @param Account $account
+	 * @param string $mailboxName
+	 * @param string|null $filter
+	 * @param string|null $cursor
+	 *
+	 * @return IMAPMessage[]
+	 * @throws ServiceException
+	 */
+	public function findMessages(Account $account, string $mailboxName, ?string $filter, ?int $cursor): array;
+
+}