Skillnad mellan versioner av "Templating:Emails"

Från Vendre Help
Hoppa till: navigering, sök
(→‎order_confirmation)
(→‎order_confirmation)
 
(21 mellanliggande versioner av 5 användare visas inte)
Rad 36: Rad 36:
 
|settings.ACCOUNT_GENDER
 
|settings.ACCOUNT_GENDER
 
|boolean
 
|boolean
 +
|
 +
|-
 +
|settings.CREATE_ACCOUNT_BY_ORDER
 +
|boolean
 +
|
 +
|-
 +
|settings.SHOP_LOGO
 +
|string
 +
|
 +
|-
 +
|settings.INVOICE_LOGO
 +
|string
 +
|
 +
|-
 +
|settings.INVOICE_ORG_NUMBER
 +
|string
 +
|
 +
|-
 +
|settings.INVOICE_STORE_ADDRESS
 +
|string
 +
|
 +
|-
 +
|settings.INVOICE_STORE_POST_ADDRESS
 +
|string
 +
|
 +
|-
 +
|settings.INVOICE_TELEPHONE
 +
|string
 
|
 
|
 
|}
 
|}
Rad 69: Rad 97:
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
 +
!Description
 
|-
 
|-
 
| enquiry
 
| enquiry
 +
| The message sent in.
 +
|-
 +
| fields
 +
| The POST variable 'fields' passed along, support for PHP array fields is available.
 
|}
 
|}
 +
 
===create_account===
 
===create_account===
 
Sent when customer's account has been automatically activated.
 
Sent when customer's account has been automatically activated.
Rad 82: Rad 116:
 
|-
 
|-
 
| lastname
 
| lastname
 +
|}
 +
 +
===customer_created===
 +
Belongs to plugin customer_created_notification_email.
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|customer
 +
|
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|entry_firstname
 +
|
 +
|-
 +
|entry_lastname
 +
|
 +
|-
 +
|entry_street_address
 +
|
 +
|-
 +
|entry_street_address2
 +
|
 +
|-
 +
|entry_city
 +
|
 +
|-
 +
|entry_postcode
 +
|
 +
|-
 +
|entry_country_id
 +
|
 +
|-
 +
|customers_email_address
 +
|
 +
|-
 +
|customers_telephone
 +
|
 +
|-
 +
|customers_mobile
 +
|
 +
|-
 +
|customers_group_id
 +
|
 +
|-
 +
|customers_id
 +
|
 +
|}
 +
 +
|-
 +
|customer_admin_href
 +
|Link to customer administration page.
 +
|-
 +
|customer_entry_country_name
 +
|Name of country in customer.entry_country_id.
 +
|-
 +
|customer_customer_group_name
 +
|Name of group in customer.customer_group_name.
 +
|-
 +
|source
 +
|Different strings depending on from where the customer was created.
 
|}
 
|}
  
Rad 93: Rad 192:
 
| message
 
| message
 
|}
 
|}
 +
 
===get_new_pass===
 
===get_new_pass===
 
