4.3.3 Message Functions

Scheme Function: mu-message-copy MESG

Creates the copy of the given message.

Scheme Function: mu-message-set-header MESG HEADER VALUE REPLACE

Sets new VALUE to the header HEADER of the message MESG. If the HEADER is already present in the message its value is replaced with the supplied one if the optional REPLACE is #t. Otherwise new header is created and appended.

Scheme Function: mu-message-get-size MESG

Returns the size of the given message.

Scheme Function: mu-message-get-lines MESG

Returns number of lines in the given message.

Scheme Function: mu-message-get-sender MESG

Returns the sender email address for the message MESG.

Scheme Function: mu-message-get-header MESG HEADER

Returns the header value of the HEADER in the MESG.

Scheme Function: mu-message-get-header-fields MESG HEADERS

Returns the list of headers in the MESG. If optional HEADERS is specified it should be a list of header names to restrict return value to.

Scheme Function: mu-message-set-header-fields MESG LIST REPLACE

Set the headers in the message MESG from LIST. LIST is a list of (cons HEADER VALUE). Optional parameter REPLACE specifies whether the new header values should replace the headers already present in the message.

Scheme Function: mu-message-delete MESG FLAG

Mark given message as deleted. Optional FLAG allows to toggle deleted mark. The message is deleted if it is #t and undeleted if it is #f.

Scheme Function: mu-message-get-flag MESG FLAG

Return value of the attribute FLAG.

Scheme Function: mu-message-set-flag MESG FLAG VALUE

Set the given attribute of the message. If optional VALUE is #f, the attribute is unset.

Scheme Function: mu-message-get-user-flag MESG FLAG

Returns value of the user attribute FLAG.

Scheme Function: mu-message-set-user-flag MESG FLAG VALUE

Set the given user attribute of the message. If optional VALUE is #f, the attribute is unset.

Scheme Function: mu-message-get-port MESG MODE FULL

Returns a port associated with the given MESG. MODE is a string defining operation mode of the stream. It may contain any of the two characters: `r' for reading, `w' for writing. If optional FULL argument specified, it should be a boolean value. If it is #t then the returned port will allow access to any part of the message (including headers). If it is #f then the port accesses only the message body (the default).

Scheme Function: mu-message-get-body MESG

Returns the message body for the message MESG.

Scheme Function: mu-message-send MESG MAILER

Sends the message MESG. Optional MAILER overrides default mailer settings in mu-mailer.