Wrapper for IEmailer for sending confirm email sender. More...

Public Member Functions
	__construct (private readonly ServiceOptions $options, private readonly HookRunner $hookRunner, private readonly UserFactory $userFactory, private readonly IEmailer $emailer, private readonly ConfirmEmailBuilderFactory $confirmEmailBuilderFactory, private readonly LoggerInterface $logger,)

	sendConfirmationMail (IContextSource $ctx, string $type, ConfirmEmailData $data)
	Send the email address confirmation message.

Public Attributes
const array	CONSTRUCTOR_OPTIONS

const string	EMAIL_TYPE_CHANGED = 'changed'

const string	EMAIL_TYPE_CREATED = 'created'

const string	EMAIL_TYPE_SET = 'set'

Detailed Description

Wrapper for IEmailer for sending confirm email sender.

Definition at line 21 of file ConfirmEmailSender.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Mail\ConfirmEmail\ConfirmEmailSender::__construct	(	private readonly ServiceOptions	$options,
		private readonly HookRunner	$hookRunner,
		private readonly UserFactory	$userFactory,
		private readonly IEmailer	$emailer,
		private readonly ConfirmEmailBuilderFactory	$confirmEmailBuilderFactory,
		private readonly LoggerInterface	$logger )

Definition at line 31 of file ConfirmEmailSender.php.

Member Function Documentation

◆ sendConfirmationMail()

MediaWiki\Mail\ConfirmEmail\ConfirmEmailSender::sendConfirmationMail	(	IContextSource	$ctx,
		string	$type,
		ConfirmEmailData	$data )

Send the email address confirmation message.

This method: (1) Calls the builder to build the email message (2) Runs onUserSendConfirmationMail to allow extensions to modify the email (3) Calls IEmailer to actually send the message out

Definition at line 91 of file ConfirmEmailSender.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const array MediaWiki\Mail\ConfirmEmail\ConfirmEmailSender::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::PasswordSender,
    ]

Definition at line 27 of file ConfirmEmailSender.php.

◆ EMAIL_TYPE_CHANGED

const string MediaWiki\Mail\ConfirmEmail\ConfirmEmailSender::EMAIL_TYPE_CHANGED = 'changed'

Definition at line 24 of file ConfirmEmailSender.php.

◆ EMAIL_TYPE_CREATED

const string MediaWiki\Mail\ConfirmEmail\ConfirmEmailSender::EMAIL_TYPE_CREATED = 'created'

Definition at line 23 of file ConfirmEmailSender.php.

◆ EMAIL_TYPE_SET

const string MediaWiki\Mail\ConfirmEmail\ConfirmEmailSender::EMAIL_TYPE_SET = 'set'

Definition at line 25 of file ConfirmEmailSender.php.

The documentation for this class was generated from the following file:

includes/Mail/ConfirmEmail/ConfirmEmailSender.php

Public Member Functions

Public Attributes