Value parameters
- byte_count
-
mostly relevant when content is included by reference instead of by value. Lets the receiver guess how expensive it will be, in time, bandwidth, and storage, to fully fetch the attachment
- data
-
JSON object that gives access to the actual content of the attachment. This MUST contain at least one of the following subfields, and enough of them to allow access to the data
- description
-
human-readable description of the content
- filename
-
hint about the name that might be used if this attachment is persisted as a file. It need not be unique. If this field is present and media_type is not, the extension on the filename may be used to infer a MIME type.
- format
-
further describes the format of the attachment if the media_type is not sufficient
- id
-
but recommended. Identifies attached content within the scope of a given message, so it can be referenced. For example, in a message documenting items for sale on an auction website, there might be a field named front_view that contains the value #attachment1; this would reference an attachment to the message with id equal to attachment1. If omitted, then there is no way to refer to the attachment later in the thread, in error messages, and so forth. Because the id of an attachment is used to compose URIs, this value should be brief and MUST consist entirely of unreserved URI characters – meaning that it is not necessary to percent encode the value to incorporate it in a URI.
- lastmod_time
-
hint about when the content in this attachment was last modified
- media_type
-
describes the media type of the attached content
Attributes
- Companion
- object
- Graph
-
- Supertypes