Revision control
Copy as Markdown
Other Tools
[
{
"namespace": "messages",
"annotations": [
{
"note": "When the term ``messageId`` is used in these documents, it *doesn't* refer to the Message-ID email header. It is an internal tracking number that does not remain after a restart. Nor does it follow an email that has been moved to a different folder."
},
{
"warning": "Some functions in this API potentially return a lot of messages. See $(doc:guides/messageLists) for more information."
}
],
"functions": [
{
"name": "getAttachmentFile",
"annotations": [
{
"text": "The most simple way to get the content of an attachment is to use the $(url:dom-file-text)[<code>text()</code>] method of the returned $(url:dom-file)[File] object:"
},
{
"code": "includes/messages/file.js"
}
]
},
{
"name": "listInlineTextParts",
"annotations": [
{
"note": "A message usually contains only one inline text part per subtype, but technically messages can contain multiple inline text parts per subtype."
}
]
},
{
"name": "getRaw",
"parameters": [
{
"name": "options",
"properties": {
"data_format": {
"annotations": [
{
"text": "Working with binary strings is error prone and needs special handling:"
},
{
"code": "includes/messages/decodeBinaryString.js"
},
{
"text": " See MDN for $(url:input-encoding)[supported input encodings]."
}
]
}
}
}
]
}
]
}
]