Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
sg_mail
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TYPO3
sg_mail
Commits
cbabe118
Commit
cbabe118
authored
7 years ago
by
Torsten Oppermann
Browse files
Options
Downloads
Patches
Plain Diff
[TASK] Working on readme wip
parent
33423287
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+22
-9
22 additions, 9 deletions
README.md
with
22 additions
and
9 deletions
README.md
+
22
−
9
View file @
cbabe118
...
...
@@ -25,10 +25,9 @@ Clicking on it loads the administration panel. Here you can create, update, dele
## Usage
### Registering your Extension
To
integrat
e sg_mail available for your extension, you have to register it inside your
**ext_localconf.php**
To
mak
e 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**
:
A
n
example class can be found here:
**SGalinski\SgMail\Example\Register**
A
fully working
example class can be found here:
**SGalinski\SgMail\Example\Register**
R
egister your class in
**ext_localconf.php**
with:
All you need to do to get the example to work is r
egister
ing
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
\S
gMail
\S
ervice
\F
ormhandlerFinisherService
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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment