Headers & MessageAttributes
All X-Headers that are currently used by DataMotion are described in this article. Each X-Header is its own section with the corresponding MessageAttribute and information contained in the text of the section.
For technical information regarding the API methods and their expected request formats see the DataMotion Developer Center website.
X-COBRAND
MessageAttribute.CoBrand
- Not used in code.
X-EMAILRECEIPT
MessageAttribute.EmailReceipt
Expected to be numeric:
- MessageReceipt.DontSend = 0
- MessageReceipt.Send = 1
X-EXPIRE
MessageAttribute.Expire
Expected to be numeric:
- Value is added as days to the creation time to get the expiration time.
X-HINT
MessageAttribute.Hint
Expected to be a string:
- Value is used as the password hint displayed to the user in a “password protected” message.
X-ANSWER
MessageAttribute.Password
Expected to be a string:
- Value is used as the password for the “password protected” message. This value is plain text, and is stored as plain text.
- If PDF/Zip push is enabled, this is used for the password on the PDF/Zip.
X-REGCODE
MessageAttribute.RegCode
- Not used in code.
X-SSL
MessageAttribute.SSL
- Not used in code.
X-USERTYPE
MessageAttribute.UserType
- Not used in code.
X-PRIORITY
MessageAttribute.Priority
Expected to be numeric:
- 1,2 = high priority
- 4,5 = low priority
- Everything else = normal priority. (everything includes 3)
X-NOFORWARD
MessageAttribute.NoForward
Expected to be numeric:
- 1 = restrict forward
- Anything else = use userprops.
X-NOREPLY
MessageAttribute.NoReply
Expected to be numeric:
- 1 = restrict forward
- Anything else = use userprops.
Disposition-Notification-To
MessageAttribute.ReadConfirmation
- Anything other than empty string is considered true.
- Generally this is an email address.
MessageAttribute.Xrcpt
- If not empty and different than the SCSeverAccount psv setting, used for a BCC property.
X-MAILER
MessageAttribute.XMailer
- Saved by the collector
X-MimeOLE
MessageAttribute.XMimeOle
- Not used in code
X-DM-RefID
MessageAttribute.CustomID
- Related to E-Forms
X-SENDER
MessageAttribute.XSender
- Not used in code
X-RULESMATCHED
MessageAttribute.RulesMatched
- Filled by Gateway rule engine
Trial Account Provisioning
The following headers pertain to trial account provisioning.
X-CMRCPTTRIALLICENSE
MessageAttribute.CmRcptTrialLicense
X-CMRCPTPHONE
MessageAttribute.CmRcptPhone
X-CMRCPTLICENSES
MessageAttribute.CmRcptLicenses
X-CMRCPTFIRSTNAME
MessageAttribute.CmRcptFirstName
X-CMRCPTCOMPANYNAME
MessageAttribute.CmRcptCompanyName
X-CMRCPTLASTNAME
MessageAttribute.CmRcptLastName
X-CMRCPTEXPDAYS
MessageAttribute.CmRcptExpDays
X-CMRCPTCHECKSUM
MessageAttribute.CmRcptChecksum
X-CMRcptHashType
MessageAttribute.CmRcptHashType