A bit of documentation for my favorite function, makeComposeLink()...

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@6186 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/doc/compose.txt b/doc/compose.txt
index 9cf0904e4d9804d3cb2f5f57fab86d70ddf622d9..7abdea47f49d0a18e16935abab0c28a369c282aa 100644 (file)
--- a/doc/compose.txt
+++ b/doc/compose.txt
@@ -1,5 +1,25 @@
-Using the comp_in_new function
-==============================
+Creating Links to compose.php easily
+====================================
+
+makeComposeLink() PHP function helps to create links to the compose page
+easily, taking into account the user's settings, "Compose in new window" and
+"Use javascript". Here's how to use it:
+
+1) Build the last part of the URL as follows:
+   $comp_uri = 'src/compose.php?mailbox='.$mailboxbox.'&send_to='.urlencode($usermail);
+
+2) The display part of the link can be anything you like (such the name of the user):
+   $disp = 'The user's name';
+
+3) Print it:
+   echo makeComposeLink($comp_uri, $disp);
+
+makeComposeLink() has been available since Squirrelmail 1.4.2.
+
+
+
+Using the comp_in_new javascript function
+=========================================
 
 comp_in_new is the javascript function to popup a new compose window.