KP.GmailClient
4.0.0
dotnet add package KP.GmailClient --version 4.0.0
NuGet\Install-Package KP.GmailClient -Version 4.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="KP.GmailClient" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="KP.GmailClient" Version="4.0.0" />
<PackageReference Include="KP.GmailClient" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add KP.GmailClient --version 4.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: KP.GmailClient, 4.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package KP.GmailClient@4.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=KP.GmailClient&version=4.0.0
#tool nuget:?package=KP.GmailClient&version=4.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
KP.GmailClient
This is an alternative client for the auto generated Google.Apis.Gmail.v1 Client Library.
Prerequisites
- Create a new project in the Google Cloud Console (Guide)
- Create a OAuth consent screen (Guide)
- Publish the app or add any test users
- Create Desktop application credentials and download the client secret JSON file (Guide)
- Enable the Gmail API
Setup
One-time setup which opens the browser to authenticate the user.
// Define the required scopes
const GmailScopes scopes = GmailScopes.Readonly | GmailScopes.Send;
var broker = new GmailAuthenticationBroker();
var token = await broker.AuthenticateAsync("oauth_client_credentials.json", scopes);
var tokenStore = new FileTokenStore("token.json");
await tokenStore.StoreTokenAsync(token);
Usage examples
// Use the previously created files
var tokenClient = TokenClient.Create("oauth_client_credentials.json");
var tokenStore = new FileTokenStore("token.json");
using var client = new GmailClient(tokenClient, tokenStore);
// Send a plain text email
Message plainMessage = await client.Messages.SendAsync("example@gmail.com", "Subject", "Plain text body");
// Send a HTML email
Message htmlMessage = await client.Messages.SendAsync("example@gmail.com", "Subject", "<h1>HTML body</h1>", isBodyHtml: true);
// Get the users profile
Profile profile = await client.GetProfileAsync();
// Get inbox messages
IList<Message> messages = await client.Messages.ListAsync();
// Get starred messages
IList<Message> starredMessages = await client.Messages.ListByLabelAsync(Label.Starred);
// List all labels
IList<Label> labels = await client.Labels.ListAsync();
// List all drafts
IList<Draft> drafts = await client.Drafts.ListAsync();
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.