includes/mail/UserEmailContact.php

   1 <?php
   2
   3 namespace MediaWiki\Mail;
   4
   5 use MediaWiki\User\UserIdentity;
   6
   7 /**
   8  * @since 1.36
   9  * @ingroup Mail
  10  */
  11 interface UserEmailContact {
  12
  13         /**
  14          * Get the identity of the user this contact belongs to.
  15          *
  16          * @return UserIdentity
  17          */
  18         public function getUser(): UserIdentity;
  19
  20         /**
  21          * Get user email address an empty string if unknown.
  22          *
  23          * @return string
  24          */
  25         public function getEmail(): string;
  26
  27         /**
  28          * Get user real name or an empty string if unknown.
  29          *
  30          * @return string
  31          */
  32         public function getRealName(): string;
  33
  34         /**
  35          * Whether user email was confirmed.
  36          *
  37          * @return bool
  38          */
  39         public function isEmailConfirmed(): bool;
  40 }