mirror of
https://github.com/nextcloud/server.git
synced 2026-06-20 05:59:40 -04:00
119 lines
2.3 KiB
PHP
119 lines
2.3 KiB
PHP
<?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;
|
|
|
|
use JsonSerializable;
|
|
use OCP\Json\JsonDeserializable;
|
|
|
|
/**
|
|
* Mail Address Object
|
|
*
|
|
* This object is used to define the address and label of a email address
|
|
*
|
|
* @since 30.0.0
|
|
*
|
|
*/
|
|
class Address implements IAddress, JsonSerializable, JsonDeserializable {
|
|
|
|
/**
|
|
* initialize the mail address object
|
|
*
|
|
* @since 30.0.0
|
|
*
|
|
* @param string|null $address mail address (e.g test@example.com)
|
|
* @param string|null $label mail address label/name
|
|
*/
|
|
public function __construct(
|
|
protected ?string $address = null,
|
|
protected ?string $label = null,
|
|
) {
|
|
}
|
|
|
|
/**
|
|
* export this objects data as an array
|
|
*
|
|
* @since 33.0.0
|
|
*
|
|
* @return array representation of this object as an array
|
|
*/
|
|
public function jsonSerialize(): array {
|
|
return [
|
|
'address' => $this->address,
|
|
'label' => $this->label,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* import this objects data from an array
|
|
*
|
|
* @since 33.0.0
|
|
*
|
|
* @param array array representation of this object
|
|
*/
|
|
public static function jsonDeserialize(array|string $data): static {
|
|
if (is_string($data)) {
|
|
$data = json_decode($data, true);
|
|
}
|
|
$address = $data['address'] ?? null;
|
|
$label = $data['label'] ?? null;
|
|
|
|
return new static($address, $label);
|
|
}
|
|
|
|
/**
|
|
* sets the mail address
|
|
*
|
|
* @since 30.0.0
|
|
*
|
|
* @param string $value mail address (e.g. test@example.com)
|
|
*
|
|
* @return self return this object for command chaining
|
|
*/
|
|
public function setAddress(string $value): self {
|
|
$this->address = $value;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* gets the mail address
|
|
*
|
|
* @since 30.0.0
|
|
*
|
|
* @return string|null returns the mail address or null if one is not set
|
|
*/
|
|
public function getAddress(): ?string {
|
|
return $this->address;
|
|
}
|
|
|
|
/**
|
|
* 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 {
|
|
$this->label = $value;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* gets the mail address label/name
|
|
*
|
|
* @since 30.0.0
|
|
*
|
|
* @return string|null returns the mail address label/name or null if one is not set
|
|
*/
|
|
public function getLabel(): ?string {
|
|
return $this->label;
|
|
}
|
|
|
|
}
|