Skip to content

Commit 61798e6

Browse files
committed
docs: update HtEmailClient documentation
- Added `senderEmail` parameter to `sendTransactionalEmail` method. - Updated README.md to reflect changes.
1 parent b22b84e commit 61798e6

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Then run `dart pub get`.
2424
## Features
2525

2626
* **`HtEmailClient` Abstract Class:** Defines a generic, provider-agnostic interface for sending transactional emails. This approach decouples application logic from email content and styling, which can be managed directly within your email service provider (e.g., SendGrid, AWS SES).
27-
* `Future<void> sendTransactionalEmail({required String recipientEmail, required String templateId, required Map<String, dynamic> templateData})`: Sends an email using a pre-defined template. Implementations must handle underlying service errors and map them to standard `ht_shared` exceptions.
27+
* `Future<void> sendTransactionalEmail({required String senderEmail, required String recipientEmail, required String templateId, required Map<String, dynamic> templateData})`: Sends an email using a pre-defined template. Implementations must handle underlying service errors and map them to standard `ht_shared` exceptions.
2828

2929
## Usage
3030

@@ -52,6 +52,7 @@ class AuthService {
5252
// Use the generic method to send an email via a template.
5353
// The template ID and data structure are managed by the email provider.
5454
await _emailClient.sendTransactionalEmail(
55+
senderEmail: '[email protected]',
5556
recipientEmail: email,
5657
templateId: 'd-1234567890abcdef1234567890abcdef', // Example SendGrid Template ID
5758
templateData: {

0 commit comments

Comments
 (0)