"Push" Feedback Via SMTP

Description

Feedback is emailed to the originator of a letter at various points in the process of its handling.

Human-readable status information is available within the email body, formatted according to the user's locale. Due to the variability of this information's format it is not recommended to attempt to parse it by machine.

Each feedback email message contains machine-readable status information in its X-PostalMethods headers. X-Headers may appear anywhere in the message header and may not be in any fixed location.

Setup

Define your preferred feedback method in the PostalMethods control panel under User Settings -> Feedback. Select Email. Feedback email messages are normally sent to the email address which originated the letter. However, if a letter is originated via Web Service, or if you would like to always get feedback to a specific email address, click on Advanced Settings and enter an email address into the Default Feedback Email text box.

Example

X-PostalMethods-ID: 10220817
X-PostalMethods-ItemID: 1
X-PostalMethods-Auth: J9J4AAQSkZJRgABAQEAYABgAADC4QBmRXhpZgAASUkqAAgA
X-PostalMethods-Status: -1000
X-PostalMethods-DateTime: 2008/06/16 02:50:55

Field Definitions

Property Type Comments
ID int Matches the ID provided as the response for the original Web Service request
ItemID int For future use. Default value: 1
Auth String (255) The authentication (AUTH) string is defined by the user in the Control Panel -> User Settings -> Feedback section. PostalMethods will provide this string when accessing this method. You may validate this string to make sure it is coming from PostalMethods. If not populated, this X-header will not appear in the message header.
Status int See the list of Letter Sending Status Codes.
StatusTime datetime Date and time when the update occurred. Returned in the user's time zone, as defined in the control panel. DateTime is formatted as 'YYYY-MM-DDTHH:MM:SS'

Output

The PostalMethods email server which sends feedback messages is a regular email server and adheres to the standard SMTP protocol. The details of the response(s) it expects are beyond the scope of this document.