src/MailboxInterface.php

Defines IMAP mailbox interface with methods for message handling.

// Source: https://github.com/ddeboer/imap | License: MIT | Copyright 2013 David de Boer <david@ddeboer.nl>
// Provided via justclaw.it.com; keep this notice with the code.
<?php

declare(strict_types=1);

namespace Ddeboer\Imap;

use Ddeboer\Imap\Message\PartInterface;
use Ddeboer\Imap\Search\ConditionInterface;

/**
 * An IMAP mailbox (commonly referred to as a 'folder').
 *
 * @extends \IteratorAggregate<int, MessageInterface>
 */
interface MailboxInterface extends \Countable, \IteratorAggregate
{
    /**
     * Get mailbox decoded name.
     */
    public function getName(): string;

    /**
     * Set new mailbox name.
     */
    public function renameTo(string $name): bool;

    /**
     * Get mailbox encoded path.
     */
    public function getEncodedName(): string;

    /**
     

... (truncated -- full source via MCP)