Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derstimmler/csharpulmdsl
C# client for fetching emails from the temp mail service ulm-dsl.
https://github.com/derstimmler/csharpulmdsl
api client csharp dotnet free library mail mit nuget package temp tempmail ulmdsl
Last synced: 19 days ago
JSON representation
C# client for fetching emails from the temp mail service ulm-dsl.
- Host: GitHub
- URL: https://github.com/derstimmler/csharpulmdsl
- Owner: DerStimmler
- License: mit
- Created: 2022-05-14T21:09:59.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-18T21:42:38.000Z (over 1 year ago)
- Last Synced: 2024-12-14T23:56:21.489Z (about 1 month ago)
- Topics: api, client, csharp, dotnet, free, library, mail, mit, nuget, package, temp, tempmail, ulmdsl
- Language: C#
- Homepage: https://github.com/DerStimmler/CSharpUlmDsl
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CSharpUlmDsl
[](https://www.nuget.org/packages/CSharpUlmDsl/)
[](https://www.nuget.org/packages/CSharpUlmDsl/)
[](https://www.nuget.org/packages/CSharpUlmDsl/)
[](https://codecov.io/gh/DerStimmler/CSharpUlmDsl)
[](https://github.com/DerStimmler/CSharpUlmDsl/blob/master/LICENSE.md)
C# client for fetching emails from the temp mail service [ulm-dsl](https://ulm-dsl.de/).
## Installation
Available on [NuGet](https://www.nuget.org/packages/CSharpUlmDsl/).
```bash
dotnet add package CSharpUlmDsl
```
or
```powershell
PM> Install-Package CSharpUlmDsl
```
## Usage
The following examples use the email address `[email protected]`. Just replace the inbox name `max.mustermann`
to match your address.
Note that you have to fetch your inbox once before you can receive emails at your address. Your address stays active for 14 days. This period renews for every request.
### Initialization
First create an instance of `UlmDslClient` by passing an instance of `HttpClient` to its constructor.
```csharp
var httpClient = new HttpClient();
var client = new UlmDslClient(httpClient);
```
### Get Inbox
You can fetch the basic information **except the body** for all emails in an inbox by calling the `GetInbox`
/ `GetInboxAsync` methods and passing the inbox name.
```csharp
var emails = client.GetInbox("max.mustermann");
```
```csharp
var emails = await client.GetInboxAsync("max.mustermann");
```
### Get Mail by Id
You can get all available information for a specific email by calling the `GetMailById` / `GetMailByIdAsync` methods and
passing the inbox name and email identifier.
```csharp
var email = client.GetMailById("max.mustermann", 7);
```
```csharp
var email = await client.GetMailByIdAsync("max.mustermann", 7);
```
### Get Mails
You can get all available information for all emails in an inbox by calling the `GetMails` / `GetMailsAsync` methods and
passing the inbox name.
```csharp
var emails = client.GetMails("max.mustermann");
```
```csharp
var emails = await client.GetMailsAsync("max.mustermann");
```
### Dependency Injection
You can register the `UlmDslClient` in your Startup with a typed `HttpClient`.
```csharp
builder.Services.AddHttpClient();
```
Then inject the client wherever you like. E.g. in a controller:
```csharp
[Route("Home")]
[ApiController]
public class HomeController : ControllerBase
{
private readonly UlmDslClient _client;
public HomeController(UlmDslClient client)
{
_client = client;
}
}
```
### API rate limits
The api is limited to about 100 requests per minute. So you should keep in mind when this client fires requests:
- When you fetch your inbox only a single request gets fired.
- When you fetch a specific email by id, two requests get fired. One for the basic information e.g. the sender and
receiver and one for the email body.
- When you fetch all emails a first request gets fired for the basic information of all emails and then another request
per email to retrieve each email body.
So based on your inbox size you should think twice before you fetch all emails. Maybe it's better to just fetch the
inbox and then retrieve a single email by id.
## Related
Here are some related projects:
- [ts-ulm-dsl](https://github.com/DerStimmler/ts-ulm-dsl): Typescript version of this library