# SpamFoo Help

> Help for SpamFoo, which stops spam and sorts email into Primary, Transactions, Updates, and Promotions. SpamFoo Client runs on the mail server and classifies mail locally. It is built into SmarterMail and can be connected to other mail servers or applications through its local HTTP API or command line. Every page is also available as Markdown by adding .md to its URL, and a read-only MCP server at https://help.spamfoo.com/mcp searches and reads the help.

Guides are for mailbox users, domain admins, and server administrators. Integrations and API Reference are for administrators and developers connecting SpamFoo Client to a mail server or their own code.

## Start

- [SpamFoo Help Center](https://help.spamfoo.com/index.md): Help for SpamFoo, which stops spam and sorts email into Primary, Transactions, Updates, and Promotions.

## Guides

- [Get to Know SpamFoo](https://help.spamfoo.com/guides.md): The main ideas behind SpamFoo and where to go next.
- [How SpamFoo Classifies Email](https://help.spamfoo.com/guides/how-classification-works.md): Each result SpamFoo can give a message and the steps it takes to choose one.
- [Open Your Dashboard](https://help.spamfoo.com/guides/open-dashboard.md): How to open the SpamFoo Dashboard and what you will see.
- [Read Your Overview](https://help.spamfoo.com/guides/overview.md): The dashboard's first page, which sums up how SpamFoo handled your mail.
- [Review Your Messages](https://help.spamfoo.com/guides/my-messages.md): Find a message SpamFoo checked, see how it was handled, and fix a wrong result.
- [Correct a Wrong Result](https://help.spamfoo.com/guides/correct-result.md): Tell SpamFoo when it got spam or an Email Classification wrong.
- [See Why a Message Was Spam](https://help.spamfoo.com/guides/why-spam.md): Find the reason SpamFoo gave a result and what the common reasons mean.
- [Manage Your Rules](https://help.spamfoo.com/guides/my-rules.md): The rules that apply to your mailbox, including ones made from your corrections.
- [Manage a Domain](https://help.spamfoo.com/guides/manage-domain.md): The Domain Admin menu: watch a domain's mail, set domain spam rules, and stop impersonation.
- [System Requirements](https://help.spamfoo.com/guides/system-requirements.md): The hardware, operating systems, and network access SpamFoo Client needs.
- [Install SpamFoo Client](https://help.spamfoo.com/guides/install.md): Install SpamFoo Client, add a license key, and check that it works.
- [Configure SpamFoo Client](https://help.spamfoo.com/guides/configure.md): Settings SpamFoo Client reads at startup from environment variables, command-line options, and files.
- [Use SpamFoo Client Commands](https://help.spamfoo.com/guides/commands.md): Make sign-in links, add a license key, check readiness, and change the proxy secret from the command line.
- [Use the Admin Console](https://help.spamfoo.com/guides/admin-console.md): A tour of the admin console that System Admins see in the SpamFoo Dashboard.
- [Manage Sign-In and Roles](https://help.spamfoo.com/guides/roles.md): How people sign in to the dashboard, what each role can do, and remote access.
- [Manage Spam Rules and Senders](https://help.spamfoo.com/guides/rules-protection.md): System Spam Rules, finding senders that need a rule, and Sender Verification.
- [Protect Against Phishing](https://help.spamfoo.com/guides/phishing-protection.md): How SpamFoo spots phishing, how to set up the Anti-Phishing model, and how to set up protected identities.
- [Monitor Logs and Health](https://help.spamfoo.com/guides/monitoring.md): Read SpamFoo Client's logs, check its health, and connect monitoring tools.
- [Update and Back Up](https://help.spamfoo.com/guides/updates.md): How SpamFoo Client updates itself, and how to back it up or move it to a new server.
- [Turn On GPU Acceleration](https://help.spamfoo.com/guides/gpu-acceleration.md): Use an NVIDIA GPU to scan mail faster.
- [Fix Common Problems](https://help.spamfoo.com/guides/common-problems.md): Common SpamFoo Client problems, their causes, and how to fix them.
- [Use Diagnostic Tools](https://help.spamfoo.com/guides/diagnostics.md): Tools to check that SpamFoo Client is running and see why it handled a message as it did.
- [How Personalization Works](https://help.spamfoo.com/guides/personalization.md): How SpamFoo adjusts to each user, and what personal data it keeps.
- [How Corrections Are Used](https://help.spamfoo.com/guides/corrections.md): What SpamFoo does with a correction on your server and what it sends to SpamFoo's servers.

## Integrations

- [How Integration Works](https://help.spamfoo.com/integrations.md): How a mail server or application hands mail to SpamFoo Client, and how to pick a method.
- [SmarterMail Overview](https://help.spamfoo.com/integrations/smartermail.md): SmarterMail's built-in SpamFoo integration and what it does for you.
- [Set Up SmarterMail](https://help.spamfoo.com/integrations/smartermail/setup.md): Turn on SpamFoo spam checking and Email Classifications in SmarterMail.
- [What SmarterMail Users See](https://help.spamfoo.com/integrations/smartermail/users.md): What SmarterMail webmail users see and can do when SpamFoo is on.
- [Troubleshoot SmarterMail](https://help.spamfoo.com/integrations/smartermail/troubleshoot.md): Causes and fixes when SpamFoo isn't working as expected in SmarterMail.
- [How SmarterMail Uses SpamFoo](https://help.spamfoo.com/integrations/smartermail/how-it-works.md): How SmarterMail runs SpamFoo Client and uses its result in the spam score.
- [Start With the Local API](https://help.spamfoo.com/integrations/local-api.md): Connect a mail server or application to SpamFoo Client's local API, step by step.
- [Use the Command Line](https://help.spamfoo.com/integrations/command-line.md): Start SpamFoo Client from a terminal and classify saved .eml files with curl.
- [Send Corrections Back](https://help.spamfoo.com/integrations/send-corrections.md): When and how an integration should report user corrections to SpamFoo Client.
- [Use Classification Only](https://help.spamfoo.com/integrations/classification-only.md): Get Email Classifications when another product already decides what is spam.

## API Reference

- [API Overview](https://help.spamfoo.com/api.md): What every SpamFoo Client local API endpoint has in common.
- [Classify a Message](https://help.spamfoo.com/api/classify.md): Get a spam verdict and an Email Classification for a raw message.
- [Classify Without Spam Checks](https://help.spamfoo.com/api/classify-tabs.md): Get only an Email Classification for a raw message, with no spam checks.
- [Report Spam or Not Spam](https://help.spamfoo.com/api/feedback.md): Report that a user marked a message as spam or not spam.
- [Report a Classification Fix](https://help.spamfoo.com/api/feedback-tabs.md): Report that a user moved a message to a different Email Classification.
- [Manage Personal Data](https://help.spamfoo.com/api/personal-data.md): Count or delete the corrections SpamFoo Client has stored for one user.
- [Check Health](https://help.spamfoo.com/api/health.md): Check that SpamFoo Client is up, ready to classify mail, and how busy its queues are.
- [Read and Change Settings](https://help.spamfoo.com/api/settings.md): Read or change SpamFoo Client's saved settings from a script.
- [Get Integration Info](https://help.spamfoo.com/api/integration-info.md): Read the version, mode, license status, and limits of a SpamFoo Client.
- [Push an Address Map](https://help.spamfoo.com/api/address-map.md): Tell SpamFoo Client which addresses belong to each mailbox, plus address books for phishing protection.
- [Create a Sign-In Link](https://help.spamfoo.com/api/login-link.md): Make a one-time link that signs someone in to the dashboard with a chosen role.

## AI Agents

- [MCP server](https://help.spamfoo.com/mcp): Read-only Model Context Protocol endpoint (streamable HTTP, no sign-in) with tools to search and read the help.
- [All pages as one file](https://help.spamfoo.com/llms-full.txt): The Markdown of every help page.
- [HTTP API description](https://help.spamfoo.com/agent-api/openapi.json): OpenAPI description of the same tools over plain HTTP.
- [MCP server card](https://help.spamfoo.com/.well-known/mcp/server-card.json): Machine-readable description of the MCP server.
- [Use SpamFoo Help With AI Assistants](https://help.spamfoo.com/ai-assistants.md): How to connect an AI assistant to the MCP server.
- [Sitemap](https://help.spamfoo.com/sitemap.xml): Every page on the site.