Skip to content

Commit dc7156a

Browse files
committed
feat(README): update sendTransactionalEmail method description
- Add `subject` parameter to the method description - Reflect the updated method signature in the usage example
1 parent e80e3b4 commit dc7156a

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
* **`EmailClient` 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 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 `core` exceptions.
27+
* `Future<void> sendTransactionalEmail({required String senderEmail, required String recipientEmail, required String subject, 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 `core` exceptions.
2828

2929
## Usage
3030

@@ -54,6 +54,7 @@ class AuthService {
5454
await _emailClient.sendTransactionalEmail(
5555
senderEmail: '[email protected]',
5656
recipientEmail: email,
57+
subject: 'Your Verification Code',
5758
templateId: 'd-1234567890abcdef1234567890abcdef', // Example SendGrid Template ID
5859
templateData: {
5960
'otp_code': otp,

0 commit comments

Comments
 (0)