GetInboxItemInfo Method
This method returns field values from an Inbox item and, if GetParams is true, then returns the name-value pairs for the Inbox item.
The method searches as follows:
InboxItemId
ObjectId + InboxTypeName
Input Arguments
The following table shows the input arguments for this method.
Property Name | Required | Comments |
---|---|---|
InboxItemId |
No |
This property is the row ID of the Inbox item. The ID is not updated, but is used for searching. |
ObjectId |
No |
This property is the object ID of the Inbox item. It is not updated, but is used for searching. |
InboxTypeName |
No |
This property is the name of Inbox type. It is not updated, but is used for searching. |
GetParams |
No |
This property returns all name-value pairs if the value is Y. |
Output Arguments
The following table shows the output arguments for this method.
Property Name | Comments |
---|---|
ObjectId |
This property is the object ID of the Inbox item. |
InboxTypeId |
This property is the ID for the Inbox type. |
InboxTypeName |
This property is the name of Inbox type. |
InboxName |
This property is the name for the Inbox. |
InboxPartyId |
This property is the party ID of the Inbox owner. |
Comments |
None. |
InboxUTCExpirationTS |
This property is the UTC timestamp. |
Name - value pairs |
None. |