TRUE on success; FALSE on failure. Call the osGetLastError function to retrieve extended error information.

This function removes all messages from the specified mailbox. Each message stored within the mailbox has an allocated memory buffer. When this function is executed, all messages are cleared, and the mailbox is returned to an empty state for further use. During this process, the task calling osClearMailbox is responsible for releasing each associated memory buffer back to the system.

This function is available only when both the OS_USE_MAILBOX and OS_MBOX_CLEAR_FUNC constants are set to 1. For more information regarding mailbox functionality, refer to the mailbox objects section.