Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | /** |
| 3 | * Pop PHP Framework (https://www.popphp.org/) |
| 4 | * |
| 5 | * @link https://github.com/popphp/popphp-framework |
| 6 | * @author Nick Sagona, III <dev@noladev.com> |
| 7 | * @copyright Copyright (c) 2009-2026 NOLA Interactive, LLC. |
| 8 | * @license https://www.popphp.org/license New BSD License |
| 9 | */ |
| 10 | |
| 11 | /** |
| 12 | * @namespace |
| 13 | */ |
| 14 | namespace Pop\Mail\Client; |
| 15 | |
| 16 | /** |
| 17 | * Mail client interface |
| 18 | * |
| 19 | * @category Pop |
| 20 | * @package Pop\Mail |
| 21 | * @author Nick Sagona, III <dev@noladev.com> |
| 22 | * @copyright Copyright (c) 2009-2026 NOLA Interactive, LLC. |
| 23 | * @license https://www.popphp.org/license New BSD License |
| 24 | * @version 4.0.7 |
| 25 | */ |
| 26 | interface MailClientInterface |
| 27 | { |
| 28 | |
| 29 | /** |
| 30 | * Get mail client host |
| 31 | * |
| 32 | * @return ?string |
| 33 | */ |
| 34 | public function getHost(): ?string; |
| 35 | |
| 36 | /** |
| 37 | * Get mail client port |
| 38 | * |
| 39 | * @return int|string|null |
| 40 | */ |
| 41 | public function getPort(): int|string|null; |
| 42 | |
| 43 | /** |
| 44 | * Get mail client service |
| 45 | * |
| 46 | * @return ?string |
| 47 | */ |
| 48 | public function getService(): ?string; |
| 49 | |
| 50 | /** |
| 51 | * Get username |
| 52 | * |
| 53 | * @return string |
| 54 | */ |
| 55 | public function getUsername(): string; |
| 56 | |
| 57 | /** |
| 58 | * Get password |
| 59 | * |
| 60 | * @return string |
| 61 | */ |
| 62 | public function getPassword(): string; |
| 63 | |
| 64 | /** |
| 65 | * Get folder |
| 66 | * |
| 67 | * @return string |
| 68 | */ |
| 69 | public function getFolder(): string; |
| 70 | |
| 71 | /** |
| 72 | * Set mail client host |
| 73 | * |
| 74 | * @param string $host |
| 75 | * @return MailClientInterface |
| 76 | */ |
| 77 | public function setHost(string $host): MailClientInterface; |
| 78 | |
| 79 | /** |
| 80 | * Set mail client port |
| 81 | * |
| 82 | * @param int|string $port |
| 83 | * @return MailClientInterface |
| 84 | */ |
| 85 | public function setPort(int|string $port): MailClientInterface; |
| 86 | |
| 87 | /** |
| 88 | * Set mail client service |
| 89 | * |
| 90 | * @param string $service |
| 91 | * @return MailClientInterface |
| 92 | */ |
| 93 | public function setService(string $service): MailClientInterface; |
| 94 | |
| 95 | /** |
| 96 | * Set username |
| 97 | * |
| 98 | * @param string $username |
| 99 | * @return MailClientInterface |
| 100 | */ |
| 101 | public function setUsername(string $username): MailClientInterface; |
| 102 | |
| 103 | /** |
| 104 | * Set password |
| 105 | * |
| 106 | * @param string $password |
| 107 | * @return MailClientInterface |
| 108 | */ |
| 109 | public function setPassword(string $password): MailClientInterface; |
| 110 | |
| 111 | /** |
| 112 | * Set folder |
| 113 | * |
| 114 | * @param string $folder |
| 115 | * @return MailClientInterface |
| 116 | */ |
| 117 | public function setFolder(string $folder): MailClientInterface; |
| 118 | |
| 119 | } |