From 7773c8aa7f7a475bace67ad0a54e2a7231b0a972 Mon Sep 17 00:00:00 2001 From: TekH Date: Wed, 29 Jul 2026 14:36:47 +0200 Subject: [PATCH] Update OnReconnect docs and README examples Updated XML documentation in `OnReconnect.cs` to reference the updated `EmailSender.ConnectRabbitMq` method signature, clarifying its behavior when a connection is already established. Revised `README.md` examples to replace `OutgoingEmailEvent` with `Email` and removed `Id` and `QueuedAt` properties, as they are now set internally. Added a note to clarify required fields for the `Email` object. Added a new section to the `README.md` demonstrating how to check the connection status using `EmailSender.IsConnected`. --- .../OnReconnect.cs | 2 +- .../DigitalData.MessagingService.Client/README.md | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/src/presentation/DigitalData.MessagingService.Client/OnReconnect.cs b/src/presentation/DigitalData.MessagingService.Client/OnReconnect.cs index 11c4ef5..631eb0b 100644 --- a/src/presentation/DigitalData.MessagingService.Client/OnReconnect.cs +++ b/src/presentation/DigitalData.MessagingService.Client/OnReconnect.cs @@ -1,7 +1,7 @@ namespace DigitalData.MessagingService.Client; /// -/// Defines the behavior when is called +/// Defines the behavior when is called /// while a connection has already been established. /// public enum OnReconnect diff --git a/src/presentation/DigitalData.MessagingService.Client/README.md b/src/presentation/DigitalData.MessagingService.Client/README.md index 9997eac..5430d69 100644 --- a/src/presentation/DigitalData.MessagingService.Client/README.md +++ b/src/presentation/DigitalData.MessagingService.Client/README.md @@ -63,30 +63,28 @@ EmailSender.ConnectRabbitMq( ### 2. E-Mail versenden ```csharp -EmailSender.Send(new OutgoingEmailEvent +EmailSender.Send(new Email { - Id = Guid.NewGuid(), Recipient = "empfaenger@beispiel.de", Subject = "Willkommen", Body = "

Hallo Welt!

", - IsHtml = true, - QueuedAt = DateTime.Now + IsHtml = true }); ``` ```vb -EmailSender.Send(New OutgoingEmailEvent With { - .Id = Guid.NewGuid(), +EmailSender.Send(New Email With { .Recipient = "empfaenger@beispiel.de", .Subject = "Willkommen", .Body = "

Hallo Welt!

", - .IsHtml = True, - .QueuedAt = DateTime.Now + .IsHtml = True }) ``` `Send` ist eine **Fire-and-Forget**-Methode: die Nachricht wird in die RabbitMQ-Queue eingereiht und der aufrufende Code wartet nicht auf die eigentliche Zustellung. +> **Hinweis:** `Id` und `QueuedAt` werden intern automatisch gesetzt. Im `Email`-Objekt müssen nur `Recipient`, `Subject`, `Body` und `IsHtml` angegeben werden. + ### 3. Verbindungsstatus prüfen ```csharp