You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: developer_manual/digging_deeper/groupware/mail_provider.rst
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -16,17 +16,17 @@ The reverse is also possible, one can register an app to supply mail services to
16
16
Terminology
17
17
-----------
18
18
19
-
For clarificaftion this is a referace of terminology used.
19
+
For clarificaftion this is a reference of terminology used.
20
20
21
21
1. *Provider* - this is the app that provides mail services e.g. "BigHostingApp", this can a general app for a specific protocol
22
-
2. *Service* - this is a configure mail service account e.g. "Big Email Hosting Co". Each mail provider may have multiple mail services configure for a user.
22
+
2. *Service* - this is a configured mail service account e.g. "Big Email Hosting Co". Each mail provider may have multiple mail services configured for a user.
23
23
24
24
.. _mail-provider-consume:
25
25
26
26
Consuming a Mail Service
27
27
------------------------
28
28
29
-
To use mail a service provided by another app your app only needs to instance the mail manager class, then use the built in methods to list or find an appropriate provider and service.
29
+
To use mail as a service provided by another app, your app needs to instantiate the mail manager class, then use the built in methods to list or find an appropriate provider and service.
30
30
31
31
.. code-block:: php
32
32
@@ -116,7 +116,7 @@ For your app to provide mail service to other apps, your app needs to implement
116
116
Step 1: Create a Mail Provider Class
117
117
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118
118
119
-
The mail provider class is the main class that the mail manager uses to retrieve available services from your app. Each mail provider can have multiple mail services configure for a user.
119
+
The mail provider class is the main class that the mail manager uses to retrieve available services from your app. Each mail provider can have multiple mail services configured for a user.
120
120
121
121
This class needs to implement the `IProvider` interface and have all the required methods defined.
122
122
@@ -150,7 +150,7 @@ This class needs to implement the `IProvider` interface and have all the require
150
150
}
151
151
152
152
public function findServiceByAddress(string $userId, string $address): IService | null {
153
-
// app specific code to find a with a specific email address
153
+
// app specific code to find a service with a specific email address
154
154
}
155
155
156
156
}
@@ -196,7 +196,7 @@ This class needs to implement the `IService` interface and have all the required
196
196
}
197
197
198
198
public function getSecondaryAddresses(): array {
199
-
// app specific code to retrieve the secondary (aliases) email addresses of the service
199
+
// app specific code to retrieve the secondary email addresses (aliases) of the service
200
200
}
201
201
202
202
public function initiateMessage(): IMessage {
@@ -214,7 +214,7 @@ This class needs to implement the `IService` interface and have all the required
214
214
Step 3: Register the Mail Provider
215
215
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
216
216
217
-
The registration is performed at the initial stages of your app being loaded by the Nextcloud system, inside the 'AppInfo/Application.php'
217
+
The registration is performed at the initial stages of your app being loaded by the Nextcloud system, inside the 'AppInfo/Application.php' file
218
218
219
219
.. code-block:: php
220
220
@@ -234,7 +234,7 @@ The registration is performed at the initial stages of your app being loaded by
234
234
235
235
public function register(IRegistrationContext $context): void {
236
236
237
-
// Tip: If your app spans multiple version of Nextcloud, we recommend testing to make sure the method exists 'method_exists()' first
237
+
// Tip: If your app spans multiple version of Nextcloud, we recommend to make sure the method exists with 'method_exists()'
0 commit comments