email static method

String? email({
  1. required String email,
  2. String? emptyMessage,
  3. String? invalidFormatMessage,
  4. bool trimWhitespace = true,
  5. List<String>? existingEmails,
  6. String? alreadyExistsMessage,
})

Validates an email address format and checks against existing emails.

Returns null if valid, or an error message if invalid.

Parameters:

  • email: The email address to validate
  • emptyMessage: Custom message when empty
  • invalidFormatMessage: Custom message for invalid format
  • trimWhitespace: Whether to trim whitespace (default: true)
  • existingEmails: List of existing emails to check against
  • alreadyExistsMessage: Custom message when email already exists Validates an email address against standard format requirements.

Parameters:

  • email: The email address to validate
  • emptyMessage: Custom message for empty input (default: 'Please enter your email.')
  • invalidFormatMessage: Custom message for invalid format (default: 'The email address is badly formatted.')
  • trimWhitespace: Whether to trim whitespace from input (default: true)
  • existingEmails: List of existing emails to check against for uniqueness
  • alreadyExistsMessage: Custom message for duplicate emails (default: 'This email is already registered.')

Returns null if valid, or an error message if invalid.

Example:

final error = SahihValidator.email(
  email: 'user@example.com',
  existingEmails: ['admin@example.com'],
);
if (error != null) {
  print('Validation error: $error');
}

Implementation

static String? email({
  required String email,
  String? emptyMessage,
  String? invalidFormatMessage,
  bool trimWhitespace = true,
  List<String>? existingEmails,
  String? alreadyExistsMessage,
}) {
  return validateEmail(
    email: email,
    emptyMessage: emptyMessage,
    invalidFormatMessage: invalidFormatMessage,
    trimWhitespace: trimWhitespace,
    existingEmails: existingEmails,
    alreadyExistsMessage: alreadyExistsMessage,
  );
}