@@ -129,20 +129,20 @@ With the **Mail Queue** mode, you can see the current content of your mailing qu
## Developer Guide
### Service Classes
##### Register Interface
#### Register Interface
To register your extension you need at least one implementation of this interface.
Inside the **init()** function of your Implementation you should define variables for the following purposes:
######Template Key
A unique Identifier for this particular template. It should be obvious from the template key for what purpose this template is intended.
######Extension Key
#####Extension Key
The extension key of the TYPO3 extension registering with sg_mail. This should be the same for all of your extensions!
######Description
#####Description
A brief description about the template, visible in the backend module
######subject
#####subject
The default subject text for the emails. It is possible to specify language specific texts with an associative array:
[
...
...
@@ -151,7 +151,7 @@ The default subject text for the emails. It is possible to specify language spec
...
]
######markers
#####markers
This is an array of information for substitute variables that are used to replace certain values at runtime.
Each Array element should be its own array and structured like this:
...
...
@@ -183,17 +183,17 @@ This class provides you with an API to the mailing functionality and various hel
Here is an overview of some important functions:
######function registerTemplate
#####function registerTemplate
A static function that adds your template to the service. Should be called from within your **Register** class (see **RegisterInterface**).
######function registerByFile
#####function registerByFile
Registers a template by providing a complete class name of your **RegisterInterface** implementation as an argument.
Needs to be called from within your **ext_localconf.php**.
######function getDefaultTemplateMarker
#####function getDefaultTemplateMarker
Reads custom example template marker from your **locallang.xlf**. This is only useful if you need multi language examples in your Backend Marker
######function getRegisterArray
#####function getRegisterArray
Returns an array of all registered templates, with each element in the following format:
[
...
...
@@ -206,27 +206,27 @@ Returns an array of all registered templates, with each element in the following
'usage' => 'optional description of this templates usage'
]
######function loadPredefinedValuesForTemplate
#####function loadPredefinedValuesForTemplate
Sets the predefined values for this template that have been supplied by the editor. Use this method if you have no custom values for
cc, bcc, replyTo, fromMail and fromName. Returns **false** if the template & extension key combination was not found.
######function sendEmail
#####function sendEmail
Sends your mail or adds it to the mailing queue, depending on the settings. You can specify in with the boolean parameter if the preview values should be used or not.
######function sendMailFromQueue
#####function sendMailFromQueue
Forces the sending of an E-Mail from within the queue. If it has already been sent, it gets send again.
######function setRegisterArray
#####function setRegisterArray
Enables you to overwrite the register array. This overwrites **ALL** registered templates with the supplied data
and should be handled with care.
######function addAttachment
#####function addAttachment
With this function you can add attachments to your mail. The attachment must be of type *Swift_OutputByteStream*. You must also specify the content-type of the attachment.
######function getMailMessage
#####function getMailMessage
You can get the instance of **\TYPO3\CMS\Core\Mail\MailMessage** that is internally used by the service, if you want a more direct interaction with the mail object.
######functions setX
#####functions setX
Sets the various variables to the supplied values. With these functions you can overwrite for instance from/cc/bcc Adresses, from name etc.
You can also tell the **MailTemplateService** to not ignore this mail when adding to the mailing queue: **function setIgnoreMailQueue**.
