Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

/<customer>/emails/boards will instruct the WXM_CART2 plugin to load all templates from SAN’s directory /<customer>/emails/boards.

The plugin will expect following templates to exist (default template can be found in WXM_CART2/res/email):

Note

Whereas the recipient of the email refers to an existing user for which we know his UI language, only the default locale is loaded, you cannot define different values for different user locales.

Within the template, you cannot reference the bundle.

...

collaborate.html

The template can be specialized per board type. Create a <type>/collaborate.html

Used to notify a user that he has been added as a collaborator on a cart. Subject of the mail is defined in

Email subject: WXM_CART2 bundle from key: email.collaborate.subject

...

Within the template, you cannot reference the bundle.

...

download-zip.html

The template can be specialized per board type. Create a <type>/download-zip.html

Used to notify a user that a board he owns has been downloaded

Email subject: WXM_CART2 bundle from key: email.download-zip.subject

...

...

share.html

The template can be specialized per board type. Create a <type>/share.html

Used to notify an external user that a board has been shared with him

Email subject: WXM_CART2 bundle from key: email.share.subject

Info

As the recipient is unknown from the system, we cannot determine the locale to use. Only the default locale is loaded, you cannot define different values for different user locales.

Within the template, you cannot reference the bundle.

...

.

...

sharezip.html

The template can be specialized per board type. Create a <type>/sharesharezip.html

Used to notify an external user that a board zip has been shared with him

Email subject: WXM_CART2 bundle from key: email.sharesharezip.subject

Info

As the recipient is unknown from the system, we cannot determine the locale to use. Only the default locale is loaded.

...

zip-available.html

Used to notify a zip

...

is ready

Email subject: WXM_CART2 bundle from key: email.download-zip.subject

Registration related

...

You can customize registration related templates by setting in PACKAGED_RegistrationEmails plugin the parameter email_root with a SAN path to your customized templates folder. Example:

/<customer>/emails/registration will instruct the PACKAGED_RegistrationEmails plugin to load all templates from SAN’s directory /<customer>/emails/registration.

The plugin will expect following templates to exist (default template can be found in PACKAGED_RegistrationEmails/res/email):

account_email_verification.html

Used to verify an email address during the registration process. Recipient has to clink on a link to finalize his account request.

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_email_verification.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_email_verification.title)

body Body text of the email (email.account_email_verification.body)

reason Why user is receiving this email (email.account_email_verification.reason)

buttonLabel Label of the button (email.account_email_verification.verify)

buttonUrl URL of the button

...

account_pending.html

Used to notify a user that his account request is being reviewed

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_pending.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_pending.title)

body Body text of the email (email.account_pending.body)

reason Why user is receiving this email (email.account_pending.reason)

...

account_request.html

Used to notify users of role defined by their ID in plugin approving_recipient_roles_for_public_owner_user parameter or email addresses in approving_recipient_emails_for_public_owner_user that a new account request has been submitted (the email address has been verified)

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_request.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_pending.title)

body Body text of the email (email.account_pending.body)

reason Why user is receiving this email (email.account_pending.reason)

buttonLabel Label of the button to review the account request (email.account_request.button)

buttonUrl Url of the button

user The email of the user requesting access

...

account_welcome.html

Used to notify a user that his account has been activated

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_welcome.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_welcome.title)

body Body text of the email (email.account_welcome.body)

reason Why user is receiving this email (email.account_welcome.reason)

buttonLabel Label of the button to access the application(email.account_welcome.button)

buttonUrl Url of the button

user The email of the user requesting access

...

Common texts

Following PACKAGED_RegistrationEmails bundle keys can be configured:

contact Contact email (email.account_common.contact)

abuse Abuse text (email.account_common.abuse)

Engine based

You can customize engine managed notifications by personalizing templates from /__default/bov3/template/mail in /SAN/__perso/bov3/template/mail

authorizedusers/user_deactivate.html

...

login/mail_confirm_user.html

...

login/mail_password_changed.html

...

statusPageEvents/mail_status_page_events.html