diff options
Diffstat (limited to 'tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/starttls.html')
| -rw-r--r-- | tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/starttls.html | 237 |
1 files changed, 237 insertions, 0 deletions
diff --git a/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/starttls.html b/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/starttls.html new file mode 100644 index 0000000..e16b915 --- /dev/null +++ b/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/starttls.html @@ -0,0 +1,237 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + <title>starttls | JsDoc Reference</title> + + <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> + <meta name="mobileoptimized" content="0" /> + + <link rel="stylesheet" href="../css/all.css" media="all" /> + <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" /> + <link rel="stylesheet" href="../css/handheld.css" media="handheld" /> + <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" /> + + <script src="../javascript/all.js"></script> + <!--[if lt IE 9]> + <script src="../javascript/html5.js"></script> + <![endif]--> + </head> + + <body> + +<div class="index"> + <div class="menu"> + <div class="indexLinks"> + <a href="../index.html">Classes</a> + <a href="../files.html">Files</a> + </div> + + <h2 class="heading1">Classes</h2> + + <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input> + + <nav> + <ul class="classList" id="ClassList"> + + <li><a href="../symbols/_global_.html">_global_</a></li> + + <li><a href="../symbols/mockup.html">mockup</a></li> + + <li><a href="../symbols/RAIServer.html">RAIServer</a></li> + + <li><a href="../symbols/RAISocket.html">RAISocket</a></li> + + <li><a href="../symbols/starttls.html">starttls</a></li> + + </ul> + </nav> + </div> + <div class="fineprint" style="clear:both"> + <footer> + + Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br /> + Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br /> + Generated on: + <time datetime='2012-0-22' pubdate>2012-0-22 12:15</time> + </footer> + </div> +</div> + +<div class="index indexStatic"></div> + +<div class="content"> + <div class="innerContent"> + <article> + <header> + <h1 class="classTitle"> + + Namespace <span>starttls</span> + </h1> + + <div class="intro"> + <p class="description summary"> + STARTTLS module + </p> + + + <ul class="summary"> + + + + <li>Defined in: <a href="../symbols/src/RAI_lib_starttls.js.html">starttls.js</a></li> + + + </ul> + + </div> + </header> + + + + + <!-- + #### METHODS SUMMARY + --> + + <section> + + + <div class="props"> + <h2 class="sectionTitle">Method Summary</h2> + + + <nav> + <table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class starttls."> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + + <tbody> + + + <tr + class='item0' + > + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">starttls.<b><a href="../symbols/starttls.html#.starttls">starttls</a></b>(socket, options, callback) + </div> + <div class="description"><p>Upgrades a socket to a secure TLS connection</p></div> + </td> + </tr> + + </tbody> + </table> + </nav> + + + + </div> + </section> + + + <!-- + #### EVENTS SUMMARY + --> + + <!-- + #### CONSTRUCTOR DETAILS + --> + + <!-- + #### FIELD DETAILS + --> + + <!-- + #### METHOD DETAILS + --> + + <section> + <div class="details props"> + <div class="innerProps"> + <h2 class="sectionTitle"> + Method Detail + </h2> + + <ul class="methodDetail" id="MethodDetail"> + + + <li + class='item0' + > + <div class="fixedFont heading" id=".starttls"> + <span class='lighter'> + <static> + </span> + + + + <span class="light">starttls.</span><b>starttls</b>(socket, options, callback) + </div> + + <div class="description"> + <p>Upgrades a socket to a secure TLS connection</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>socket</b> + + </dt> + <dd>Plaintext socket to be upgraded</dd> + + <dt> + <span class="light fixedFont">{Object}</span> <b>options</b> + + </dt> + <dd>Certificate data for the server</dd> + + <dt> + <span class="light fixedFont">{Function}</span> <b>callback</b> + + </dt> + <dd>Callback function to be run after upgrade</dd> + + </dl> + + + + + </li> + + </ul> + </div> + </div> + </section> + + + <!-- + #### EVENT DETAILS + --> + + </article> + </div> +</div> + + <script type="text/javascript"> + wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660) + codeview.classFilter.Init() + </script> + </body> +</html> + |