*
* | Function | Description
* | :--------------------------- | :---------------------------------------------------------
- * | mutt_addr_cmp() | compare two e-mail addresses
- * | mutt_addr_search() | Search for an e-mail address in a list
- * | mutt_addr_has_recips() | Count the number of Addresses with valid recipients
- * | mutt_addr_parse_list2() | Parse a list of email addresses
* | mutt_addr_append() | Append one list of addresses onto another
* | mutt_addr_cat() | Copy a string and escape the specified characters
- * | mutt_addr_copy_list() | Copy an Address
- * | mutt_addr_copy | Copy the real address
+ * | mutt_addr_cmp() | Compare two e-mail addresses
+ * | mutt_addr_cmp_strict() | Strictly compare two Address lists
+ * | mutt_addr_copy() | Copy the real address
+ * | mutt_addr_copy_list() | Copy a list of addresses
* | mutt_addr_free() | Free a list of Addresses
+ * | mutt_addr_has_recips() | Count the number of Addresses with valid recipients
+ * | mutt_addr_new() | Create a new Address
* | mutt_addr_parse_list() | Parse a list of email addresses
+ * | mutt_addr_parse_list2() | Parse a list of email addresses
* | mutt_addr_qualify() | Expand local names in an Address list using a hostname
* | mutt_addr_remove_from_list() | Remove an Address from a list
+ * | mutt_addr_search() | Search for an e-mail address in a list
* | mutt_addr_valid_msgid() | Is this a valid Message ID?
*/
* mutt_addr_copy - Copy the real address
* @param addr Address to copy
* @retval ptr New Address
- *
- * this should be mutt_addr_copy_list
*/
struct Address *mutt_addr_copy(struct Address *addr)
{
* @param addr Address list
* @param prune Skip groups if there are more addresses
* @retval ptr New Address list
- *
- * this should be rfc822_cpy_adrlist
*/
struct Address *mutt_addr_copy_list(struct Address *addr, int prune)
{
}
/**
- * mutt_addr_cmp - compare two e-mail addresses
+ * mutt_addr_cmp - Compare two e-mail addresses
* @param a Address 1
* @param b Address 2
* @retval true if they are equivalent
ERR_BAD_ADDR_SPEC
};
+extern int RFC822Error;
+extern const char *const RFC822Errors[];
+extern const char RFC822Specials[];
+
+#define rfc822_error(x) RFC822Errors[x]
+
struct Address *mutt_addr_append(struct Address **a, struct Address *b, int prune);
void mutt_addr_cat(char *buf, size_t buflen, const char *value, const char *specials);
int mutt_addr_cmp_strict(const struct Address *a, const struct Address *b);
int mutt_addr_search(struct Address *a, struct Address *lst);
bool mutt_addr_valid_msgid(const char *msgid);
-extern int RFC822Error;
-extern const char *const RFC822Errors[];
-extern const char RFC822Specials[];
-
-#define rfc822_error(x) RFC822Errors[x]
-
#endif /* _MUTT_ADDRESS_H */
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
- <tab type="usergroup" url="pages.html" title="Libaries">
+ <tab type="usergroup" url="pages.html" title="Libraries">
<tab type="pages" visible="yes" title="Libraries" intro="These libraries contain are an attempt to make NeoMutt more modular."/>
</tab>
<tab type="modules" visible="yes" title="" intro=""/>
*
* Representation of an email header (envelope)
*
- * | Function | Description
- * | :--------------- | :---------------------------------
- * | mutt_env_free() | Free an Envelope
- * | mutt_env_merge() | Merge the headers of two Envelopes
- * | mutt_env_new() | Create a new Envelope
+ * | Function | Description
+ * | :-------------------- | :---------------------------------
+ * | mutt_env_cmp_strict() | Strictly compare two Envelopes
+ * | mutt_env_free() | Free an Envelope
+ * | mutt_env_merge() | Merge the headers of two Envelopes
+ * | mutt_env_new() | Create a new Envelope
*/
#include "config.h"
mutt_env_free(extra);
}
-int mutt_env_cmp_strict(const struct Envelope *e1, const struct Envelope *e2)
+/**
+ * mutt_env_cmp_strict - Strictly compare two Envelopes
+ * @param e1 First Envelope
+ * @param e2 Second Envelope
+ * @retval true Envelopes are strictly identical
+ */
+bool mutt_env_cmp_strict(const struct Envelope *e1, const struct Envelope *e2)
{
if (e1 && e2)
{
!mutt_addr_cmp_strict(e1->reply_to, e2->reply_to) ||
!mutt_addr_cmp_strict(e1->to, e2->to) || !mutt_addr_cmp_strict(e1->cc, e2->cc) ||
!mutt_addr_cmp_strict(e1->return_path, e2->return_path))
- return 0;
+ return false;
else
- return 1;
+ return true;
}
else
{
if (!e1 && !e2)
- return 1;
+ return true;
else
- return 0;
+ return false;
}
}
bool refs_changed : 1; /**< References changed to break thread */
};
-int mutt_env_cmp_strict(const struct Envelope *e1, const struct Envelope *e2);
+bool mutt_env_cmp_strict(const struct Envelope *e1, const struct Envelope *e2);
void mutt_env_free(struct Envelope **p);
void mutt_env_merge(struct Envelope *base, struct Envelope **extra);
struct Envelope *mutt_env_new(void);
/**
* imap_buffy_check - Check for new mail in subscribed folders
- * @param force Force an update
* @param check_stats Check for message stats too
- * @retval num Number of mailboxes with new mail
* @retval 0 Failure
*
* @note Returns 0 on failure
/**
* mutt_debug_real - Output some debugging information
- * @param level Debug level
- * @param fmt printf-like formatting string
- * @param ... Arguments to be formatted
+ * @param function Function
+ * @param file File
+ * @param line Line number
+ * @param level Debug level
+ * @param ... Arguments to be formatted
*
* This stub function ignores the logging level and outputs all information to
* stderr.
*/
/**
- * @page lib Library of shared functions
+ * @page mutt Shared functions
*
* Each source file in the library provides a group of related functions.
*
*
* Store attributes associated with a MIME part
*
- * | Function | Description
- * | :--------------------------- | :---------------------------------------------------------
- * | mutt_param_delete() | Delete a matching Parameter
- * | mutt_param_free() | Free a Parameter
- * | mutt_param_get() | Find a matching Parameter
- * | mutt_param_set() | Set a Parameter
+ * | Function | Description
+ * | :---------------------- | :------------------------------
+ * | mutt_param_cmp_strict() | Strictly compare two Parameters
+ * | mutt_param_delete() | Delete a matching Parameter
+ * | mutt_param_free() | Free a Parameter
+ * | mutt_param_get() | Find a matching Parameter
+ * | mutt_param_new() | Create a new Parameter
+ * | mutt_param_set() | Set a Parameter
*/
#include "config.h"
}
/**
- * mutt_param_cmp_strict - strictly compare two parameters
- * @param p1 first parameter
- * @param p2 second parameter
- * @retval true parameters are strictly identical
+ * mutt_param_cmp_strict - Strictly compare two Parameters
+ * @param p1 First parameter
+ * @param p2 Second parameter
+ * @retval true Parameters are strictly identical
*/
int mutt_param_cmp_strict(const struct Parameter *p1, const struct Parameter *p2)
{
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @page tags Driver based email tags
+ *
+ * Driver based email tags
+ *
+ * | Data | Description
+ * | :------------- | :--------------------------------------------------
+ * | #HiddenTags | Private tags which should not be displayed
+ * | #TagTransforms | Lookup table of alternative tag names
+ *
+ * | Function | Description
+ * | :-------------------------------- | :-----------------------------------------------
+ * | driver_tags_free() | Free tags from a header
+ * | driver_tags_getter() | Get transformed tags
+ * | driver_tags_get_transformed() | Get transformed tags
+ * | driver_tags_get() | Get tags
+ * | driver_tags_get_with_hidden() | Get tags with hiddens
+ * | driver_tags_get_transformed_for() | Get transformed tag for a tag name from a header
+ * | driver_tags_add() | Add a tag to header
+ * | driver_tags_replace() | Replace all tags
+ */
+
#include "config.h"
#include <stddef.h>
#include "mutt/hash.h"
#include "tags.h"
#include "globals.h"
-char *HiddenTags;
-struct Hash *TagTransforms;
+char *HiddenTags; /**< Private tags which should not be displayed */
+struct Hash *TagTransforms; /**< Lookup table of alternative tag names */
/**
* driver_tags_free - Free tags from a header
}
/**
- * driver_tags_get_transformed - Get transformed tags
+ * driver_tags_getter - Get transformed tags
* @param head List of tags
* @param show_hidden Show hidden tags
* @param show_transformed Show transformed tags
* driver_tags_replace - Replace all tags
* @param[in] head List of tags
* @param[in] tags string of all tags separated by space
+ * @retval false No changes are made
+ * @retval true Tags are updated
*
- * @retval 0 If no change are made
- * @retval 1 If tags are updated
- *
- * Free current tags structures and replace it by
- * new tags
+ * Free current tags structures and replace it by new tags
*/
-int driver_tags_replace(struct TagHead *head, char *tags)
+bool driver_tags_replace(struct TagHead *head, char *tags)
{
if (!head)
- return 0;
+ return false;
driver_tags_free(head);
driver_tags_add(head, tag);
FREE(&tags);
}
- return 1;
+ return true;
}
*
* Keep a linked list of header tags and their transformed values.
* Textual tags can be transformed to symbols to save space.
- *
- * @sa TagNode
*/
struct TagNode
{
};
STAILQ_HEAD(TagHead, TagNode);
-void driver_tags_free(struct TagHead *head);
+void driver_tags_free(struct TagHead *head);
char *driver_tags_get(struct TagHead *head);
-char *driver_tags_get_with_hidden(struct TagHead *head);
-char *driver_tags_get_transformed(struct TagHead *head);
char *driver_tags_get_transformed_for(char *name, struct TagHead *head);
-int driver_tags_replace(struct TagHead *head, char *tags);
+char *driver_tags_get_transformed(struct TagHead *head);
+char *driver_tags_get_with_hidden(struct TagHead *head);
+bool driver_tags_replace(struct TagHead *head, char *tags);
#endif /* _MUTT_TAG_H */
projects / neomutt / commitdiff