<?php

declare(strict_types=1);

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

namespace KTXF\Mail\Service;

use JsonSerializable;

/**
 * Mail Service Identity Interface
 * 
 * Base interface for authentication credentials used by mail services.
 * 
 * @since 2025.05.01
 */
interface IServiceIdentity extends JsonSerializable {

    public const TYPE_BASIC = 'basic';
    public const TYPE_OAUTH = 'oauth';
    public const TYPE_APIKEY = 'apikey';

    /**
     * Gets the identity/authentication type
     * 
     * @since 2025.05.01
     * 
     * @return string One of: 'basic', 'oauth', 'apikey'
     */
    public function getType(): string;

}