msg:mime

March 26, 2020

Name

msg:mime — Returns the top of the MIME tree for the message, a message part

Synopsis

msg:mime(readonly);

readonly: boolean, optional

Description

Returns the top of the MIME tree for the message, a message part. Setting readonly to false, indicates that modifications are going to be made and a MIME tree optimized for modifications is returned. If you attempt to modify a MIME part that is not writable, a runtime error will result. The returned part has a "thread" member that allows easy iteration of the MIME tree.

Enable this function with the statement require('msys.extended.message');.