Files
swift-nio-imap/Examples

Examples

This directory contains example projects built on top of swift-nio-imap. Each subdirectory is its own standalone Swift package that depends on the library in the repository root via a local path dependency (.package(path: "../..")).

Keeping them out of the root package means the library's own dependency graph stays minimal — consumers of NIOIMAP don't resolve example-only dependencies such as swift-log or swift-nio-ssl.

Example What it is
CLI A command-line interface plus its supporting CLILib (with tests).
Proxy An IMAP proxy that logs the traffic flowing through it.
Fuzzer Fuzzing harness for the IMAP parser (NIOIMAPFuzzer).
PerformanceTester Micro-benchmarks for parsing/encoding (NIOIMAPPerformanceTester).

Building and running

Each example builds independently. From the repository root:

swift build --package-path Examples/CLI
swift run   --package-path Examples/CLI CLI --help

Because they are separate packages, swift build / swift test at the repository root builds only the library targets — not these examples. CI builds them via a dedicated Build examples job.