dh-api
[ class tree: dh-api ] [ index: dh-api ] [ all elements ]
Packages:
dh-api

Source for file dh-api.php

Documentation is available at dh-api.php

  1. <?php
  2. /**
  3. *
  4. * Ok I suck at phpdoc.org but it might be useful to use it!
  5. * Thanks boldmanuk for
  6. * http://discussion.dreamhost.com/showthreaded.pl?Board=forum_programming&Number=59785
  7. *
  8. * This file needs two more variables to work : $dh_username and $dh_password, your credentials to the DreamHost Panel.
  9. *
  10. * It is a work in progress, please contribute !
  11. *
  12. * @package dh-api
  13. */
  14. /**
  15. * This is the email pattern to check for valid email address.
  16. * To use in a regex, wrap into special characters (#) and optionnaly add "^" and/or "$".
  17. * @var string 
  18. */
  19. $dhapi_emailPattern="[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,3})";
  20.  
  21.  
  22.  
  23. /**
  24. * This var (array) contains the fake browser's headers.
  25. * "Standard browser header."
  26. * @var array 
  27. */
  28. $dhapi_headerArray=array();
  29. $dhapi_headerArray['Host'] = "panel.dreamhost.com";
  30. $dhapi_headerArray['Accept'] = "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5";
  31. $dhapi_headerArray['Accept-Language'] = "en-us,en;q=0.5";
  32. $dhapi_headerArray['Accept-Encoding'] = "gzip,deflate";
  33. $dhapi_headerArray['Accept-Charset'] = "ISO-8859-1,utf-8;q=0.7,*;q=0.7";
  34. $dhapi_headerArray['Keep-Alive'] = "300";
  35. $dhapi_headerArray['Connection'] = "keep-alive";
  36.  
  37.  
  38.  
  39. /**
  40. * User-agent identifier.
  41. * @var string 
  42. */
  43. $dhapi_userAgent = "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.7) Gecko/20060909 Firefox/1.5.0.7 with dh-api (http://api.dreamhosters.com/)";
  44.  
  45.  
  46.  
  47. /**
  48. * This var (string) stores the first cookie.
  49. * "I'm using two cookie jars, one for before the login, one for after. Not sure if this is neccessary however."
  50. * note: not sure if it's "mixed"
  51. * @var string 
  52. * @name $dhapi_cookieJar1
  53. * @todo Check if the second one is absolutely necessary.
  54. */
  55. $dhapi_cookieJar1 = tempnam($_SERVER['DOCUMENT_ROOT']."/admin",'cookie1');
  56.  
  57.  
  58.  
  59. /**
  60. * This var (string) stores the second cookie.
  61. * note: not sure if it's "mixed"
  62. * @name $dhapi_cookieJar2
  63. * @todo Check if this is absolutely necessary.
  64. */
  65. $dhapi_cookieJar2 = tempnam($_SERVER['DOCUMENT_ROOT']."/admin",'cookie2');
  66.  
  67.  
  68.  
  69. /**
  70. * This function output eventuals cURL errors.
  71. * @param mixed $chan This is the result of curl_init().
  72. */
  73. function dhapi_showCurlErrors($dhapi_curlhan) {
  74.  if (curl_errno($dhapi_curlhan) != 0) {
  75.   print "Last cURL error : ".curl_errno($dhapi_curlhan)."\n";
  76.   print "Last cURL error : ".curl_error($dhapi_curlhan)."\n";
  77.  }
  78. } // dhapi_showCurlErrors()
  79.  
  80.  
  81.  
  82. /**
  83. * This function takes the HTML of the page and returns the security hash contained in the hidden form field "security key".
  84. * @param string $dhapi_page The HTML of the page returned by cURL.
  85. * @return mixed The security_key found in the HTML of the page.
  86. * @todo Maybe check that the key was found, and if not return false to break the rest?
  87. */
  88. function dhapi_getSecurityKey($dhapi_page) {
  89.  $code = preg_match("#name=\"security_key\" value=\"(.{32,32})\"#", $dhapi_page, $matches);
  90.  return $matches[1];
  91. } // dhapi_getSecurityKey()
  92.  
  93.  
  94.  
  95. /**
  96. * This function disconnects from the panel (deletes the cookie associated with the connection).
  97. */
  98. function dhapi_dhapi_panelDisconnect() {
  99.  global $dhapi_cookieJar2;
  100.  unlink($dhapi_cookieJar2);
  101. //  exit;
  102. } // dhapi_panelDisconnect()
  103.  
  104.  
  105.  
  106. /**
  107. * This actually connects to the panel. Three steps:
  108. * <ol>
  109. * <li>connect to the start page and gets the cookies,</li>
  110. * <li>send credentials to authenticate and get the panel,</li>
  111. * <li>reget the panel, in case of loss (...?)</li>
  112. * </ol>
  113. * @return bool True or false whether connection succeeded (true) or failed (false).
  114. */
  115. function dhapi_dhapi_panelConnect() {
  116.  global $dh_username, $dh_password;
  117.  global $dhapi_headerArray, $dhapi_userAgent;
  118.  global $dhapi_cookieJar1, $dhapi_cookieJar2;
  119.  # start session on index/login page
  120.  $dhapi_ref_url = "";
  121.  $dhapi_url     = "https://panel.dreamhost.com/";
  122.  
  123.  $dhapi_curl = curl_init($dhapi_url);
  124.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  125.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  126.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  127.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  128.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  129.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  130.  curl_setopt($dhapi_curl, CURLOPT_COOKIEJAR,  $dhapi_cookieJar1);
  131.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  132.  $dhapi_page = curl_exec($dhapi_curl);
  133.  dhapi_showCurlErrors($dhapi_curl);
  134.  curl_close($dhapi_curl);
  135.  
  136.  $dhapi_post    = "Nscmd=Nlogin&username=$dh_username&password=$dh_password";
  137.  
  138.  # Submit login request
  139.  $dhapi_ref_url = $dhapi_url;
  140.  $dhapi_url     = "https://panel.dreamhost.com/index.cgi";
  141.  
  142.  $dhapi_curl = curl_init($dhapi_url);
  143.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  144.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  145.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  146.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  147.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  148.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  149.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  150.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar1);
  151.  curl_setopt($dhapi_curl, CURLOPT_COOKIEJAR,  $dhapi_cookieJar2);
  152.  curl_setopt($dhapi_curl, CURLOPT_POST, 1);
  153.  curl_setopt($dhapi_curl, CURLOPT_POSTFIELDS, $dhapi_post);
  154.  $dhapi_page = curl_exec($dhapi_curl);
  155.  dhapi_showCurlErrors ($dhapi_curl);
  156.  curl_close($dhapi_curl);
  157.  unlink($dhapi_cookieJar1);
  158.  
  159.  # Resubmit the index page request - often get a blank response from the login page. This makes sure the session is legit
  160.  $dhapi_ref_url = $dhapi_url;
  161.  $dhapi_url     = "https://panel.dreamhost.com/index.cgi";
  162.  
  163.  $dhapi_curl = curl_init($dhapi_url);
  164.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  165.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  166.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  167.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  168.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  169.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  170.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  171.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  172.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  173.  $dhapi_page = curl_exec($dhapi_curl);
  174.  dhapi_showCurlErrors ($dhapi_curl);
  175.  curl_close($dhapi_curl);
  176.  
  177.  $success = strpos($dhapi_page, "Welcome to your DreamHost Control Panel!");
  178.  if ($success>0) { return true; } else { return false; }
  179. } // dhapi_panelConnect()
  180.  
  181.  
  182.  
  183. /**
  184. * This function creates a new email account. Steps:
  185. * <ol>
  186. *  <li>Get the "Create New Email Address" page to extract the security_key.</li>
  187. *  <li>Post the variables to the "?" page.</li>
  188. *  <li>Extract from the result page "error" or "success"</li>
  189. * </ol>
  190. * @param string    $email        (input "text")        The email address, like user@example.com. The hashing is done inside the function.
  191. * @param string    $redirect     (input "textarea")    The email address(es) to redirect the new one to, or empty (""). One or many line-separated addresses (NOTE: is this \\n, \\r, mix?).
  192. * @param mixed    $redirect_only    (input "hidden")    Boolean "false" creates a normal inbox (also with forward capabilities) ; boolean "true" creates a forward-only email-address (no actual inbox is created) ; string "null" creates a "garbage email address. Warning : Last two value dump gecos and other values...
  193. * @param mixed    $name         (input "text")        The "name" (ex: John Doe), facultative.
  194. * @param string    $pass         (input "text")        The password for this account. It is used twice, so have it confirmed/checked before. Min 6 chars. TODO: Max?
  195. * @param mixed    $limMB        (input "text")        Limit value of disk usage (in MB or empty), or "false".
  196. * @param bool    $warning     (input "checkbox")    The "email me if my usage is within 10% of my limit (or 100MB, whichever is smaller)".
  197. * @param int    $rem_qty     (input "text")        Remove read messages when inbox reaches this message quantity (max 2000). Set to false for 0. NOTE: MIN:0, MAX:2000.
  198. * @param int    $rem_age     (input "text")        Remove read messages older than this numbers of days (max 9999). Set to false for 0. NOTE: MIN:0, MAX:9999.
  199. * @param bool    $rem_new     (input "checkbox")    Remove even unread messages.
  200. * @param mixed    $rem_fol     (input "text")        Save removed messages in this folder. Leave empty or set to false to really deleted them. NOTE: This will be formatted with imap_utf7_encode() so warn the user if input does not match formatted.
  201. * @param bool    $rem_mai     (input "checkbox")    Email me when messages are removed.
  202. * @return bool True If the email was created, false otherwise.
  203. */
  204. function dhapi_panelEmailCreate($email, $redirect, $redirect_only, $name, $pass, $limMB, $warning, $rem_qty, $rem_age, $rem_new, $rem_fol, $rem_mai) {
  205.  global $dhapi_headerArray, $dhapi_userAgent, $dhapi_url;
  206.  global $dhapi_cookieJar2;
  207.  
  208.  # ask for the "Create New Email" page and get the security_key
  209.  $dhapi_ref_url=$dhapi_url;
  210.  $dhapi_url  = "https://panel.dreamhost.com/index.cgi?tree=mail.addresses&current_step=Index&next_step=New";
  211.  $dhapi_curl = curl_init($dhapi_url);
  212.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  213.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  214.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  215.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  216.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  217.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  218.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  219.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  220.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  221.  $dhapi_page = curl_exec($dhapi_curl);
  222.  dhapi_showCurlErrors ($dhapi_curl);
  223.  curl_close($dhapi_curl);
  224.  $dhapi_skey = dhapi_getSecurityKey($dhapi_page);
  225.  
  226.  # post vars after they are created
  227.  $mail=split("@", $email);
  228.  $alias=$mail[0];
  229.  $domain=$mail[1];
  230.  if ($limMB)    { $enable_quota="on"; $hard_quota=intval($limMB); }
  231.  if (!$warning)    { $notify_disk=""; } else { $notify_disk="on"; }
  232.  if ($rem_qty)    { $max_messages=intval($rem_qty); } else { $max_messages="2000"; }
  233.  if ($rem_age)    { $days=intval($rem_age); } else { $days=9999; }
  234.  if ($rem_new)    { $rotate_new="on"; } else { $rotate_new=""; }
  235.  if ($rem_fol)    { $archive="on"; $archive_folder=imap_utf7_encode($rem_fol); }
  236.  if ($rem_mai)    { $notify="on"; } else { $notify=""; }
  237.  
  238.  $dhapi_ref_url = $dhapi_url;
  239.  $dhapi_url  = "https://panel.dreamhost.com/index.cgi?";
  240.  
  241.  if ($redirect_only==="null") {
  242.   $dhapi_post = "tree=mail.addresses&current_step=New&next_step=NewFinal&security_key=$dhapi_skey&dest=null";
  243.   $dhapi_post.= "alias=$alias&domain=$domain";
  244.  }
  245.  elseif ($redirect_only==true) {
  246.   $dhapi_post = "tree=mail.addresses&current_step=New&next_step=NewFinal&security_key=$dhapi_skey&dest=forward";
  247.   $dhapi_post.= "&alias=$alias&domain=$domain&addresses=$redirect";
  248.  }
  249.  elseif ($redirect_only==false) {
  250.   $dhapi_post = "tree=mail.addresses&current_step=New&next_step=NewFinal&security_key=$dhapi_skey&dest=forward&mailbox=1";    // basic from hidden
  251.   $dhapi_post.= "&alias=$alias&domain=$domain&gecos=$name&random=&password1=$pass&password2=$pass";    // basic login
  252.   $dhapi_post.= "&enable_quota=$enable_quota&hard_quota=$hard_quota&notify_disk=$notify_disk&addresses=$redirect";    // advanced login, archive and forward
  253.   $dhapi_post.= "&max_messages=$max_messages&days=$days&rotate_new=$rotate_new&archive=$archive&archive_folder=$archive_folder&notify=$notify";    // tidy inboxes...
  254.  }
  255.  
  256.  $dhapi_curl = curl_init($dhapi_url);
  257.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  258.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  259.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  260.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  261.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  262.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  263.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  264.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  265.  curl_setopt($dhapi_curl, CURLOPT_POST, 1);
  266.  curl_setopt($dhapi_curl, CURLOPT_POSTFIELDS, $dhapi_post);
  267.  $dhapi_page = curl_exec($dhapi_curl);
  268.  dhapi_showCurlErrors ($dhapi_curl);
  269.  curl_close($dhapi_curl);
  270. //  echo "<div style=\"width:500px;height:500px;overflow:auto\">$dhapi_page</div>";
  271. //  echo "\n<br />dhapi_post=$dhapi_post";
  272.  
  273.  $success=strpos($dhapi_page, "Successfully added");
  274. //  echo "success=$success;\n";
  275.  
  276.  if ($success>0) {return true; }
  277.  else { return false; }
  278. } // dhapi_panelEmailCreate()
  279.  
  280.  
  281. /**
  282. * This function edits an existing email account. Steps:
  283. * <ol>
  284. *  <li>Get the "edit" page to extract the security_key.</li>
  285. *  <li>Post the variables into the "?" page.</li>
  286. *  <li>Extract from the result page...</li>
  287. * </ol>
  288. * @param string    $email        (input "text")        The email address (user@domain) to edit.
  289. * @param string    $redirect    (input "text")        The email address(es) to redirect this one, or empty (""). One or many line-separated addresses (NOTE: is this \\n, \\r, mix?).
  290. * @param mixed    $redirect_only    (input "hidden")    Boolean "false" creates a normal inbox (also with forward capabilities) ; boolean "true" creates a forward-only email-address (no actual inbox is created) ; string "null" creates a "garbage email address. Warning : Last two value dump gecos and other values...
  291. * @param mixed    $name        (input "text")        The "name" (ex: John Doe), facultative.
  292. * @param string    $pass        (input "text")        The password for the account. It is used twice, so have it confirmed/checked before. Min 6 chars. TODO: Max?
  293. * @param mixed    $limMB        (input "text")        Limit value of disk usage (in MB or empty), or "false".
  294. * @param bool    $warning    (input "checkbox")    The "email me if my usage is within 10% of my limit (or 100MB, whichever is smaller)".
  295. * @param int    $rem_qty    (input "text")        Remove read messages when inbox reaches this message quantity (max 2000). Set to false for 0. NOTE: MIN:0, MAX:2000.
  296. * @param int    $rem_age    (input "text")        Remove read messages older than this numbers of days (max 9999). Set to false for 0. NOTE: MIN:0, MAX:9999.
  297. * @param bool    $rem_new    (input "checkbox")    Remove even unread messages.
  298. * @param mixed    $rem_fol    (input "text")        Save removed messages in this folder. Leave empty or set to false to really deleted them. NOTE: This will be formatted with imap_utf7_encode() so warn the user if input does not match formatted.
  299. * @param bool    $rem_mai     (input "checkbox")    Email me when messages are removed.
  300. * @return bool True If the email was edited, false otherwise.
  301. */
  302. function dhapi_panelEmailEdit($email, $redirect, $redirect_only, $name, $pass, $limMB, $warning, $rem_qty, $rem_age, $rem_new, $rem_fol, $rem_mai) {
  303.  global $dhapi_headerArray, $dhapi_userAgent, $dhapi_url;
  304.  global $dhapi_cookieJar2;
  305.  
  306.  $mail=split("@", $email);
  307.  $alias=$mail[0];
  308.  $domain=$mail[1];
  309.  if ($limMB)    { $enable_quota="on"; $hard_quota=intval($limMB); }
  310.  if (!$warning)    { $notify_disk=""; } else { $notify_disk="on"; }
  311.  if ($rem_qty)    { $max_messages=intval($rem_qty); } else { $max_messages="2000"; }
  312.  if ($rem_age)    { $days=intval($rem_age); } else { $days=9999; }
  313.  if ($rem_new)    { $rotate_new="on"; } else { $rotate_new=""; }
  314.  if ($rem_fol)    { $archive="on"; $archive_folder=imap_utf7_encode($rem_fol); }
  315.  if ($rem_mai)    { $notify="on"; } else { $notify=""; }
  316.  
  317.  # get the security_key
  318.  $dhapi_ref_url = $dhapi_url;
  319.  $dhapi_url = "https://panel.dreamhost.com/index.cgi?tree=mail.addresses&odomain=$domain&current_step=Index&next_step=Edit&oalias=$alias";
  320.  $dhapi_curl = curl_init($dhapi_url);
  321.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  322.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  323.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  324.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  325.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  326.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  327.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  328.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  329.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  330.  $dhapi_page = curl_exec($dhapi_curl);
  331.  dhapi_showCurlErrors ($dhapi_curl);
  332.  curl_close($dhapi_curl);
  333.  $dhapi_skey = dhapi_getSecurityKey($dhapi_page);
  334.  
  335.  # post vars after they are created
  336.  $dhapi_ref_url=$dhapi_url;
  337.  $dhapi_url  = "https://panel.dreamhost.com/index.cgi?";
  338.  
  339.  if ($redirect_only==="null") {
  340.   $dhapi_post = "tree=mail.addresses&current_step=Edit&next_step=EditFinal&security_key=$dhapi_skey&dest=null";
  341.   $dhapi_post.= "&alias=$alias&domain=$domain";
  342.  }
  343.  elseif ($redirect_only==true) {
  344.   $dhapi_post = "tree=mail.addresses&current_step=Edit&next_step=EditFinal&security_key=$dhapi_skey&dest=forward";
  345.   $dhapi_post.= "&alias=$alias&domain=$domain&addresses=$redirect";
  346.  }
  347.  elseif ($redirect_only==false) {
  348.   $dhapi_post = "tree=mail.addresses&current_step=Edit&next_step=EditFinal&security_key=$dhapi_skey&dest=forward&mailbox=1";    // basic from hidden
  349.   $dhapi_post.= "&alias=$alias&domain=$domain&gecos=$name&random=&password1=$pass&password2=$pass";    // basic login
  350.   $dhapi_post.= "&enable_quota=$enable_quota&hard_quota=$hard_quota&notify_disk=$notify_disk&addresses=$redirect";    // advanced login, archive and forward
  351.   $dhapi_post.= "&max_messages=$max_messages&days=$days&rotate_new=$rotate_new&archive=$archive&archive_folder=$archive_folder&notify=$notify";    // tidy inboxes...
  352.  }
  353.  
  354.  $dhapi_curl = curl_init($dhapi_url);
  355.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  356.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  357.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  358.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  359.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  360.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  361.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  362.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  363.  curl_setopt($dhapi_curl, CURLOPT_POST, 1);
  364.  curl_setopt($dhapi_curl, CURLOPT_POSTFIELDS, $dhapi_post);
  365.  $dhapi_page = curl_exec($dhapi_curl);
  366.  dhapi_showCurlErrors ($dhapi_curl);
  367.  curl_close($dhapi_curl);
  368. //  echo "<div style=\"width:500px;height:500px;overflow:auto\">$dhapi_page</div>";
  369. //  echo "\n<br />dhapi_post:$dhapi_post;\n\n";
  370.  
  371.  $success=strpos($dhapi_page, "Successfully edited ");
  372. //  echo "success=$success;\n";
  373.  
  374.  if ($success>0) {return true; }
  375.  else { return false; }
  376. } // dhapi_panelEmailEdit()
  377.  
  378.  
  379.  
  380. /**
  381. * This function checks if an email address already exists. It takes the address as parameter and checks for USER in DOMAIN.
  382. * @param string $email This is the email address to check.
  383. * @return bool True if the email DOES NOT exist, false otherwise.
  384. */
  385. function dhapi_panelEmailCheck($email) {
  386.  global $USER, $PASS, $dhapi_url;
  387.  global $dhapi_headerArray, $dhapi_userAgent;
  388.  global $dhapi_cookieJar1, $dhapi_cookieJar2;
  389.  $dhapi_ref_url = $dhapi_url;
  390.  $dhapi_url     = "https://panel.dreamhost.com/index.cgi?tree=mail.addresses&";
  391.  $param_string = "";
  392.  
  393.  $dhapi_curl = curl_init($dhapi_url);
  394.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  395.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  396.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  397.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  398.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  399.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  400.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  401.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  402.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  403.  $dhapi_page = curl_exec($dhapi_curl);
  404.  dhapi_showCurlErrors ($dhapi_curl);
  405.  curl_close($dhapi_curl);
  406.  
  407.  $mail = split("@", $email);
  408.  $dhapi_skey = dhapi_getSecurityKey($dhapi_page);
  409.  $dhapi_post    = "tree=mail.addresses&current_step=Index&next_step=DoSelector&security_key=$dhapi_skey&domainselector={$mail[1]}";
  410.  
  411.  $dhapi_ref_url = $dhapi_url;
  412.  $dhapi_url     = "https://panel.dreamhost.com/index.cgi?";
  413.  
  414.  $dhapi_curl = curl_init($dhapi_url);
  415.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  416.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  417.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  418.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  419.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  420.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  421.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  422.  curl_setopt($dhapi_curl, CURLOPT_POST, 1);
  423.  curl_setopt($dhapi_curl, CURLOPT_POSTFIELDS, $dhapi_post);
  424.  $dhapi_page = curl_exec($dhapi_curl);
  425. //  echo "<div style=\"width:500px;height:500px;overflow:auto\">$dhapi_page</div>";
  426.  dhapi_showCurlErrors ($dhapi_curl);
  427.  curl_close($dhapi_curl);
  428.  
  429.  // the following line is because in the panel HTML, the alias is bolded and not the @domain
  430.  $email=str_replace("@", "</b>@", $email);
  431.  $exist=strpos($dhapi_page, $email);
  432.  
  433.  if ($exist>0) { return false; } else { return true; }
  434. } // dhapi_panelEmailCheck()
  435.  
  436.  
  437.  
  438. /**
  439. * This functions deletes PERMANENTLY an email account and all its messages
  440. * First connects to the "Manage email" page and get the security code;
  441. * Then  requests the delete-email URI.
  442. * @param string $email The email address to delete.
  443. * @return bool True is email deleted, false otherwise
  444. */
  445. function dhapi_panelEmailDelete($email) {
  446.  global $dhapi_headerArray, $dhapi_userAgent, $dhapi_url;
  447.  global $dhapi_cookieJar2;
  448.  
  449.  # build the variables...
  450.  $dh_mailDelete = split("@", $email);
  451.  $alias  = $dh_mailDelete[0];
  452.  $domain = $dh_mailDelete[1];
  453.  
  454.  # get the security key...
  455.  $dhapi_ref_url = $dhapi_url;
  456.  $dhapi_url     = "https://panel.dreamhost.com/index.cgi?tree=mail.addresses&";
  457.  $dhapi_curl=curl_init($dhapi_url);
  458.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  459.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  460.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  461.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  462.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  463.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  464.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  465.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  466.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  467.  $dhapi_page = curl_exec($dhapi_curl);
  468.  dhapi_showCurlErrors ($dhapi_curl);
  469.  curl_close($dhapi_curl);
  470.  $dhapi_skey = dhapi_getSecurityKey($dhapi_page);
  471.  
  472.  # delete the email address...
  473.  $dhapi_ref_url = $dhapi_url;
  474.  $dhapi_url = "https://panel.dreamhost.com/index.cgi?tree=mail.addresses&odomain=$domain&current_step=Index&next_step=DeleteFinal&oalias=$alias&security_key=$dhapi_skey";
  475.  $dhapi_curl=curl_init($dhapi_url);
  476.  curl_setopt($dhapi_curl, CURLOPT_VERBOSE, 1);
  477.  curl_setopt($dhapi_curl, CURLOPT_RETURNTRANSFER, 1);
  478.  curl_setopt($dhapi_curl, CURLOPT_HEADER, 1);
  479.  curl_setopt($dhapi_curl, CURLOPT_REFERER, $dhapi_ref_url);
  480.  curl_setopt($dhapi_curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  481.  curl_setopt($dhapi_curl, CURLOPT_HTTPHEADER, $dhapi_headerArray);
  482.  curl_setopt($dhapi_curl, CURLOPT_USERAGENT,  $dhapi_userAgent);
  483.  curl_setopt($dhapi_curl, CURLOPT_COOKIEFILE, $dhapi_cookieJar2);
  484.  curl_setopt($dhapi_curl, CURLOPT_POST, 0);
  485.  $dhapi_page = curl_exec($dhapi_curl);
  486.  dhapi_showCurlErrors ($dhapi_curl);
  487.  curl_close($dhapi_curl);
  488. //  echo "<div style=\"width:500px;height:500px;overflow:auto\">$dhapi_page</div>";
  489.  
  490.  $success=strpos($dhapi_page, "Successfully deleted $email!");
  491.  
  492.  if ($success>0) { return true; }
  493.  else { return false; }
  494. } // dhapi_panelEmailDelete()
  495.  
  496. ?>
Documentation generated on Sat, 06 Sep 2008 14:09:50 -0700 by phpDocumentor 1.4.1