Header Record Specifications for FTP files in TrackMyMail
Header record specifications for TrackMyMail jobs created via FTP
Products affected: TrackMyMail™
The file header enables TrackMyMail users to create jobs, encode Intelligent Mail barcodes (IMbs), and upload their jobs to TrackMyMail in a more efficient, automated, and integrated manner.
File Header Record (Job / Mailing Information)
| Column | Type | Max Size | Required/Optional |
|---|---|---|---|
| Record Type | Char | 1 | Required |
| Value must be "H" (Header) | |||
| VersionNbr | Char | 5 | Required |
| Value must be "4.0" | |||
| MasterUserID | Char | 50 | Optional |
| MasterPassword | Char | 50 | Optional |
| ResellerVendorUserID | Char | 50 | Optional |
| ResellerVendorPassword | Char | 50 | Optional |
| ClientUserID | Char | 50 | Required |
| ClientPassword | Char | 50 | Password |
| JobID | Char | 50 | Required - Dept. Name |
| JobTitle | Char | 50 | Required - Mailing Name |
| VersionID | Char | 50 | Optional |
| MailDate | Char | 10 | Required (YYYY/MM/DD) |
| MailerID | Char | 6 | Optional |
| Registration of MID via the IV Data Delegation Request form required with both TMM and USPS if using client's own MID | |||
| ServiceTypeID | Char | 3 | Required |
| UploadType | Char | 1 | Required |
| N = New, Initial Upload | |||
| A = Append to Existing Job | |||
| R = Replace/Reload Data on Previous Job | |||
| FileNeedsEncoding | Char | 1 | Required |
| Value should be "N" unless instructed otherwise | |||
| TotalPiecesMailed | Numeric | 8 | Optional |
| TrackedPiecesMailed | Numeric | 8 | Optional |
| TargetInHomeDateStart | Date | 10 | Optional |
| (YYYY/MM/DD) | |||
| TargetInHomeDateTo | Date | 10 | Optional |
| (YYYY/MM/DD) | |||
| ReturnedPostnet | Char | 11 | Optional |
| ReceiveDailyNotifications | Char | 1 | Optional |
| 'Y' or 'N' | |||
| Default: 'N' | |||
| ReceiveCriticalScans | Char | 1 | Optional |
| 'Y' or 'N' | |||
| Default: 'N' | |||
| ReceiveLateMail | Char | 1 | Optional |
| 'Y' or 'N' | |||
| Default: 'N' | |||
| LateMailThreshold | Numeric | 3 | Optional |
| NotificationEmail | Char | 255 | Optional |
| UpdateProRequested | Char | 1 | Optional |
| UpdateProAuthorization | Char | 50 | Required IF UpdatePro Requested |
| UpdateProFileFormat | Char | 3 | Optional |
| CSV or XLS | |||
| UpdateProEmail | Char | 255 | Optional (e-mail address) |
| ConfirmationEmail | Char | 255 | Optional (e-mail address) |
| TMMJobID | Integer | 9 | Optional for previously-created jobs |
| TMMSequenceNumber | Integer | 4 | Optional for previously-created jobs |
| Type of Tracking | Char | 1 | Required |
| O - Outbound Only | |||
| I - Inbound Only | |||
| R - Round Trip | |||
| TrackItBack Requested | Char | 1 | Optional |
| 'Y' or 'N' | |||
| Type of Reply Mail (Service Type ID) | Char | 3 | Required if TrackItBack Requested |
| 050 or 030 - Courtesy Reply | |||
| 052 or 032 - Business Reply | |||
| TrackItBack Start Date | Date | 10 | Required if TIB Requested |
| TrackItBack End Date | Date | 10 | Required if TIB Requested |
| Receive Daily Suppression File | Char | 1 | Required if TIB Requested |
| 'Y' or 'N' | |||
| Daily Suppression File Format | Char | 3 | Required if TIB Requested |
| CSV or XLS | |||
| Daily Suppression to be Sent | Char | 1 | Required if 'Receive Daily Suppression File' is 'Y' |
| D - Daily | |||
| W - Weekly | |||
| M - Monthly | |||
| O - Only Once | |||
| Blank - None | |||
| Daily Suppression E-mail | Char | 255 | Required if 'Receive Daily Suppression File' is 'Y' |
| If more than one e-mail address is present, separate the addresses by commas | |||
| PTD Job ID | Integer | 9 | Value should be '0' unless instructed otherwise |
| UpdatePro to be Sent | Char | 1 | Optional |
| D - Daily | |||
| W - Weekly | |||
| M - Monthly | |||
| O - Once | |||
| Blank - None |
Sample Header
H,4.0,,,,,clientuser,clientpassword,jobid,jobtitle,,2020/07/30,,271,N,N,,,,,,Y,Y,N,,emailaddr@forreports,N,,,,emailaddr@forconfirmation,,,O,N,,,,,,,,0,
UPDATED: November 22, 2022