/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: Emails.Transactional
* File: IMailTransferAgent.cs 
*
* IMailTransferAgent.cs is part of Emails.Transactional which is part of the larger 
* VNLib collection of libraries and utilities.
*
* Emails.Transactional is free software: you can redistribute it and/or modify 
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
* Emails.Transactional 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 
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License 
* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/

using System.Threading;
using System.Threading.Tasks;

namespace Emails.Transactional.Mta
{
    /// <summary>
    /// Represents an email transfer agent or mail server.
    /// </summary>
    internal interface IMailTransferAgent
    {
        /// <summary>
        /// Sends an email using the specified transaction and template.
        /// </summary>
        /// <param name="transaction">The email transaction containing message metadata</param>
        /// <param name="message">The email message body</param>
        /// <param name="cancellation">A token to cancel the operation</param>
        /// <returns>A task that completes with the result of the operation</returns>
        Task<MtaResult> SendEmailAsync(EmailTransaction transaction, IEmailMessageData message, CancellationToken cancellation = default);
    }
}