Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
EmailNotificationInterface Interface Reference
Inheritance diagram for EmailNotificationInterface:
EmailNotification

Public Member Functions

 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 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'
 

Detailed Description

@api

Since
100.1.0

Definition at line 15 of file EmailNotificationInterface.php.

Member Function Documentation

◆ credentialsChanged()

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

Send notification to customer when email and/or password changed

Parameters
CustomerInterface$savedCustomer
string$origCustomerEmail
bool$isPasswordChanged
Returns
void
Since
100.1.0

Implemented in EmailNotification.

◆ 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
Since
100.1.0

Implemented in EmailNotification.

◆ passwordReminder()

passwordReminder ( CustomerInterface  $customer)

Send email with new customer password

Parameters
CustomerInterface$customer
Returns
void
Since
100.1.0

Implemented in EmailNotification.

◆ passwordResetConfirmation()

passwordResetConfirmation ( CustomerInterface  $customer)

Send email with reset password confirmation link

Parameters
CustomerInterface$customer
Returns
void
Since
100.1.0

Implemented in EmailNotification.

Field Documentation

◆ NEW_ACCOUNT_EMAIL_CONFIRMATION

const NEW_ACCOUNT_EMAIL_CONFIRMATION = 'confirmation'

Welcome email, when confirmation is enabled

Definition at line 30 of file EmailNotificationInterface.php.

◆ NEW_ACCOUNT_EMAIL_CONFIRMED

const NEW_ACCOUNT_EMAIL_CONFIRMED = 'confirmed'

Confirmation email, when account is confirmed

Definition at line 35 of file EmailNotificationInterface.php.

◆ NEW_ACCOUNT_EMAIL_REGISTERED

const NEW_ACCOUNT_EMAIL_REGISTERED = 'registered'

Constants for the type of new account email to be sent

Definition at line 20 of file EmailNotificationInterface.php.

◆ NEW_ACCOUNT_EMAIL_REGISTERED_NO_PASSWORD

const NEW_ACCOUNT_EMAIL_REGISTERED_NO_PASSWORD = 'registered_no_password'

Welcome email, when password setting is required

Definition at line 25 of file EmailNotificationInterface.php.


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