blob: ff01f93d2a4082a55ea0867625d14eba3c27fc59 (
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?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 Provider Manager Interface
*
* This interface is a base requirement of methods and functionality used to construct a mail provider manager object
*
* @since 30.0.0
*
*/
interface IManager {
/**
* determine if any mail providers are registered
*
* @since 30.0.0
*
* @return bool
*/
public function has(): bool;
/**
* retrieve a count of how many mail providers are registered
*
* @since 30.0.0
*
* @return int
*/
public function count(): int;
/**
* retrieve which mail providers are registered
*
* @since 30.0.0
*
* @return array<string,String> collection of provider id and label ['jmap' => 'JMap Connector']
*/
public function types(): array;
/**
* retrieve all registered mail providers
*
* @since 30.0.0
*
* @return array<string,IProvider> collection of provider id and object ['jmap' => IProviderObject]
*/
public function providers(): array;
/**
* retrieve a provider with a specific id
*
* @since 30.0.0
*
* @param string $providerId provider id
*
* @return 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
*
* @return array<string,array<string,IService>> collection of provider id, service id and object ['jmap' => ['Service1' => IServiceObject]]
*/
public function services(string $userId): array;
/**
* retrieve a service with a specific id
*
* @since 30.0.0
*
* @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
*/
public function findServiceById(string $userId, string $serviceId, ?string $providerId = null): IService|null;
/**
* retrieve a service for a specific mail address
* returns first service with specific primary address
*
* @since 30.0.0
*
* @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
*/
public function findServiceByAddress(string $userId, string $address, ?string $providerId = null): IService|null;
}
|
