* mu-msg-iter.{cc,h}: clear-up api, update callers
This commit is contained in:
Dirk-Jan C. Binnema
@ -82,21 +82,18 @@ void mu_msg_iter_destroy (MuMsgIter *iter);
|
||||
|
||||
|
||||
/**
|
||||
* get the corresponding MuMsg for this iter; this requires the actual
|
||||
* message file to be present at the expected place in the maildir in
|
||||
* the file system. Note, it's faster to use the database fields (the
|
||||
* various mu_msg_iter_get_... functions), so MuMsg should use only
|
||||
* when information is needed that is not provided from the iter).
|
||||
* get the corresponding MuMsg for this iter; this instance is owned
|
||||
* by MuMsgIter, and becomes invalid after either mu_msg_iter_destroy
|
||||
* or mu_msg_iter_next. _do not_ unref it.
|
||||
*
|
||||
* @param iter a valid MuMsgIter instance
|
||||
* @param err which receives error info or NULL. err is only filled
|
||||
* when the function returns NULL
|
||||
*
|
||||
* @return a MuMsg instance, or NULL in case of error. Use
|
||||
* mu_msg_unref when the instance is no longer needed
|
||||
* @return a MuMsg instance, or NULL in case of error
|
||||
*/
|
||||
MuMsg* mu_msg_iter_get_msg (MuMsgIter *iter, GError **err)
|
||||
G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
|
||||
G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
|
||||
|
||||
|
||||
|
||||
@ -123,147 +120,6 @@ unsigned int mu_msg_iter_get_docid (MuMsgIter *iter);
|
||||
*/
|
||||
unsigned int mu_msg_iter_get_index (MuMsgIter *iter);
|
||||
|
||||
|
||||
/**
|
||||
* get the full path of the message file
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the path, or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_path (MuMsgIter *iter);
|
||||
|
||||
|
||||
/**
|
||||
* get the maildir of the message - e.g., a message file
|
||||
* /home/user/Maildir/foo/bar/cur/abc123 would have maildir
|
||||
* "/foo/bar"
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
* * @return the path, or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_maildir (MuMsgIter *iter);
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* get the msgid of the message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the msgid or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_msgid (MuMsgIter *iter);
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* get the size of the message in Kb
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the size, or 0 in case of error
|
||||
*/
|
||||
size_t mu_msg_iter_get_size (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get the timestamp (ctime) of the message file
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the size, or 0 in case of error
|
||||
*/
|
||||
time_t mu_msg_iter_get_timestamp (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get the sent time of the message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the time, or 0 in case of error
|
||||
*/
|
||||
time_t mu_msg_iter_get_date (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get the message sender(s) of the message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the time, or 0 in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_from (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get the message recipient (To:) of the message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the To-recipient(s), or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_to (MuMsgIter *iter);
|
||||
|
||||
|
||||
/**
|
||||
* get the 'carbon-copy' recipient(s) (Cc:) of the message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the Cc-recipient(s), or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_cc (MuMsgIter *iter);
|
||||
|
||||
|
||||
/**
|
||||
* get the 'blind carbon-copy' message recipient(s) (Bcc:) of the
|
||||
* message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the Bcc-recipient(s), or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_bcc (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get the subject of the message
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the subject, or NULL in case of error
|
||||
*/
|
||||
const char* mu_msg_iter_get_subject (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get the message flags
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the message flags, or MU_MSG_FLAG_UNKNOWN
|
||||
*/
|
||||
MuMsgFlags mu_msg_iter_get_flags (MuMsgIter *iter);
|
||||
|
||||
|
||||
/**
|
||||
* get the message priority
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the message priority, or MU_MSG_PRIO_NONE
|
||||
*/
|
||||
MuMsgPrio mu_msg_iter_get_prio (MuMsgIter *iter);
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* get the references (References: and Reply-To:) as a comma-separated
|
||||
* string, with the last one pointing at the parent
|
||||
*
|
||||
* @param iter a valid MuMsgIter iterator
|
||||
*
|
||||
* @return the message references, or NULL in case of error or if
|
||||
* there is none
|
||||
*/
|
||||
const char* mu_msg_iter_get_refs (MuMsgIter *iter);
|
||||
|
||||
/**
|
||||
* get some message field
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user