email

Documentation

Overview

Package email handles generic email addresses from major providers.

This package supports major email providers like Outlook, ProtonMail, Yahoo, iCloud, AOL, and others. It extracts usernames for cross-platform guessing.

For Gmail addresses, use the google package which has GAIA ID resolution. For Mail.ru addresses, use the mailru package which has profile fetching.

Index

• func AuthRequired() bool
• func Match(input string) bool
• type Client
  • func New(_ context.Context, _ ...Option) (*Client, error)
  • func (*Client) Fetch(_ context.Context, input string) (*profile.Profile, error)
• type Option
  • func WithHTTPCache(cache any) Option
  • func WithLogger(logger any) Option

Functions

func AuthRequired

func AuthRequired() bool

AuthRequired returns false because we don't fetch any external data.

func Match

func Match(input string) bool

Match returns true if the input is a supported email address. Gmail and Mail.ru domains are excluded as they have dedicated packages.

Types

type Client

type Client struct{}

Client handles email address extraction.

func New

func New(_ context.Context, _ ...Option) (*Client, error)

New creates an email client.

func (*Client) Fetch

func (*Client) Fetch(_ context.Context, input string) (*profile.Profile, error)

Fetch extracts username and email from a mailto: URL.

type Option

type Option func(*config)

Option configures the email client.

func WithHTTPCache

func WithHTTPCache(cache any) Option

WithHTTPCache is a stub for consistency with other packages. Email parsing doesn't require HTTP caching.

func WithLogger

func WithLogger(logger any) Option

WithLogger is a stub for consistency with other packages. Email parsing doesn't require logging.