Inheritance diagram for EmailNotification:

Public Member Functions
	__construct (CustomerRegistry $customerRegistry, StoreManagerInterface $storeManager, TransportBuilder $transportBuilder, CustomerViewHelper $customerViewHelper, DataObjectProcessor $dataProcessor, ScopeConfigInterface $scopeConfig, SenderResolverInterface $senderResolver=null)

	credentialsChanged (CustomerInterface $savedCustomer, $origCustomerEmail, $isPasswordChanged=false)

	passwordReminder (CustomerInterface $customer)

	passwordResetConfirmation (CustomerInterface $customer)

	newAccount (CustomerInterface $customer, $type=self::NEW_ACCOUNT_EMAIL_REGISTERED, $backUrl='', $storeId=0, $sendemailStoreId=null)

Data Fields
const	XML_PATH_FORGOT_EMAIL_IDENTITY = 'customer/password/forgot_email_identity'

const	XML_PATH_RESET_PASSWORD_TEMPLATE = 'customer/password/reset_password_template'

const	XML_PATH_CHANGE_EMAIL_TEMPLATE = 'customer/account_information/change_email_template'

const	XML_PATH_CHANGE_EMAIL_AND_PASSWORD_TEMPLATE

const	XML_PATH_FORGOT_EMAIL_TEMPLATE = 'customer/password/forgot_email_template'

const	XML_PATH_REMIND_EMAIL_TEMPLATE = 'customer/password/remind_email_template'

const	XML_PATH_REGISTER_EMAIL_IDENTITY = 'customer/create_account/email_identity'

const	XML_PATH_REGISTER_EMAIL_TEMPLATE = 'customer/create_account/email_template'

const	XML_PATH_REGISTER_NO_PASSWORD_EMAIL_TEMPLATE = 'customer/create_account/email_no_password_template'

const	XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'customer/create_account/email_confirmation_template'

const	XML_PATH_CONFIRMED_EMAIL_TEMPLATE = 'customer/create_account/email_confirmed_template'

const	TEMPLATE_TYPES

Data Fields inherited from EmailNotificationInterface
const	NEW_ACCOUNT_EMAIL_REGISTERED = 'registered'

const	NEW_ACCOUNT_EMAIL_REGISTERED_NO_PASSWORD = 'registered_no_password'

const	NEW_ACCOUNT_EMAIL_CONFIRMATION = 'confirmation'

const	NEW_ACCOUNT_EMAIL_CONFIRMED = 'confirmed'

Protected Attributes
	$customerViewHelper

	$dataProcessor

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 22 of file EmailNotification.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	CustomerRegistry	$customerRegistry,
		StoreManagerInterface	$storeManager,
		TransportBuilder	$transportBuilder,
		CustomerViewHelper	$customerViewHelper,
		DataObjectProcessor	$dataProcessor,
		ScopeConfigInterface	$scopeConfig,
		SenderResolverInterface	$senderResolver = `null`
	)

Parameters

CustomerRegistry	$customerRegistry
StoreManagerInterface	$storeManager
TransportBuilder	$transportBuilder
CustomerViewHelper	$customerViewHelper
DataObjectProcessor	$dataProcessor
ScopeConfigInterface	$scopeConfig
SenderResolverInterface \| null	$senderResolver

Definition at line 110 of file EmailNotification.php.

       {
         $this->customerRegistry = $customerRegistry;
         $this->storeManager = $storeManager;
         $this->transportBuilder = $transportBuilder;
         $this->customerViewHelper = $customerViewHelper;
         $this->dataProcessor = $dataProcessor;
         $this->scopeConfig = $scopeConfig;
         $this->senderResolver = $senderResolver ?: ObjectManager::getInstance()->get(SenderResolverInterface::class);
     }

Member Function Documentation

◆ credentialsChanged()

credentialsChanged	(	CustomerInterface	$savedCustomer,
			$origCustomerEmail,
			$isPasswordChanged = `false`
	)

Send notification to customer when email or/and password changed

Parameters

CustomerInterface	$savedCustomer
string	$origCustomerEmail
bool	$isPasswordChanged

Returns: void

Implements EmailNotificationInterface.

Definition at line 136 of file EmailNotification.php.

       {
         if ($origCustomerEmail != $savedCustomer->getEmail()) {
             if ($isPasswordChanged) {
                 $this->emailAndPasswordChanged($savedCustomer, $origCustomerEmail);
                 $this->emailAndPasswordChanged($savedCustomer, $savedCustomer->getEmail());
                 return;
             }
 
             $this->emailChanged($savedCustomer, $origCustomerEmail);
             $this->emailChanged($savedCustomer, $savedCustomer->getEmail());
             return;
         }
 
         if ($isPasswordChanged) {
             $this->passwordReset($savedCustomer);
         }
     }

◆ newAccount()

newAccount	(	CustomerInterface	$customer,
			$type = `self::NEW_ACCOUNT_EMAIL_REGISTERED`,
			$backUrl = `''`,
			$storeId = `0`,
			$sendemailStoreId = `null`
	)

Send email with new account related information

Parameters

CustomerInterface	$customer
string	$type
string	$backUrl
string	$storeId
string	$sendemailStoreId

Returns: void

Exceptions

LocalizedException

Implements EmailNotificationInterface.

Definition at line 368 of file EmailNotification.php.

       {
         $types = self::TEMPLATE_TYPES;
 
         if (!isset($types[$type])) {
             throw new LocalizedException(
                 __('The transactional account email type is incorrect. Verify and try again.')
             );
         }
 
         if (!$storeId) {
             $storeId = $this->getWebsiteStoreId($customer, $sendemailStoreId);
         }
 
         $store = $this->storeManager->getStore($customer->getStoreId());
 
         $customerEmailData = $this->getFullCustomerObject($customer);
 
         $this->sendEmailTemplate(
             $customer,
             $types[$type],
             self::XML_PATH_REGISTER_EMAIL_IDENTITY,
             ['customer' => $customerEmailData, 'back_url' => $backUrl, 'store' => $store],
             $storeId
         );
     }

◆ passwordReminder()

passwordReminder ( CustomerInterface $customer )

Send email with new customer password

Parameters

CustomerInterface $customer

Returns: void

Implements EmailNotificationInterface.

Definition at line 315 of file EmailNotification.php.

     {
         $storeId = $customer->getStoreId();
         if (!$storeId) {
             $storeId = $this->getWebsiteStoreId($customer);
         }
 
         $customerEmailData = $this->getFullCustomerObject($customer);
 
         $this->sendEmailTemplate(
             $customer,
             self::XML_PATH_REMIND_EMAIL_TEMPLATE,
             self::XML_PATH_FORGOT_EMAIL_IDENTITY,
             ['customer' => $customerEmailData, 'store' => $this->storeManager->getStore($storeId)],
             $storeId
         );
     }

◆ passwordResetConfirmation()

passwordResetConfirmation ( CustomerInterface $customer )

Send email with reset password confirmation link

Parameters

CustomerInterface $customer

Returns: void

Implements EmailNotificationInterface.

Definition at line 339 of file EmailNotification.php.

     {
         $storeId = $this->storeManager->getStore()->getId();
         if (!$storeId) {
             $storeId = $this->getWebsiteStoreId($customer);
         }
 
         $customerEmailData = $this->getFullCustomerObject($customer);
 
         $this->sendEmailTemplate(
             $customer,
             self::XML_PATH_FORGOT_EMAIL_TEMPLATE,
             self::XML_PATH_FORGOT_EMAIL_IDENTITY,
             ['customer' => $customerEmailData, 'store' => $this->storeManager->getStore($storeId)],
             $storeId
         );
     }

Field Documentation

◆ $customerViewHelper

$customerViewHelper

protected

Definition at line 84 of file EmailNotification.php.

◆ $dataProcessor

$dataProcessor

protected

Definition at line 89 of file EmailNotification.php.

◆ TEMPLATE_TYPES

const TEMPLATE_TYPES

Initial value:

= [
        self::NEW_ACCOUNT_EMAIL_REGISTERED => self::XML_PATH_REGISTER_EMAIL_TEMPLATE,
        self::NEW_ACCOUNT_EMAIL_REGISTERED_NO_PASSWORD => self::XML_PATH_REGISTER_NO_PASSWORD_EMAIL_TEMPLATE,
        self::NEW_ACCOUNT_EMAIL_CONFIRMED => self::XML_PATH_CONFIRMED_EMAIL_TEMPLATE,
        self::NEW_ACCOUNT_EMAIL_CONFIRMATION => self::XML_PATH_CONFIRM_EMAIL_TEMPLATE,
    ]

