View Source Mobilizon.Service.AntiSpam.Provider behaviour (Mobilizon v5.0.0-beta.1)

Provider Behaviour for anti-spam detection.

Supported backends

Mobilizon.Service.AntiSpam.Akismet 🔗

Summary

Types

result()

spam_result()

Callbacks

check_comment(comment_body, username, is_reply?, email, ip, user_agent)

Check a comment details

check_event(event_body, username, email, ip, user_agent)

Check an event details

check_profile(username, summary, email, ip, user_agent)

Check a profile details

check_user(email, ip, user_agent)

Check an user details

ready?()

Make sure the provider is ready

Types

result()

@type result() :: spam_result() | {:error, any()}

spam_result()

@type spam_result() :: :ham | :spam | :discard

Callbacks

check_comment(comment_body, username, is_reply?, email, ip, user_agent)

@callback check_comment(
  comment_body :: String.t(),
  username :: String.t(),
  is_reply? :: boolean(),
  email :: String.t() | nil,
  ip :: String.t(),
  user_agent :: String.t() | nil
) :: result()

Check a comment details

check_event(event_body, username, email, ip, user_agent)

@callback check_event(
  event_body :: String.t(),
  username :: String.t(),
  email :: String.t() | nil,
  ip :: String.t(),
  user_agent :: String.t() | nil
) :: result()

Check an event details

check_profile(username, summary, email, ip, user_agent)

@callback check_profile(
  username :: String.t(),
  summary :: String.t(),
  email :: String.t() | nil,
  ip :: String.t(),
  user_agent :: String.t() | nil
) :: result()

Check a profile details

check_user(email, ip, user_agent)

@callback check_user(email :: String.t(), ip :: String.t(), user_agent :: String.t()) ::
  result()

Check an user details

ready?()

@callback ready?() :: boolean()

Make sure the provider is ready