INFRA: Nuget Package Description

mabroukmahdhi · Aug 11, 2024 · fb54849 · fb54849
1 parent ccc550a
commit fb54849
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 6 deletions.
diff --git a/FlexiMail/FlexiMail.csproj b/FlexiMail/FlexiMail.csproj
@@ -4,18 +4,54 @@
         <TargetFramework>net8.0</TargetFramework>
         <ImplicitUsings>disable</ImplicitUsings>
         <Nullable>disable</Nullable>
+        <Title>FlexiMail</Title>
+        <PackageId>FlexiMail</PackageId>
+        <Authors>Mabrouk Mahdhi</Authors>
+        <Company>Mabrouk Mahdhi</Company>
+        <Product>FlexiMail</Product>
+        <Description>FlexiMail is a robust, test-driven C# library tailored specifically for seamless email integration using Microsoft Exchange Web Services (EWS).</Description>
+        <Copyright>Mabrouk Mahdhi (c) 2024</Copyright>
+        <PackageProjectUrl>https://github.com/mabroukmahdhi/FlexiMail</PackageProjectUrl>
+        <PackageIcon>icmail.png</PackageIcon>
+        <RepositoryUrl>https://github.com/mabroukmahdhi/FlexiMail</RepositoryUrl>
+        <RepositoryType>git</RepositoryType>
+        <PackageTags>EWS; .NET; Mailing; Message; Exchange; Exchange WebServices</PackageTags>
+        <PackageReleaseNotes>This release offers the beta version of FlexiMail.</PackageReleaseNotes>
+        <AssemblyVersion>0.1</AssemblyVersion>
+        <FileVersion>0.1</FileVersion>
+        <PackageLicenseFile>license.txt</PackageLicenseFile>
+        <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
+        <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+        <Version>0.1</Version>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <GenerateDocumentationFile>True</GenerateDocumentationFile>
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Microsoft.Exchange.WebServices" Version="2.2.0" />
-      <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
-      <PackageReference Include="Microsoft.Identity.Client" Version="4.63.0" />
-      <PackageReference Include="Xeption" Version="2.8.0" />
+        <None Include="..\README.md">
+            <Pack>True</Pack>
+            <PackagePath>\</PackagePath>
+        </None>
+        <None Update="icmail.png">
+            <Pack>True</Pack>
+            <PackagePath>\</PackagePath>
+        </None>
+        <None Update="license.txt">
+            <Pack>True</Pack>
+            <PackagePath>\</PackagePath>
+        </None>
     </ItemGroup>
 
     <ItemGroup>
-        <InternalsVisibleTo Include="FlexiMail.Tests.Unit" />
-        <InternalsVisibleTo Include="DynamicProxyGenAssembly2" /> 
+        <PackageReference Include="Microsoft.Exchange.WebServices" Version="2.2.0"/>
+        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0"/>
+        <PackageReference Include="Microsoft.Identity.Client" Version="4.63.0"/>
+        <PackageReference Include="Xeption" Version="2.8.0"/>
+    </ItemGroup>
+
+    <ItemGroup>
+        <InternalsVisibleTo Include="FlexiMail.Tests.Unit"/>
+        <InternalsVisibleTo Include="DynamicProxyGenAssembly2"/>
     </ItemGroup>
 
 </Project>
diff --git a/FlexiMail/FlexiMailClient.cs b/FlexiMail/FlexiMailClient.cs
@@ -13,10 +13,17 @@
 
 namespace FlexiMail
 {
+    /// <summary>
+    /// Client class to send mails through Exchange WebServices.
+    /// </summary>
     public class FlexiMailClient : IFlexiMailClient
     {
         private readonly IFlexiExchangeService exchangeService;
 
+        /// <summary>
+        /// Creates Client Instance.
+        /// </summary>
+        /// <param name="configurations">The Exchange Configurations</param>
         public FlexiMailClient(ExchangeConfigurations configurations)
         {
             var serviceProvider = RegisterServices(configurations);
@@ -25,6 +32,10 @@ public FlexiMailClient(ExchangeConfigurations configurations)
                 serviceProvider.GetRequiredService<IFlexiExchangeService>();
         }
 
+        /// <summary>
+        /// Sends the email.
+        /// </summary>
+        /// <param name="flexiMessage">The email model</param>
         public async ValueTask SendAndSaveCopyAsync(FlexiMessage flexiMessage) =>
             await this.exchangeService.SendAndSaveCopyAsync(flexiMessage);
 

diff --git a/FlexiMail/icmail.png b/FlexiMail/icmail.png
diff --git a/FlexiMail/license.txt b/FlexiMail/license.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mabrouk Mahdhi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.