self::NEW_ACCOUNT_EMAIL_REGISTERED welcome email, when confirmation is disabled and password is set self::NEW_ACCOUNT_EMAIL_REGISTERED_NO_PASSWORD welcome email, when confirmation is disabled and password is not set self::NEW_ACCOUNT_EMAIL_CONFIRMED welcome email, when confirmation is enabled and password is set self::NEW_ACCOUNT_EMAIL_CONFIRMATION email with confirmation link

Definition at line 59 of file EmailNotification.php.

◆ XML_PATH_CHANGE_EMAIL_AND_PASSWORD_TEMPLATE

const XML_PATH_CHANGE_EMAIL_AND_PASSWORD_TEMPLATE

Initial value:

=

'customer/account_information/change_email_and_password_template'

Definition at line 33 of file EmailNotification.php.

◆ XML_PATH_CHANGE_EMAIL_TEMPLATE

const XML_PATH_CHANGE_EMAIL_TEMPLATE = 'customer/account_information/change_email_template'

Definition at line 31 of file EmailNotification.php.

◆ XML_PATH_CONFIRM_EMAIL_TEMPLATE

const XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'customer/create_account/email_confirmation_template'

Definition at line 46 of file EmailNotification.php.

◆ XML_PATH_CONFIRMED_EMAIL_TEMPLATE

const XML_PATH_CONFIRMED_EMAIL_TEMPLATE = 'customer/create_account/email_confirmed_template'

Definition at line 48 of file EmailNotification.php.

◆ XML_PATH_FORGOT_EMAIL_IDENTITY

const XML_PATH_FORGOT_EMAIL_IDENTITY = 'customer/password/forgot_email_identity'

#+ Configuration paths for email templates and identities

Definition at line 27 of file EmailNotification.php.

◆ XML_PATH_FORGOT_EMAIL_TEMPLATE

const XML_PATH_FORGOT_EMAIL_TEMPLATE = 'customer/password/forgot_email_template'

Definition at line 36 of file EmailNotification.php.

◆ XML_PATH_REGISTER_EMAIL_IDENTITY

const XML_PATH_REGISTER_EMAIL_IDENTITY = 'customer/create_account/email_identity'

Definition at line 40 of file EmailNotification.php.

◆ XML_PATH_REGISTER_EMAIL_TEMPLATE

const XML_PATH_REGISTER_EMAIL_TEMPLATE = 'customer/create_account/email_template'

Definition at line 42 of file EmailNotification.php.

◆ XML_PATH_REGISTER_NO_PASSWORD_EMAIL_TEMPLATE

const XML_PATH_REGISTER_NO_PASSWORD_EMAIL_TEMPLATE = 'customer/create_account/email_no_password_template'

Definition at line 44 of file EmailNotification.php.

◆ XML_PATH_REMIND_EMAIL_TEMPLATE

const XML_PATH_REMIND_EMAIL_TEMPLATE = 'customer/password/remind_email_template'

Definition at line 38 of file EmailNotification.php.

◆ XML_PATH_RESET_PASSWORD_TEMPLATE

const XML_PATH_RESET_PASSWORD_TEMPLATE = 'customer/password/reset_password_template'

Definition at line 29 of file EmailNotification.php.

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

vendor/magento/module-customer/Model/EmailNotification.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ credentialsChanged()

◆ newAccount()

◆ passwordReminder()

◆ passwordResetConfirmation()

Field Documentation

◆ $customerViewHelper

◆ $dataProcessor

◆ TEMPLATE_TYPES

◆ XML_PATH_CHANGE_EMAIL_AND_PASSWORD_TEMPLATE

◆ XML_PATH_CHANGE_EMAIL_TEMPLATE

◆ XML_PATH_CONFIRM_EMAIL_TEMPLATE

◆ XML_PATH_CONFIRMED_EMAIL_TEMPLATE

◆ XML_PATH_FORGOT_EMAIL_IDENTITY

◆ XML_PATH_FORGOT_EMAIL_TEMPLATE

◆ XML_PATH_REGISTER_EMAIL_IDENTITY

◆ XML_PATH_REGISTER_EMAIL_TEMPLATE

◆ XML_PATH_REGISTER_NO_PASSWORD_EMAIL_TEMPLATE

◆ XML_PATH_REMIND_EMAIL_TEMPLATE

◆ XML_PATH_RESET_PASSWORD_TEMPLATE