Method

CamelStoreDBread_message

unstable since: 3.58

Declaration [src]

gboolean
camel_store_db_read_message (
  CamelStoreDB* self,
  const gchar* folder_name,
  const gchar* uid,
  CamelStoreDBMessageRecord* out_record,
  GError** error
)

Description [src]

Reads information about a single message stored in the self. The message in the out_record is identified by the folder ID and the UID members of the structure.

Call camel_store_db_message_record_clear() on the out_record structure to clear dynamically allocated memory in it.

See also camel_store_db_read_messages().

Available since: 3.58

Parameters

folder_name

Type: const gchar*

A folder name.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
uid

Type: const gchar*

Message UID.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
out_record

Type: CamelStoreDBMessageRecord

A CamelStoreDBMessageRecord to read the information to.

The argument will be set by the function.
The returned data is owned by the instance.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

Whether succeeded.