The
mailbox-read
function returns the next object from the mailbox
mailbox
, or
nil
.
If
mailbox
is empty and
timeout
is
nil
, then
mailbox-read
blocks until an object is placed in
mailbox
. If
mailbox
is empty and
timeout
is a number, then
mailbox-read
blocks until an object is placed in
mailbox
or
timeout
seconds have passed. If the timeout occurs, then
mailbox-read
returns
nil
.
The
wait-reason
argument (or the string
"Waiting for message"
if
wait-reason
is
nil
) and the
timeout
argument are both passed to process-wait-with-timeout.
The default value of
wait-reason
is
nil
and the default value of
timeout
is
nil
.