X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/4e6bc7b6d19bd083ee0446a3a7f2968a1b9dba20..50c8114d791602fcc427c6dc94b55f3226e8a21d:/h/addrsbr.h

diff --git a/h/addrsbr.h b/h/addrsbr.h
index a753e623..fbb4cd05 100644
--- a/h/addrsbr.h
+++ b/h/addrsbr.h
@@ -32,6 +32,10 @@ struct mailname {
     char *m_note;		/* Note (post-address comment) */
 };
 
+/*
+ * See notes for auxformat() below.
+ */
+
 #define	adrformat(m) auxformat ((m), 1)
 
 /*
@@ -57,8 +61,24 @@ int ismymbox(struct mailname *);
  */
 
 char *getname(const char *header);
-char *getlocaladdr(void);
-char *auxformat(struct mailname *, int);
+
+/*
+ * Format an email address given a struct mailname.
+ *
+ * This function takes a pointer to a struct mailname and returns a pointer
+ * to a static buffer holding the resulting email address.
+ *
+ * It is worth noting that group names are NOT handled, so if you want to
+ * do something with groups you need to handle it externally to this function.
+ *
+ * Arguments include:
+ *
+ * mp		- Pointer to mailname structure
+ * extras	- If true, include the personal name and/or note in the
+ *		  address.  Otherwise, omit it.
+ */
+
+char *auxformat(struct mailname *mp, int extras);
 
 /*
  * Parse an email address into it's components.