Class PHPMailer

Package: PHPMailer
Copyright: 2004 - 2009 Andy Prevost
License: GNU Lesser General Public License
Author: Andy Prevost
Author: Marcus Bointon
Located at vendors/phpmailer/class.phpmailer.php

Methods summary

`public`	# `__construct( boolean $exceptions = false )` Constructor Constructor Parameters `$exceptions` `boolean` $exceptions Should we throw external exceptions?
`public`	# `IsHTML( boolean $ishtml = true )` Sets message type to HTML. Sets message type to HTML. Parameters `$ishtml` `boolean` $ishtml
`public`	# `IsSMTP( )` Sets Mailer to send message using SMTP. Sets Mailer to send message using SMTP.
`public`	# `IsMail( )` Sets Mailer to send message using PHP mail() function. Sets Mailer to send message using PHP mail() function.
`public`	# `IsSendmail( )` Sets Mailer to send message using the $Sendmail program. Sets Mailer to send message using the $Sendmail program.
`public`	# `IsQmail( )` Sets Mailer to send message using the qmail MTA. Sets Mailer to send message using the qmail MTA.
`public boolean`	# `AddAddress( string $address, string $name = '' )` Adds a "To" address. Adds a "To" address. Parameters `$address` `string` $address `$name` `string` $name Returns `boolean` true on success, false if address already used
`public boolean`	# `AddCC( string $address, string $name = '' )` Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer. Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer. Parameters `$address` `string` $address `$name` `string` $name Returns `boolean` true on success, false if address already used
`public boolean`	# `AddBCC( string $address, string $name = '' )` Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer. Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer. Parameters `$address` `string` $address `$name` `string` $name Returns `boolean` true on success, false if address already used
`public boolean`	# `AddReplyTo( string $address, string $name = '' )` Adds a "Reply-to" address. Adds a "Reply-to" address. Parameters `$address` `string` $address `$name` `string` $name Returns `boolean`
`private boolean`	# `AddAnAddress( string $kind, string $address, string $name = '' )` Adds an address to one of the recipient arrays Addresses that have been added already return false, but do not throw exceptions Adds an address to one of the recipient arrays Addresses that have been added already return false, but do not throw exceptions Parameters `$kind` `string` $kind One of 'to', 'cc', 'bcc', 'ReplyTo' `$address` `string` $address The email address to send to `$name` `string` $name Returns `boolean` true on success, false if address already used or invalid in some way
`public boolean`	# `SetFrom( string $address, string $name = '', mixed $auto = 1 )` Set the From and FromName properties Set the From and FromName properties Parameters `$address` `string` $address `$name` `string` $name `$auto` Returns `boolean`
`public static boolean`	# `ValidateAddress( string $address )` Check that a string looks roughly like an email address should Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822 Check that a string looks roughly like an email address should Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822 Parameters `$address` `string` $address The email address to check Returns `boolean` Link Original pattern found here
`public boolean`	# `Send( )` Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error. Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error. Returns `boolean`
`protected boolean`	# `SendmailSend( string $header, string $body )` Sends mail using the $Sendmail program. Sends mail using the $Sendmail program. Parameters `$header` `string` $header The message headers `$body` `string` $body The message body Returns `boolean`
`protected boolean`	# `MailSend( string $header, string $body )` Sends mail using the PHP mail() function. Sends mail using the PHP mail() function. Parameters `$header` `string` $header The message headers `$body` `string` $body The message body Returns `boolean`
`protected boolean`	# `SmtpSend( string $header, string $body )` Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input. Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input. Parameters `$header` `string` $header The message headers `$body` `string` $body The message body Returns `boolean` Uses `SMTP`
`public boolean`	# `SmtpConnect( )` Initiates a connection to an SMTP server. Returns false if the operation failed. Initiates a connection to an SMTP server. Returns false if the operation failed. Returns `boolean` Uses `SMTP`
`public`	# `SmtpClose( )` Closes the active SMTP session if one exists. Closes the active SMTP session if one exists.
`public`	# `SetLanguage( string $langcode = 'en', string $lang_path = 'language/' )` Sets the language for all class error messages. Returns false if it cannot load the language file. The default language is English. Sets the language for all class error messages. Returns false if it cannot load the language file. The default language is English. Parameters `$langcode` `string` $langcode ISO 639-1 2-character language code (e.g. Portuguese: "br") `$lang_path` `string` $lang_path Path to the language file directory
`public array`	# `GetTranslations( )` Return the current array of language strings Return the current array of language strings Returns `array`
`public string`	# `AddrAppend( mixed $type, mixed $addr )` Creates recipient headers. Creates recipient headers. Returns `string`
`public string`	# `AddrFormat( mixed $addr )` Formats an address correctly. Formats an address correctly. Returns `string`
`public string`	# `WrapText( string $message, integer $length, boolean $qp_mode = false )` Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable. Original written by philippe. Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable. Original written by philippe. Parameters `$message` `string` $message The message to wrap `$length` `integer` $length The line length to wrap to `$qp_mode` `boolean` $qp_mode Whether to run in Quoted-Printable mode Returns `string`
`public integer`	# `UTF8CharBoundary( string $encodedText, integer $maxLength )` Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string. Original written by Colin Brown. Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string. Original written by Colin Brown. Parameters `$encodedText` `string` $encodedText utf-8 QP text `$maxLength` `integer` $maxLength find last character boundary prior to this length Returns `integer`
`public`	# `SetWordWrap( )` Set the body wrapping. Set the body wrapping.
`public string`	# `CreateHeader( )` Assembles message header. Assembles message header. Returns `string` The assembled header
`public string`	# `GetMailMIME( )` Returns the message MIME. Returns the message MIME. Returns `string`
`public string`	# `CreateBody( )` Assembles the message body. Returns an empty string on failure. Assembles the message body. Returns an empty string on failure. Returns `string` The assembled message body
`private`	# `GetBoundary( mixed $boundary, mixed $charSet, mixed $contentType, mixed $encoding )` Returns the start of a message boundary. Returns the start of a message boundary.
`private`	# `EndBoundary( mixed $boundary )` Returns the end of a message boundary. Returns the end of a message boundary.
`private`	# `SetMessageType( )` Sets the message type. Sets the message type.
`public string`	# `HeaderLine( mixed $name, mixed $value )` Returns a formatted header line. Returns a formatted header line. Returns `string`
`public string`	# `TextLine( mixed $value )` Returns a formatted mail line. Returns a formatted mail line. Returns `string`
`public boolean`	# `AddAttachment( string $path, string $name = '', string $encoding = 'base64', string $type = 'application/octet-stream' )` Adds an attachment from a path on the filesystem. Returns false if the file could not be found or accessed. Adds an attachment from a path on the filesystem. Returns false if the file could not be found or accessed. Parameters `$path` `string` $path Path to the attachment. `$name` `string` $name Overrides the attachment name. `$encoding` `string` $encoding File encoding (see $Encoding). `$type` `string` $type File extension (MIME) type. Returns `boolean`
`public array`	# `GetAttachments( )` Return the current array of attachments Return the current array of attachments Returns `array`
`private string`	# `AttachAll( )` Attaches all fs, string, and binary attachments to the message. Returns an empty string on failure. Attaches all fs, string, and binary attachments to the message. Returns an empty string on failure. Returns `string`
`private string`	# `EncodeFile( string $path, string $encoding = 'base64' )` Encodes attachment in requested format. Returns an empty string on failure. Encodes attachment in requested format. Returns an empty string on failure. Parameters `$path` `string` $path The full path to the file `$encoding` `string` $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' Returns `string` See `PHPMailer::EncodeFile()`
`public string`	# `EncodeString( string $str, string $encoding = 'base64' )` Encodes string to requested format. Returns an empty string on failure. Encodes string to requested format. Returns an empty string on failure. Parameters `$str` `string` $str The text to encode `$encoding` `string` $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' Returns `string`
`public string`	# `EncodeHeader( mixed $str, mixed $position = 'text' )` Encode a header string to best (shortest) of Q, B, quoted or none. Encode a header string to best (shortest) of Q, B, quoted or none. Returns `string`
`public boolean`	# `HasMultiBytes( string $str )` Checks if a string contains multibyte characters. Checks if a string contains multibyte characters. Parameters `$str` `string` $str multi-byte text to wrap encode Returns `boolean`
`public string`	# `Base64EncodeWrapMB( string $str )` Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php Parameters `$str` `string` $str multi-byte text to wrap encode Returns `string`
`public string`	# `EncodeQPphp( string $input = '', integer $line_max = 76, mixed $space_conv = false )` Encode string to quoted-printable. Only uses standard PHP, slow, but will always work Encode string to quoted-printable. Only uses standard PHP, slow, but will always work Parameters `$input` `string` $string the text to encode `$line_max` `integer` $line_max Number of chars allowed on a line before wrapping `$space_conv` Returns `string`
`public string`	# `EncodeQP( string $string, integer $line_max = 76, boolean $space_conv = false )` Encode string to RFC2045 (6.7) quoted-printable format Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding Encode string to RFC2045 (6.7) quoted-printable format Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding Parameters `$string` `string` $string the text to encode `$line_max` `integer` $line_max Number of chars allowed on a line before wrapping `$space_conv` `boolean` $space_conv Dummy param for compatibility with existing EncodeQP function Returns `string` Author Marcus Bointon See `PHPMailer::EncodeQPphp()`
`public string`	# `EncodeQ( string $str, string $position = 'text' )` Encode string to q encoding. Encode string to q encoding. Parameters `$str` `string` $str the text to encode `$position` `string` $position Where the text is going to be used, see the RFC for what that means Returns `string` Link http://tools.ietf.org/html/rfc2047
`public`	# `AddStringAttachment( string $string, string $filename, string $encoding = 'base64', string $type = 'application/octet-stream' )` Adds a string or binary attachment (non-filesystem) to the list. This method can be used to attach ascii or binary data, such as a BLOB record from a database. Adds a string or binary attachment (non-filesystem) to the list. This method can be used to attach ascii or binary data, such as a BLOB record from a database. Parameters `$string` `string` $string String attachment data. `$filename` `string` $filename Name of the attachment. `$encoding` `string` $encoding File encoding (see $Encoding). `$type` `string` $type File extension (MIME) type.
`public boolean`	# `AddEmbeddedImage( string $path, string $cid, string $name = '', string $encoding = 'base64', string $type = 'application/octet-stream' )` Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif". Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif". Parameters `$path` `string` $path Path to the attachment. `$cid` `string` $cid Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form. `$name` `string` $name Overrides the attachment name. `$encoding` `string` $encoding File encoding (see $Encoding). `$type` `string` $type File extension (MIME) type. Returns `boolean`
`public boolean`	# `InlineImageExists( )` Returns true if an inline attachment is present. Returns true if an inline attachment is present. Returns `boolean`
`public`	# `ClearAddresses( )` Clears all recipients assigned in the TO array. Returns void. Clears all recipients assigned in the TO array. Returns void.
`public`	# `ClearCCs( )` Clears all recipients assigned in the CC array. Returns void. Clears all recipients assigned in the CC array. Returns void.
`public`	# `ClearBCCs( )` Clears all recipients assigned in the BCC array. Returns void. Clears all recipients assigned in the BCC array. Returns void.
`public`	# `ClearReplyTos( )` Clears all recipients assigned in the ReplyTo array. Returns void. Clears all recipients assigned in the ReplyTo array. Returns void.
`public`	# `ClearAllRecipients( )` Clears all recipients assigned in the TO, CC and BCC array. Returns void. Clears all recipients assigned in the TO, CC and BCC array. Returns void.
`public`	# `ClearAttachments( )` Clears all previously set filesystem, string, and binary attachments. Returns void. Clears all previously set filesystem, string, and binary attachments. Returns void.
`public`	# `ClearCustomHeaders( )` Clears all custom headers. Returns void. Clears all custom headers. Returns void.
`protected`	# `SetError( mixed $msg )` Adds the error message to the error container. Adds the error message to the error container.
`public static string`	# `RFCDate( )` Returns the proper RFC 822 formatted date. Returns the proper RFC 822 formatted date. Returns `string`
`private string`	# `ServerHostname( )` Returns the server hostname or 'localhost.localdomain' if unknown. Returns the server hostname or 'localhost.localdomain' if unknown. Returns `string`
`private string`	# `Lang( mixed $key )` Returns a message in the appropriate language. Returns a message in the appropriate language. Returns `string`
`public boolean`	# `IsError( )` Returns true if an error occurred. Returns true if an error occurred. Returns `boolean`
`private string`	# `FixEOL( mixed $str )` Changes every end of line from CR or LF to CRLF. Changes every end of line from CR or LF to CRLF. Returns `string`
`public`	# `AddCustomHeader( mixed $custom_header )` Adds a custom header. Adds a custom header.
`public mixed`	# `MsgHTML( mixed $message, mixed $basedir = '' )` Evaluates the message and returns modifications for inline images and backgrounds Evaluates the message and returns modifications for inline images and backgrounds Returns `mixed` $message
`public static string`	# `_mime_types( string $ext = '' )` Gets the MIME type of the embedded or inline image Gets the MIME type of the embedded or inline image Parameters `$ext` `string` File extension Returns `string` MIME type of ext
`public`	# `set( string $name, mixed $value = '' )` Set (or reset) Class Objects (variables) Set (or reset) Class Objects (variables) Usage Example: $page->set('X-Priority', '3'); Parameters `$name` `string` $name Parameter Name `$value` `mixed` $value Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset
`public string`	# `SecureHeader( string $str )` Strips newlines to prevent header injection. Strips newlines to prevent header injection. Parameters `$str` `string` $str String Returns `string`
`public`	# `Sign( string $cert_filename, string $key_filename, mixed $key_pass )` Set the private key file and password to sign the message. Set the private key file and password to sign the message. Parameters `$cert_filename` `string` $key_filename Parameter File Name `$key_filename` `string` $key_pass Password for private key `$key_pass`
`public`	# `DKIM_QP( string $txt )` Set the private key file and password to sign the message. Set the private key file and password to sign the message. Parameters `$txt` `string` $key_filename Parameter File Name
`public`	# `DKIM_Sign( string $s )` Generate DKIM signature Generate DKIM signature Parameters `$s` `string` $s Header
`public`	# `DKIM_HeaderC( string $s )` Generate DKIM Canonicalization Header Generate DKIM Canonicalization Header Parameters `$s` `string` $s Header
`public`	# `DKIM_BodyC( string $body )` Generate DKIM Canonicalization Body Generate DKIM Canonicalization Body Parameters `$body` `string` $body Message Body
`public`	# `DKIM_Add( string $headers_line, string $subject, string $body )` Create the DKIM header, body, as new header Create the DKIM header, body, as new header Parameters `$headers_line` `string` $headers_line Header lines `$subject` `string` $subject Subject `$body` `string` $body Body
`protected`	# `doCallback( mixed $isSent, mixed $to, mixed $cc, mixed $bcc, mixed $subject, mixed $body )`

