mirror
/
PHPMailer
mirror of https://github.com/PHPMailer/PHPMailer.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #515 from dnepro/master 

[TASK] replace "@type" annotation in favor of "@var" as proposed by phpdoc.org
This commit is contained in:
Marcus Bointon 2015-09-28 12:19:31 +02:00
parent 40a0a1b160 870350756b
commit e2a9ec16bd
6 changed files with 118 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

150
class.phpmailer.php
View File

@ -29,7 +29,7 @@ class PHPMailer
{
/**
* The PHPMailer Version number.
* @type string
* @var string
*/
public $Version = '5.2.13';
@ -37,58 +37,58 @@ class PHPMailer
* Email priority.
* Options: null (default), 1 = High, 3 = Normal, 5 = low.
* When null, the header is not set at all.
* @type integer
* @var integer
*/
public $Priority = null;
/**
* The character set of the message.
* @type string
* @var string
*/
public $CharSet = 'iso-8859-1';
/**
* The MIME Content-type of the message.
* @type string
* @var string
*/
public $ContentType = 'text/plain';
/**
* The message encoding.
* Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".
* @type string
* @var string
*/
public $Encoding = '8bit';
/**
* Holds the most recent mailer error message.
* @type string
* @var string
*/
public $ErrorInfo = '';
/**
* The From email address for the message.
* @type string
* @var string
*/
public $From = 'root@localhost';
/**
* The From name of the message.
* @type string
* @var string
*/
public $FromName = 'Root User';
/**
* 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.
* @type string
* @var string
*/
public $Sender = '';
/**
* The Return-Path of the message.
* If empty, it will be set to either From or Sender.
* @type string
* @var string
* @deprecated Email senders should never set a return-path header;
* it's the receiver's job (RFC5321 section 4.4), so this no longer does anything.
* @link https://tools.ietf.org/html/rfc5321#section-4.4 RFC5321 reference
@ -97,14 +97,14 @@ class PHPMailer
/**
* The Subject of the message.
* @type string
* @var string
*/
public $Subject = '';
/**
* An HTML or plain text message body.
* If HTML then call isHTML(true).
* @type string
* @var string
*/
public $Body = '';
@ -113,7 +113,7 @@ class PHPMailer
* This body can be read by mail clients that do not have HTML email
* capability such as mutt & Eudora.
* Clients that can read HTML will view the normal Body.
* @type string
* @var string
*/
public $AltBody = '';
@ -123,27 +123,27 @@ class PHPMailer
* To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator
* @link http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/
* @link http://kigkonsult.se/iCalcreator/
* @type string
* @var string
*/
public $Ical = '';
/**
* The complete compiled MIME message body.
* @access protected
* @type string
* @var string
*/
protected $MIMEBody = '';
/**
* The complete compiled MIME message headers.
* @type string
* @var string
* @access protected
*/
protected $MIMEHeader = '';
/**
* Extra headers that createHeader() doesn't fold in.
* @type string
* @var string
* @access protected
*/
protected $mailHeader = '';
@ -151,41 +151,41 @@ class PHPMailer
/**
* Word-wrap the message body to this number of chars.
* Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance.
* @type integer
* @var integer
*/
public $WordWrap = 0;
/**
* Which method to use to send mail.
* Options: "mail", "sendmail", or "smtp".
* @type string
* @var string
*/
public $Mailer = 'mail';
/**
* The path to the sendmail program.
* @type string
* @var string
*/
public $Sendmail = '/usr/sbin/sendmail';
/**
* Whether mail() uses a fully sendmail-compatible MTA.
* One which supports sendmail's "-oi -f" options.
* @type boolean
* @var boolean
*/
public $UseSendmailOptions = true;
/**
* Path to PHPMailer plugins.
* Useful if the SMTP class is not in the PHP include path.
* @type string
* @var string
* @deprecated Should not be needed now there is an autoloader.
*/
public $PluginDir = '';
/**
* The email address that a reading confirmation should be sent to.
* @type string
* @var string
*/
public $ConfirmReadingTo = '';
@ -194,21 +194,21 @@ class PHPMailer
* If empty, PHPMailer attempts to find one with, in order,
* $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value
* 'localhost.localdomain'.
* @type string
* @var string
*/
public $Hostname = '';
/**
* An ID to be used in the Message-ID header.
* If empty, a unique id will be generated.
* @type string
* @var string
*/
public $MessageID = '';
/**
* The message Date to be used in the Date header.
* If empty, the current date will be added.
* @type string
* @var string
*/
public $MessageDate = '';
@ -221,13 +221,13 @@ class PHPMailer
* You can also specify encryption type, for example:
* (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465").
* Hosts will be tried in order.
* @type string
* @var string
*/
public $Host = 'localhost';
/**
* The default SMTP server port.
* @type integer
* @var integer
* @TODO Why is this needed when the SMTP class takes care of it?
*/
public $Port = 25;
@ -236,7 +236,7 @@ class PHPMailer
* The SMTP HELO of the message.
* Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find
* one with the same method described above for $Hostname.
* @type string
* @var string
* @see PHPMailer::$Hostname
*/
public $Helo = '';
@ -244,7 +244,7 @@ class PHPMailer
/**
* What kind of encryption to use on the SMTP connection.
* Options: '', 'ssl' or 'tls'
* @type string
* @var string
*/
public $SMTPSecure = '';
@ -252,14 +252,14 @@ class PHPMailer
* Whether to enable TLS encryption automatically if a server supports it,
* even if `SMTPSecure` is not set to 'tls'.
* Be aware that in PHP >= 5.6 this requires that the server's certificates are valid.
* @type boolean
* @var boolean
*/
public $SMTPAutoTLS = true;
/**
* Whether to use SMTP authentication.
* Uses the Username and Password properties.
* @type boolean
* @var boolean
* @see PHPMailer::$Username
* @see PHPMailer::$Password
*/
@ -267,47 +267,47 @@ class PHPMailer
/**
* Options array passed to stream_context_create when connecting via SMTP.
* @type array
* @var array
*/
public $SMTPOptions = array();
/**
* SMTP username.
* @type string
* @var string
*/
public $Username = '';
/**
* SMTP password.
* @type string
* @var string
*/
public $Password = '';
/**
* SMTP auth type.
* Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5
* @type string
* @var string
*/
public $AuthType = '';
/**
* SMTP realm.
* Used for NTLM auth
* @type string
* @var string
*/
public $Realm = '';
/**
* SMTP workstation.
* Used for NTLM auth
* @type string
* @var string
*/
public $Workstation = '';
/**
* The SMTP server timeout in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* @type integer
* @var integer
*/
public $Timeout = 300;
@ -320,7 +320,7 @@ class PHPMailer
* * `2` Data and commands
* * `3` As 2 plus connection status
* * `4` Low-level data output
* @type integer
* @var integer
* @see SMTP::$do_debug
*/
public $SMTPDebug = 0;
@ -336,7 +336,7 @@ class PHPMailer
* <code>
* $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* </code>
* @type string|callable
* @var string|callable
* @see SMTP::$Debugoutput
*/
public $Debugoutput = 'echo';
@ -345,20 +345,20 @@ class PHPMailer
* Whether to keep SMTP connection open after each message.
* If this is set to true then to close the connection
* requires an explicit call to smtpClose().
* @type boolean
* @var boolean
*/
public $SMTPKeepAlive = false;
/**
* Whether to split multiple to addresses into multiple messages
* or send them all in one message.
* @type boolean
* @var boolean
*/
public $SingleTo = false;
/**
* Storage for addresses when SingleTo is enabled.
* @type array
* @var array
* @TODO This should really not be public
*/
public $SingleToArray = array();
@ -368,13 +368,13 @@ class PHPMailer
* Only applicable when sending via SMTP.
* @link https://en.wikipedia.org/wiki/Variable_envelope_return_path
* @link http://www.postfix.org/VERP_README.html Postfix VERP info
* @type boolean
* @var boolean
*/
public $do_verp = false;
/**
* Whether to allow sending messages with an empty body.
* @type boolean
* @var boolean
*/
public $AllowEmpty = false;
@ -382,40 +382,40 @@ class PHPMailer
* The default line ending.
* @note The default remains "\n". We force CRLF where we know
* it must be used via self::CRLF.
* @type string
* @var string
*/
public $LE = "\n";
/**
* DKIM selector.
* @type string
* @var string
*/
public $DKIM_selector = '';
/**
* DKIM Identity.
* Usually the email address used as the source of the email
* @type string
* @var string
*/
public $DKIM_identity = '';
/**
* DKIM passphrase.
* Used if your key is encrypted.
* @type string
* @var string
*/
public $DKIM_passphrase = '';
/**
* DKIM signing domain name.
* @example 'example.com'
* @type string
* @var string
*/
public $DKIM_domain = '';
/**
* DKIM private key file path.
* @type string
* @var string
*/
public $DKIM_private = '';
@ -435,21 +435,21 @@ class PHPMailer
* string $subject the subject
* string $body the email body
* string $from email address of sender
* @type string
* @var string
*/
public $action_function = '';
/**
* What to put in the X-Mailer header.
* Options: An empty string for PHPMailer default, whitespace for none, or a string to use
* @type string
* @var string
*/
public $XMailer = '';
/**
* Only For XOAUTH - Google
* Options: An empty string for PHPMailer default, Enter the email used to get access token
* @type string
* @var string
*/
// public $UserEmail = '';
// public $RefreshToken = '';
@ -459,35 +459,35 @@ class PHPMailer
/**
* An instance of the SMTP sender class.
* @type SMTP
* @var SMTP
* @access protected
*/
protected $smtp = null;
/**
* The array of 'to' addresses.
* @type array
* @var array
* @access protected
*/
protected $to = array();
/**
* The array of 'cc' addresses.
* @type array
* @var array
* @access protected
*/
protected $cc = array();
/**
* The array of 'bcc' addresses.
* @type array
* @var array
* @access protected
*/
protected $bcc = array();
/**
* The array of reply-to names and addresses.
* @type array
* @var array
* @access protected
*/
protected $ReplyTo = array();
@ -495,77 +495,77 @@ class PHPMailer
/**
* An array of all kinds of addresses.
* Includes all of $to, $cc, $bcc
* @type array
* @var array
* @access protected
*/
protected $all_recipients = array();
/**
* The array of attachments.
* @type array
* @var array
* @access protected
*/
protected $attachment = array();
/**
* The array of custom headers.
* @type array
* @var array
* @access protected
*/
protected $CustomHeader = array();
/**
* The most recent Message-ID (including angular brackets).
* @type string
* @var string
* @access protected
*/
protected $lastMessageID = '';
/**
* The message's MIME type.
* @type string
* @var string
* @access protected
*/
protected $message_type = '';
/**
* The array of MIME boundary strings.
* @type array
* @var array
* @access protected
*/
protected $boundary = array();
/**
* The array of available languages.
* @type array
* @var array
* @access protected
*/
protected $language = array();
/**
* The number of errors encountered.
* @type integer
* @var integer
* @access protected
*/
protected $error_count = 0;
/**
* The S/MIME certificate file path.
* @type string
* @var string
* @access protected
*/
protected $sign_cert_file = '';
/**
* The S/MIME key file path.
* @type string
* @var string
* @access protected
*/
protected $sign_key_file = '';
/**
* The optional S/MIME extra certificates ("CA Chain") file path.
* @type string
* @var string
* @access protected
*/
protected $sign_extracerts_file = '';
@ -573,21 +573,21 @@ class PHPMailer
/**
* The S/MIME password for the key.
* Used only if the key is encrypted.
* @type string
* @var string
* @access protected
*/
protected $sign_key_pass = '';
/**
* Whether to throw exceptions for errors.
* @type boolean
* @var boolean
* @access protected
*/
protected $exceptions = false;
/**
* Unique ID used for message ID and boundaries.
* @type string
* @var string
* @access protected
*/
protected $uniqueid = '';
@ -614,7 +614,7 @@ class PHPMailer
/**
* The maximum line length allowed by RFC 2822 section 2.1.1
* @type integer
* @var integer
*/
const MAX_LINE_LENGTH = 998;

10
class.phpmaileroauth.php
View File

@ -27,31 +27,31 @@ class PHPMailerOAuth extends PHPMailer
{
/**
* The OAuth user's email address
* @type string
* @var string
*/
public $oauthUserEmail = '';
/**
* The OAuth refresh token
* @type string
* @var string
*/
public $oauthRefreshToken = '';
/**
* The OAuth client ID
* @type string
* @var string
*/
public $oauthClientId = '';
/**
* The OAuth client secret
* @type string
* @var string
*/
public $oauthClientSecret = '';
/**
* An instance of the OAuth class.
* @type OAuth
* @var OAuth
* @access protected
*/
protected $oauth = null;

26
class.pop3.php
View File

@ -31,28 +31,28 @@ class POP3
{
/**
* The POP3 PHPMailer Version number.
* @type string
* @var string
* @access public
*/
public $Version = '5.2.13';
/**
* Default POP3 port number.
* @type integer
* @var integer
* @access public
*/
public $POP3_PORT = 110;
/**
* Default timeout in seconds.
* @type integer
* @var integer
* @access public
*/
public $POP3_TIMEOUT = 30;
/**
* POP3 Carriage Return + Line Feed.
* @type string
* @var string
* @access public
* @deprecated Use the constant instead
*/
@ -61,63 +61,63 @@ class POP3
/**
* Debug display level.
* Options: 0 = no, 1+ = yes
* @type integer
* @var integer
* @access public
*/
public $do_debug = 0;
/**
* POP3 mail server hostname.
* @type string
* @var string
* @access public
*/
public $host;
/**
* POP3 port number.
* @type integer
* @var integer
* @access public
*/
public $port;
/**
* POP3 Timeout Value in seconds.
* @type integer
* @var integer
* @access public
*/
public $tval;
/**
* POP3 username
* @type string
* @var string
* @access public
*/
public $username;
/**
* POP3 password.
* @type string
* @var string
* @access public
*/
public $password;
/**
* Resource handle for the POP3 connection socket.
* @type resource
* @var resource
* @access protected
*/
protected $pop_conn;
/**
* Are we connected?
* @type boolean
* @var boolean
* @access protected
*/
protected $connected = false;
/**
* Error container.
* @type array
* @var array
* @access protected
*/
protected $errors = array();

34
class.smtp.php
View File

@ -28,25 +28,25 @@ class SMTP
{
/**
* The PHPMailer SMTP version number.
* @type string
* @var string
*/
const VERSION = '5.2.13';
/**
* SMTP line break constant.
* @type string
* @var string
*/
const CRLF = "\r\n";
/**
* The SMTP port to use if one is not specified.
* @type integer
* @var integer
*/
const DEFAULT_SMTP_PORT = 25;
/**
* The maximum line length allowed by RFC 2822 section 2.1.1
* @type integer
* @var integer
*/
const MAX_LINE_LENGTH = 998;
@ -77,7 +77,7 @@ class SMTP
/**
* The PHPMailer SMTP Version number.
* @type string
* @var string
* @deprecated Use the `VERSION` constant instead
* @see SMTP::VERSION
*/
@ -85,7 +85,7 @@ class SMTP
/**
* SMTP server port number.
* @type integer
* @var integer
* @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead
* @see SMTP::DEFAULT_SMTP_PORT
*/
@ -93,7 +93,7 @@ class SMTP
/**
* SMTP reply line ending.
* @type string
* @var string
* @deprecated Use the `CRLF` constant instead
* @see SMTP::CRLF
*/
@ -107,7 +107,7 @@ class SMTP
* * self::DEBUG_SERVER (`2`) Client commands and server responses
* * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status
* * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages
* @type integer
* @var integer
*/
public $do_debug = self::DEBUG_OFF;
@ -122,7 +122,7 @@ class SMTP
* <code>
* $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* </code>
* @type string|callable
* @var string|callable
*/
public $Debugoutput = 'echo';
@ -130,7 +130,7 @@ class SMTP
* Whether to use VERP.
* @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
* @link http://www.postfix.org/VERP_README.html Info on VERP
* @type boolean
* @var boolean
*/
public $do_verp = false;
@ -139,26 +139,26 @@ class SMTP
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
* @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
* @type integer
* @var integer
*/
public $Timeout = 300;
/**
* How long to wait for commands to complete, in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* @type integer
* @var integer
*/
public $Timelimit = 300;
/**
* The socket for the server connection.
* @type resource
* @var resource
*/
protected $smtp_conn;
/**
* Error information, if any, for the last SMTP command.
* @type array
* @var array
*/
protected $error = array(
'error' => '',
@ -170,7 +170,7 @@ class SMTP
/**
* The reply the server sent to us for HELO.
* If null, no HELO string has yet been received.
* @type string|null
* @var string|null
*/
protected $helo_rply = null;
@ -181,13 +181,13 @@ class SMTP
* represents the server name. In case of HELO it is the only element of the array.
* Other values can be boolean TRUE or an array containing extension options.
* If null, no HELO/EHLO string has yet been received.
* @type array|null
* @var array|null
*/
protected $server_caps = null;
/**
* The most recent reply received from the server.
* @type string
* @var string
*/
protected $last_reply = '';

4
extras/EasyPeasyICS.php
View File

@ -21,12 +21,12 @@ class EasyPeasyICS
{
/**
* The name of the calendar
* @type string
* @var string
*/
protected $calendarName;
/**
* The array of events to add to this calendar
* @type array
* @var array
*/
protected $events = array();

12
test/phpmailerTest.php
View File

@ -24,40 +24,40 @@ class PHPMailerTest extends PHPUnit_Framework_TestCase
/**
* Holds the default phpmailer instance.
* @private
* @type PHPMailer
* @var PHPMailer
*/
public $Mail;
/**
* Holds the SMTP mail host.
* @public
* @type string
* @var string
*/
public $Host = '';
/**
* Holds the change log.
* @private
* @type string[]
* @var string[]
*/
public $ChangeLog = array();
/**
* Holds the note log.
* @private
* @type string[]
* @var string[]
*/
public $NoteLog = array();
/**
* Default include path
* @type string
* @var string
*/
public $INCLUDE_DIR = '../';
/**
* PIDs of any processes we need to kill
* @type array
* @var array
* @access private
*/
private $pids = array();