gravatar

Documentation

Overview

Package gravatar fetches Gravatar profile data from email addresses.

Gravatar uses SHA256 hashes of email addresses to look up profiles. This package supports any email address - if a Gravatar profile exists, it returns the profile photo, display name, and linked accounts.

Index

• func AuthRequired() bool
• func Match(input string) bool
• type Client
  • func New(_ context.Context, opts ...Option) (*Client, error)
  • func (c *Client) Fetch(ctx context.Context, input string) (*profile.Profile, error)
• type Option
  • func WithHTTPCache(httpCache httpcache.Cacher) Option
  • func WithLogger(logger *slog.Logger) Option

Functions

func AuthRequired

func AuthRequired() bool

AuthRequired returns false because Gravatar lookups are public.

func Match

func Match(input string) bool

Match returns true if the input is an email address or Gravatar URL. Note: This matches ANY email address, not just specific domains.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client handles Gravatar requests.

func New

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

New creates a Gravatar client.

func (*Client) Fetch

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

Fetch retrieves Gravatar profile data for an email address.

type Option

type Option func(*config)

Option configures a Client.

func WithHTTPCache

func WithHTTPCache(httpCache httpcache.Cacher) Option

WithHTTPCache sets the HTTP cache.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger sets a custom logger.