Skip to content

Commit 1cd28f5

Browse files
feat: mail provider
Signed-off-by: SebastianKrupinski <[email protected]>
1 parent 96f9258 commit 1cd28f5

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

developer_manual/digging_deeper/groupware/mail_provider.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ The reverse is also possible, one can register an app to supply mail services to
1616
Terminology
1717
-----------
1818

19-
For clarificaftion this is a referace of terminology used.
19+
For clarificaftion this is a reference of terminology used.
2020

2121
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.
2323

2424
.. _mail-provider-consume:
2525

2626
Consuming a Mail Service
2727
------------------------
2828

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.
3030

3131
.. code-block:: php
3232
@@ -116,7 +116,7 @@ For your app to provide mail service to other apps, your app needs to implement
116116
Step 1: Create a Mail Provider Class
117117
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118118

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.
120120

121121
This class needs to implement the `IProvider` interface and have all the required methods defined.
122122

@@ -150,7 +150,7 @@ This class needs to implement the `IProvider` interface and have all the require
150150
}
151151
152152
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
154154
}
155155
156156
}
@@ -196,7 +196,7 @@ This class needs to implement the `IService` interface and have all the required
196196
}
197197
198198
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
200200
}
201201
202202
public function initiateMessage(): IMessage {
@@ -214,7 +214,7 @@ This class needs to implement the `IService` interface and have all the required
214214
Step 3: Register the Mail Provider
215215
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
216216

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
218218

219219
.. code-block:: php
220220
@@ -234,7 +234,7 @@ The registration is performed at the initial stages of your app being loaded by
234234
235235
public function register(IRegistrationContext $context): void {
236236
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()'
238238
$context->registerMailProvider(MailProvider::class);
239239
240240
}

0 commit comments

Comments
 (0)