{| class="wikitable"
 
{| class="wikitable"
Rad 130: Rad 230:
 
| customer_id
 
| customer_id
 
|-
 
|-
−
| order_Id
+
| customer_external_id
 +
|-
 +
| order_id
 +
|-
 +
| previous_order_count
 
|-
 
|-
 
| order_info_url
 
| order_info_url
Rad 149: Rad 253:
 
|-
 
|-
 
| payment_module_footer
 
| payment_module_footer
 +
|
 +
| Not availabe for all modules.
 +
|-
 +
| shipping_module_footer
 
|-
 
|-
 
|custom
 
|custom
Rad 154: Rad 262:
 
|Custom fields.
 
|Custom fields.
 
|-
 
|-
−
| payment_module_footer
+
|partner
−
| [[Templating:Variables#partner||partner]]
+
|[[Templating:Variables#partner|partner]]
 +
|-
 +
|order
 +
|[[Templating:Variables#dictionary|dictionary]]
 +
|
 +
{| class="wikitable"
 +
! Key !! Type !! Description
 +
|-
 +
| products || [[Templating:Variables#list|list]] ||
 +
{| class="wikitable"
 +
! Key !! Type !! Description
 +
|-
 +
|qty
 +
|
 +
|
 +
|-
 +
|op_id
 +
|
 +
|
 +
|-
 +
|id
 +
|
 +
|
 +
|-
 +
|name
 +
|
 +
|
 +
|-
 +
|model
 +
|
 +
|
 +
|-
 +
|tax_class_id
 +
|
 +
|
 +
|-
 +
|tax
 +
|
 +
|
 +
|-
 +
|price
 +
|
 +
|
 +
|-
 +
|status
 +
|
 +
|
 +
|-
 +
|href
 +
|
 +
|
 +
|-
 +
|image
 +
|
 +
|
 +
|-
 +
|final_price
 +
|
 +
|
 +
|-
 +
|total_price
 +
|
 +
|
 +
|-
 +
|total_final_price
 +
|
 +
|
 +
|-
 +
|final_price_difference
 +
|
 +
|
 +
|-
 +
|total_final_price_difference
 +
|
 +
|
 +
|-
 +
|final_price_discount_percent
 +
|
 +
|
 +
|-
 +
| package_content
 +
|
 +
|
 +
|-
 +
| unit
 +
|
 +
|
 +
|-
 +
| unit_title
 +
|
 +
|
 +
|-
 +
| external_unit
 +
|
 +
|
 +
|-
 +
| external_unit_title
 +
|
 +
|
 +
|-
 +
|attributes
 +
|[[Templating:Variables#list|list]]
 +
|
 +
{| class="wikitable"
 +
! Key !! Type !! Description
 +
|-
 +
|option
 +
|
 +
|
 +
|-
 +
|value
 +
|
 +
|
 +
|-
 +
|value_comment
 +
|
 +
|
 +
|-
 +
|prefix
 +
|
 +
|
 +
|-
 +
|price
 +
|
 +
|
 +
|}
 +
|-
 +
| variants || [[Templating:Variables#list|list]] ||
 +
{| class="wikitable"
 +
! Key !! Type !! Description
 +
|-
 +
| id ||
 +
|-
 +
| name ||
 +
|-
 +
| choice || [[Templating:Variables#dictionary|dictionary]] ||
 +
{| class="wikitable"
 +
! Key !! Description
 +
|-
 +
| id ||
 +
|-
 +
| name ||
 +
|}
 +
|}
 +
|}
 +
|}
 +
|-
 +
|discounts
 +
|
 +
|
 +
|-
 +
|partner
 +
|
 +
|
 +
|-
 +
|custom
 +
|
 +
|
 +
|-
 +
|p_authorize_order_order
 +
|
 +
|
 +
|-
 +
|urbit
 +
|
 +
|
 +
|-
 +
|order_references
 +
|[[Templating:Variables#dictionary|dictionary]]
 +
|Order integration references for the order.  The dictionary key is an integration key and the value is a reference value of type string.
 +
 
 +
{| class="wikitable"
 +
! Key !! Description
 +
|-
 +
|svea_checkout_shipping_option
 +
|Available for Svea Checkout.
 +
|-
 +
|nshift_parcel_numbers
 +
|
 +
|-
 +
|ecster_pay_checkout
 +
|Availble for Ecster Pay Checkout.
 +
|-
 +
|nshift_prepared_shipment_id
 +
|
 +
|-
 +
|nshift_prepared_shipment_service_code
 +
|Available for Klarna Checkout.
 +
|-
 +
|nshift_pickup_location_id
 +
|Available for Klarna Checkout.
 +
|-
 +
|APP4SALES_CMS
 +
|No value stored.
 +
|-
 +
|APP4SALES_ERP
 +
|No value stored.
 +
|}
 +
 
 +
|}
 +
 
 +
====Customer Data====
 +
In order_confirmation, variable: order.customer
 +
{| class="wikitable"
 +
!Name
 +
|-
 +
| login_id
 +
|-
 +
| name
 +
|-
 +
| company
 +
|-
 +
| street_address
 +
|-
 +
| street_address2
 +
|-
 +
| suburb
 +
|-
 +
| city
 +
|-
 +
| postcode
 +
|-
 +
| state
 +
|-
 +
| country
 +
|-
 +
| country_id
 +
|-
 +
| zone_id
 +
|-
 +
| format_id
 +
|-
 +
| telephone
 +
|-
 +
| ip
 +
|-
 +
| email_address
 +
|-
 +
| personnummer
 +
|-
 +
| personnummer_validated
 +
|-
 +
| personnummer_validated_ip
 +
|-
 +
| vat_identification_number
 +
|-
 +
| customers_group_id
 +
|-
 +
| mobile
 
|}
 
|}
  
Rad 176: Rad 532:
 
|-
 
|-
 
| new_password
 
| new_password
 +
|-
 +
| firstname
 +
|-
 +
| lastname
 
|}
 
|}
 +
 
===question_about_product===
 
===question_about_product===
 
Sent from question_about_product.php.
 
Sent from question_about_product.php.
Rad 188: Rad 549:
 
| signature
 
| signature
 
|}
 
|}
 +
 +
===reservation/customer_reservation_created===
 +
Sent from PostReservation.php.
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|store_url
 +
|Link to store
 +
|-
 +
|url_accept
 +
|Link to accept the reservation
 +
|-
 +
|url_reject
 +
|Link to reject the reservation
 +
|-
 +
|partner
 +
|
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|id
 +
|Partner id
 +
|-
 +
|name
 +
|Partner name
 +
|-
 +
|display_name
 +
|Partner display name
 +
|-
 +
|address
 +
|Partner address
 +
|-
 +
|zip
 +
|Zip code (postnummer)
 +
|-
 +
|city
 +
|City (ort)
 +
|-
 +
|phone
 +
|Phone number
 +
|-
 +
|Email
 +
|Email address
 +
|}
 +
 +
|-
 +
|reservation
 +
|
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|id
 +
|Reservation id
 +
|-
 +
|name
 +
|Customer name
 +
|-
 +
|email
 +
|Customer email
 +
|-
 +
|phone
 +
|Customer phone number
 +
|-
 +
|created_at
 +
|Reservation created date
 +
|-
 +
|updated_at
 +
|Reservation last updated date
 +
|-
 +
|status
 +
|Reservation status
 +
|-
 +
|data
 +
|Store specific extra data (json)
 +
|-
 +
|products
 +
|Array of products
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|id
 +
|Product id
 +
|-
 +
|quantity
 +
|Quantity reserved
 +
|-
 +
|model
 +
|Product model
 +
|-
 +
|name
 +
|Product name
 +
|-
 +
|image
 +
|Image object
 +
|}
 +
|}
 +
|}
 +
 +
===reservation/customer_reservation_processed===
 +
Sent from ReservationChanged.php.
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|store_url
 +
|Link to store
 +
 +
|-
 +
|constants
 +
|
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|STATUS_CREATED
 +
|Initial status
 +
|-
 +
|STATUS_CANCELED
 +
|
 +
|-
 +
|STATUS_ACCEPTED
 +
|
 +
|}
 +
 +
|-
 +
|partner
 +
|
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|id
 +
|Partner id
 +
|-
 +
|name
 +
|Partner name
 +
|-
 +
|display_name
 +
|Partner display name
 +
|-
 +
|address
 +
|Partner address
 +
|-
 +
|zip
 +
|Zip code (postnummer)
 +
|-
 +
|city
 +
|City (ort)
 +
|-
 +
|phone
 +
|Phone number
 +
|-
 +
|Email
 +
|Email address
 +
|}
 +
 +
|-
 +
|reservation
 +
|
 +
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|id
 +
|Reservation id
 +
|-
 +
|name
 +
|Customer name
 +
|-
 +
|email
 +
|Customer email
 +
|-
 +
|phone
 +
|Customer phone number
 +
|-
 +
|created_at
 +
|Reservation created date
 +
|-
 +
|updated_at
 +
|Reservation last updated date
 +
|-
 +
|status
 +
|Reservation status
 +
|-
 +
|data
 +
|Store specific extra data (json)
 +
|-
 +
|products
 +
|Array of products
 +
{| class="wikitable"
 +
!Name
 +
!Description
 +
|-
 +
|id
 +
|Product id
 +
|-
 +
|quantity
 +
|Quantity reserved
 +
|-
 +
|model
 +
|Product model
 +
|-
 +
|name
 +
|Product name
 +
|-
 +
|image
 +
|Image object
 +
|}
 +
|}
 +
|}
 +
 +
Reservation status can be confirmed using the reservation constants.
 +
 
===tell_a_friend===
 
===tell_a_friend===
 
Sent from tell_a_friend.php.
 
Sent from tell_a_friend.php.
Rad 204: Rad 789:
 
!Name
 
!Name
 
|-
 
|-
−
| order_id
+
| action
 +
|-
 +
| order
 
|-
 
|-
 
| order_href
 
| order_href
Rad 212: Rad 799:
 
| order_status
 
| order_status
 
|-
 
|-
−
| new_comment
+
| comment
 +
|-
 +
| template_method
 +
|-
 +
| template_group
 
|}
 
|}
  

Nuvarande version från 23 oktober 2024 kl. 17.07

See also Templating:Variables.

Globals

Name Type Description
from.name string Name of sender. Often the same as store_owner.
from.email string Email of sender. Often the same as store_email.
to.name string Name of first recipient.
to.email string Email of first recipient.
store_name string "Butiksnamn" under "Allmän information".
store_owner string "Företagsnamn" under "Allmän information".
store_email string "E-postaddress" under "Allmän information".
settings.ACCOUNT_GENDER boolean
settings.CREATE_ACCOUNT_BY_ORDER boolean
settings.SHOP_LOGO string
settings.INVOICE_LOGO string
settings.INVOICE_ORG_NUMBER string
settings.INVOICE_STORE_ADDRESS string
settings.INVOICE_STORE_POST_ADDRESS string
settings.INVOICE_TELEPHONE string

Emails

Templates support both text and HTML, and language-specific files. If only a text template is available, a text-only email is sent. If text and HTML templates are available, a multipart message is sent. If only an HTML template is available, a multipart message is sent with the content of htmlonly.txt as the text part.

Language-specific templates are looked for before language-neutral templates. Names are constructed from the base name, the ISO 639-1 language code, and the file extension; example: contact.en.html.

activate_customer

Sent when customer's account has been manually activated.

Name
customers_id

administrators

Sent when an administrator's account has been updated.

Name
username
password
login_href

contact

Sent from contact.php.

Name Description
enquiry The message sent in.
fields The POST variable 'fields' passed along, support for PHP array fields is available.

create_account

Sent when customer's account has been automatically activated.

Name
customer_id
firstname
lastname

customer_created

Belongs to plugin customer_created_notification_email.

Name Description
customer
Name Description
entry_firstname
entry_lastname
entry_street_address
entry_street_address2
entry_city
entry_postcode
entry_country_id
customers_email_address
customers_telephone
customers_mobile
customers_group_id
customers_id
customer_admin_href Link to customer administration page.
customer_entry_country_name Name of country in customer.entry_country_id.
customer_customer_group_name Name of group in customer.customer_group_name.
source Different strings depending on from where the customer was created.

customer_mail

Sent from Admin/mail.php.

Name
subject
message

get_new_pass

Name
remote_addr
new_password

newsletter

Name
subject
content

newsletter_send

Sent from Admin/newsletter_send.php.

Name
subject
content

order_confirmation

Name
customer_comments
customer_telephone
customer_mobile
customer_id
customer_external_id
order_id
previous_order_count
order_info_url
order_date
item_list
list_total
delivery_address
billing_address
payment_module_text
shipping_module_text
payment_module_footer Not availabe for all modules.
shipping_module_footer
custom list of custom field Custom fields.
partner partner
order dictionary
Key Type Description
products list
Key Type Description
qty
op_id
id
name
model
tax_class_id
tax
price
status
href
image
final_price
total_price
total_final_price
final_price_difference
total_final_price_difference
final_price_discount_percent
package_content
unit
unit_title
external_unit
external_unit_title
attributes list
Key Type Description
option
value
value_comment
prefix
price
variants list
Key Type Description
id
name
choice dictionary
Key Description
id
name
discounts
partner
custom
p_authorize_order_order
urbit
order_references dictionary Order integration references for the order. The dictionary key is an integration key and the value is a reference value of type string.
Key Description
svea_checkout_shipping_option Available for Svea Checkout.
nshift_parcel_numbers
ecster_pay_checkout Availble for Ecster Pay Checkout.
nshift_prepared_shipment_id
nshift_prepared_shipment_service_code Available for Klarna Checkout.
nshift_pickup_location_id Available for Klarna Checkout.
APP4SALES_CMS No value stored.
APP4SALES_ERP No value stored.

Customer Data

In order_confirmation, variable: order.customer

Name
login_id
name
company
street_address
street_address2
suburb
city
postcode
state
country
country_id
zone_id
format_id
telephone
ip
email_address
personnummer
personnummer_validated
personnummer_validated_ip
vat_identification_number
customers_group_id
mobile

order_print

Sent from Admin/order_print.php. Order PDF is attached.

Name
subject
content

password_forgotten

Sent from password_forgotten.php.

Name
request_ip
new_password
firstname
lastname

question_about_product

Sent from question_about_product.php.

Name
message
product
signature

reservation/customer_reservation_created

Sent from PostReservation.php.

Name Description
store_url Link to store
url_accept Link to accept the reservation
url_reject Link to reject the reservation
partner
Name Description
id Partner id
name Partner name
display_name Partner display name
address Partner address
zip Zip code (postnummer)
city City (ort)
phone Phone number
Email Email address
reservation
Name Description
id Reservation id
name Customer name
email Customer email
phone Customer phone number
created_at Reservation created date
updated_at Reservation last updated date
status Reservation status
data Store specific extra data (json)
products Array of products
Name Description
id Product id
quantity Quantity reserved
model Product model
name Product name
image Image object

reservation/customer_reservation_processed

Sent from ReservationChanged.php.

Name Description
store_url Link to store
constants
Name Description
STATUS_CREATED Initial status
STATUS_CANCELED
STATUS_ACCEPTED
partner
Name Description
id Partner id
name Partner name
display_name Partner display name
address Partner address
zip Zip code (postnummer)
city City (ort)
phone Phone number
Email Email address
reservation
Name Description
id Reservation id
name Customer name
email Customer email
phone Customer phone number
created_at Reservation created date
updated_at Reservation last updated date
status Reservation status
data Store specific extra data (json)
products Array of products
Name Description
id Product id
quantity Quantity reserved
model Product model
name Product name
image Image object

Reservation status can be confirmed using the reservation constants.

tell_a_friend

Sent from tell_a_friend.php.

Name
message
product
signature

update_order

Sent when an order is updated.

Name
action
order
order_href
order_date
order_status
comment
template_method
template_group

Files

email.html

Extended by some HTML templates.

htmlonly.txt

Used when an email does not have a text alternative, but does have an HTML alternative.

Hämtad från "https://wiki.vendre.se/index.php?title=Templating:Emails&oldid=8049"