Merge branch 'master' of https://github.com/RyuzakiH/Temp-Mail-API

Author: RyuzakiH

README.md

@@ -3,84 +3,133 @@ Temp-Mail-API
 [![NuGet](https://img.shields.io/nuget/v/TempMail.API.svg?maxAge=60)](https://www.nuget.org/packages/TempMail.API)
 ===============
 
-Unofficial API for [TempMail](https://temp-mail.org) in .NET
+Unofficial API Client Library for [TempMail](https://temp-mail.org) in .NET Standard
 
 > Disposable email - is a service that allows to receive email at a temporary address that self-destructed after a certain time elapses. It is also known by names like : tempmail, 10minutemail, throwaway email, fake-mail or trash-mail. Many forums, Wi-Fi owners, websites and blogs ask visitors to register before they can view content, post comments or download something. Temp-Mail - is most advanced throwaway email service that helps you avoid spam and stay safe.
 
-**NuGet**: https://www.nuget.org/packages/TempMail.API
+# Installation
 
+`PM> Install-Package TempMail.API`
 
 # Usage
 
-Synchronous Example
+- #### Initialize Client
+_Creates and initializes a new temp-mail client with a temporary email_
 
 ```csharp
+var client = TempMailClient.Create();
+```
+
+```csharp
+var client = await TempMailClient.CreateAsync();
+```
 
-var client = new Client();
+- #### Current Email
+_Gets current temporary email_
+```csharp
+var email = client.Email;
+```
 
-// To get a new temporary email
-client.StartNewSession();
+- #### Available Domains
+_Gets available domains_
 
-// To get the available domains
+```csharp
 var availableDomains = client.AvailableDomains;
+```
 
-// To get Mailbox
-var mails = client.Inbox.Refresh();
+- #### Change Email
+_Changes the temporary email to a specific email (ex: login@domain)_
 
-// To change email to a specific login@domain
-client.Change("loginexample", availableDomains[0]);
+```csharp
+client.ChangeEmail("loginexample", availableDomains[0]);
+```
+```csharp
+await client.ChangeEmailAsync("loginexample", availableDomains[0]);
+```
+
+- #### Delete
+_Deletes the temporary email and gets a new one_
 
-// To delete email and get a new one
+```csharp
 client.Delete();
+```
+```csharp
+await client.DeleteAsync();
+```
 
-// To get the current email
-var email = client.Email;
+- ### Refresh
+_Gets all mails in mailbox_
 
+```csharp
+var mails = client.Inbox.Refresh();
+```
+```csharp
+var mails = await client.Inbox.RefreshAsync();
 ```
 
-Asynchronous Example
+- #### Mailbox
+_Gets all mails in mailbox (doesn't update from temp-mail)_
 
 ```csharp
+var mails = client.Inbox.Mails;
+```
 
-var client = new Client();
+- #### Inbox Auto Check
+_Checks for incoming mails every period of time_
 
-// To get a new temporary email
-await client.StartNewSessionAsync();
+```csharp
+client.StartAutoCheck(delay: 10000); // default delay is 10s
+```
 
-// To get the available domains (not async)
-var availableDomains = await Task.Run(() => client.AvailableDomains);
+```csharp
+client.StopAutoCheck();
+```
 
-// To get Mailbox
-var mails = await client.Inbox.RefreshAsync();
+- #### Events
 
-// To change email to a specific login@domain
-await client.ChangeAsync("loginexample", availableDomains[0]);
+_Occurs when the temporary email changes_
 
-// To delete email and get a new one
-await client.DeleteAsync();
+```csharp
+client.EmailChanged += (o, e) => Console.WriteLine($"Email changed: {e.Email}");
+```
 
-// To get the current email
-var email = client.Email;
+_Occurs when a new mail is received by client_
 
+```csharp
+client.Inbox.NewMailReceived += (o, e) => Console.WriteLine($"\tSender: {e.Mail.SenderName}\n\tSubject: {e.Mail.Subject}\n\tBody: {e.Mail.TextBody}");
 ```
 
-To use a Proxy, if your IP is banned by Cloudflare
+# Additional Features
+
+- #### Cloudflare Protection
+Website sometimes uses Cloudflare protection, so we use [CloudflareSolverRe](https://www.nuget.org/packages/CloudflareSolverRe) to bypass it.
+
+Sometimes Cloudflare forces captcha challenges or Js challenge cannot be solved, so we need to use [CloudflareSolverRe.Captcha](https://www.nuget.org/packages/CloudflareSolverRe.Captcha) package to bypass it using (2captcha or AntiCaptcha)
+
 ```csharp
-var client = new Client(proxy: new WebProxy("163.172.220.221", 8888));
+var client = TempMailClient.Create(
+    captchaProvider: new AntiCaptchaProvider("YOUR_API_KEY"));
 ```
 
-To add your 2captcha api key, if cloudflare challenge is a captcha
 ```csharp
-var client = new Client(_2CaptchaKey: YOUR_2CAPTCHA_KEY);
+var client = TempMailClient.Create(
+    captchaProvider: new TwoCaptchaProvider("YOUR_API_KEY"));
+```
+
+_for more information read the documentation here [CloudflareSolverRe](https://github.com/RyuzakiH/CloudflareSolverRe)_
+
+- #### Proxy
+
+```csharp
+var client = TempMailClient.Create(
+    proxy: new WebProxy("163.172.220.221", 8888));
 ```
 
-Full Test Example [Here](https://github.com/RyuzakiH/Temp-Mail-API/blob/master/src/TempMail.Example/Program.cs)
+Full Examples [Here](https://github.com/RyuzakiH/Temp-Mail-API/tree/master/sample/TempMail.Sample)
 
 # Supported Platforms
 [.NET Standard 1.3](https://github.com/dotnet/standard/blob/master/docs/versions.md)
 
 # Dependencies
-* [HtmlAgilityPack](https://www.nuget.org/packages/HtmlAgilityPack)
-* [MimeKit](https://www.nuget.org/packages/MimeKit)
-* [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json)
-* [CloudflareSolver](https://www.nuget.org/packages/CloudflareSolver)
+* [CloudflareSolverRe](https://www.nuget.org/packages/CloudflareSolverRe)
+* [MimeKitLite](https://www.nuget.org/packages/MimeKitLite)

appveyor.yml

@@ -1,8 +1,8 @@
-version: 2.0.0
+version: 2.0.{build}
 image: Visual Studio 2017
 before_build:
  - dotnet restore
 build_script:
  - dotnet build /verbosity:quiet "TempMail-API.sln"
 test_script:
- - dotnet test --no-build .\test\TempMail.Tests\TempMail.Tests.csproj
+ - dotnet test --no-build .\test\TempMail.Tests\TempMail.Tests.csproj