email_inmemory

An in-memory implementation of the EmailClient interface, suitable for testing and development environments where actual email sending is not required.

Getting Started

Add the dependency to your pubspec.yaml:

dependencies:
  email_inmemory:
    git:
      url: https://github.com/flutter-news-app-full-source-code/email-inmemory.git
      # Use a specific ref/tag for stability in production
      # ref: some-tag

Then, import the package:

import 'package:email_inmemory/email_inmemory.dart';

Features

• Provides an EmailInMemory class that implements the EmailClient interface.
• Simulates the sendTransactionalEmail operation without sending actual emails.
• Logs the simulated email details to the console, which is useful for debugging during development (e.g., viewing OTP codes).
• Includes basic input validation and throws standard core exceptions on failure.

Usage

Instantiate the client and use it where an EmailClient is expected. You can optionally provide a Logger instance.

import 'package:email_client/email_client.dart';
import 'package:email_inmemory/email_inmemory.dart';
import 'package:core/core.dart';
import 'package:logging/logging.dart';

void main() async {
  // Set up logging to see the output
  Logger.root.level = Level.ALL;
  Logger.root.onRecord.listen((record) {
    print('${record.level.name}: ${record.time}: ${record.message}');
  });

  // Instantiate the in-memory client
  final EmailClient emailClient = EmailInMemory();

  // Example: Sending a transactional email (simulated)
  try {
    await emailClient.sendTransactionalEmail(
      senderEmail: '[email protected]',
      recipientEmail: '[email protected]',
      subject: 'Your One-Time Code',
      templateId: 'd-12345',
      templateData: {'otp_code': '987654'},
    );
    print('Successfully simulated sending email.');
  } on HttpException catch (e) {
    print('Failed to send email: $e');
  }
}

🔑 Licensing

This package is source-available and licensed under the PolyForm Free Trial 1.0.0. Please review the terms before use.

For commercial licensing options that grant the right to build and distribute unlimited applications, please visit the main Flutter News App - Full Source Code Toolkit organization.