View Source Disposable (Disposable v0.2.0)

Checks whether an email address uses a disposable domain.

Email handling is intentionally limited validation: the value must be a printable UTF-8 string with one non-empty local part and a valid ASCII domain. This module does not implement complete RFC 5322 parsing.

Summary

Types

domain()

A disposable domain name represented as a UTF-8 string.

email()

An email address represented as a UTF-8 string.

Functions

check(email) deprecated

Compatibility alias for disposable?/1; invalid and unavailable lookups return false.

disposable?(email)

Returns true only for a valid email whose exact domain is listed.

load_url(url)

Loads a newline-delimited domain list from an administrator-controlled URL.

lookup(email)

Looks up an email address without collapsing errors.

reload() deprecated

Reloads the configured source, preserving the active generation on failure.

start_link(opts \\ []) deprecated

Starts the ETS-backed domain store registered as Disposable.

Types

domain()

@type domain() :: String.t()

A disposable domain name represented as a UTF-8 string.

email()

@type email() :: String.t()

An email address represented as a UTF-8 string.

Functions

check(email)

This function is deprecated. use disposable?/1 instead.

@spec check(term()) :: boolean()

Compatibility alias for disposable?/1; invalid and unavailable lookups return false.

disposable?(email)

@spec disposable?(term()) :: boolean()

Returns true only for a valid email whose exact domain is listed.

load_url(url)

@spec load_url(String.t()) :: :ok | {:error, term()}

Loads a newline-delimited domain list from an administrator-controlled URL.

Redirects, non-200 responses, invalid content, and transport failures leave the active generation unchanged.

lookup(email)

@spec lookup(term()) :: {:ok, boolean()} | {:error, :invalid_email | :not_running}

Looks up an email address without collapsing errors.

Returns {:ok, boolean()} for valid input, or {:error, reason} for :invalid_email and :not_running.

reload()

This function is deprecated. use the configured source and an administrator-controlled refresh operation.

@spec reload() :: :ok | {:error, term()}

Reloads the configured source, preserving the active generation on failure.

start_link(opts \\ [])

This function is deprecated. the application starts the store automatically.

@spec start_link(keyword()) :: GenServer.on_start()

Starts the ETS-backed domain store registered as Disposable.