diff --git a/README.md b/README.md index 569a1667d5d498719ee588e9492ec5a200442f74..a74ad7bf0927ccc508bc9d2c50a17298a0bbc4b6 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,9 @@ Clicking on it loads the administration panel. Here you can create, update, dele ## Usage - ### Registering your Extension -To integrate sg_mail available for your extension, you have to register it inside your **ext_localconf.php** +To make sg_mail available for your extension, you have to register it inside your **ext_localconf.php** by supplying a path string to an implementation of **SGalinski\SgMail\Service\RegisterInterface** with: * your extension key @@ -38,11 +37,11 @@ by supplying a path string to an implementation of **SGalinski\SgMail\Service\Re * the template markers(placeholder variables) * the subjects for all templates. Here you have to use an associative array language_code => subject -**Example*** : +**Example** : -An example class can be found here: **SGalinski\SgMail\Example\Register** +A fully working example class can be found here: **SGalinski\SgMail\Example\Register** -Register your class in **ext_localconf.php** with: +All you need to do to get the example to work is registering your class in **ext_localconf.php** with: ```\SGalinski\SgMail\Service\MailTemplateService::registerByFile('SGalinski\SgMail\Example\Register');``` @@ -71,17 +70,16 @@ The higher the priority, the more likely the mail will get send immediately (dep In your **setup.ts** of your formhandler extension, you have to invoke the **FormhandlerFinisherService** of sg_mail. This is done in a similar fashion as with the usual finisher classes. -### Example of sg_formhandler_ordercard +### Example ``` finishers { - # Finisher_Mail sends emails to an admin and/or the user. 1 { class = SGalinski\SgMail\Service\FormhandlerFinisherService config { checkBinaryCrLf = message - template_key = order_card_admin - extension_key = sg_formhandler_ordercard + template_key = your_template + extension_key = extension_key to_address = admin@sgalinski.de from_address = info@sgalinski.de from_name = sgalinski.de @@ -90,3 +88,18 @@ finishers { } } ``` + + +## Developer Guide + +### Service Classes +#### RegisterInterface +#### MailTemplateService +#### FormhandlerFinisherService +#### TypoScriptSettingsService + +## Database and Models + +### The mail queue + +#### The command controller \ No newline at end of file