E-mail Template

Available in: Enterprise edition.

Select the SystemTools -> Email -> Templates menu option to customize the e-mail sent out. The Email Template form will be displayed.

Select Add to create a new template or Edit to edit an existing template setup. Fill in the following fields:

Code - This is the code by which you want the email template to be referenced in the WorldLink system.
Description - This field is for providing a description of the email template.
Email Type - Select the email type, that is the event for which the template is used (Shipped, Delivered or Late).
Recipient Type - Select the recipient type for which this template should be used. Options are All, Sender, Recipient and Requestor.
Send On - This option is only available when the Email Type is Shipped. Select Processed Date to send the email when the shipment is processed. Select Manifest Date to hold the email until the shipment has been manifested.

Select the View button to view or edit the template.

The XML object used in inserting details about the shipment is the same as the XML defined in the GetShipment ASP page.

An e-mail template can be defined for each organization in WorldLink. To configure a unique template for an organization/site group, indicate the organization/site group identifier in the XRefGroup tag. Org/site groups without a defined template use the default template (XRefGroup Id of -1).

The E-mail XML is designed to list each package in a shipment.

<?xml version="1.0"?>

<Email>

<Server>smtp.email.server.com</Server>

<From>someone@someplace.com</From>

<Subject>Email Notification</Subject>

<Line>Dear [//Shipment/Contact],</Line>

<Line>This email message is to inform you that the items you ordered were shipped today.</Line>

<Line>It was shipped to:</Line>

<Line>[//Shipment/Address1]</Line>

<Line>[//Shipment/Address2]</Line>

<Line>[//Shipment/Address3]</Line>

<Line>[//Shipment/City] [//Shipment/State], [//Shipment/Zip]</Line>

</Header>

<Body>

<Line>Tracking Number: [//Shipment/Package/TrackingNumber]</Line>

</Body>

<Line>Thank you for your order</Line>

<Line>[//Shipment/Organization/OrgName]</Line>

</Footer>

</XRefGroup>

</Email>

The Server tag indicates the SMTP server used to send the e-mail.
The From tag indicates the email address used to send the e-mail. Most mail servers require a valid e-mail address to be entered in the From field.
The Subject tag indicates the subject line of the e-mail.
The Header tag indicates the first static part of the e-mail. Generally, this section is used to start the e-mail.
The Body tag indicates the dynamic part of the e-mail that can have one or more entries.
The IncludeLink tag indicates that a link to track the package will be included.
The Footer tag indicates the last static part of the e-mail. Generally, this section is used to close out the e-mail.
The Attachment tag indicates a file to be sent as an attachment on the email.
The Line tag is used to indicate a single line in the e-mail. It is good practice to keep line lengths to 72 characters or less.

You can add variables to be used in the email template that are replaced during the XML replacement. These variables are indicated by braces {}. When the value between the braces is a standard variable, the {VAR} will be replaced with the actual value of the variable. The variables available are:

<Line>{CARRIER_CODE} - Shipping Carrier Code </Line>

<Line>{CARRIER_DESCRIPTION} - Shipping Carrier Description </Line>

<Line>{SHIPVIA_CODE} - Shipping ShipVia Code </Line>

<Line>{SHIPVIA_DESCRIPTION} - Shipping ShipVia Description </Line>

<Line>{WEIGHT_UOM} - Package Weight Unit Of Measure (i.e. LB or KG) </Line>

<Line>{DIM_UOM} - Package Dimensions Unit Of Measure (i.e. IN or CM) </Line>

<Line>{SHIPMENT_SOURCE} - Shipment Source (i.e. Host or Manual) </Line>

<Line>{PAYMENT_TYPE}</Line>

<Line>{DEPARTMENTCODE} - Department Code </Line>

<Line>{DEPARTMENTDESCRIPTION} - Department Description </Line>