Feather Mail

An abstract mail component for Feather CMS.

Features

• Mail currency type to send messages
• Validation helpers and errors
• Raw MIME encoder for transport providers
• Attachments and HTML support

Requirements

• Swift 6.3+
• Platforms:
  • Linux
  • macOS 15+
  • iOS 18+
  • tvOS 18+
  • watchOS 11+
  • visionOS 2+

Installation

Use Swift Package Manager; add the dependency to your Package.swift file:

.package(url: "https://github.com/feather-framework/feather-mail", exact: "1.0.0-rc.3"),

Then add FeatherMail to your target dependencies:

.product(name: "FeatherMail", package: "feather-mail"),

For in-memory test support, add FeatherMailTesting:

.product(name: "FeatherMailTesting", package: "feather-mail"),

TestMailClient validates and records sent messages. Use getMailbox() to inspect them and clearMailbox() to reset the client between test cases.

Usage

API documentation is available at the following link.

Warning

This repository is a work in progress, things can break until it reaches v1.0.0.

Mail implementations

The following mail client implementations are available for use:

• Feather Mail SES
• Feather Mail SMTP

The in-memory testing client is provided by FeatherMailTesting in this package; it is not a delivery provider.

Development

• Build: swift build
• Test:
  • local: make test
  • using Docker: make docker-test
• Format: make format
• Check: make check

Contributing

Pull requests are welcome. Please keep changes focused and include tests for new logic.