ServiceProvider

Registers the mailer manager service.

Mailer configuration is resolved from mailer.driver, mailer.default, and mailer.drivers.<driver>. Driver options are merged over defaults before constructing Phalcon Incubator's mailer manager, then the DI container and shared events manager are attached when available.

• Full name: \PhalconKit\Provider\Mailer\ServiceProvider
• Parent class: \PhalconKit\Provider\AbstractServiceProvider

Constants

Properties

serviceName

Stable DI service name managed by this provider.

protected string $serviceName

This value is part of the provider contract because controllers, tasks, other injectables, and replacement providers resolve services by name. Concrete providers must set it to a non-empty value.

Methods

register

Register the shared mailer service.

public register(\PhalconKit\Di\DiInterface $di): void

SMTP encryption is normalized case-insensitively and validated before the mailer is created so bad config fails before network I/O. The SMTP driver also enables PHPMailer authentication explicitly because SMTP credentials in the merged options imply authenticated transport.

Parameters:

Throws:

When the selected driver, option shape, or SMTP encryption value is invalid. - ConfigurationException

normalizeOptions

Normalize and validate the options passed to the incubator mailer.

private static normalizeOptions(array $options, string $driver): array

• This method is static. Parameters:

Throws:

When SMTP encryption is unsupported. - ConfigurationException

resolveDefaultOptions

Return validated defaults from the canonical key or legacy alias.

private static resolveDefaultOptions(array $mailerConfig): array

• This method is static. Parameters:

normalizeDrivers

Normalize and validate driver option groups keyed by driver name.

private static normalizeDrivers(mixed $drivers): array<string,array>

• This method is static. Parameters:

normalizeOptionArray

Validate a mailer option group.

private static normalizeOptionArray(mixed $options, string $path): array

• This method is static. Parameters:

assertSupportedDriver

Validate the selected driver against the providers this class can create.

private static assertSupportedDriver(string $driver): void

• This method is static. Parameters:

normalizeMailerToken

Normalize ASCII mailer config tokens such as driver and encryption names.

private static normalizeMailerToken(mixed $value, string $path): string

• This method is static. Parameters:

normalizeOptionalMailerToken

Normalize optional mailer config tokens that may intentionally be empty.

private static normalizeOptionalMailerToken(string $value): string

• This method is static. Parameters:

Inherited methods

__construct

Stores the DI container and prepares the provider for registration.

public __construct(\PhalconKit\Di\DiInterface $di): mixed

The constructor intentionally requires PhalconKit\Di\DiInterface so providers can rely on typed service helpers during configuration and registration.

Parameters:

Throws:

When a concrete provider does not define a non-empty service name. - LogicException

getName

Returns the DI service name managed by this provider.

public getName(): string

boot

Optional post-registration hook.

public boot(): void

The base implementation is intentionally empty. Custom bootstraps or application code may call this method for provider-specific startup work after all services have been registered.

configure

Optional provider-local configuration hook.

public configure(): void

This runs during construction after DI has been stored and before register() is called. Use it to normalize provider options or prepare lightweight state; service creation belongs in register().