da_notmuch_database_find_message_by_filename

Find a message with the given filename.

If the database contains a message with the given filename then, on successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message object. The caller should call notmuch_message_destroy when done with the message.

On any failure or when the message is not found, this function initializes '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the caller is supposed to check '*message' for NULL to find out whether the message with the given filename is found.

Return value:

alias da_notmuch_database_find_message_by_filename = notmuch_status_t function(
,
const(char)* filename
,
notmuch_message_t** message
)

Detailed Description

NOTMUCH STATUS SUCCESS

Successful return, check '*message'

NOTMUCH STATUS NULL POINTER

The given 'message' argument is NULL

NOTMUCH STATUS OUT OF MEMORY

Out of memory, creating the message object

NOTMUCH STATUS XAPIAN EXCEPTION

A Xapian exception occurred

NOTMUCH STATUS UPGRADE REQUIRED

The caller must upgrade the database to use this function.

Meta