provider_imap/lib/Client/Protocol/Command/NoopCommand.php

<?php

declare(strict_types=1);

namespace KTXM\ProviderImap\Client\Protocol\Command;

use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
use KTXM\ProviderImap\Client\Result\CommandCompletion;
use KTXM\ProviderImap\Client\ImapException;
use KTXM\ProviderImap\Client\Protocol\RequestFrame;
use KTXM\ProviderImap\Client\Protocol\Response\TaggedResponse;
use KTXM\ProviderImap\Client\Protocol\ResponseStream;
use KTXM\ProviderImap\Client\Protocol\SessionContext;
use KTXM\ProviderImap\Client\Protocol\SessionState;

/**
 * @implements CommandInterface<CommandCompletion>
 */
final class NoopCommand implements CommandInterface
{
    public function name(): string
    {
        return 'NOOP';
    }

    public function allowedStates(): array
    {
        return [
            SessionState::NotAuthenticated,
            SessionState::Authenticated,
            SessionState::Selected,
        ];
    }

    public function encode(string $tag, SessionContext $context): RequestFrame
    {
        unset($tag, $context);

        return new RequestFrame('NOOP');
    }

    public function handle(ResponseStream $responses, SessionContext $context): CommandCompletion
    {
        unset($context);

        foreach ($responses as $response) {
            if ($response instanceof TaggedResponse) {
                CompletionChecker::assertSuccess($this->name(), $response);

                return new CommandCompletion($response->status(), $response->text());
            }
        }

        throw new ImapException('NOOP did not receive a tagged completion response.');
    }
}