<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace KTXF\Mail\Collection;

use KTXF\Resource\Provider\Node\NodePropertiesBaseInterface;

interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface {

	public const JSON_TYPE = 'mail.collection';
	public const JSON_PROPERTY_TOTAL = 'total';
	public const JSON_PROPERTY_UNREAD = 'unread';
	public const JSON_PROPERTY_LABEL = 'label';
	public const JSON_PROPERTY_ROLE = 'role';
	public const JSON_PROPERTY_RANK = 'rank';
	public const JSON_PROPERTY_SUBSCRIPTION = 'subscription';

	public function total(): int;

	public function unread(): int;

	public function getLabel(): string;

	public function getRole(): CollectionRoles;

	public function getRank(): int;
    
	public function getSubscription(): bool;
}