Åtkomst till Gmail via IMAP med OAuth2 i C#

Denna artikel fokuserar på att arbeta med Gmail, en mycket använd e-posttjänst, genom att utnyttja IMAP-klienten som en del av .NET-biblioteket. Den täcker de viktiga stegen för att autentisera användare via OAuth 2.0, vilket möjliggör säker åtkomst till Gmail-konton. Den förklarar också hur man får de nödvändiga referenserna från Google Cloud Console, hämtar åtkomsttoken och ansluter till Gmail med C# och .NET API. I slutet av denna guide kommer du att få färdigheter för att programmera hantering av e-postmeddelanden, vilket möjliggör att applikationer interagerar med Gmail. Dessa tekniker är användbara för att bygga en e-postklient eller automatisera uppgifter, vilket förbättrar utvecklingsinsatser.

.NET-bibliotek för att få åtkomst till Gmail via IMAP

Aspose.Email för .NET förenklar processen för att få åtkomst till Gmail via IMAP med OAuth 2.0-autentisering genom att tillhandahålla kraftfulla, färdiga klasser och metoder för interaktion med Gmails IMAP-servrar. Det är ett bibliotek som är utformat för att hantera ett brett spektrum av e-postrelaterade uppgifter inom .NET-applikationer. Det stöder populära e-postprotokoll, inklusive IMAP, POP3 och SMTP, vilket gör det till ett viktigt verktyg för utvecklare som arbetar med e-postfunktionalitet.

Med Aspose.Email kan du ansluta till Gmail-konton säkert, hämta meddelanden och hantera postlådedata utan att behöva oroa dig för komplexiteten i protokollimplementering. Detta bibliotek abstraherar många lågnivådetaljer, vilket gör att utvecklare kan fokusera på att skriva ren, funktionell kod för e-posthantering, oavsett om det gäller e-postklienter, automatisering eller backend-tjänster.

För att utnyttja kraften i biblioteket, installera det enkelt med NuGet Package Manager och integrera det i ditt projekt:

  • Öppna ditt projekt i Visual Studio.
  • Gå till Verktyg > NuGet Package Manager > Hantera NuGet-paket för lösning.
  • Sök efter Aspose.Email.
  • Välj paketet och klicka på Installera.

Alternativt kan du använda Package Manager Console och skriva in följande kommando:

Install-Package Aspose.Email

Du kan också ladda ner den senaste versionen av API:et direkt från Aspose-webbplatsen.

När biblioteket har installerats, börja koda!

Hämta klient-ID & klienthemlighet för OAuth i Google Cloud Console

Eftersom Gmail inte längre stöder direkt inloggning och lösenordsautentisering måste du använda OAuth 2.0 för att ansluta. OAuth 2.0 tillhandahåller en robust auktoriseringsram, vilket gör det möjligt för applikationer att säkert få åtkomst till användardata utan att exponera känsliga referenser.

Följande steg kommer att vägleda dig genom processen att hämta ett klient-ID och en klienthemlighet från Google Cloud Console, specifikt för att ansluta till en postlåda via IMAP.

  1. Åtkomst till Google Cloud Console

Börja med att navigera till Google Cloud Console och logga in med ditt Google-konto. Denna plattform tillåter dig att hantera och konfigurera Google-tjänster för dina projekt.

  1. Skapa ett nytt projekt
  • Klicka på rullgardinsmenyn för projekt högst upp på sidan.
  • Välj “Nytt projekt.”
  • Ange ett beskrivande namn för ditt projekt och välj ett faktureringskonto om det krävs.
  • Klicka på “Skapa” för att slutföra ditt nya projekt.
  1. Aktivera Gmail API för att få åtkomst till data
  • I den vänstra navigeringspanelen, klicka på “APIs & Tjänster,” sedan “Bibliotek.”
  • Sök efter “Gmail API.”
  • Klicka på API-posten och tryck på “Aktivera.”
  1. Ställ in OAuth-samtyckesskärmen
  • Navigera till “APIs & Tjänster,” sedan “OAuth-samtyckesskärm.”
  • Välj antingen “Extern” eller “Intern,” beroende på din användarbas.
  • Fyll i de nödvändiga fälten som appnamn och användarstödse-post.
  • Klicka på “Spara och fortsätt” för att fortsätta.
  1. Skapa referenser

