webiny-api-mailer-catalog

Catalogs Webiny api-mailer abstractions with import paths and source file locations.

8.0k|673|Updated Jan 9, 2018
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-mailer-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-api-mailer-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/mailer
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-mailer-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending Webiny's mailer package often struggle to locate the correct abstraction, its exact import path, and its source file, leading to guesswork and incorrect implementations.

Core Features & Use Cases

  • Abstraction Catalog: Lists 11 mailer abstractions including MailerService, SendMailUseCase, and settings repositories with exact import statements.
  • Source Mapping: Maps each abstraction to its source file in @webiny/api-mailer so developers can read the exact interface and types.
  • Use Case: When building a custom email-sending feature in a Webiny project, look up SendMailUseCase, read its source file for the interface, and import it via the documented path.

Quick Start

Ask the AI to show the import path and source file for the SendMailUseCase abstraction in the Webiny mailer package.

Frequently Asked Questions about webiny-api-mailer-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I send email in a Webiny project?

Use the SendMailUseCase abstraction from the webiny/api/mailer import path. Read its source file at @webiny/api-mailer/features/SendMail/index.ts to get the exact interface before implementing.

What abstractions does the Webiny api-mailer package provide?

The package exposes 11 abstractions including MailerService, SendMailUseCase, GetSettingsUseCase, SaveSettingsUseCase, and event handlers for mail send and settings save lifecycles.

How do I hook into mail sending events in Webiny?

Implement MailBeforeSendEventHandler, MailAfterSendEventHandler, or MailSendErrorEventHandler from webiny/api/mailer. Their interfaces are defined in @webiny/api-mailer/features/SendMail/index.ts.

Where are Webiny mailer settings stored and managed?

Mailer settings are managed through GetSettingsUseCase and SaveSettingsUseCase, backed by GetSettingsRepository and SaveSettingsRepository abstractions in the @webiny/api-mailer features directory.

Can I use these mailer abstractions without reading the source files?

No, the catalog explicitly requires reading the referenced source file to obtain the exact interface and types before importing and implementing any abstraction.