aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Mail/Provider/IAddress.php
blob: b980f31150b378fbc35e8b8d55b5ae895f3e490d (plain)
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Mail\Provider;

/**
 * Mail Address Interface
 *
 * This interface is a base requirement of methods and functionality used to construct a mail address object
 *
 * @since 30.0.0
 *
 */
interface IAddress {
	
	/**
	 * sets the mail address
	 *
	 * @since 30.0.0
	 *
	 * @param string $value     mail address (test@example.com)
	 *
	 * @return self             return this object for command chaining
	 */
	public function setAddress(string $value): self;

	/**
	 * gets the mail address
	 *
	 * @since 30.0.0
	 *
	 * @return string			returns the mail address
	 */
	public function getAddress(): string | null;

	/**
	 * sets the mail address label/name
	 *
	 * @since 30.0.0
	 *
	 * @param string $value     mail address label/name
	 *
	 * @return self             return this object for command chaining
	 */
	public function setLabel(string $value): self;

	/**
	 * gets the mail address label/name
	 *
	 * @since 30.0.0
	 *
	 * @return string			returns the mail address label/name
	 */
	public function getLabel(): string | null;

}