Referenser är avgörande för att din applikation ska kommunicera säkert med Googles tjänster.

  • Gå till “APIs & Tjänster” och välj “Referenser.”
  • Klicka på “+ SKAPA REFERENSER” och välj “OAuth 2.0-klient-ID:n.”
  1. Konfigurera ditt OAuth 2.0-klient-ID
  • Välj “Skrivbordsapp” som applikationstyp.
  • Namnge din OAuth 2.0-klient.
  • Lägg till auktoriserade omdirigerings-URI:er, såsom http://localhost för lokal testning.
  • Klicka på “Skapa” för att generera referenserna.
  1. Hämta klient-ID och klienthemlighet

När du har skapat referenserna kommer du att se en dialogruta som visar ditt Klient-ID och Klienthemlighet. Ladda ner filen med referenserna i JSON-format genom att klicka på Ladda ner-knappen.

  1. Konfigurera behörigheter
  • Återgå till “OAuth-samtyckesskärmen.”
  • Klicka på “Lägg till eller ta bort behörigheter” för att välja “https://mail.google.com/"-behörigheten för att få åtkomst till postlådedata via IMAP.

Du har nu framgångsrikt fått ditt klient-ID och din klienthemlighet för OAuth i Google Cloud Console. Dessa referenser möjliggör för dig att autentisera användare och säkert ansluta till deras postlådor via IMAP med hjälp av IMAP-klientappen.

Hämta åtkomsttoken för Gmail API

Åtkomsttoken är avgörande för att autentisera förfrågningar till API:er, såsom Gmail API. Denna sektion förklarar hur man får en åtkomsttoken. Vi kommer att gå igenom ett kodexempel som demonstrerar processen för att skaffa en åtkomsttoken för att interagera med Gmail-data.

Innan du börjar, se till att du har:

  • Ett Google Cloud-projekt med Gmail API aktiverat.
  • OAuth 2.0-referenser (JSON-fil) nedladdade från Google Cloud Console.
  • Google.Apis.Auth-biblioteket installerat i ditt C#-projekt. Du kan installera det via NuGet:
Install-Package Google.Apis.Auth

För att få token programmatisk kommer vi att vidta följande åtgärder:

  1. Importera det nödvändiga namnrymden Google.Apis.Auth.OAuth2 för att använda Googles autentiseringsfunktioner.
  2. Skapa en statisk asynkron metod GetAccessToken som tar emot sökvägen till en JSON-fil med OAuth 2.0-referenser som argument.

Hämtningen av GetAccessToken-metoden kommer att inkludera följande steg:

  1. Definiera de nödvändiga behörigheterna för Gmail API. I vårt fall begär vi åtkomst till användarens Gmail-konto.
  2. Använd metoden GoogleClientSecrets.FromFile för att ladda OAuth 2.0-klienthemligheterna från den angivna JSON-filen.
  3. Använd metoden GoogleWebAuthorizationBroker.AuthorizeAsync för att initiera auktoriseringsprocessen. Metoden kommer att be användaren att autentisera och godkänna åtkomst.

När auktoriseringen har genomförts framgångsrikt returneras åtkomsttoken, vilket gör att du kan göra autentiserade förfrågningar till Gmail API.

Här är kodexemplet för att hämta åtkomsttoken:

using Google.Apis.Auth.OAuth2;
static async Task<string> GetAccessToken(string pathToAccessParameters)
{
// Gmail API scope
string[] scopes = { "https://mail.google.com/" };
// Use the JSON file with OAuth 2.0 credentials
var clientSecrets = GoogleClientSecrets.FromFile(pathToAccessParameters).Secrets;
// Acquire tokens
var credential = await GoogleWebAuthorizationBroker.AuthorizeAsync(
clientSecrets,
scopes,
"username (e.g. username@gmail.com)",
CancellationToken.None);
return credential.Token.AccessToken;
}
view raw GetAccessTokenForGmailAPI.cs hosted with ❤ by GitHub

