You are here

public function EmailConfirmationInterface::getStatus in Email confirmer 8

Returns the most representative current status of the email confirmation.

Possible status values:

  • pending: confirmation is pending response
  • confirmed: the email confirmation was sent and positively responded
  • cancelled: the confirmation process was cancelled; request could be sent or not
  • expired: the confirmation age is over the allowed maximum, regardless of any other status

Note that an expired confirmation could be confirmed as well. Check the confirmed status with the isConfirmed method.

Return value

string The current status.

See also

\Drupal\email_confirmer\EmailConfirmationInterface::isConfirmed

1 method overrides EmailConfirmationInterface::getStatus()
EmailConfirmation::getStatus in src/Entity/EmailConfirmation.php
Returns the most representative current status of the email confirmation.

File

src/EmailConfirmationInterface.php, line 129

Class

EmailConfirmationInterface
Email confirmation interface.

Namespace

Drupal\email_confirmer

Code

public function getStatus();