2.4.91 DocRoute
The DocRoute record specifies the document routing information for a routing slip<77> that is used to send a document in an e-mail message and specifies the beginning of a collection of RecipName records as defined by the Globals Substream ABNF. The collection of RecipName records specifies the recipients of the routing slip.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
iStage |
cRecip |
||||||||||||||||||||||||||||||
|
delOption |
A |
B |
C |
D |
E |
F |
unused2 |
||||||||||||||||||||||||
|
cchSubject |
cchMessage |
||||||||||||||||||||||||||||||
|
cchRouteID |
cchCustType |
||||||||||||||||||||||||||||||
|
cchBookTitle |
cchOrg |
||||||||||||||||||||||||||||||
|
ulEIDSize |
|||||||||||||||||||||||||||||||
|
szSubject (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
szMessage (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
szRouteID (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
szCustType (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
szBookTitle (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
szOrg (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
rgchSSAddr (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
iStage (2 bytes): An unsigned integer that specifies the routing stage of the slip. This value MUST be less than or equal to the cRecip field +1.
cRecip (2 bytes): An unsigned integer that specifies the number of recipients. MUST equal the actual number of RecipName records that follow this record.
delOption (2 bytes): An unsigned integer that specifies the delivery option. MUST be a value from the following table:
-
Value
Meaning
0x00
Deliver to one recipient at a time
0x01
Deliver to all recipients at once
A - fRouted (1 bit): A bit that specifies whether the document has been routed.
B - fReturnOrig (1 bit): A bit that specifies whether the document is returned to the originator after being routed to the last recipient.
C - fTrackStatus (1 bit): A bit that specifies whether a status message is sent to the originator after the document is routed.
D - fCustomType (1 bit): A bit that specifies whether there is a custom message type defined by szCustType.
E - unused1 (3 bits): Undefined and MUST be ignored.
F - fSaveRouteInfo (1 bit): A bit that specifies whether the routing information is saved with the document. MUST equal 1.
unused2 (8 bits): Undefined and MUST be ignored.
cchSubject (2 bytes): An unsigned integer that specifies the count of characters in the szSubject field string. MUST be less than or equal to 256.
cchMessage (2 bytes): An unsigned integer that specifies the count of characters in the szMessage field string. MUST be less than or equal to 256.
cchRouteID (2 bytes): An unsigned integer that specifies the count of characters in the szRouteID field string. MUST be less than or equal to 256.
cchCustType (2 bytes): An unsigned integer that specifies the count of characters in the szCustType field string. MUST be less than or equal to 256. MUST equal 0 if the fCustomType field equals 0.
cchBookTitle (2 bytes): An unsigned integer that specifies the count of characters in the szBookTitle field string. MUST be less than or equal to 256.
cchOrg (2 bytes): An unsigned integer that specifies the count of characters in the szOrg field string. MUST be less than or equal to 256.
ulEIDSize (4 bytes): An unsigned integer that specifies the count of characters in the rgchSSAddr field string. When combined with the values of cchSubject, cchMessage, cchRouteID, cchCustType, cchBookTitle, and cchOrg fields, the value MUST be less than or equal to 8202.
szSubject (variable): A NULL terminated array of ANSI characters that specifies the subject of the routed document. The length of the string MUST be specified by the cchSubject field. The field MUST NOT exist if the cchSubject field is 0.
szMessage (variable): A NULL terminated array of ANSI characters that specifies the message of the routed document. The length of the string MUST be specified by the cchMessage field. The field MUST NOT exist if the cchMessage field is 0.
szRouteID (variable): A NULL terminated array of ANSI characters that specifies the name of the routing identifier. The length of the string MUST be specified by the cchRouteID field. The field MUST NOT exist if the cchRouteID field is 0.
szCustType (variable): A NULL terminated array of ANSI characters that specifies a custom message. The length of the string MUST be specified by the cchCustType field. The field MUST NOT exist if the field cchCustType is 0.
-
For more information about the MapiMessage structure, see [MSDN-MapiMessage].
szBookTitle (variable): A NULL terminated array of ANSI characters that specifies the workbook title. The length of the string MUST be specified by the cchBookTitle field. The field MUST NOT exist if the cchBookTitle field is 0.
szOrg (variable): A NULL terminated array of ANSI characters that specifies the originator’s friendly name. The length of the string MUST be specified by the cchOrg field. The field MUST NOT exist if the cchOrg field is 0.
rgchSSAddr (variable): A NULL terminated array of ANSI characters that specifies the identifier used by the messaging system service provider to identify the originator’s e-mail address. The length of the string MUST be specified by the ulEIDSize field. The field MUST NOT exist if the ulEIDSize field is 0.