Du har framgångsrikt implementerat en metod för att få åtkomsttoken för Gmail API med hjälp av OAuth 2.0 i C#. Denna åtkomsttoken gör att din applikation kan utföra auktoriserade operationer på användarens vägnar. Kom ihåg att hantera åtkomsttoken på ett säkert sätt och uppdatera den vid behov för att upprätthålla användartillgång.

Anslut till Gmail via IMAP

Denna sektion kommer att vägleda dig genom processen att ansluta till Gmail med Aspose.Email för .NET. Vi kommer att överväga den nödvändiga koden för att etablera en säker anslutning och hämta e-postmeddelanden från ett Gmail-konto.

Innan du börjar, se till att du har metoden för att hämta åtkomsttoken för autentisering, som beskrivits i föregående avsnitt.

Som ett exempel kommer vi att skapa en IMAP-klient med de nödvändiga parametrarna och lista meddelanden från “Inkorgen”:

  1. Anropa metoden GetAccessToken och skicka sökvägen till OAuth 2.0-referensfilen. Denna metod returnerar en åtkomsttoken som behövs för autentisering.

  2. Skapa en instans av ImapClient med hjälp av parametrarna.

    Värd: "imap.gmail.com" specificerar IMAP-servern för Gmail.

    Port: 993 är den säkra porten för IMAP över SSL.

    Användarnamn: Din Gmail-e-postadress.

    Åtkomsttoken: Åtkomsttoken som hämtades från metoden GetAccessToken.

    Använd OAuth: Parametern true indikerar att OAuth används för anslutningen.

    Säkerhetsalternativ: SecurityOptions.SSLAuto säkerställer automatisk SSL-förhandling.

  3. Anropa metoden SelectFolderAsync för att specificera postlådefoldern som ska nås—i vårt fall Inkorgen.

  4. Anropa metoden ListMessages för att hämta en lista över e-postmeddelanden från den valda mappen. Vi skriver ut antalet hämtade meddelanden och itererar genom varje meddelande för att skriva ut ämnesraden.

Här är C#-koden för att ansluta till Gmail med IMAP:

using Aspose.Email.Clients;
using Aspose.Email.Clients.Base;
using Aspose.Email.Clients.Imap;
var accessToken =
await GetAccessToken(
"googleusercontent.com.json");
// Connect to Gmail IMAP with OAuth
using var client = new ImapClient("imap.gmail.com", 993, "dmitbox@gmail.com", accessToken, true, SecurityOptions.SSLAuto);
// Select the Inbox folder
await client.SelectFolderAsync(ImapFolderInfo.InBox);
// Retrieve messages
var messages = client.ListMessages();
Console.WriteLine($"Number of messages: {messages.Count}");
foreach (var message in messages)
{
Console.WriteLine(message.Subject);
}
view raw ConnectToGmailViaIMAP.cs hosted with ❤ by GitHub

Du har nu framgångsrikt anslutit till Gmail via IMAP med hjälp av C# och Aspose.Email .NET.

Självklart är metoderna för ImapClient som används i exemplet ovan bara några få. Aspose.Email täcker nästan alla funktioner av IMAP-protokollet på klientsidan. Detta inkluderar funktioner som mapphantering, meddelandehämtning och hantering av bilagor. Dessutom tillhandahåller det stöd för avancerade operationer som att söka och filtrera meddelanden.

Slutsats

I denna artikel utforskade vi tekniker för att arbeta med Gmail genom IMAP-protokollet med C#. Vi täckte hur man får OAuth 2.0-referenser från Google Cloud Console, hämtar åtkomsttoken och ansluter till Gmail på ett säkert sätt för att hantera e-post.

Genom att utnyttja de tillhandahållna kodexemplen kan du integrera Gmail-funktionaliteter i dina applikationer, vilket möjliggör effektiv hämtning och hantering av e-post.

Kodproverna tillhandahålls av det avancerade och robusta Aspose.Email för .NET biblioteket som också erbjuder ett antal gratisresurser:

  • en omfattande dokumentation,
  • en omfattande API-referens,
  • en mängd gratis onlineverktyg och appar för att förbättra utvecklingsprocessen,
  • gratis supportforum för gemenskapsassistans och insikter,
  • bloggen för att hålla dig uppdaterad med de senaste tipsen och handledningarna.

Dessa resurser är ovärderliga för att maximera potentialen av biblioteket i dina projekt.

Se även