Order Mail
|
Product version: |
EPiServer Mail 4.4 SP1 |
|---|---|
|
Document version: |
1.0 |
|
Document last saved: |
The distribution is initiated when the EPiServer Mail Server cluster receives an order mail. The order mail is created either according to the specification below or with the EPiServer Mail Editor (the client part of EPiServer Mail).
The order mail includes the actual email content, subject, sender information, recipients and, etc.
The order mail is sent to “account”@episervermail.episerver.com
Specification of EPiServer Mail OrderMail 2.0
Below is an example and specification of an order mail that complies with EPiServer Mail Order Mail Version 2.0:
----options----
subject: Subject Text
sender: name@domain.com
sendername: The Name
guid: f1e5693f-49b0-40f7-b526-8d3befc02ebc
senddate: 2008-06-23 24:30
----endofoptions----
----maildata----
<html> Hi §a§ §b§!<br>
<br>
Here is the content of the <i>email or Newsletter</i>.
<br>
Your title is §c§
</html>
----endofmaildata----
----maildatatext----
Hi §a§! Here is the content of the email or Newsletter.
----endofmaildatatext----
----htmladdr----
emailA@example.com;Andrew;Anderson;CEO emailB@example.com;Anna;Smith;Partner Manager emailC@example.com;Elvis;Presley;The King emailD@example.com;Tiger;Woods;Golf Pro
----endofhtmladdr----
----textaddr----
emailE@example.com;Andrew;Anderson;CEO emailF@example.com;Anna;Smith;Partner Manager emailG@example.com;Elvis;Presley;The King emailH@example.com;Tiger;Woods;Golf Pro
----endoftextaddr----
Options
In the part of the order mail named ----Options---- the following parameters can be set.
----options----
subject: Subject Text
sender: Name@domain.com
sendername: Name
guid: f1e5693f-49b0-40f7-b526-8d3befc02ebc
senddate: 2006-12-30 24:30
charset: iso-8859-1
----endofoptions----
“Subject” Sets the Subject text for the message.
”Sender” Sets the sender e-mail address.
”Sendername” Sets the name of the sender.
”GUID” Sets the Globally Unique Identifier of the specific newsletter to prevent the same message from being sent out more than once. This replaces the deprecated option “Version”.
”Senddate” Sets when the distribution will start. With this setting it is possible to schedule a distribution. Format for senddate is YYYY-MM-DD HH:MM. Setting this is optional (the entire row should be excluded if not used).
Maildata HTML
In the part of the order mail named ----maildata---- the content of the mail is included. The maildata is only delivered to the email addresses in the order mail ----htmladdr----
----maildata----
<html>
Hi §a§ §b§!<br>
<br>
Here is the content of the <i>email or Newsletter</i>.
<br>
Your title is §c§
</html>
----endofmaildata----
In the example above, variables are being used. The variables are inserted in the email by writing§ before the variable name for example §a§. The variables are assigned names automatically; a, b, c, etc. Below are two examples of how the resulting email from the example would look like to the end user:
Email 1
Hi Andrew Anderson
Here is the content of the email or Newsletter.
Your title is CEO
Email 2
Hi Anna Smith
Here is the content of the email or Newsletter.
Your title is Partner Manager
Maildata Text
The part of the order mail named ----maildata---- works the same way as Maildata except that the content could not be html. The maildata is only delivered to the email addresses in the order mail ----textaddr----
----maildatatext----
Hi §a§! Here is the content of the email or Newsletter.
----endofmaildatatext----
Email addresses and variables
In the part of the order mail named ----htmladdr---- and ----textaddr---- the addresses and variables for the distribution is included. One row for each recipient, containing email addresses and attribute values, separated by semicolon.
----htmladdr----
emailA@example.com;Andrew;Anderson;CEO
emailB@example.com;Anna;Smith;Partner Manager
emailC@example.com;Elvis;Presley;The King
emailD@example.com;Tiger;Woods;Golf Pro
----endofhtmladdr----
----textaddr----
emailE@example.com;Andrew;Anderson;CEO
emailF@example.com;Anna;Smith;Partner Manager
emailG@example.com;Elvis;Presley;The King
emailH@example.com;Tiger;Woods;Golf Pro
----endoftextaddr----
The example below illustrates how the variables for the recipient on the first row are interpreted:
Email address = emailA@example.com
Variable A - §a§ = Andrew
Variable B - §b§ = Anderson
Variable C - §c§ = CEO
Encryption
EPiServer Mail Order Mail Specification 2.0 has support for RSA/AES-based encryption. If the <BrokerPublicKey> parameter in EPiServerMail.config contains a valid public key at EPiServer Mail Editor initialization; all outgoing order mails are encrypted.
Here is an example of an encrypted order mail:
-----BEGIN ORDERMAIL MESSAGE-----
Version: EPiServer Mail Client 4.3.0.0
cdRBVQS7uTf0MdUi0Q+PF6BOR9Lm3Ai01nYuvRhD1gh0hDjCIvDl1rFx5Ixkwps/
bonMFg3neHIOLvTtokpdxefTO/avb3RsbpIZsa7ngD2xHUPyvu6AOTefniu+G+Ih
ob99O3JwwjCHf+AC76Ka7Jf19XcMafTYeiHUCN27NU646cCGkN3bbZGzdAWst0t+
/XXvu6jAMiAcAsbJR1RN2X6wBe2fT06hjg0T89ewNKg3Ks2+d/gtvM55EsbnHi0N
ksVV6NbR5OP4OYSP2PYUJ3NLX6xWzHKBPhBaFUYFxhtqcyGeru1X3XKQP/DNpqYd
nMd1wovZxcW/kS1EJWQQqvTmo2dQQV1FYLwlDNkLsuuVwizRBrMJ9k+ZO5tPB95F
nlNESpgz/EP5OYd+49Di+xaTArE3DQmn87x1XYgXMRd6muhKn36D1kcGziPep59K
zX1Jt0ucHMzkZB0s/jxifU9pi2QWa7w16AgcNxebhBPtPUWj0J5l4ChwuZiFFoCG
FfXci1dM21j/JOGvlVb6Sq7E/9aHTXwi5LUS3MocGhTCak65O3jFzmXQsFq+C2sj
IGAzdkd78MTFdzTSgoT/sP3XWeUqVSiQgVrt9aZQJXVK3QqX9kdQwHvZeKnrtfXq
PDi7sexw4Aze3ElrZA5eZcPNafSzVzQBXngKI3d9SU4/0bsOgnvN3OmHEKkvmrtS
ARwLbJb8aPkvpjBHXbJ/HWlLK2KExk+cHFmuOvg6Z+Rjqb65AZG3CN3veyyieqjy
ATSLdJ0Kusn6EPHGowcbnG/T75y45jcIOhX8qII0hWT1qtPfMjyhFlgPRJvJyiT8
oNLrbmffCSWwYWuUI5TSgaCmrZJ+Oy5SiKaoaQN/Px5lq8M93kMO8DWM5tMPNbmM
Ra6XaRZTshhEex/UKisp0OdT1A6THEjcrs5m+0Yufy3rgw0gOp6QL4aZGyRlifhE
Klc2+o9FKnD/Dnma69C9m61WYm2jAqGPzf9at/Vv5eEdZcgUkWrMKGCvSrXMbCS7
DOPFQwPhPVstMe6xkFA2amY+LQtm4IXF1EwOF8xx ndq/pWRXLzFqfYl9sxquVZX
2eEJgd7KdINghyg9RnL1COQ==
-----END ORDERMAIL MESSAGE-----
-----BEGIN ORDERMAIL KEY-----
giLwNtgaVxYyspoYsjLt74/XfALLwm9JSXN8Z6Ynzf+2LC+Xcirln/oktq4fjDBg
Fwdgpqu6im0xvM/GyrDaE9Ebzf946oWvFdM4nmWxKpZX/ZPLQcDXhO+yg6n0upzk
A0nhQR5hUEaPtg4Bwt6uUf7c kltM+dxOKjk8k0L1p1lWaRjWZdWP/5jdtUrg0aY
IVLT6pbbWPhhP/Y9wrdKIEkrhPci+0ow0wi7Ee+vN62dcFTyejSi2iOYwk9ZbEmi
VpqukKyDYPJMNylh+GrNOU/rIbdJMbYkXSY2Q4esowyuHDOkw/cOKxfrjvUVK116
HLLl8KzxhQbL5AI0EvQ9J0sC5F/Ar697BU6XmDE3ETiC+n9cg9E8saJwv9WVqSCK
Bbur1oOgiLQO9G8NGVYaJ3Z8EDIg1QBExcF0tOfbeHjo1QaJ20Bg1rQJimzwvkOz
+otpjFngLuKq+J4j3wJmx3nEW5fT3XqT1RKVftsPBWwJgA1cjcIjqXuVLkqESGNK
f+XjDuTw1SSyXZbPVwxzc+dbwsemSy1mI6enFaW+6oH3lO8cuKXUihDRAH/JCelL
nPBUKq8hqt7uDd6rA5oFWJuSP45O8UxLr Z9+fm2AZny+Y6memYcORjhXvTYliWE
5xaVtjvSvcx/2F2HMctg2LflXJ3tilvI/IBPmMAlrrtIo=
-----END ORDERMAIL KEY-----
-----BEGIN ORDERMAIL IV-----
cGIC2K8B3ZnMzGy5Lqt3JlYbsfMXB7N/T+L0i6Jz1t2zHkISQN/Ej6OwZ5+mmgWG
/oXDdbhnhGVJ M9PV6dzJiKBjCZqhCKiw6uqkemqwofM+8herk7CzsMaQ3u+pvO0
G2jsBlTq8AeQx/OPhQQk/eVOs6LO2T9iEIdywA4K09gWyuxwxMa7bAwOuKZMzweY
vcfZ/tV14P3wNjNicfpop6ew7dss9RDEO4VtpGIy3Mnfdjgg5J0sIBH2iwO2ySwB
pTSCSKe8Yh/Vdl0KPy2ObkAdA3I13u2kP+jWFTN8GM6lQcAyhzh8GnQLSsIfhduu
BJH1rtaOYgRza6NwQa9MDD177o0iomps0RgG9nfX56kEX0abl3I5lElnO1cekqtW
tZJpGbkdpZ19HdKH6hiVyfhAsm01H/dXlWLA0SqOBQtAC7QS9mgepSBM7TqmJ/0W
2mjemuBK7a7aOV3l071Oho6rA2XDL5oW8QwzMBWzIejP1fFQE65AWDqYOooWSN9W
6GNeNIwbD8fVmp53LCGdrEdV60B3QDQfKNBhvhOVvSPqoUqlEYKOLBbTxF9OynSQ
pnLmQoh3UmILRwND2o63MKiGHbznRZW7Lb/8zplY7gccjGWrO4gRPhW82Fv/QpVh
Oo929fUnPorexXGzc2dMrhJugjaRDNIWmIhFeBv5KUj0=
-----END ORDERMAIL IV-----
EPiServer Mail creates a unique symmetric key and uses it to encrypt the order mail content (found starting at -----BEGIN ORDERMAIL MESSAGE-----). The symmetric key and initialization vector is then encrypted with the custom public RSA key of the EPiServer Mail installation and supplies it for decryption on the server side, as shown in example above.
Headers
From EPiServer Mail Order Mail Specification 2.0, version number is defined in the mail header as parameter “EPiServer-Mail-OrderMail-Version”.
