Skip to content

Commit

Permalink
Merge pull request #47452 from nextcloud/fix/issue-47447-mail-provide…
Browse files Browse the repository at this point in the history
…r-documentation

fix: correct documentation for mail provider
  • Loading branch information
SebastianKrupinski authored Aug 23, 2024
2 parents 4a3ade5 + b260dd0 commit e5e795c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
18 changes: 9 additions & 9 deletions lib/public/Mail/Provider/IMessage.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public function setFrom(IAddress $value): self;
*
* @since 30.0.0
*
* @param IAddress|null sender's mail address object
* @return IAddress|null sender's mail address object
*/
public function getFrom(): IAddress | null;

Expand All @@ -63,7 +63,7 @@ public function setReplyTo(IAddress $value): self;
*
* @since 30.0.0
*
* @param IAddress|null sender's reply to mail address object
* @return IAddress|null sender's reply to mail address object
*/
public function getReplyTo(): IAddress | null;

Expand All @@ -83,7 +83,7 @@ public function setTo(IAddress ...$value): self;
*
* @since 30.0.0
*
* @param array<int,IAddress> collection of all recipient mail address objects
* @return array<int,IAddress> collection of all recipient mail address objects
*/
public function getTo(): array;

Expand All @@ -103,7 +103,7 @@ public function setCc(IAddress ...$value): self;
*
* @since 30.0.0
*
* @param array<int,IAddress> collection of all copied recipient mail address objects
* @return array<int,IAddress> collection of all copied recipient mail address objects
*/
public function getCc(): array;

Expand All @@ -123,7 +123,7 @@ public function setBcc(IAddress ...$value): self;
*
* @since 30.0.0
*
* @param array<int,IAddress> collection of all blind copied recipient mail address objects
* @return array<int,IAddress> collection of all blind copied recipient mail address objects
*/
public function getBcc(): array;

Expand All @@ -143,7 +143,7 @@ public function setSubject(string $value): self;
*
* @since 30.0.0
*
* @param string|null subject of message or null if one is not set
* @return string|null subject of message or null if one is not set
*/
public function getSubject(): string | null;

Expand All @@ -166,7 +166,7 @@ public function setBody(string $value, bool $html): self;
*
* @since 30.0.0
*
* @param string|null html/plain body of this message or null if one is not set
* @return string|null html/plain body of this message or null if one is not set
*/
public function getBody(): string | null;

Expand All @@ -186,7 +186,7 @@ public function setBodyHtml(string $value): self;
*
* @since 30.0.0
*
* @param string|null html body of this message or null if one is not set
* @return string|null html body of this message or null if one is not set
*/
public function getBodyHtml(): string | null;

Expand All @@ -206,7 +206,7 @@ public function setBodyPlain(string $value): self;
*
* @since 30.0.0
*
* @param string|null plain text body of this message or null if one is not set
* @return string|null plain text body of this message or null if one is not set
*/
public function getBodyPlain(): string | null;

Expand Down
2 changes: 1 addition & 1 deletion lib/public/Mail/Provider/IMessageSend.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ interface IMessageSend {
*
* @throws \OCP\Mail\Provider\Exception\SendException on failure, check message for reason
*/
public function sendMessage(IMessage $message, array $option = []): void;
public function sendMessage(IMessage $message, array $options = []): void;

}
4 changes: 2 additions & 2 deletions lib/public/Mail/Provider/IService.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public function id(): string;
/**
* checks if a service is able of performing an specific action
*
* @since 4.0.0
* @since 30.0.0
*
* @param string $value required ability e.g. 'MessageSend'
*
Expand All @@ -41,7 +41,7 @@ public function capable(string $value): bool;
/**
* retrieves a collection of what actions a service can perfrom
*
* @since 4.0.0
* @since 30.0.0
*
* @return array collection of abilities otherwise empty collection
*/
Expand Down
18 changes: 9 additions & 9 deletions lib/public/Mail/Provider/Message.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public function setFrom(IAddress $value): self {
*
* @since 30.0.0
*
* @param IAddress|null sender's mail address object
* @return IAddress|null sender's mail address object
*/
public function getFrom(): IAddress | null {
// evaluate if data store field exists and return value(s) or null otherwise
Expand Down Expand Up @@ -91,7 +91,7 @@ public function setReplyTo(IAddress $value): self {
*
* @since 30.0.0
*
* @param IAddress|null sender's reply to mail address object
* @return IAddress|null sender's reply to mail address object
*/
public function getReplyTo(): IAddress | null {
// evaluate if data store field exists and return value(s) or null otherwise
Expand Down Expand Up @@ -119,7 +119,7 @@ public function setTo(IAddress ...$value): self {
*
* @since 30.0.0
*
* @param array<int,IAddress> collection of all recipient mail address objects
* @return array<int,IAddress> collection of all recipient mail address objects
*/
public function getTo(): array {
// evaluate if data store field exists and return value(s) or empty collection
Expand Down Expand Up @@ -147,7 +147,7 @@ public function setCc(IAddress ...$value): self {
*
* @since 30.0.0
*
* @param array<int,IAddress> collection of all copied recipient mail address objects
* @return array<int,IAddress> collection of all copied recipient mail address objects
*/
public function getCc(): array {
// evaluate if data store field exists and return value(s) or empty collection
Expand Down Expand Up @@ -175,7 +175,7 @@ public function setBcc(IAddress ...$value): self {
*
* @since 30.0.0
*
* @param array<int,IAddress> collection of all blind copied recipient mail address objects
* @return array<int,IAddress> collection of all blind copied recipient mail address objects
*/
public function getBcc(): array {
// evaluate if data store field exists and return value(s) or empty collection
Expand Down Expand Up @@ -203,7 +203,7 @@ public function setSubject(string $value): self {
*
* @since 30.0.0
*
* @param string|null subject of message or null if one is not set
* @return string|null subject of message or null if one is not set
*/
public function getSubject(): string | null {
// evaluate if data store field exists and return value(s) or null otherwise
Expand Down Expand Up @@ -238,7 +238,7 @@ public function setBody(string $value, bool $html = false): self {
*
* @since 30.0.0
*
* @param string|null html/plain body of this message or null if one is not set
* @return string|null html/plain body of this message or null if one is not set
*/
public function getBody(): string | null {
// evaluate if data store field(s) exists and return value
Expand Down Expand Up @@ -272,7 +272,7 @@ public function setBodyHtml(string $value): self {
*
* @since 30.0.0
*
* @param string|null html body of this message or null if one is not set
* @return string|null html body of this message or null if one is not set
*/
public function getBodyHtml(): string | null {
// evaluate if data store field exists and return value(s) or null otherwise
Expand Down Expand Up @@ -300,7 +300,7 @@ public function setBodyPlain(string $value): self {
*
* @since 30.0.0
*
* @param string|null plain text body of this message or null if one is not set
* @return string|null plain text body of this message or null if one is not set
*/
public function getBodyPlain(): string | null {
// evaluate if data store field exists and return value(s) or null otherwise
Expand Down

0 comments on commit e5e795c

Please sign in to comment.