Magic methods summary

Constants summary

`integer`	`STOP_MESSAGE`	`0`	#
`integer`	`STOP_CONTINUE`	`1`	#
`integer`	`STOP_CRITICAL`	`2`	#

Properties summary

`public integer`	`$Priority`	# Email priority (1 = High, 3 = Normal, 5 = low). Email priority (1 = High, 3 = Normal, 5 = low).
`public string`	`$CharSet`	# Sets the CharSet of the message. Sets the CharSet of the message.
`public string`	`$ContentType`	# Sets the Content-type of the message. Sets the Content-type of the message.
`public string`	`$Encoding`	# Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable". Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
`public string`	`$ErrorInfo`	# Holds the most recent mailer error message. Holds the most recent mailer error message.
`public string`	`$From`	# Sets the From email address for the message. Sets the From email address for the message.
`public string`	`$FromName`	# Sets the From name of the message. Sets the From name of the message.
`public string`	`$Sender`	# Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode. Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
`public string`	`$Subject`	# Sets the Subject of the message. Sets the Subject of the message.
`public string`	`$Body`	# Sets the Body of the message. This can be either an HTML or text body. If HTML then run IsHTML(true). Sets the Body of the message. This can be either an HTML or text body. If HTML then run IsHTML(true).
`public string`	`$AltBody`	# Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body. Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.
`public integer`	`$WordWrap`	# Sets word wrapping on the body of the message to a given number of characters. Sets word wrapping on the body of the message to a given number of characters.
`public string`	`$Mailer`	# Method to send mail: ("mail", "sendmail", or "smtp"). Method to send mail: ("mail", "sendmail", or "smtp").
`public string`	`$Sendmail`	# Sets the path of the sendmail program. Sets the path of the sendmail program.
`public string`	`$PluginDir`	# Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path. Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
`public string`	`$ConfirmReadingTo`	# Sets the email address that a reading confirmation will be sent. Sets the email address that a reading confirmation will be sent.
`public string`	`$Hostname`	# Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'. Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.
`public string`	`$MessageID`	# Sets the message ID to be used in the Message-Id header. If empty, a unique id will be generated. Sets the message ID to be used in the Message-Id header. If empty, a unique id will be generated.
`public string`	`$Host`	# Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). Hosts will be tried in order. Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). Hosts will be tried in order.
`public integer`	`$Port`	# Sets the default SMTP server port. Sets the default SMTP server port.
`public string`	`$Helo`	# Sets the SMTP HELO of the message (Default is $Hostname). Sets the SMTP HELO of the message (Default is $Hostname).
`public string`	`$SMTPSecure`	# Sets connection prefix. Options are "", "ssl" or "tls" Sets connection prefix. Options are "", "ssl" or "tls"
`public boolean`	`$SMTPAuth`	# Sets SMTP authentication. Utilizes the Username and Password variables. Sets SMTP authentication. Utilizes the Username and Password variables.
`public string`	`$Username`	# Sets SMTP username. Sets SMTP username.
`public string`	`$Password`	# Sets SMTP password. Sets SMTP password.
`public integer`	`$Timeout`	# Sets the SMTP server timeout in seconds. This function will not work with the win32 version. Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
`public boolean`	`$SMTPDebug`	# Sets SMTP class debugging on or off. Sets SMTP class debugging on or off.
`public boolean`	`$SMTPKeepAlive`	# Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose(). Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().
`public boolean`	`$SingleTo`	# Provides the ability to have the TO field process individual emails, instead of sending to entire TO addresses Provides the ability to have the TO field process individual emails, instead of sending to entire TO addresses
`public boolean`	`$SingleToArray`	# If SingleTo is true, this provides the array to hold the email addresses If SingleTo is true, this provides the array to hold the email addresses
`public string`	`$LE`	# Provides the ability to change the line ending Provides the ability to change the line ending
`public string`	`$DKIM_selector`	# Used with DKIM DNS Resource Record Used with DKIM DNS Resource Record
`public string`	`$DKIM_identity`	# Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com' Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com'
`public string`	`$DKIM_domain`	# Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com' Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com'
`public string`	`$DKIM_private`	# Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com' Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com'
`public string`	`$action_function`	# Callback Action function name the function that handles the result of the send email action. Parameters: bool $result result of the send action string $to email address of the recipient string $cc cc email addresses string $bcc bcc email addresses string $subject the subject string $body the email body Callback Action function name the function that handles the result of the send email action. Parameters: bool $result result of the send action string $to email address of the recipient string $cc cc email addresses string $bcc bcc email addresses string $subject the subject string $body the email body
`public string`	`$Version`	# Sets the PHPMailer Version number Sets the PHPMailer Version number
`private mixed`	`$smtp`	#
`private array`	`$to`	#
`private array`	`$cc`	#
`private array`	`$bcc`	#
`private array`	`$ReplyTo`	#
`private array`	`$all_recipients`	#
`private array`	`$attachment`	#
`private array`	`$CustomHeader`	#
`private string`	`$message_type`	#
`private array`	`$boundary`	#
`protected array`	`$language`	#
`private integer`	`$error_count`	#
`private string`	`$sign_cert_file`	#
`private string`	`$sign_key_file`	#
`private string`	`$sign_key_pass`	#
`private boolean`	`$exceptions`	#

Packages

Classes

Exceptions

Class PHPMailer

Methods summary

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Link

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Uses

Returns

Uses

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

See

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Author

See

Parameters

Returns

Link

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns