E-mail delivery
attachments#
List of file paths whose content should be attached to all delivery e-mails
client/html/email/delivery/attachments = Array
(
[0] => invalid
)
- Default: Array
- Type: array - List of absolute file paths
- Since: 2016.10
This configuration option allows you to add files to the e-mails that are sent to the customer when the delivery status changes. These files can't be customer specific.
See also:
- client/html/email/payment/attachments
bcc-email#
E-Mail address all delivery e-mails should be also sent to
client/html/email/delivery/bcc-email =
- Default:
- Type: string|array - E-mail address or list of e-mail addresses
- Since: 2014.03
Using this option you can send a copy of all delivery related e-mails to a second e-mail account. This can be handy for testing and checking the e-mails sent to customers.
It also allows shop owners with a very small volume of orders to be notified about new orders. Be aware that this isn't useful if the order volumne is high or has peeks!
This configuration option overwrites the e-mail address set via "client/html/email/bcc-email".
See also:
- client/html/email/bcc-email
- client/html/email/reply-email
- client/html/email/from-email
decorators#
excludes#
Excludes decorators added by the "common" option from the email delivery html client
client/html/email/delivery/decorators/excludes = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2014.05
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to remove a decorator added via "client/html/common/decorators/default" before they are wrapped around the html client.
client/html/email/delivery/decorators/excludes = array( 'decorator1' )
This would remove the decorator named "decorator1" from the list of common decorators ("\Aimeos\Client\Html\Common\Decorator*") added via "client/html/common/decorators/default" to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/decorators/global
- client/html/email/delivery/decorators/local
global#
Adds a list of globally available decorators only to the email delivery html client
client/html/email/delivery/decorators/global = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2014.05
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to wrap global decorators ("\Aimeos\Client\Html\Common\Decorator*") around the html client.
client/html/email/delivery/decorators/global = array( 'decorator1' )
This would add the decorator named "decorator1" defined by "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/decorators/excludes
- client/html/email/delivery/decorators/local
local#
Adds a list of local decorators only to the email delivery html client
client/html/email/delivery/decorators/local = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2014.05
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to wrap local decorators ("\Aimeos\Client\Html\Email\Decorator*") around the html client.
client/html/email/delivery/decorators/local = array( 'decorator2' )
This would add the decorator named "decorator2" defined by "\Aimeos\Client\Html\Email\Decorator\Decorator2" only to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/decorators/excludes
- client/html/email/delivery/decorators/global
from-email#
E-Mail address used when sending delivery e-mails
client/html/email/delivery/from-email = me@localhost
- Default: me@localhost
- Type: string - E-mail address
- Since: 2014.03
The e-mail address of the person or account that is used for sending all shop related delivery emails to customers. This configuration option overwrites the e-mail address set via "client/html/email/from-email".
See also:
- client/html/email/delivery/from-name
- client/html/email/from-email
- client/html/email/reply-email
- client/html/email/bcc-email
from-name#
Name used when sending delivery e-mails
client/html/email/delivery/from-name = My company
- Default: My company
- Type: string - Name shown in the e-mail
- Since: 2014.03
The name of the person or e-mail account that is used for sending all shop related delivery e-mails to customers. This configuration option overwrites the name set in "client/html/email/from-name".
See also:
- client/html/email/from-name
- client/html/email/from-email
- client/html/email/reply-email
- client/html/email/bcc-email
html#
decorators/excludes#
Excludes decorators added by the "common" option from the "email delivery html" html client
client/html/email/delivery/html/decorators/excludes =
- Default:
- Type: array - List of decorator names
- Since: 2015.08
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to remove a decorator added via "client/html/common/decorators/default" before they are wrapped around the html client.
client/html/email/delivery/html/decorators/excludes = array( 'decorator1' )
This would remove the decorator named "decorator1" from the list of common decorators ("\Aimeos\Client\Html\Common\Decorator*") added via "client/html/common/decorators/default" to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/html/decorators/global
- client/html/email/delivery/html/decorators/local
decorators/global#
Adds a list of globally available decorators only to the "email delivery html" html client
client/html/email/delivery/html/decorators/global = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2015.08
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to wrap global decorators ("\Aimeos\Client\Html\Common\Decorator*") around the html client.
client/html/email/delivery/html/decorators/global = array( 'decorator1' )
This would add the decorator named "decorator1" defined by "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/html/decorators/excludes
- client/html/email/delivery/html/decorators/local
decorators/local#
Adds a list of local decorators only to the "email delivery html" html client
client/html/email/delivery/html/decorators/local = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2015.08
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to wrap local decorators ("\Aimeos\Client\Html\Checkout\Decorator*") around the html client.
client/html/email/delivery/html/decorators/local = array( 'decorator2' )
This would add the decorator named "decorator2" defined by "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/html/decorators/excludes
- client/html/email/delivery/html/decorators/global
name#
Name of the html part used by the email delivery client implementation
client/html/email/delivery/html/name = Standard
- Default: Standard
- Type: string - Last part of the client class name
- Since: 2014.03
Use "Myname" if your class is named "\Aimeos\Client\Html\Email\Delivery\Html\Myname". The name is case-sensitive and you should avoid camel case names like "MyName".
standard/subparts#
List of HTML sub-clients rendered within the email delivery html section
client/html/email/delivery/html/standard/subparts = Array
(
)
- Default: Array
- Type: array - List of sub-client names
- Since: 2014.03
The output of the frontend is composed of the code generated by the HTML clients. Each HTML client can consist of serveral (or none) sub-clients that are responsible for rendering certain sub-parts of the output. The sub-clients can contain HTML clients themselves and therefore a hierarchical tree of HTML clients is composed. Each HTML client creates the output that is placed inside the container of its parent.
At first, always the HTML code generated by the parent is printed, then the HTML code of its sub-clients. The order of the HTML sub-clients determines the order of the output of these sub-clients inside the parent container. If the configured list of clients is
array( "subclient1", "subclient2" )
you can easily change the order of the output by reordering the subparts:
client/html/<clients>/subparts = array( "subclient1", "subclient2" )
You can also remove one or more parts if they shouldn't be rendered:
client/html/<clients>/subparts = array( "subclient1" )
As the clients only generates structural HTML, the layout defined via CSS should support adding, removing or reordering content by a fluid like design.
standard/template-body#
Relative path to the HTML body template of the email delivery html client.
client/html/email/delivery/html/standard/template-body = email/delivery/html-body-standard
- Default: email/delivery/html-body-standard
- Type: string - Relative path to the template creating code for the HTML e-mail body
- Since: 2014.03
The template file contains the HTML code and processing instructions to generate the result shown in the body of the e-mail. The configuration string is the path to the template file relative to the templates directory (usually in client/html/templates).
You can overwrite the template file configuration in extensions and provide alternative templates. These alternative templates should be named like the default one but with the string "standard" replaced by an unique name. You may use the name of your project for this. If you've implemented an alternative client class as well, "standard" should be replaced by the name of the new class.
The email delivery html client allows to use a different template for
each delivery status value. You can create a template for each delivery
status and store it in the "email/delivery/
See also:
- client/html/email/delivery/html/standard/template-header
name#
Class name of the used email delivery client implementation
client/html/email/delivery/name = Standard
- Default: Standard
- Type: string - Last part of the class name
- Since: 2014.03
Each default HTML client can be replace by an alternative imlementation. To use this implementation, you have to set the last part of the class name as configuration value so the client factory knows which class it has to instantiate.
For example, if the name of the default class is
\Aimeos\Client\Html\Email\Delivery\Standard
and you want to replace it with your own version named
\Aimeos\Client\Html\Email\Delivery\Mydelivery
then you have to set the this configuration option:
client/html/email/delivery/name = Mydelivery
The value is the last part of your own class name and it's case sensitive, so take care that the configuration value is exactly named like the last part of the class name.
The allowed characters of the class name are A-Z, a-z and 0-9. No other characters are possible! You should always start the last part of the class name with an upper case character and continue only with lower case characters or numbers. Avoid chamel case names like "MyDelivery"!
reply-email#
E-Mail address used by the customer when replying to delivery e-mails
client/html/email/delivery/reply-email = me@localhost
- Default: me@localhost
- Type: string - E-mail address
- Since: 2014.03
The e-mail address of the person or e-mail account the customer should reply to in case of questions or problems. This configuration option overwrites the e-mail address set via "client/html/email/reply-email".
See also:
- client/html/email/delivery/reply-name
- client/html/email/reply-email
- client/html/email/from-email
- client/html/email/bcc-email
reply-name#
Recipient name displayed when the customer replies to delivery e-mails
client/html/email/delivery/reply-name = My company
- Default: My company
- Type: string - Name shown in the e-mail
- Since: 2014.03
The name of the person or e-mail account the customer should reply to in case of questions or problems. This configuration option overwrites the name set via "client/html/email/reply-name".
See also:
- client/html/email/delivery/reply-email
- client/html/email/reply-name
- client/html/email/reply-email
- client/html/email/from-email
- client/html/email/bcc-email
standard#
subparts#
List of HTML sub-clients rendered within the email delivery section
client/html/email/delivery/standard/subparts = Array
(
[0] => text
[1] => html
)
- Default: Array
- Type: array - List of sub-client names
- Since: 2014.03
The output of the frontend is composed of the code generated by the HTML clients. Each HTML client can consist of serveral (or none) sub-clients that are responsible for rendering certain sub-parts of the output. The sub-clients can contain HTML clients themselves and therefore a hierarchical tree of HTML clients is composed. Each HTML client creates the output that is placed inside the container of its parent.
At first, always the HTML code generated by the parent is printed, then the HTML code of its sub-clients. The order of the HTML sub-clients determines the order of the output of these sub-clients inside the parent container. If the configured list of clients is
array( "subclient1", "subclient2" )
you can easily change the order of the output by reordering the subparts:
client/html/<clients>/subparts = array( "subclient1", "subclient2" )
You can also remove one or more parts if they shouldn't be rendered:
client/html/<clients>/subparts = array( "subclient1" )
As the clients only generates structural HTML, the layout defined via CSS should support adding, removing or reordering content by a fluid like design.
template-body#
Relative path to the text body template of the email delivery client.
client/html/email/delivery/standard/template-body = Array
(
[0] => email/delivery/4/body-standard
[1] => email/delivery/body-standard
)
- Default: Array
- Type: string - Relative path to the template creating code for the e-mail body
- Since: 2014.03
The template file contains the text and processing instructions to generate the result shown in the e-mail. The configuration string is the path to the template file relative to the templates directory (usually in client/html/templates).
You can overwrite the template file configuration in extensions and provide alternative templates. These alternative templates should be named like the default one but with the string "standard" replaced by an unique name. You may use the name of your project for this. If you've implemented an alternative client class as well, "standard" should be replaced by the name of the new class.
The email delivery text client allows to use a different template for
each delivery status value. You can create a template for each delivery
status and store it in the "email/delivery/
See also:
- client/html/email/delivery/standard/template-header
template-header#
Relative path to the text header template of the email delivery client.
client/html/email/delivery/standard/template-header = Array
(
[0] => email/delivery/4/header-standard
[1] => email/delivery/header-standard
)
- Default: Array
- Type: string - Relative path to the template creating code for the e-mail header
- Since: 2014.03
The template file contains the text and processing instructions to generate the text that is inserted into the header of the e-mail. The configuration string is the path to the template file relative to the templates directory (usually in client/html/templates).
You can overwrite the template file configuration in extensions and provide alternative templates. These alternative templates should be named like the default one but with the string "standard" replaced by an unique name. You may use the name of your project for this. If you've implemented an alternative client class as well, "standard" should be replaced by the name of the new class.
The email payment text client allows to use a different template for
each payment status value. You can create a template for each payment
status and store it in the "email/payment/
See also:
- client/html/email/delivery/standard/template-body
text#
decorators/excludes#
Excludes decorators added by the "common" option from the "email delivery text" html client
client/html/email/delivery/text/decorators/excludes =
- Default:
- Type: array - List of decorator names
- Since: 2015.08
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to remove a decorator added via "client/html/common/decorators/default" before they are wrapped around the html client.
client/html/email/delivery/text/decorators/excludes = array( 'decorator1' )
This would remove the decorator named "decorator1" from the list of common decorators ("\Aimeos\Client\Html\Common\Decorator*") added via "client/html/common/decorators/default" to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/text/decorators/global
- client/html/email/delivery/text/decorators/local
decorators/global#
Adds a list of globally available decorators only to the "email delivery text" html client
client/html/email/delivery/text/decorators/global = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2015.08
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to wrap global decorators ("\Aimeos\Client\Html\Common\Decorator*") around the html client.
client/html/email/delivery/text/decorators/global = array( 'decorator1' )
This would add the decorator named "decorator1" defined by "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/text/decorators/excludes
- client/html/email/delivery/text/decorators/local
decorators/local#
Adds a list of local decorators only to the "email delivery text" html client
client/html/email/delivery/text/decorators/local = Array
(
)
- Default: Array
- Type: array - List of decorator names
- Since: 2015.08
Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.
This option allows you to wrap local decorators ("\Aimeos\Client\Html\Checkout\Decorator*") around the html client.
client/html/email/delivery/text/decorators/local = array( 'decorator2' )
This would add the decorator named "decorator2" defined by "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
See also:
- client/html/common/decorators/default
- client/html/email/delivery/text/decorators/excludes
- client/html/email/delivery/text/decorators/global
name#
Name of the text part used by the email delivery client implementation
client/html/email/delivery/text/name = Standard
- Default: Standard
- Type: string - Last part of the client class name
- Since: 2014.03
Use "Myname" if your class is named "\Aimeos\Client\Html\Email\Delivery\Text\Myname". The name is case-sensitive and you should avoid camel case names like "MyName".
standard/subparts#
List of HTML sub-clients rendered within the email delivery text section
client/html/email/delivery/text/standard/subparts = Array
(
)
- Default: Array
- Type: array - List of sub-client names
- Since: 2014.03
The output of the frontend is composed of the code generated by the HTML clients. Each HTML client can consist of serveral (or none) sub-clients that are responsible for rendering certain sub-parts of the output. The sub-clients can contain HTML clients themselves and therefore a hierarchical tree of HTML clients is composed. Each HTML client creates the output that is placed inside the container of its parent.
At first, always the HTML code generated by the parent is printed, then the HTML code of its sub-clients. The order of the HTML sub-clients determines the order of the output of these sub-clients inside the parent container. If the configured list of clients is
array( "subclient1", "subclient2" )
you can easily change the order of the output by reordering the subparts:
client/html/<clients>/subparts = array( "subclient1", "subclient2" )
You can also remove one or more parts if they shouldn't be rendered:
client/html/<clients>/subparts = array( "subclient1" )
As the clients only generates structural HTML, the layout defined via CSS should support adding, removing or reordering content by a fluid like design.
standard/template-body#
Relative path to the text body template of the email delivery text client.
client/html/email/delivery/text/standard/template-body = email/delivery/text-body-standard
- Default: email/delivery/text-body-standard
- Type: string - Relative path to the template creating code for the e-mail body
- Since: 2014.03
The template file contains the text and processing instructions to generate the result shown in the body of the e-mail. The configuration string is the path to the template file relative to the templates directory (usually in client/html/templates).
You can overwrite the template file configuration in extensions and provide alternative templates. These alternative templates should be named like the default one but with the string "standard" replaced by an unique name. You may use the name of your project for this. If you've implemented an alternative client class as well, "standard" should be replaced by the name of the new class.
The email delivery text client allows to use a different template for
each delivery status value. You can create a template for each delivery
status and store it in the "email/delivery/
See also:
- client/html/email/delivery/text/standard/template-header