Skip to content

E-Mail components

Common#

The Aimeos web shop can send out e-mails after for every payment and delivery status update which also includes the confirmation e-mail. Some configuration options listed in this section are very important for shop owners as you should configure at least the e-mail addresses!

The options that are shared and which you should keep an eye on:

client/html/email/logo
Path to the logo image displayed in HTML e-mails
client/html/email/from-email
E-Mail address used when sending e-mails
client/html/email/from-name
Name used when sending e-mails
client/html/email/reply-email
E-Mail address used by the customer when replying to e-mails
client/html/email/reply-name
Recipient name displayed when the customer replies to e-mails
client/html/email/bcc-email
E-Mail address all e-mails should be also sent to (can be used as notification of the shop owner)

Account#

Aimeos is able to create customer accounts after placing an order automatically. The customers will get an e-mail that contains the credentials for their new accounts created by the customer/email/account job controller.

Structure#

Account e-mails consists of a HTML and a text part. They are sent in one e-mail as alternative views and the mail clients will display the one that is preferred by the customer.

Aimeos-email-account-html Aimeos-email-account-text

Templates#

You can adapt the templates for the HTML/text account e-mails itself and the included sections by overwriting them in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Delivery#

Delivery e-mails are sent out by the order/email/delivery job after the delivery status of an order has changed. The available order delivery status values are :

  • STAT_UNFINISHED (-1)
  • STAT_DELETED (0)
  • STAT_PENDING (1)
  • STAT_PROGRESS (2)
  • STAT_DISPATCHED (3)
  • STAT_DELIVERED (4)
  • STAT_LOST (5)
  • STAT_REFUSED (6)
  • STAT_RETURNED (7)

For each of these delivery status values you are able to send out an e-mail to the customers informing them about the delivery status change. For which status changes e-mails are sent is configured via the controller/jobs/order/email/delivery/standard/status setting.

E-Mail settings#

Shop owners have the possibility to configure specific e-mail settings for the delivery e-mails that differ from the common settings. Each specific setting overwrites the correlated common setting for the delivery e-mails. The list of specific settings is:

client-html/email-delivery/from-email
E-Mail address used when sending delivery e-mails
client-html/email-delivery/from-name
Name used when sending delivery e-mails
client-html/email-delivery/reply-email
E-Mail address used by the customer when replying to delivery e-mails
client-html/email-delivery/reply-name
Recipient name displayed when the customer replies to delivery e-mails
client-html/email-delivery/bcc-email
E-Mail address all delivery e-mails should be also sent to (can be used as notification for the shop owner)

Structure#

Delivery e-mails consists of an HTML and a text part. They are sent in one e-mail as alternative views and the mail clients will display the one that is preferred by the customer.

Aimeos-email-service-html Aimeos-email-service-text

Templates#

You can adapt the templates for the HTML/text delivery e-mails itself and the included sections by overwriting them in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Payment#

Payment e-mails are sent out by the order/email/payment job after the payment status of an order has changed. This is also used for the order confirmation e-mails which are sent when the payment status is "authorized" or "received". The available order payment status values are :

  • PAY_UNFINISHED (-1)
  • PAY_DELETED (0)
  • PAY_CANCELED (1)
  • PAY_REFUSED (2)
  • PAY_REFUND (3)
  • PAY_PENDING (4)
  • PAY_AUTHORIZED (5)
  • PAY_RECEIVED (6)

For each of these payment status values you are able to send out an e-mail to the customers informing them about the payment status change. For which status changes e-mails are sent is configured via the controller/jobs/order/email/payment/standard/status setting.

E-Mail settings#

Shop owners have the possibility to configure specific e-mail settings for the payment e-mails that differ from the common settings. Each specific setting overwrites the correlated common setting for the payment e-mails. The list of specific settings is:

Structure#

Payment e-mails consists of an HTML and a text part. They are sent in one e-mail as alternative views and the mail clients will display the one that is preferred by the customer.

Aimeos-email-service-html Aimeos-email-service-text

Templates#

You can adapt the templates for the HTML/text payment e-mails itself and the included sections by overwriting the templates in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Product watch#

Notification e-mails for watched products are sent out by the customer/email/watch job after the product was updated. This includes both, price and stock level updates.

E-Mail settings#

Shop owners have the possibility to configure specific e-mail settings for the product notification e-mails that differ from the common settings. Each specific setting overwrites the correlated common setting for the watch e-mails. The list of specific settings is:

client-html/email-watch/from-email
E-Mail address used when sending notification e-mails
client-html/email-watch/from-name
Name used when sending notification e-mails
client-html/email-watch/reply-email
E-Mail address used by the customer when replying to notification e-mails
client-html/email-watch/reply-name
Recipient name displayed when the customer replies to notification e-mails
client-html/email-watch/bcc-email
E-Mail address all notification e-mails should be also sent to (can be used for debug purposes or to explicitly remove a common BCC e-mail address by setting it to NULL)

Structure#

Product notification e-mails consists of an HTML and a text part. They are sent in one e-mail as alternative views and the mail clients will display the one that is preferred by the customer.

Aimeos-email-watch-html Aimeos-email-watch-text

Templates#

You can adapt the templates for the HTML/text product notification e-mails itself and the included sections by overwriting them in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Comments