Files
Wino-Mail/Wino.Core.Domain/Interfaces/IMailService.cs
Burak Kaan Köse 12d3814626 Initial commit.
2024-04-18 01:44:37 +02:00

82 lines
4.0 KiB
C#

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using MimeKit;
using Wino.Core.Domain.Entities;
using Wino.Core.Domain.Models.MailItem;
namespace Wino.Core.Domain.Interfaces
{
public interface IMailService
{
Task<MailCopy> GetSingleMailItemAsync(string mailCopyId, string remoteFolderId);
Task<MailCopy> GetSingleMailItemAsync(Guid uniqueMailId);
Task<MailCopy> CreateDraftAsync(MailAccount composerAccount, MimeMessage generatedReplyMime, MimeMessage replyingMimeMessage = null, IMailItem replyingMailItem = null);
Task<List<IMailItem>> FetchMailsAsync(MailListInitializationOptions options);
Task<List<string>> GetMailIdsByFolderIdAsync(Guid folderId);
// v2
/// <summary>
/// Deletes all mail copies for all folders.
/// </summary>
/// <param name="accountId">Account to remove from</param>
/// <param name="mailCopyId">Mail copy id to remove.</param>
Task DeleteMailAsync(Guid accountId, string mailCopyId);
Task ChangeReadStatusAsync(string mailCopyId, bool isRead);
Task ChangeFlagStatusAsync(string mailCopyId, bool isFlagged);
Task CreateAssignmentAsync(Guid accountId, string mailCopyId, string remoteFolderId);
Task DeleteAssignmentAsync(Guid accountId, string mailCopyId, string remoteFolderId);
Task<bool> CreateMailAsync(Guid accountId, NewMailItemPackage package);
/// <summary>
/// Maps new mail item with the existing local draft copy.
/// In case of failure, it returns false.
/// Then synchronizers must insert a new mail item.
/// </summary>
/// <param name="accountId">Id of the account. It's important to map to the account since if the user use the same account with different providers, this call must map the correct one.</param>
/// <param name="localDraftCopyUniqueId">UniqueId of the local draft copy.</param>
/// <param name="newMailCopyId">New assigned remote mail item id.</param>
/// <param name="newDraftId">New assigned draft id if exists.</param>
/// <param name="newThreadId">New message's thread/conversation id.</param>
/// <returns>True if mapping is done. False if local copy doesn't exists.</returns>
Task<bool> MapLocalDraftAsync(Guid accountId, Guid localDraftCopyUniqueId, string newMailCopyId, string newDraftId, string newThreadId);
/// <summary>
/// Maps new mail item with the existing local draft copy.
///
/// </summary>
/// <param name="newMailCopyId"></param>
/// <param name="newDraftId"></param>
/// <param name="newThreadId"></param>
/// <returns></returns>
Task MapLocalDraftAsync(string newMailCopyId, string newDraftId, string newThreadId);
Task<MimeMessage> CreateDraftMimeMessageAsync(Guid accountId, DraftCreationOptions options);
Task UpdateMailAsync(MailCopy mailCopy);
/// <summary>
/// Gets the new inserted unread mails after the synchronization.
/// </summary>
/// <param name="accountId">Account id.</param>
/// <param name="downloadedMailCopyIds">
/// Mail ids that synchronizer tried to download. If there was an issue with the
/// Items that tried and actually downloaded may differ. This function will return only new inserted ones.
/// </param>
/// <returns>Newly inserted unread mails inside the Inbox folder.</returns>
Task<List<MailCopy>> GetDownloadedUnreadMailsAsync(Guid accountId, IEnumerable<string> downloadedMailCopyIds);
/// <summary>
/// Returns the account that this mail copy unique id is assigned.
/// Used in toast notification handler.
/// </summary>
/// <param name="uniqueMailId">Unique id of the mail item.</param>
/// <returns>Account that mail belongs to.</returns>
Task<MailAccount> GetMailAccountByUniqueIdAsync(Guid uniqueMailId);
}
}