Version: Streamsheets 3.0

INBOXMETADATA

Creates a JSON key from the given values or range to retrieve metadata from within a message. This function is normally used in the READ function. INBOXMETADATA retrieves values from the Metadata section of a message.

Syntax

=INBOXMETADATA([Streamsheet], [Message], [ValuesOrRange])

Arguments

Name	Type	Description
Streamsheet (optional)	Sheet	Streamsheet, where to look for inbox. Options:
Message (optional)	String	Message to retrieve data from. If left empty, the current message in the inbox is used.
ValuesOrRange (optional)		A list of values or a range of cells describing the path to the element path within a JSON structure.

Return

Type	Description
String	A string key to retrieve data from a message.

Examples

Formula	Result	Comment
`=INBOXMETADATA(,,"arrivalTime")`	[S1][][arrivalTime]	Returns an identifier that can be used in other Streamsheet functions like READ. As Streamsheet and Message are left empty, the current Streamsheet and inbox Message is used.
`=READ(INBOXMETADATA(,,"arrivalTime"),C11,"Number")`	arrivalTime	The READ function return the last part of the JSON Path. The value of the Message at the given Path will be pushed into cell C11. Here we retrieve the arrival time of a message, which is a default Metadata field added to each message.