diff options
Diffstat (limited to 'lib/public/Mail')
| -rw-r--r-- | lib/public/Mail/IEMailTemplate.php | 10 | ||||
| -rw-r--r-- | lib/public/Mail/IMailer.php | 4 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/Address.php | 20 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/Attachment.php | 38 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IAddress.php | 16 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IAttachment.php | 30 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IManager.php | 32 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IMessage.php | 58 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IMessageSend.php | 4 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IProvider.php | 30 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/IService.php | 28 | ||||
| -rw-r--r-- | lib/public/Mail/Provider/Message.php | 60 |
12 files changed, 165 insertions, 165 deletions
diff --git a/lib/public/Mail/IEMailTemplate.php b/lib/public/Mail/IEMailTemplate.php index 71a02eff19e..66379abd8ae 100644 --- a/lib/public/Mail/IEMailTemplate.php +++ b/lib/public/Mail/IEMailTemplate.php @@ -57,7 +57,7 @@ interface IEMailTemplate { * * @param string $title * @param string|bool $plainTitle Title that is used in the plain text email - * if empty the $title is used, if false none will be used + * if empty the $title is used, if false none will be used * * @since 12.0.0 */ @@ -68,7 +68,7 @@ interface IEMailTemplate { * * @param string $text; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email * @param string|bool $plainText Text that is used in the plain text email - * if empty the $text is used, if false none will be used + * if empty the $text is used, if false none will be used * * @since 12.0.0 */ @@ -81,9 +81,9 @@ interface IEMailTemplate { * @param string $metaInfo; Note: When $plainMetaInfo falls back to this, HTML is automatically escaped in the HTML email * @param string $icon Absolute path, must be 16*16 pixels * @param string|bool $plainText Text that is used in the plain text email - * if empty the $text is used, if false none will be used + * if empty the $text is used, if false none will be used * @param string|bool $plainMetaInfo Meta info that is used in the plain text email - * if empty the $metaInfo is used, if false none will be used + * if empty the $metaInfo is used, if false none will be used * @param integer plainIndent If > 0, Indent plainText by this amount. * @since 12.0.0 */ @@ -109,7 +109,7 @@ interface IEMailTemplate { * @param string $text Text of button; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email * @param string $url URL of button * @param string|false $plainText Text of button in plain text version - * if empty the $text is used, if false none will be used + * if empty the $text is used, if false none will be used * * @since 12.0.0 */ diff --git a/lib/public/Mail/IMailer.php b/lib/public/Mail/IMailer.php index 93efdce1a2d..18eaef541c0 100644 --- a/lib/public/Mail/IMailer.php +++ b/lib/public/Mail/IMailer.php @@ -69,9 +69,9 @@ interface IMailer { * * @param IMessage $message Message to send * @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and - * therefore should be considered + * therefore should be considered * @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address - * has been supplied.) + * has been supplied.) * @since 8.1.0 */ public function send(IMessage $message): array; diff --git a/lib/public/Mail/Provider/Address.php b/lib/public/Mail/Provider/Address.php index 9cd2859a8a5..44a5544ee4b 100644 --- a/lib/public/Mail/Provider/Address.php +++ b/lib/public/Mail/Provider/Address.php @@ -23,8 +23,8 @@ class Address implements \OCP\Mail\Provider\IAddress { * * @since 30.0.0 * - * @param string|null $address mail address (e.g test@example.com) - * @param string|null $label mail address label/name + * @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, @@ -37,9 +37,9 @@ class Address implements \OCP\Mail\Provider\IAddress { * * @since 30.0.0 * - * @param string $value mail address (e.g. test@example.com) + * @param string $value mail address (e.g. test@example.com) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setAddress(string $value): self { $this->address = $value; @@ -51,9 +51,9 @@ class Address implements \OCP\Mail\Provider\IAddress { * * @since 30.0.0 * - * @return string|null returns the mail address or null if one is not set + * @return string|null returns the mail address or null if one is not set */ - public function getAddress(): string | null { + public function getAddress(): string|null { return $this->address; } @@ -62,9 +62,9 @@ class Address implements \OCP\Mail\Provider\IAddress { * * @since 30.0.0 * - * @param string $value mail address label/name + * @param string $value mail address label/name * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setLabel(string $value): self { $this->label = $value; @@ -76,9 +76,9 @@ class Address implements \OCP\Mail\Provider\IAddress { * * @since 30.0.0 * - * @return string|null returns the mail address label/name or null if one is not set + * @return string|null returns the mail address label/name or null if one is not set */ - public function getLabel(): string | null { + public function getLabel(): string|null { return $this->label; } diff --git a/lib/public/Mail/Provider/Attachment.php b/lib/public/Mail/Provider/Attachment.php index d7790a3bbc6..cb7b9b0d241 100644 --- a/lib/public/Mail/Provider/Attachment.php +++ b/lib/public/Mail/Provider/Attachment.php @@ -23,10 +23,10 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @param string|null $contents binary contents of file - * @param string|null $name file name (e.g example.txt) - * @param string|null $type mime type (e.g. text/plain) - * @param bool $embedded embedded status of the attachment, default is false + * @param string|null $contents binary contents of file + * @param string|null $name file name (e.g example.txt) + * @param string|null $type mime type (e.g. text/plain) + * @param bool $embedded embedded status of the attachment, default is false */ public function __construct( protected ?string $contents, @@ -41,9 +41,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @param string $value file name (e.g example.txt) + * @param string $value file name (e.g example.txt) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setName(string $value): self { $this->name = $value; @@ -55,9 +55,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @return string | null returns the attachment file name or null if not set + * @return string | null returns the attachment file name or null if not set */ - public function getName(): string | null { + public function getName(): string|null { return $this->name; } @@ -66,9 +66,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @param string $value mime type (e.g. text/plain) + * @param string $value mime type (e.g. text/plain) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setType(string $value): self { $this->type = $value; @@ -80,9 +80,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @return string | null returns the attachment mime type or null if not set + * @return string | null returns the attachment mime type or null if not set */ - public function getType(): string | null { + public function getType(): string|null { return $this->type; } @@ -91,9 +91,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @param string $value binary contents of file + * @param string $value binary contents of file * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setContents(string $value): self { $this->contents = $value; @@ -105,9 +105,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @return string | null returns the attachment contents or null if not set + * @return string | null returns the attachment contents or null if not set */ - public function getContents(): string | null { + public function getContents(): string|null { return $this->contents; } @@ -116,9 +116,9 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @param bool $value true - embedded / false - not embedded + * @param bool $value true - embedded / false - not embedded * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setEmbedded(bool $value): self { $this->embedded = $value; @@ -130,7 +130,7 @@ class Attachment implements \OCP\Mail\Provider\IAttachment { * * @since 30.0.0 * - * @return bool embedded status of the attachment + * @return bool embedded status of the attachment */ public function getEmbedded(): bool { return $this->embedded; diff --git a/lib/public/Mail/Provider/IAddress.php b/lib/public/Mail/Provider/IAddress.php index b980f31150b..b5748a51cc0 100644 --- a/lib/public/Mail/Provider/IAddress.php +++ b/lib/public/Mail/Provider/IAddress.php @@ -23,9 +23,9 @@ interface IAddress { * * @since 30.0.0 * - * @param string $value mail address (test@example.com) + * @param string $value mail address (test@example.com) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setAddress(string $value): self; @@ -34,18 +34,18 @@ interface IAddress { * * @since 30.0.0 * - * @return string returns the mail address + * @return string returns the mail address */ - public function getAddress(): string | null; + public function getAddress(): string|null; /** * sets the mail address label/name * * @since 30.0.0 * - * @param string $value mail address label/name + * @param string $value mail address label/name * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setLabel(string $value): self; @@ -54,8 +54,8 @@ interface IAddress { * * @since 30.0.0 * - * @return string returns the mail address label/name + * @return string returns the mail address label/name */ - public function getLabel(): string | null; + public function getLabel(): string|null; } diff --git a/lib/public/Mail/Provider/IAttachment.php b/lib/public/Mail/Provider/IAttachment.php index b5bdffc0e81..e27f5ee066b 100644 --- a/lib/public/Mail/Provider/IAttachment.php +++ b/lib/public/Mail/Provider/IAttachment.php @@ -23,9 +23,9 @@ interface IAttachment { * * @since 30.0.0 * - * @param string $value file name (e.g example.txt) + * @param string $value file name (e.g example.txt) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setName(string $value): self; @@ -34,18 +34,18 @@ interface IAttachment { * * @since 30.0.0 * - * @return string | null returns the attachment file name or null if one is not set + * @return string | null returns the attachment file name or null if one is not set */ - public function getName(): string | null; + public function getName(): string|null; /** * sets the attachment mime type * * @since 30.0.0 * - * @param string $value mime type (e.g. text/plain) + * @param string $value mime type (e.g. text/plain) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setType(string $value): self; @@ -54,18 +54,18 @@ interface IAttachment { * * @since 30.0.0 * - * @return string | null returns the attachment mime type or null if not set + * @return string | null returns the attachment mime type or null if not set */ - public function getType(): string | null; + public function getType(): string|null; /** * sets the attachment contents (actual data) * * @since 30.0.0 * - * @param string $value binary contents of file + * @param string $value binary contents of file * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setContents(string $value): self; @@ -74,18 +74,18 @@ interface IAttachment { * * @since 30.0.0 * - * @return string | null returns the attachment contents or null if not set + * @return string | null returns the attachment contents or null if not set */ - public function getContents(): string | null; + public function getContents(): string|null; /** * sets the embedded status of the attachment * * @since 30.0.0 * - * @param bool $value true - embedded / false - not embedded + * @param bool $value true - embedded / false - not embedded * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setEmbedded(bool $value): self; @@ -94,7 +94,7 @@ interface IAttachment { * * @since 30.0.0 * - * @return bool embedded status of the attachment + * @return bool embedded status of the attachment */ public function getEmbedded(): bool; diff --git a/lib/public/Mail/Provider/IManager.php b/lib/public/Mail/Provider/IManager.php index 4c06cfff87c..ff01f93d2a4 100644 --- a/lib/public/Mail/Provider/IManager.php +++ b/lib/public/Mail/Provider/IManager.php @@ -41,7 +41,7 @@ interface IManager { * * @since 30.0.0 * - * @return array<string,String> collection of provider id and label ['jmap' => 'JMap Connector'] + * @return array<string,String> collection of provider id and label ['jmap' => 'JMap Connector'] */ public function types(): array; @@ -50,7 +50,7 @@ interface IManager { * * @since 30.0.0 * - * @return array<string,IProvider> collection of provider id and object ['jmap' => IProviderObject] + * @return array<string,IProvider> collection of provider id and object ['jmap' => IProviderObject] */ public function providers(): array; @@ -59,20 +59,20 @@ interface IManager { * * @since 30.0.0 * - * @param string $providerId provider id + * @param string $providerId provider id * * @return IProvider|null */ - public function findProviderById(string $providerId): IProvider | null; + public function findProviderById(string $providerId): IProvider|null; /** * retrieve all services for all registered mail providers * * @since 30.0.0 * - * @param string $userId user id + * @param string $userId user id * - * @return array<string,array<string,IService>> collection of provider id, service id and object ['jmap' => ['Service1' => IServiceObject]] + * @return array<string,array<string,IService>> collection of provider id, service id and object ['jmap' => ['Service1' => IServiceObject]] */ public function services(string $userId): array; @@ -81,13 +81,13 @@ interface IManager { * * @since 30.0.0 * - * @param string $userId user id - * @param string $serviceId service id - * @param string $providerId provider id + * @param string $userId user id + * @param string $serviceId service id + * @param string $providerId provider id * - * @return IService|null returns service object or null if none found + * @return IService|null returns service object or null if none found */ - public function findServiceById(string $userId, string $serviceId, ?string $providerId = null): IService | null; + public function findServiceById(string $userId, string $serviceId, ?string $providerId = null): IService|null; /** * retrieve a service for a specific mail address @@ -95,12 +95,12 @@ interface IManager { * * @since 30.0.0 * - * @param string $userId user id - * @param string $address mail address (e.g. test@example.com) - * @param string $providerId provider id + * @param string $userId user id + * @param string $address mail address (e.g. test@example.com) + * @param string $providerId provider id * - * @return IService|null returns service object or null if none found + * @return IService|null returns service object or null if none found */ - public function findServiceByAddress(string $userId, string $address, ?string $providerId = null): IService | null; + public function findServiceByAddress(string $userId, string $address, ?string $providerId = null): IService|null; } diff --git a/lib/public/Mail/Provider/IMessage.php b/lib/public/Mail/Provider/IMessage.php index 625c8a33556..d4f03b24d0d 100644 --- a/lib/public/Mail/Provider/IMessage.php +++ b/lib/public/Mail/Provider/IMessage.php @@ -23,7 +23,7 @@ interface IMessage { * * @since 30.0.0 * - * @return string id of this message + * @return string id of this message */ public function id(): string; @@ -32,9 +32,9 @@ interface IMessage { * * @since 30.0.0 * - * @param IAddress $value sender's mail address object + * @param IAddress $value sender's mail address object * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setFrom(IAddress $value): self; @@ -45,16 +45,16 @@ interface IMessage { * * @return IAddress|null sender's mail address object */ - public function getFrom(): IAddress | null; + public function getFrom(): IAddress|null; /** * sets the sender's reply to address of this message * * @since 30.0.0 * - * @param IAddress $value senders's reply to mail address object + * @param IAddress $value senders's reply to mail address object * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setReplyTo(IAddress $value): self; @@ -65,16 +65,16 @@ interface IMessage { * * @return IAddress|null sender's reply to mail address object */ - public function getReplyTo(): IAddress | null; + public function getReplyTo(): IAddress|null; /** * sets the recipient(s) of this message * * @since 30.0.0 * - * @param IAddress ...$value collection of or one or more mail address objects + * @param IAddress ...$value collection of or one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setTo(IAddress ...$value): self; @@ -92,9 +92,9 @@ interface IMessage { * * @since 30.0.0 * - * @param IAddress ...$value collection of or one or more mail address objects + * @param IAddress ...$value collection of or one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setCc(IAddress ...$value): self; @@ -112,9 +112,9 @@ interface IMessage { * * @since 30.0.0 * - * @param IAddress ...$value collection of or one or more mail address objects + * @param IAddress ...$value collection of or one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBcc(IAddress ...$value): self; @@ -132,9 +132,9 @@ interface IMessage { * * @since 30.0.0 * - * @param string $value subject of mail message + * @param string $value subject of mail message * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setSubject(string $value): self; @@ -145,17 +145,17 @@ interface IMessage { * * @return string|null subject of message or null if one is not set */ - public function getSubject(): string | null; + public function getSubject(): string|null; /** * sets the plain text or html body of this message * * @since 30.0.0 * - * @param string $value text or html body of message - * @param bool $html html flag - true for html + * @param string $value text or html body of message + * @param bool $html html flag - true for html * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBody(string $value, bool $html): self; @@ -168,16 +168,16 @@ interface IMessage { * * @return string|null html/plain body of this message or null if one is not set */ - public function getBody(): string | null; + public function getBody(): string|null; /** * sets the html body of this message * * @since 30.0.0 * - * @param string $value html body of message + * @param string $value html body of message * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBodyHtml(string $value): self; @@ -188,16 +188,16 @@ interface IMessage { * * @return string|null html body of this message or null if one is not set */ - public function getBodyHtml(): string | null; + public function getBodyHtml(): string|null; /** * sets the plain text body of this message * * @since 30.0.0 * - * @param string $value plain text body of message + * @param string $value plain text body of message * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBodyPlain(string $value): self; @@ -208,16 +208,16 @@ interface IMessage { * * @return string|null plain text body of this message or null if one is not set */ - public function getBodyPlain(): string | null; + public function getBodyPlain(): string|null; /** * sets the attachments of this message * * @since 30.0.0 * - * @param IAttachment ...$value collection of or one or more mail attachment objects + * @param IAttachment ...$value collection of or one or more mail attachment objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setAttachments(IAttachment ...$value): self; @@ -226,7 +226,7 @@ interface IMessage { * * @since 30.0.0 * - * @return array<int,IAttachment> collection of all mail attachment objects + * @return array<int,IAttachment> collection of all mail attachment objects */ public function getAttachments(): array; } diff --git a/lib/public/Mail/Provider/IMessageSend.php b/lib/public/Mail/Provider/IMessageSend.php index c5c473bcf2e..fe1b2884452 100644 --- a/lib/public/Mail/Provider/IMessageSend.php +++ b/lib/public/Mail/Provider/IMessageSend.php @@ -23,8 +23,8 @@ interface IMessageSend { * * @since 30.0.0 * - * @param IMessage $message mail message object with all required parameters to send a message - * @param array $options array of options reserved for future use + * @param IMessage $message mail message object with all required parameters to send a message + * @param array $options array of options reserved for future use * * @throws \OCP\Mail\Provider\Exception\SendException on failure, check message for reason */ diff --git a/lib/public/Mail/Provider/IProvider.php b/lib/public/Mail/Provider/IProvider.php index 47d6002f9b0..e94ee73217a 100644 --- a/lib/public/Mail/Provider/IProvider.php +++ b/lib/public/Mail/Provider/IProvider.php @@ -23,7 +23,7 @@ interface IProvider { * * @since 30.0.0 * - * @return string id of this provider (e.g. UUID or 'IMAP/SMTP' or anything else) + * @return string id of this provider (e.g. UUID or 'IMAP/SMTP' or anything else) */ public function id(): string; @@ -32,7 +32,7 @@ interface IProvider { * * @since 30.0.0 * - * @return string label/name of this provider (e.g. Plain Old IMAP/SMTP) + * @return string label/name of this provider (e.g. Plain Old IMAP/SMTP) */ public function label(): string; @@ -41,20 +41,20 @@ interface IProvider { * * @since 30.0.0 * - * @param string $userId user id + * @param string $userId user id * - * @return bool true if any services are configure for the user + * @return bool true if any services are configure for the user */ public function hasServices(string $userId): bool; /** * retrieve collection of services for a specific user * - * @param string $userId user id + * @param string $userId user id * * @since 30.0.0 * - * @return array<string,IService> collection of service id and object ['1' => IServiceObject] + * @return array<string,IService> collection of service id and object ['1' => IServiceObject] */ public function listServices(string $userId): array; @@ -63,31 +63,31 @@ interface IProvider { * * @since 30.0.0 * - * @param string $userId user id - * @param string $serviceId service id + * @param string $userId user id + * @param string $serviceId service id * - * @return IService|null returns service object or null if none found + * @return IService|null returns service object or null if none found */ - public function findServiceById(string $userId, string $serviceId): IService | null; + public function findServiceById(string $userId, string $serviceId): IService|null; /** * retrieve a service for a specific mail address * * @since 30.0.0 * - * @param string $userId user id - * @param string $address mail address (e.g. test@example.com) + * @param string $userId user id + * @param string $address mail address (e.g. test@example.com) * - * @return IService|null returns service object or null if none found + * @return IService|null returns service object or null if none found */ - public function findServiceByAddress(string $userId, string $address): IService | null; + public function findServiceByAddress(string $userId, string $address): IService|null; /** * construct a new empty service object * * @since 30.0.0 * - * @return IService blank service object + * @return IService blank service object */ public function initiateService(): IService; diff --git a/lib/public/Mail/Provider/IService.php b/lib/public/Mail/Provider/IService.php index d23c0a92444..e0bb5161aa6 100644 --- a/lib/public/Mail/Provider/IService.php +++ b/lib/public/Mail/Provider/IService.php @@ -23,7 +23,7 @@ interface IService { * * @since 30.0.0 * - * @return string id of this service (e.g. 1 or service1 or anything else) + * @return string id of this service (e.g. 1 or service1 or anything else) */ public function id(): string; @@ -32,9 +32,9 @@ interface IService { * * @since 30.0.0 * - * @param string $value required ability e.g. 'MessageSend' + * @param string $value required ability e.g. 'MessageSend' * - * @return bool true/false if ability is supplied and found in collection + * @return bool true/false if ability is supplied and found in collection */ public function capable(string $value): bool; @@ -43,7 +43,7 @@ interface IService { * * @since 30.0.0 * - * @return array collection of abilities otherwise empty collection + * @return array collection of abilities otherwise empty collection */ public function capabilities(): array; @@ -52,7 +52,7 @@ interface IService { * * @since 30.0.0 * - * @return string label/name of service (e.g. ACME Company Mail Service) + * @return string label/name of service (e.g. ACME Company Mail Service) */ public function getLabel(): string; @@ -61,9 +61,9 @@ interface IService { * * @since 30.0.0 * - * @param string $value label/name of service (e.g. ACME Company Mail Service) + * @param string $value label/name of service (e.g. ACME Company Mail Service) * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setLabel(string $value): self; @@ -72,7 +72,7 @@ interface IService { * * @since 30.0.0 * - * @return IAddress mail address object + * @return IAddress mail address object */ public function getPrimaryAddress(): IAddress; @@ -81,9 +81,9 @@ interface IService { * * @since 30.0.0 * - * @param IAddress $value mail address object + * @param IAddress $value mail address object * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setPrimaryAddress(IAddress $value): self; @@ -92,7 +92,7 @@ interface IService { * * @since 30.0.0 * - * @return array<int, IAddress> collection of mail address objects + * @return array<int, IAddress> collection of mail address objects */ public function getSecondaryAddresses(): array; @@ -101,9 +101,9 @@ interface IService { * * @since 30.0.0 * - * @param IAddress ...$value collection of one or more mail address objects + * @param IAddress ...$value collection of one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setSecondaryAddresses(IAddress ...$value): self; @@ -112,7 +112,7 @@ interface IService { * * @since 30.0.0 * - * @return IMessage blank message object + * @return IMessage blank message object */ public function initiateMessage(): IMessage; diff --git a/lib/public/Mail/Provider/Message.php b/lib/public/Mail/Provider/Message.php index b5742985fcf..bfa5153f4ef 100644 --- a/lib/public/Mail/Provider/Message.php +++ b/lib/public/Mail/Provider/Message.php @@ -23,7 +23,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param array $data message data array + * @param array $data message data array */ public function __construct( protected array $data = [], @@ -35,7 +35,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @return string id of this message + * @return string id of this message */ public function id(): string { // return id of message @@ -47,9 +47,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param IAddress $value sender's mail address object + * @param IAddress $value sender's mail address object * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setFrom(IAddress $value): self { // create or update field in data store with value @@ -65,7 +65,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @return IAddress|null sender's mail address object */ - public function getFrom(): IAddress | null { + public function getFrom(): IAddress|null { // evaluate if data store field exists and return value(s) or null otherwise return (isset($this->data['from'])) ? $this->data['from'] : null; } @@ -75,9 +75,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param IAddress $value senders's reply to mail address object + * @param IAddress $value senders's reply to mail address object * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setReplyTo(IAddress $value): self { // create or update field in data store with value @@ -93,7 +93,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @return IAddress|null sender's reply to mail address object */ - public function getReplyTo(): IAddress | null { + public function getReplyTo(): IAddress|null { // evaluate if data store field exists and return value(s) or null otherwise return (isset($this->data['replyTo'])) ? $this->data['replyTo'] : null; } @@ -103,9 +103,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param IAddress ...$value collection of or one or more mail address objects + * @param IAddress ...$value collection of or one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setTo(IAddress ...$value): self { // create or update field in data store with value @@ -131,9 +131,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param IAddress ...$value collection of or one or more mail address objects + * @param IAddress ...$value collection of or one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setCc(IAddress ...$value): self { // create or update field in data store with value @@ -159,9 +159,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param IAddress ...$value collection of or one or more mail address objects + * @param IAddress ...$value collection of or one or more mail address objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBcc(IAddress ...$value): self { // create or update field in data store with value @@ -187,9 +187,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param string $value subject of mail message + * @param string $value subject of mail message * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setSubject(string $value): self { // create or update field in data store with value @@ -205,7 +205,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @return string|null subject of message or null if one is not set */ - public function getSubject(): string | null { + public function getSubject(): string|null { // evaluate if data store field exists and return value(s) or null otherwise return (isset($this->data['subject'])) ? $this->data['subject'] : null; } @@ -215,10 +215,10 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param string $value text or html body of message - * @param bool $html html flag - true for html + * @param string $value text or html body of message + * @param bool $html html flag - true for html * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBody(string $value, bool $html = false): self { // evaluate html flag and create or update appropriate field in data store with value @@ -240,7 +240,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @return string|null html/plain body of this message or null if one is not set */ - public function getBody(): string | null { + public function getBody(): string|null { // evaluate if data store field(s) exists and return value if (isset($this->data['bodyHtml'])) { return $this->data['bodyHtml']; @@ -256,9 +256,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param string $value html body of message + * @param string $value html body of message * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBodyHtml(string $value): self { // create or update field in data store with value @@ -274,7 +274,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @return string|null html body of this message or null if one is not set */ - public function getBodyHtml(): string | null { + public function getBodyHtml(): string|null { // evaluate if data store field exists and return value(s) or null otherwise return (isset($this->data['bodyHtml'])) ? $this->data['bodyHtml'] : null; } @@ -284,9 +284,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param string $value plain text body of message + * @param string $value plain text body of message * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setBodyPlain(string $value): self { // create or update field in data store with value @@ -302,7 +302,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @return string|null plain text body of this message or null if one is not set */ - public function getBodyPlain(): string | null { + public function getBodyPlain(): string|null { // evaluate if data store field exists and return value(s) or null otherwise return (isset($this->data['bodyPlain'])) ? $this->data['bodyPlain'] : null; } @@ -312,9 +312,9 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @param IAttachment ...$value collection of or one or more mail attachment objects + * @param IAttachment ...$value collection of or one or more mail attachment objects * - * @return self return this object for command chaining + * @return self return this object for command chaining */ public function setAttachments(IAttachment ...$value): self { // create or update field in data store with value @@ -328,7 +328,7 @@ class Message implements \OCP\Mail\Provider\IMessage { * * @since 30.0.0 * - * @return array<int,IAttachment> collection of all mail attachment objects + * @return array<int,IAttachment> collection of all mail attachment objects */ public function getAttachments(): array { // evaluate if data store field exists and return value(s) or null otherwise |