aboutsummaryrefslogtreecommitdiffstats
path: root/includes/mail/UserEmailContact.php
blob: 32de48f8de1d17980da45d5cd79e69e2ec11b1b7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<?php

namespace MediaWiki\Mail;

use MediaWiki\User\UserIdentity;

/**
 * @since 1.36
 * @package MediaWiki\Mail
 */
interface UserEmailContact {

	/**
	 * Get the identity of the user this contact belongs to.
	 *
	 * @return UserIdentity
	 */
	public function getUser(): UserIdentity;

	/**
	 * Get user email address an empty string if unknown.
	 *
	 * @return string
	 */
	public function getEmail(): string;

	/**
	 * Get user real name or an empty string if unknown.
	 *
	 * @return string
	 */
	public function getRealName(): string;

	/**
	 * Whether user email was confirmed.
	 *
	 * @return bool
	 */
	public function isEmailConfirmed(): bool;
}