initial
This commit is contained in:
@@ -0,0 +1,504 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
||||
|
||||
|
||||
@@ -0,0 +1,504 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
||||
|
||||
|
||||
@@ -0,0 +1,218 @@
|
||||
/*******************************************************************
|
||||
* The http://phpmailer.codeworxtech.com/ website now carries a few *
|
||||
* advertisements through the Google Adsense network. Please visit *
|
||||
* the advertiser sites and help us offset some of our costs. *
|
||||
* Thanks .... *
|
||||
********************************************************************/
|
||||
|
||||
PHPMailer
|
||||
Full Featured Email Transfer Class for PHP
|
||||
==========================================
|
||||
|
||||
Version 5.0.0 (April 02, 2009)
|
||||
|
||||
With the release of this version, we are initiating a new version numbering
|
||||
system to differentiate from the PHP4 version of PHPMailer.
|
||||
|
||||
Most notable in this release is fully object oriented code.
|
||||
|
||||
We now have available the PHPDocumentor (phpdocs) documentation. This is
|
||||
separate from the regular download to keep file sizes down. Please see the
|
||||
download area of http://phpmailer.codeworxtech.com.
|
||||
|
||||
We also have created a new test script (see /test_script) that you can use
|
||||
right out of the box. Copy the /test_script folder directly to your server (in
|
||||
the same structure ... with class.phpmailer.php and class.smtp.php in the
|
||||
folder above it. Then launch the test script with:
|
||||
http://www.yourdomain.com/phpmailer/test_script/index.php
|
||||
from this one script, you can test your server settings for mail(), sendmail (or
|
||||
qmail), and SMTP. This will email you a sample email (using contents.html for
|
||||
the email body) and two attachments. One of the attachments is used as an inline
|
||||
image to demonstrate how PHPMailer will automatically detect if attachments are
|
||||
the same source as inline graphics and only include one version. Once you click
|
||||
the Submit button, the results will be displayed including any SMTP debug
|
||||
information and send status. We will also display a version of the script that
|
||||
you can cut and paste to include in your projects. Enjoy!
|
||||
|
||||
Version 2.3 (November 08, 2008)
|
||||
|
||||
We have removed the /phpdoc from the downloads. All documentation is now on
|
||||
the http://phpmailer.codeworxtech.com website.
|
||||
|
||||
The phpunit.php has been updated to support PHP5.
|
||||
|
||||
For all other changes and notes, please see the changelog.
|
||||
|
||||
Donations are accepted at PayPal with our id "paypal@worxteam.com".
|
||||
|
||||
Version 2.2 (July 15 2008)
|
||||
|
||||
- see the changelog.
|
||||
|
||||
Version 2.1 (June 04 2008)
|
||||
|
||||
With this release, we are announcing that the development of PHPMailer for PHP5
|
||||
will be our focus from this date on. We have implemented all the enhancements
|
||||
and fixes from the latest release of PHPMailer for PHP4.
|
||||
|
||||
Far more important, though, is that this release of PHPMailer (v2.1) is
|
||||
fully tested with E_STRICT error checking enabled.
|
||||
|
||||
** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.
|
||||
IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE
|
||||
APPRECIATED.
|
||||
|
||||
We have now added S/MIME functionality (ability to digitally sign emails).
|
||||
BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.
|
||||
The "Signed Emails" functionality adds the Sign method to pass the private key
|
||||
filename and the password to read it, and then email will be sent with
|
||||
content-type multipart/signed and with the digital signature attached.
|
||||
|
||||
A quick note on E_STRICT:
|
||||
|
||||
- In about half the test environments the development version was subjected
|
||||
to, an error was thrown for the date() functions (used at line 1565 and 1569).
|
||||
This is NOT a PHPMailer error, it is the result of an incorrectly configured
|
||||
PHP5 installation. The fix is to modify your 'php.ini' file and include the
|
||||
date.timezone = America/New York
|
||||
directive, (for your own server timezone)
|
||||
- If you do get this error, and are unable to access your php.ini file, there is
|
||||
a workaround. In your PHP script, add
|
||||
date_default_timezone_set('America/Toronto');
|
||||
|
||||
* do NOT try to use
|
||||
$myVar = date_default_timezone_get();
|
||||
as a test, it will throw an error.
|
||||
|
||||
We have also included more example files to show the use of "sendmail", "mail()",
|
||||
"smtp", and "gmail".
|
||||
|
||||
We are also looking for more programmers to join the volunteer development team.
|
||||
If you have an interest in this, please let us know.
|
||||
|
||||
Enjoy!
|
||||
|
||||
|
||||
Version 2.1.0beta1 & beta2
|
||||
|
||||
please note, this is BETA software
|
||||
** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
|
||||
INTENDED STRICTLY FOR TESTING
|
||||
|
||||
** NOTE:
|
||||
|
||||
As of November 2007, PHPMailer has a new project team headed by industry
|
||||
veteran Andy Prevost (codeworxtech). The first release in more than two
|
||||
years will focus on fixes, adding ease-of-use enhancements, provide
|
||||
basic compatibility with PHP4 and PHP5 using PHP5 backwards compatibility
|
||||
features. A new release is planned before year-end 2007 that will provide
|
||||
full compatiblity with PHP4 and PHP5, as well as more bug fixes.
|
||||
|
||||
We are looking for project developers to assist in restoring PHPMailer to
|
||||
its leadership position. Our goals are to simplify use of PHPMailer, provide
|
||||
good documentation and examples, and retain backward compatibility to level
|
||||
1.7.3 standards.
|
||||
|
||||
If you are interested in helping out, visit http://sourceforge.net/projects/phpmailer
|
||||
and indicate your interest.
|
||||
|
||||
**
|
||||
|
||||
http://phpmailer.sourceforge.net/
|
||||
|
||||
This software is licenced under the LGPL. Please read LICENSE for information on the
|
||||
software availability and distribution.
|
||||
|
||||
Class Features:
|
||||
- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs
|
||||
- Redundant SMTP servers
|
||||
- Multipart/alternative emails for mail clients that do not read HTML email
|
||||
- Support for 8bit, base64, binary, and quoted-printable encoding
|
||||
- Uses the same methods as the very popular AspEmail active server (COM) component
|
||||
- SMTP authentication
|
||||
- Native language support
|
||||
- Word wrap, and more!
|
||||
|
||||
Why you might need it:
|
||||
|
||||
Many PHP developers utilize email in their code. The only PHP function
|
||||
that supports this is the mail() function. However, it does not expose
|
||||
any of the popular features that many email clients use nowadays like
|
||||
HTML-based emails and attachments. There are two proprietary
|
||||
development tools out there that have all the functionality built into
|
||||
easy to use classes: AspEmail(tm) and AspMail. Both of these
|
||||
programs are COM components only available on Windows. They are also a
|
||||
little pricey for smaller projects.
|
||||
|
||||
Since I do Linux development I�ve missed these tools for my PHP coding.
|
||||
So I built a version myself that implements the same methods (object
|
||||
calls) that the Windows-based components do. It is open source and the
|
||||
LGPL license allows you to place the class in your proprietary PHP
|
||||
projects.
|
||||
|
||||
|
||||
Installation:
|
||||
|
||||
Copy class.phpmailer.php into your php.ini include_path. If you are
|
||||
using the SMTP mailer then place class.smtp.php in your path as well.
|
||||
In the language directory you will find several files like
|
||||
phpmailer.lang-en.php. If you look right before the .php extension
|
||||
that there are two letters. These represent the language type of the
|
||||
translation file. For instance "en" is the English file and "br" is
|
||||
the Portuguese file. Chose the file that best fits with your language
|
||||
and place it in the PHP include path. If your language is English
|
||||
then you have nothing more to do. If it is a different language then
|
||||
you must point PHPMailer to the correct translation. To do this, call
|
||||
the PHPMailer SetLanguage method like so:
|
||||
|
||||
// To load the Portuguese version
|
||||
$mail->SetLanguage("br", "/optional/path/to/language/directory/");
|
||||
|
||||
That's it. You should now be ready to use PHPMailer!
|
||||
|
||||
|
||||
A Simple Example:
|
||||
|
||||
<?php
|
||||
require("class.phpmailer.php");
|
||||
|
||||
$mail = new PHPMailer();
|
||||
|
||||
$mail->IsSMTP(); // set mailer to use SMTP
|
||||
$mail->Host = "smtp1.example.com;smtp2.example.com"; // specify main and backup server
|
||||
$mail->SMTPAuth = true; // turn on SMTP authentication
|
||||
$mail->Username = "jswan"; // SMTP username
|
||||
$mail->Password = "secret"; // SMTP password
|
||||
|
||||
$mail->From = "from@example.com";
|
||||
$mail->FromName = "Mailer";
|
||||
$mail->AddAddress("josh@example.net", "Josh Adams");
|
||||
$mail->AddAddress("ellen@example.com"); // name is optional
|
||||
$mail->AddReplyTo("info@example.com", "Information");
|
||||
|
||||
$mail->WordWrap = 50; // set word wrap to 50 characters
|
||||
$mail->AddAttachment("/var/tmp/file.tar.gz"); // add attachments
|
||||
$mail->AddAttachment("/tmp/image.jpg", "new.jpg"); // optional name
|
||||
$mail->IsHTML(true); // set email format to HTML
|
||||
|
||||
$mail->Subject = "Here is the subject";
|
||||
$mail->Body = "This is the HTML message body <b>in bold!</b>";
|
||||
$mail->AltBody = "This is the body in plain text for non-HTML mail clients";
|
||||
|
||||
if(!$mail->Send())
|
||||
{
|
||||
echo "Message could not be sent. <p>";
|
||||
echo "Mailer Error: " . $mail->ErrorInfo;
|
||||
exit;
|
||||
}
|
||||
|
||||
echo "Message has been sent";
|
||||
?>
|
||||
|
||||
CHANGELOG
|
||||
|
||||
See ChangeLog.txt
|
||||
|
||||
Download: http://sourceforge.net/project/showfiles.php?group_id=26031
|
||||
|
||||
Andy Prevost
|
||||
@@ -0,0 +1,218 @@
|
||||
/*******************************************************************
|
||||
* The http://phpmailer.codeworxtech.com/ website now carries a few *
|
||||
* advertisements through the Google Adsense network. Please visit *
|
||||
* the advertiser sites and help us offset some of our costs. *
|
||||
* Thanks .... *
|
||||
********************************************************************/
|
||||
|
||||
PHPMailer
|
||||
Full Featured Email Transfer Class for PHP
|
||||
==========================================
|
||||
|
||||
Version 5.0.0 (April 02, 2009)
|
||||
|
||||
With the release of this version, we are initiating a new version numbering
|
||||
system to differentiate from the PHP4 version of PHPMailer.
|
||||
|
||||
Most notable in this release is fully object oriented code.
|
||||
|
||||
We now have available the PHPDocumentor (phpdocs) documentation. This is
|
||||
separate from the regular download to keep file sizes down. Please see the
|
||||
download area of http://phpmailer.codeworxtech.com.
|
||||
|
||||
We also have created a new test script (see /test_script) that you can use
|
||||
right out of the box. Copy the /test_script folder directly to your server (in
|
||||
the same structure ... with class.phpmailer.php and class.smtp.php in the
|
||||
folder above it. Then launch the test script with:
|
||||
http://www.yourdomain.com/phpmailer/test_script/index.php
|
||||
from this one script, you can test your server settings for mail(), sendmail (or
|
||||
qmail), and SMTP. This will email you a sample email (using contents.html for
|
||||
the email body) and two attachments. One of the attachments is used as an inline
|
||||
image to demonstrate how PHPMailer will automatically detect if attachments are
|
||||
the same source as inline graphics and only include one version. Once you click
|
||||
the Submit button, the results will be displayed including any SMTP debug
|
||||
information and send status. We will also display a version of the script that
|
||||
you can cut and paste to include in your projects. Enjoy!
|
||||
|
||||
Version 2.3 (November 08, 2008)
|
||||
|
||||
We have removed the /phpdoc from the downloads. All documentation is now on
|
||||
the http://phpmailer.codeworxtech.com website.
|
||||
|
||||
The phpunit.php has been updated to support PHP5.
|
||||
|
||||
For all other changes and notes, please see the changelog.
|
||||
|
||||
Donations are accepted at PayPal with our id "paypal@worxteam.com".
|
||||
|
||||
Version 2.2 (July 15 2008)
|
||||
|
||||
- see the changelog.
|
||||
|
||||
Version 2.1 (June 04 2008)
|
||||
|
||||
With this release, we are announcing that the development of PHPMailer for PHP5
|
||||
will be our focus from this date on. We have implemented all the enhancements
|
||||
and fixes from the latest release of PHPMailer for PHP4.
|
||||
|
||||
Far more important, though, is that this release of PHPMailer (v2.1) is
|
||||
fully tested with E_STRICT error checking enabled.
|
||||
|
||||
** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.
|
||||
IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE
|
||||
APPRECIATED.
|
||||
|
||||
We have now added S/MIME functionality (ability to digitally sign emails).
|
||||
BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.
|
||||
The "Signed Emails" functionality adds the Sign method to pass the private key
|
||||
filename and the password to read it, and then email will be sent with
|
||||
content-type multipart/signed and with the digital signature attached.
|
||||
|
||||
A quick note on E_STRICT:
|
||||
|
||||
- In about half the test environments the development version was subjected
|
||||
to, an error was thrown for the date() functions (used at line 1565 and 1569).
|
||||
This is NOT a PHPMailer error, it is the result of an incorrectly configured
|
||||
PHP5 installation. The fix is to modify your 'php.ini' file and include the
|
||||
date.timezone = America/New York
|
||||
directive, (for your own server timezone)
|
||||
- If you do get this error, and are unable to access your php.ini file, there is
|
||||
a workaround. In your PHP script, add
|
||||
date_default_timezone_set('America/Toronto');
|
||||
|
||||
* do NOT try to use
|
||||
$myVar = date_default_timezone_get();
|
||||
as a test, it will throw an error.
|
||||
|
||||
We have also included more example files to show the use of "sendmail", "mail()",
|
||||
"smtp", and "gmail".
|
||||
|
||||
We are also looking for more programmers to join the volunteer development team.
|
||||
If you have an interest in this, please let us know.
|
||||
|
||||
Enjoy!
|
||||
|
||||
|
||||
Version 2.1.0beta1 & beta2
|
||||
|
||||
please note, this is BETA software
|
||||
** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
|
||||
INTENDED STRICTLY FOR TESTING
|
||||
|
||||
** NOTE:
|
||||
|
||||
As of November 2007, PHPMailer has a new project team headed by industry
|
||||
veteran Andy Prevost (codeworxtech). The first release in more than two
|
||||
years will focus on fixes, adding ease-of-use enhancements, provide
|
||||
basic compatibility with PHP4 and PHP5 using PHP5 backwards compatibility
|
||||
features. A new release is planned before year-end 2007 that will provide
|
||||
full compatiblity with PHP4 and PHP5, as well as more bug fixes.
|
||||
|
||||
We are looking for project developers to assist in restoring PHPMailer to
|
||||
its leadership position. Our goals are to simplify use of PHPMailer, provide
|
||||
good documentation and examples, and retain backward compatibility to level
|
||||
1.7.3 standards.
|
||||
|
||||
If you are interested in helping out, visit http://sourceforge.net/projects/phpmailer
|
||||
and indicate your interest.
|
||||
|
||||
**
|
||||
|
||||
http://phpmailer.sourceforge.net/
|
||||
|
||||
This software is licenced under the LGPL. Please read LICENSE for information on the
|
||||
software availability and distribution.
|
||||
|
||||
Class Features:
|
||||
- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs
|
||||
- Redundant SMTP servers
|
||||
- Multipart/alternative emails for mail clients that do not read HTML email
|
||||
- Support for 8bit, base64, binary, and quoted-printable encoding
|
||||
- Uses the same methods as the very popular AspEmail active server (COM) component
|
||||
- SMTP authentication
|
||||
- Native language support
|
||||
- Word wrap, and more!
|
||||
|
||||
Why you might need it:
|
||||
|
||||
Many PHP developers utilize email in their code. The only PHP function
|
||||
that supports this is the mail() function. However, it does not expose
|
||||
any of the popular features that many email clients use nowadays like
|
||||
HTML-based emails and attachments. There are two proprietary
|
||||
development tools out there that have all the functionality built into
|
||||
easy to use classes: AspEmail(tm) and AspMail. Both of these
|
||||
programs are COM components only available on Windows. They are also a
|
||||
little pricey for smaller projects.
|
||||
|
||||
Since I do Linux development I�ve missed these tools for my PHP coding.
|
||||
So I built a version myself that implements the same methods (object
|
||||
calls) that the Windows-based components do. It is open source and the
|
||||
LGPL license allows you to place the class in your proprietary PHP
|
||||
projects.
|
||||
|
||||
|
||||
Installation:
|
||||
|
||||
Copy class.phpmailer.php into your php.ini include_path. If you are
|
||||
using the SMTP mailer then place class.smtp.php in your path as well.
|
||||
In the language directory you will find several files like
|
||||
phpmailer.lang-en.php. If you look right before the .php extension
|
||||
that there are two letters. These represent the language type of the
|
||||
translation file. For instance "en" is the English file and "br" is
|
||||
the Portuguese file. Chose the file that best fits with your language
|
||||
and place it in the PHP include path. If your language is English
|
||||
then you have nothing more to do. If it is a different language then
|
||||
you must point PHPMailer to the correct translation. To do this, call
|
||||
the PHPMailer SetLanguage method like so:
|
||||
|
||||
// To load the Portuguese version
|
||||
$mail->SetLanguage("br", "/optional/path/to/language/directory/");
|
||||
|
||||
That's it. You should now be ready to use PHPMailer!
|
||||
|
||||
|
||||
A Simple Example:
|
||||
|
||||
<?php
|
||||
require("class.phpmailer.php");
|
||||
|
||||
$mail = new PHPMailer();
|
||||
|
||||
$mail->IsSMTP(); // set mailer to use SMTP
|
||||
$mail->Host = "smtp1.example.com;smtp2.example.com"; // specify main and backup server
|
||||
$mail->SMTPAuth = true; // turn on SMTP authentication
|
||||
$mail->Username = "jswan"; // SMTP username
|
||||
$mail->Password = "secret"; // SMTP password
|
||||
|
||||
$mail->From = "from@example.com";
|
||||
$mail->FromName = "Mailer";
|
||||
$mail->AddAddress("josh@example.net", "Josh Adams");
|
||||
$mail->AddAddress("ellen@example.com"); // name is optional
|
||||
$mail->AddReplyTo("info@example.com", "Information");
|
||||
|
||||
$mail->WordWrap = 50; // set word wrap to 50 characters
|
||||
$mail->AddAttachment("/var/tmp/file.tar.gz"); // add attachments
|
||||
$mail->AddAttachment("/tmp/image.jpg", "new.jpg"); // optional name
|
||||
$mail->IsHTML(true); // set email format to HTML
|
||||
|
||||
$mail->Subject = "Here is the subject";
|
||||
$mail->Body = "This is the HTML message body <b>in bold!</b>";
|
||||
$mail->AltBody = "This is the body in plain text for non-HTML mail clients";
|
||||
|
||||
if(!$mail->Send())
|
||||
{
|
||||
echo "Message could not be sent. <p>";
|
||||
echo "Mailer Error: " . $mail->ErrorInfo;
|
||||
exit;
|
||||
}
|
||||
|
||||
echo "Message has been sent";
|
||||
?>
|
||||
|
||||
CHANGELOG
|
||||
|
||||
See ChangeLog.txt
|
||||
|
||||
Download: http://sourceforge.net/project/showfiles.php?group_id=26031
|
||||
|
||||
Andy Prevost
|
||||
@@ -0,0 +1,415 @@
|
||||
ChangeLog
|
||||
|
||||
NOTE: THIS VERSION OF PHPMAILER IS DESIGNED FOR PHP5/PHP6.
|
||||
IT WILL NOT WORK WITH PHP4.
|
||||
|
||||
Version 5.2 (July 19, 2011)
|
||||
* protected MIME body and header
|
||||
* better DKIM DNS Resource Record support
|
||||
* better aly handling
|
||||
* htmlfilter class added to extras
|
||||
* moved to Apache Extras
|
||||
|
||||
Version 5.1 (October 20, 2009)
|
||||
* fixed filename issue with AddStringAttachment (thanks to Tony)
|
||||
* fixed "SingleTo" property, now works with Senmail, Qmail, and SMTP in
|
||||
addition to PHP mail()
|
||||
* added DKIM digital signing functionality
|
||||
New properties:
|
||||
- DKIM_domain (sets the domain name)
|
||||
- DKIM_private (holds DKIM private key)
|
||||
- DKIM_passphrase (holds your DKIM passphrase)
|
||||
- DKIM_selector (holds the DKIM "selector")
|
||||
- DKIM_identity (holds the identifying email address)
|
||||
* added callback function support
|
||||
- callback function parameters include:
|
||||
result, to, cc, bcc, subject and body
|
||||
* see the test/test_callback.php file for usage.
|
||||
* added "auto" identity functionality
|
||||
- can automatically add:
|
||||
- Return-path (if Sender not set)
|
||||
- Reply-To (if ReplyTo not set)
|
||||
- can be disabled:
|
||||
- $mail->SetFrom('yourname@yourdomain.com','First Last',false);
|
||||
- or by adding the $mail->Sender and/or $mail->ReplyTo properties
|
||||
Note: "auto" identity added to help with emails ending up in spam
|
||||
or junk boxes because of missing headers
|
||||
|
||||
Version 5.0.2 (May 24, 2009)
|
||||
* Fix for missing attachments when inline graphics are present
|
||||
* Fix for missing Cc in header when using SMTP (mail was sent,
|
||||
but not displayed in header -- Cc receiver only saw email To:
|
||||
line and no Cc line, but did get the email (To receiver
|
||||
saw same)
|
||||
|
||||
Version 5.0.1 (April 05, 2009)
|
||||
* Temporary fix for missing attachments
|
||||
|
||||
Version 5.0.0 (April 02, 2009)
|
||||
|
||||
* With the release of this version, we are initiating a new version numbering
|
||||
system to differentiate from the PHP4 version of PHPMailer.
|
||||
* Most notable in this release is fully object oriented code.
|
||||
class.smtp.php:
|
||||
* Refactored class.smtp.php to support new exception handling
|
||||
code size reduced from 29.2 Kb to 25.6 Kb
|
||||
* Removed unnecessary functions from class.smtp.php:
|
||||
public function Expand($name) {
|
||||
public function Help($keyword="") {
|
||||
public function Noop() {
|
||||
public function Send($from) {
|
||||
public function SendOrMail($from) {
|
||||
public function Verify($name) {
|
||||
class.phpmailer.php:
|
||||
* Refactored class.phpmailer.php with new exception handling
|
||||
* Changed processing functionality of Sendmail and Qmail so they cannot be
|
||||
inadvertently used
|
||||
* removed getFile() function, just became a simple wrapper for
|
||||
file_get_contents()
|
||||
* added check for PHP version (will gracefully exit if not at least PHP 5.0)
|
||||
class.phpmailer.php enhancements
|
||||
* enhanced code to check if an attachment source is the same as an embedded or
|
||||
inline graphic source to eliminate duplicate attachments
|
||||
New /test_script
|
||||
* We have written a test script you can use to test the script as part of your
|
||||
installation. Once you press submit, the test script will send a multi-mime
|
||||
email with either the message you type in or an HTML email with an inline
|
||||
graphic. Two attachments are included in the email (one of the attachments
|
||||
is also the inline graphic so you can see that only one copy of the graphic
|
||||
is sent in the email). The test script will also display the functional
|
||||
script that you can copy/paste to your editor to duplicate the functionality.
|
||||
New examples
|
||||
* All new examples in both basic and advanced modes. Advanced examples show
|
||||
Exception handling.
|
||||
PHPDocumentator (phpdocs) documentation for PHPMailer version 5.0.0
|
||||
* all new documentation
|
||||
|
||||
Please note: the website has been updated to reflect the changes in PHPMailer
|
||||
version 5.0.0. http://phpmailer.codeworxtech.com/
|
||||
|
||||
Version 2.3 (November 06, 2008)
|
||||
|
||||
* added Arabic language (many thanks to Bahjat Al Mostafa)
|
||||
* removed English language from language files and made it a default within
|
||||
class.phpmailer.php - if no language is found, it will default to use
|
||||
the english language translation
|
||||
* fixed public/private declarations
|
||||
* corrected line 1728, $basedir to $directory
|
||||
* added $sign_cert_file to avoid improper duplicate use of $sign_key_file
|
||||
* corrected $this->Hello on line 612 to $this->Helo
|
||||
* changed default of $LE to "\r\n" to comply with RFC 2822. Can be set by the user
|
||||
if default is not acceptable
|
||||
* removed trim() from return results in EncodeQP
|
||||
* /test and three files it contained are removed from version 2.3
|
||||
* fixed phpunit.php for compliance with PHP5
|
||||
* changed $this->AltBody = $textMsg; to $this->AltBody = html_entity_decode($textMsg);
|
||||
* We have removed the /phpdoc from the downloads. All documentation is now on
|
||||
the http://phpmailer.codeworxtech.com website.
|
||||
|
||||
Version 2.2.1 () July 19 2008
|
||||
|
||||
* fixed line 1092 in class.smtp.php (my apologies, error on my part)
|
||||
|
||||
Version 2.2 () July 15 2008
|
||||
|
||||
* Fixed redirect issue (display of UTF-8 in thank you redirect)
|
||||
* fixed error in getResponse function declaration (class.pop3.php)
|
||||
* PHPMailer now PHP6 compliant
|
||||
* fixed line 1092 in class.smtp.php (endless loop from missing = sign)
|
||||
|
||||
Version 2.1 (Wed, June 04 2008)
|
||||
|
||||
** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.
|
||||
IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE
|
||||
APPRECIATED.
|
||||
|
||||
* added S/MIME functionality (ability to digitally sign emails)
|
||||
BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.
|
||||
The "Signed Emails" functionality adds the Sign method to pass the private key
|
||||
filename and the password to read it, and then email will be sent with
|
||||
content-type multipart/signed and with the digital signature attached.
|
||||
* fully compatible with E_STRICT error level
|
||||
- Please note:
|
||||
In about half the test environments this development version was subjected
|
||||
to, an error was thrown for the date() functions used (line 1565 and 1569).
|
||||
This is NOT a PHPMailer error, it is the result of an incorrectly configured
|
||||
PHP5 installation. The fix is to modify your 'php.ini' file and include the
|
||||
date.timezone = America/New York
|
||||
directive, to your own server timezone
|
||||
- If you do get this error, and are unable to access your php.ini file:
|
||||
In your PHP script, add
|
||||
date_default_timezone_set('America/Toronto');
|
||||
- do not try to use
|
||||
$myVar = date_default_timezone_get();
|
||||
as a test, it will throw an error.
|
||||
* added ability to define path (mainly for embedded images)
|
||||
function MsgHTML($message,$basedir='') ... where:
|
||||
$basedir is the fully qualified path
|
||||
* fixed MsgHTML() function:
|
||||
- Embedded Images where images are specified by <protocol>:// will not be altered or embedded
|
||||
* fixed the return value of SMTP exit code ( pclose )
|
||||
* addressed issue of multibyte characters in subject line and truncating
|
||||
* added ability to have user specified Message ID
|
||||
(default is still that PHPMailer create a unique Message ID)
|
||||
* corrected unidentified message type to 'application/octet-stream'
|
||||
* fixed chunk_split() multibyte issue (thanks to Colin Brown, et al).
|
||||
* added check for added attachments
|
||||
* enhanced conversion of HTML to text in MsgHTML (thanks to "brunny")
|
||||
|
||||
Version 2.1.0beta2 (Sun, Dec 02 2007)
|
||||
* implemented updated EncodeQP (thanks to coolbru, aka Marcus Bointon)
|
||||
* finished all testing, all known bugs corrected, enhancements tested
|
||||
- note: will NOT work with PHP4.
|
||||
|
||||
please note, this is BETA software
|
||||
** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
|
||||
INTENDED STRICTLY FOR TESTING
|
||||
|
||||
Version 2.1.0beta1
|
||||
please note, this is BETA software
|
||||
** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
|
||||
INTENDED STRICTLY FOR TESTING
|
||||
|
||||
Version 2.0.0 rc2 (Fri, Nov 16 2007), interim release
|
||||
* implements new property to control VERP in class.smtp.php
|
||||
example (requires instantiating class.smtp.php):
|
||||
$mail->do_verp = true;
|
||||
* POP-before-SMTP functionality included, thanks to Richard Davey
|
||||
(see class.pop3.php & pop3_before_smtp_test.php for examples)
|
||||
* included example showing how to use PHPMailer with GMAIL
|
||||
* fixed the missing Cc in SendMail() and Mail()
|
||||
|
||||
******************
|
||||
A note on sending bulk emails:
|
||||
|
||||
If the email you are sending is not personalized, consider using the
|
||||
"undisclosed-recipient:;" strategy. That is, put all of your recipients
|
||||
in the Bcc field and set the To field to "undisclosed-recipients:;".
|
||||
It's a lot faster (only one send) and saves quite a bit on resources.
|
||||
Contrary to some opinions, this will not get you listed in spam engines -
|
||||
it's a legitimate way for you to send emails.
|
||||
|
||||
A partial example for use with PHPMailer:
|
||||
|
||||
$mail->AddAddress("undisclosed-recipients:;");
|
||||
$mail->AddBCC("email1@anydomain.com,email2@anyotherdomain.com,email3@anyalternatedomain.com");
|
||||
|
||||
Many email service providers restrict the number of emails that can be sent
|
||||
in any given time period. Often that is between 50 - 60 emails maximum
|
||||
per hour or per send session.
|
||||
|
||||
If that's the case, then break up your Bcc lists into chunks that are one
|
||||
less than your limit, and put a pause in your script.
|
||||
*******************
|
||||
|
||||
Version 2.0.0 rc1 (Thu, Nov 08 2007), interim release
|
||||
* dramatically simplified using inline graphics ... it's fully automated and requires no user input
|
||||
* added automatic document type detection for attachments and pictures
|
||||
* added MsgHTML() function to replace Body tag for HTML emails
|
||||
* fixed the SendMail security issues (input validation vulnerability)
|
||||
* enhanced the AddAddresses functionality so that the "Name" portion is used in the email address
|
||||
* removed the need to use the AltBody method (set from the HTML, or default text used)
|
||||
* set the PHP Mail() function as the default (still support SendMail, SMTP Mail)
|
||||
* removed the need to set the IsHTML property (set automatically)
|
||||
* added Estonian language file by Indrek Päri
|
||||
* added header injection patch
|
||||
* added "set" method to permit users to create their own pseudo-properties like 'X-Headers', etc.
|
||||
example of use:
|
||||
$mail->set('X-Priority', '3');
|
||||
$mail->set('X-MSMail-Priority', 'Normal');
|
||||
* fixed warning message in SMTP get_lines method
|
||||
* added TLS/SSL SMTP support
|
||||
example of use:
|
||||
$mail = new PHPMailer();
|
||||
$mail->Mailer = "smtp";
|
||||
$mail->Host = "smtp.example.com";
|
||||
$mail->SMTPSecure = "tls"; // option
|
||||
//$mail->SMTPSecure = "ssl"; // option
|
||||
...
|
||||
$mail->Send();
|
||||
* PHPMailer has been tested with PHP4 (4.4.7) and PHP5 (5.2.7)
|
||||
* Works with PHP installed as a module or as CGI-PHP
|
||||
- NOTE: will NOT work with PHP5 in E_STRICT error mode
|
||||
|
||||
Version 1.73 (Sun, Jun 10 2005)
|
||||
* Fixed denial of service bug: http://www.cybsec.com/vuln/PHPMailer-DOS.pdf
|
||||
* Now has a total of 20 translations
|
||||
* Fixed alt attachments bug: http://tinyurl.com/98u9k
|
||||
|
||||
Version 1.72 (Wed, May 25 2004)
|
||||
* Added Dutch, Swedish, Czech, Norwegian, and Turkish translations.
|
||||
* Received: Removed this method because spam filter programs like
|
||||
SpamAssassin reject this header.
|
||||
* Fixed error count bug.
|
||||
* SetLanguage default is now "language/".
|
||||
* Fixed magic_quotes_runtime bug.
|
||||
|
||||
Version 1.71 (Tue, Jul 28 2003)
|
||||
* Made several speed enhancements
|
||||
* Added German and Italian translation files
|
||||
* Fixed HELO/AUTH bugs on keep-alive connects
|
||||
* Now provides an error message if language file does not load
|
||||
* Fixed attachment EOL bug
|
||||
* Updated some unclear documentation
|
||||
* Added additional tests and improved others
|
||||
|
||||
Version 1.70 (Mon, Jun 20 2003)
|
||||
* Added SMTP keep-alive support
|
||||
* Added IsError method for error detection
|
||||
* Added error message translation support (SetLanguage)
|
||||
* Refactored many methods to increase library performance
|
||||
* Hello now sends the newer EHLO message before HELO as per RFC 2821
|
||||
* Removed the boundary class and replaced it with GetBoundary
|
||||
* Removed queue support methods
|
||||
* New $Hostname variable
|
||||
* New Message-ID header
|
||||
* Received header reformat
|
||||
* Helo variable default changed to $Hostname
|
||||
* Removed extra spaces in Content-Type definition (#667182)
|
||||
* Return-Path should be set to Sender when set
|
||||
* Adds Q or B encoding to headers when necessary
|
||||
* quoted-encoding should now encode NULs \000
|
||||
* Fixed encoding of body/AltBody (#553370)
|
||||
* Adds "To: undisclosed-recipients:;" when all recipients are hidden (BCC)
|
||||
* Multiple bug fixes
|
||||
|
||||
Version 1.65 (Fri, Aug 09 2002)
|
||||
* Fixed non-visible attachment bug (#585097) for Outlook
|
||||
* SMTP connections are now closed after each transaction
|
||||
* Fixed SMTP::Expand return value
|
||||
* Converted SMTP class documentation to phpDocumentor format
|
||||
|
||||
Version 1.62 (Wed, Jun 26 2002)
|
||||
* Fixed multi-attach bug
|
||||
* Set proper word wrapping
|
||||
* Reduced memory use with attachments
|
||||
* Added more debugging
|
||||
* Changed documentation to phpDocumentor format
|
||||
|
||||
Version 1.60 (Sat, Mar 30 2002)
|
||||
* Sendmail pipe and address patch (Christian Holtje)
|
||||
* Added embedded image and read confirmation support (A. Ognio)
|
||||
* Added unit tests
|
||||
* Added SMTP timeout support (*nix only)
|
||||
* Added possibly temporary PluginDir variable for SMTP class
|
||||
* Added LE message line ending variable
|
||||
* Refactored boundary and attachment code
|
||||
* Eliminated SMTP class warnings
|
||||
* Added SendToQueue method for future queuing support
|
||||
|
||||
Version 1.54 (Wed, Dec 19 2001)
|
||||
* Add some queuing support code
|
||||
* Fixed a pesky multi/alt bug
|
||||
* Messages are no longer forced to have "To" addresses
|
||||
|
||||
Version 1.50 (Thu, Nov 08 2001)
|
||||
* Fix extra lines when not using SMTP mailer
|
||||
* Set WordWrap variable to int with a zero default
|
||||
|
||||
Version 1.47 (Tue, Oct 16 2001)
|
||||
* Fixed Received header code format
|
||||
* Fixed AltBody order error
|
||||
* Fixed alternate port warning
|
||||
|
||||
Version 1.45 (Tue, Sep 25 2001)
|
||||
* Added enhanced SMTP debug support
|
||||
* Added support for multiple ports on SMTP
|
||||
* Added Received header for tracing
|
||||
* Fixed AddStringAttachment encoding
|
||||
* Fixed possible header name quote bug
|
||||
* Fixed wordwrap() trim bug
|
||||
* Couple other small bug fixes
|
||||
|
||||
Version 1.41 (Wed, Aug 22 2001)
|
||||
* Fixed AltBody bug w/o attachments
|
||||
* Fixed rfc_date() for certain mail servers
|
||||
|
||||
Version 1.40 (Sun, Aug 12 2001)
|
||||
* Added multipart/alternative support (AltBody)
|
||||
* Documentation update
|
||||
* Fixed bug in Mercury MTA
|
||||
|
||||
Version 1.29 (Fri, Aug 03 2001)
|
||||
* Added AddStringAttachment() method
|
||||
* Added SMTP authentication support
|
||||
|
||||
Version 1.28 (Mon, Jul 30 2001)
|
||||
* Fixed a typo in SMTP class
|
||||
* Fixed header issue with Imail (win32) SMTP server
|
||||
* Made fopen() calls for attachments use "rb" to fix win32 error
|
||||
|
||||
Version 1.25 (Mon, Jul 02 2001)
|
||||
* Added RFC 822 date fix (Patrice)
|
||||
* Added improved error handling by adding a $ErrorInfo variable
|
||||
* Removed MailerDebug variable (obsolete with new error handler)
|
||||
|
||||
Version 1.20 (Mon, Jun 25 2001)
|
||||
* Added quoted-printable encoding (Patrice)
|
||||
* Set Version as public and removed PrintVersion()
|
||||
* Changed phpdoc to only display public variables and methods
|
||||
|
||||
Version 1.19 (Thu, Jun 21 2001)
|
||||
* Fixed MS Mail header bug
|
||||
* Added fix for Bcc problem with mail(). *Does not work on Win32*
|
||||
(See PHP bug report: http://www.php.net/bugs.php?id=11616)
|
||||
* mail() no longer passes a fifth parameter when not needed
|
||||
|
||||
Version 1.15 (Fri, Jun 15 2001)
|
||||
[Note: these changes contributed by Patrice Fournier]
|
||||
* Changed all remaining \n to \r\n
|
||||
* Bcc: header no longer writen to message except
|
||||
when sent directly to sendmail
|
||||
* Added a small message to non-MIME compliant mail reader
|
||||
* Added Sender variable to change the Sender email
|
||||
used in -f for sendmail/mail and in 'MAIL FROM' for smtp mode
|
||||
* Changed boundary setting to a place it will be set only once
|
||||
* Removed transfer encoding for whole message when using multipart
|
||||
* Message body now uses Encoding in multipart messages
|
||||
* Can set encoding and type to attachments 7bit, 8bit
|
||||
and binary attachment are sent as is, base64 are encoded
|
||||
* Can set Encoding to base64 to send 8 bits body
|
||||
through 7 bits servers
|
||||
|
||||
Version 1.10 (Tue, Jun 12 2001)
|
||||
* Fixed win32 mail header bug (printed out headers in message body)
|
||||
|
||||
Version 1.09 (Fri, Jun 08 2001)
|
||||
* Changed date header to work with Netscape mail programs
|
||||
* Altered phpdoc documentation
|
||||
|
||||
Version 1.08 (Tue, Jun 05 2001)
|
||||
* Added enhanced error-checking
|
||||
* Added phpdoc documentation to source
|
||||
|
||||
Version 1.06 (Fri, Jun 01 2001)
|
||||
* Added optional name for file attachments
|
||||
|
||||
Version 1.05 (Tue, May 29 2001)
|
||||
* Code cleanup
|
||||
* Eliminated sendmail header warning message
|
||||
* Fixed possible SMTP error
|
||||
|
||||
Version 1.03 (Thu, May 24 2001)
|
||||
* Fixed problem where qmail sends out duplicate messages
|
||||
|
||||
Version 1.02 (Wed, May 23 2001)
|
||||
* Added multiple recipient and attachment Clear* methods
|
||||
* Added Sendmail public variable
|
||||
* Fixed problem with loading SMTP library multiple times
|
||||
|
||||
Version 0.98 (Tue, May 22 2001)
|
||||
* Fixed problem with redundant mail hosts sending out multiple messages
|
||||
* Added additional error handler code
|
||||
* Added AddCustomHeader() function
|
||||
* Added support for Microsoft mail client headers (affects priority)
|
||||
* Fixed small bug with Mailer variable
|
||||
* Added PrintVersion() function
|
||||
|
||||
Version 0.92 (Tue, May 15 2001)
|
||||
* Changed file names to class.phpmailer.php and class.smtp.php to match
|
||||
current PHP class trend.
|
||||
* Fixed problem where body not being printed when a message is attached
|
||||
* Several small bug fixes
|
||||
|
||||
Version 0.90 (Tue, April 17 2001)
|
||||
* Intial public release
|
||||
@@ -0,0 +1,2473 @@
|
||||
<?php
|
||||
/*~ class.phpmailer.php
|
||||
.---------------------------------------------------------------------------.
|
||||
| Software: PHPMailer - PHP email class |
|
||||
| Version: 5.2 |
|
||||
| Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ |
|
||||
| ------------------------------------------------------------------------- |
|
||||
| Admin: Jim Jagielski (project admininistrator) |
|
||||
| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net |
|
||||
| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
|
||||
| : Jim Jagielski (jimjag) jimjag@gmail.com |
|
||||
| Founder: Brent R. Matzelle (original founder) |
|
||||
| Copyright (c) 2010-2011, Jim Jagielski. All Rights Reserved. |
|
||||
| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
|
||||
| Copyright (c) 2001-2003, Brent R. Matzelle |
|
||||
| ------------------------------------------------------------------------- |
|
||||
| License: Distributed under the Lesser General Public License (LGPL) |
|
||||
| http://www.gnu.org/copyleft/lesser.html |
|
||||
| This program is distributed in the hope that it will be useful - WITHOUT |
|
||||
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
||||
| FITNESS FOR A PARTICULAR PURPOSE. |
|
||||
'---------------------------------------------------------------------------'
|
||||
*/
|
||||
|
||||
/**
|
||||
* PHPMailer - PHP email transport class
|
||||
* NOTE: Requires PHP version 5 or later
|
||||
* @package PHPMailer
|
||||
* @author Andy Prevost
|
||||
* @author Marcus Bointon
|
||||
* @author Jim Jagielski
|
||||
* @copyright 2010 - 2011 Jim Jagielski
|
||||
* @copyright 2004 - 2009 Andy Prevost
|
||||
* @version $Id: class.phpmailer.php 450 2010-06-23 16:46:33Z coolbru $
|
||||
* @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
|
||||
*/
|
||||
|
||||
if (version_compare(PHP_VERSION, '5.0.0', '<') ) exit("Sorry, this version of PHPMailer will only run on PHP version 5 or greater!\n");
|
||||
|
||||
class PHPMailer {
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// PROPERTIES, PUBLIC
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Email priority (1 = High, 3 = Normal, 5 = low).
|
||||
* @var int
|
||||
*/
|
||||
public $Priority = 3;
|
||||
|
||||
/**
|
||||
* Sets the CharSet of the message.
|
||||
* @var string
|
||||
*/
|
||||
public $CharSet = 'iso-8859-1';
|
||||
|
||||
/**
|
||||
* Sets the Content-type of the message.
|
||||
* @var string
|
||||
*/
|
||||
public $ContentType = 'text/plain';
|
||||
|
||||
/**
|
||||
* Sets the Encoding of the message. Options for this are
|
||||
* "8bit", "7bit", "binary", "base64", and "quoted-printable".
|
||||
* @var string
|
||||
*/
|
||||
public $Encoding = '8bit';
|
||||
|
||||
/**
|
||||
* Holds the most recent mailer error message.
|
||||
* @var string
|
||||
*/
|
||||
public $ErrorInfo = '';
|
||||
|
||||
/**
|
||||
* Sets the From email address for the message.
|
||||
* @var string
|
||||
*/
|
||||
public $From = 'root@localhost';
|
||||
|
||||
/**
|
||||
* Sets the From name of the message.
|
||||
* @var string
|
||||
*/
|
||||
public $FromName = 'Root User';
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @var string
|
||||
*/
|
||||
public $Sender = '';
|
||||
|
||||
/**
|
||||
* Sets the Subject of the message.
|
||||
* @var string
|
||||
*/
|
||||
public $Subject = '';
|
||||
|
||||
/**
|
||||
* Sets the Body of the message. This can be either an HTML or text body.
|
||||
* If HTML then run IsHTML(true).
|
||||
* @var string
|
||||
*/
|
||||
public $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.
|
||||
* @var string
|
||||
*/
|
||||
public $AltBody = '';
|
||||
|
||||
/**
|
||||
* Stores the complete compiled MIME message body.
|
||||
* @var string
|
||||
* @access protected
|
||||
*/
|
||||
protected $MIMEBody = '';
|
||||
|
||||
/**
|
||||
* Stores the complete compiled MIME message headers.
|
||||
* @var string
|
||||
* @access protected
|
||||
*/
|
||||
protected $MIMEHeader = '';
|
||||
|
||||
/**
|
||||
* Sets word wrapping on the body of the message to a given number of
|
||||
* characters.
|
||||
* @var int
|
||||
*/
|
||||
public $WordWrap = 0;
|
||||
|
||||
/**
|
||||
* Method to send mail: ("mail", "sendmail", or "smtp").
|
||||
* @var string
|
||||
*/
|
||||
public $Mailer = 'mail';
|
||||
|
||||
/**
|
||||
* Sets the path of the sendmail program.
|
||||
* @var string
|
||||
*/
|
||||
public $Sendmail = '/usr/sbin/sendmail';
|
||||
|
||||
/**
|
||||
* Path to PHPMailer plugins. Useful if the SMTP class
|
||||
* is in a different directory than the PHP include path.
|
||||
* @var string
|
||||
*/
|
||||
public $PluginDir = '';
|
||||
|
||||
/**
|
||||
* Sets the email address that a reading confirmation will be sent.
|
||||
* @var string
|
||||
*/
|
||||
public $ConfirmReadingTo = '';
|
||||
|
||||
/**
|
||||
* 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'.
|
||||
* @var string
|
||||
*/
|
||||
public $Hostname = '';
|
||||
|
||||
/**
|
||||
* Sets the message ID to be used in the Message-Id header.
|
||||
* If empty, a unique id will be generated.
|
||||
* @var string
|
||||
*/
|
||||
public $MessageID = '';
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// PROPERTIES FOR SMTP
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @var string
|
||||
*/
|
||||
public $Host = 'localhost';
|
||||
|
||||
/**
|
||||
* Sets the default SMTP server port.
|
||||
* @var int
|
||||
*/
|
||||
public $Port = 25;
|
||||
|
||||
/**
|
||||
* Sets the SMTP HELO of the message (Default is $Hostname).
|
||||
* @var string
|
||||
*/
|
||||
public $Helo = '';
|
||||
|
||||
/**
|
||||
* Sets connection prefix.
|
||||
* Options are "", "ssl" or "tls"
|
||||
* @var string
|
||||
*/
|
||||
public $SMTPSecure = '';
|
||||
|
||||
/**
|
||||
* Sets SMTP authentication. Utilizes the Username and Password variables.
|
||||
* @var bool
|
||||
*/
|
||||
public $SMTPAuth = false;
|
||||
|
||||
/**
|
||||
* Sets SMTP username.
|
||||
* @var string
|
||||
*/
|
||||
public $Username = '';
|
||||
|
||||
/**
|
||||
* Sets SMTP password.
|
||||
* @var string
|
||||
*/
|
||||
public $Password = '';
|
||||
|
||||
/**
|
||||
* Sets the SMTP server timeout in seconds.
|
||||
* This function will not work with the win32 version.
|
||||
* @var int
|
||||
*/
|
||||
public $Timeout = 10;
|
||||
|
||||
/**
|
||||
* Sets SMTP class debugging on or off.
|
||||
* @var bool
|
||||
*/
|
||||
public $SMTPDebug = false;
|
||||
|
||||
/**
|
||||
* 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().
|
||||
* @var bool
|
||||
*/
|
||||
public $SMTPKeepAlive = false;
|
||||
|
||||
/**
|
||||
* Provides the ability to have the TO field process individual
|
||||
* emails, instead of sending to entire TO addresses
|
||||
* @var bool
|
||||
*/
|
||||
public $SingleTo = false;
|
||||
|
||||
/**
|
||||
* If SingleTo is true, this provides the array to hold the email addresses
|
||||
* @var bool
|
||||
*/
|
||||
public $SingleToArray = array();
|
||||
|
||||
/**
|
||||
* Provides the ability to change the line ending
|
||||
* @var string
|
||||
*/
|
||||
public $LE = "\n";
|
||||
|
||||
/**
|
||||
* Used with DKIM DNS Resource Record
|
||||
* @var string
|
||||
*/
|
||||
public $DKIM_selector = 'phpmailer';
|
||||
|
||||
/**
|
||||
* Used with DKIM DNS Resource Record
|
||||
* optional, in format of email address 'you@yourdomain.com'
|
||||
* @var string
|
||||
*/
|
||||
public $DKIM_identity = '';
|
||||
|
||||
/**
|
||||
* Used with DKIM DNS Resource Record
|
||||
* @var string
|
||||
*/
|
||||
public $DKIM_passphrase = '';
|
||||
|
||||
/**
|
||||
* Used with DKIM DNS Resource Record
|
||||
* optional, in format of email address 'you@yourdomain.com'
|
||||
* @var string
|
||||
*/
|
||||
public $DKIM_domain = '';
|
||||
|
||||
/**
|
||||
* Used with DKIM DNS Resource Record
|
||||
* optional, in format of email address 'you@yourdomain.com'
|
||||
* @var string
|
||||
*/
|
||||
public $DKIM_private = '';
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @var string
|
||||
*/
|
||||
public $action_function = ''; //'callbackAction';
|
||||
|
||||
/**
|
||||
* Sets the PHPMailer Version number
|
||||
* @var string
|
||||
*/
|
||||
public $Version = '5.2';
|
||||
|
||||
/**
|
||||
* What to use in the X-Mailer header
|
||||
* @var string
|
||||
*/
|
||||
public $XMailer = '';
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// PROPERTIES, PRIVATE AND PROTECTED
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
protected $smtp = NULL;
|
||||
protected $to = array();
|
||||
protected $cc = array();
|
||||
protected $bcc = array();
|
||||
protected $ReplyTo = array();
|
||||
protected $all_recipients = array();
|
||||
protected $attachment = array();
|
||||
protected $CustomHeader = array();
|
||||
protected $message_type = '';
|
||||
protected $boundary = array();
|
||||
protected $language = array();
|
||||
protected $error_count = 0;
|
||||
protected $sign_cert_file = '';
|
||||
protected $sign_key_file = '';
|
||||
protected $sign_key_pass = '';
|
||||
protected $exceptions = false;
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// CONSTANTS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
const STOP_MESSAGE = 0; // message only, continue processing
|
||||
const STOP_CONTINUE = 1; // message?, likely ok to continue processing
|
||||
const STOP_CRITICAL = 2; // message, plus full stop, critical error reached
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// METHODS, VARIABLES
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
* @param boolean $exceptions Should we throw external exceptions?
|
||||
*/
|
||||
public function __construct($exceptions = false) {
|
||||
$this->exceptions = ($exceptions == true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets message type to HTML.
|
||||
* @param bool $ishtml
|
||||
* @return void
|
||||
*/
|
||||
public function IsHTML($ishtml = true) {
|
||||
if ($ishtml) {
|
||||
$this->ContentType = 'text/html';
|
||||
} else {
|
||||
$this->ContentType = 'text/plain';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets Mailer to send message using SMTP.
|
||||
* @return void
|
||||
*/
|
||||
public function IsSMTP() {
|
||||
$this->Mailer = 'smtp';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets Mailer to send message using PHP mail() function.
|
||||
* @return void
|
||||
*/
|
||||
public function IsMail() {
|
||||
$this->Mailer = 'mail';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets Mailer to send message using the $Sendmail program.
|
||||
* @return void
|
||||
*/
|
||||
public function IsSendmail() {
|
||||
if (!stristr(ini_get('sendmail_path'), 'sendmail')) {
|
||||
$this->Sendmail = '/var/qmail/bin/sendmail';
|
||||
}
|
||||
$this->Mailer = 'sendmail';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets Mailer to send message using the qmail MTA.
|
||||
* @return void
|
||||
*/
|
||||
public function IsQmail() {
|
||||
if (stristr(ini_get('sendmail_path'), 'qmail')) {
|
||||
$this->Sendmail = '/var/qmail/bin/sendmail';
|
||||
}
|
||||
$this->Mailer = 'sendmail';
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// METHODS, RECIPIENTS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Adds a "To" address.
|
||||
* @param string $address
|
||||
* @param string $name
|
||||
* @return boolean true on success, false if address already used
|
||||
*/
|
||||
public function AddAddress($address, $name = '') {
|
||||
return $this->AddAnAddress('to', $address, $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a "Cc" address.
|
||||
* Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
|
||||
* @param string $address
|
||||
* @param string $name
|
||||
* @return boolean true on success, false if address already used
|
||||
*/
|
||||
public function AddCC($address, $name = '') {
|
||||
return $this->AddAnAddress('cc', $address, $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a "Bcc" address.
|
||||
* Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
|
||||
* @param string $address
|
||||
* @param string $name
|
||||
* @return boolean true on success, false if address already used
|
||||
*/
|
||||
public function AddBCC($address, $name = '') {
|
||||
return $this->AddAnAddress('bcc', $address, $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a "Reply-to" address.
|
||||
* @param string $address
|
||||
* @param string $name
|
||||
* @return boolean
|
||||
*/
|
||||
public function AddReplyTo($address, $name = '') {
|
||||
return $this->AddAnAddress('ReplyTo', $address, $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an address to one of the recipient arrays
|
||||
* Addresses that have been added already return false, but do not throw exceptions
|
||||
* @param string $kind One of 'to', 'cc', 'bcc', 'ReplyTo'
|
||||
* @param string $address The email address to send to
|
||||
* @param string $name
|
||||
* @return boolean true on success, false if address already used or invalid in some way
|
||||
* @access protected
|
||||
*/
|
||||
protected function AddAnAddress($kind, $address, $name = '') {
|
||||
if (!preg_match('/^(to|cc|bcc|ReplyTo)$/', $kind)) {
|
||||
$this->SetError($this->Lang('Invalid recipient array').': '.$kind);
|
||||
if ($this->exceptions) {
|
||||
throw new phpmailerException('Invalid recipient array: ' . $kind);
|
||||
}
|
||||
echo $this->Lang('Invalid recipient array').': '.$kind;
|
||||
return false;
|
||||
}
|
||||
$address = trim($address);
|
||||
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
|
||||
if (!self::ValidateAddress($address)) {
|
||||
$this->SetError($this->Lang('invalid_address').': '. $address);
|
||||
if ($this->exceptions) {
|
||||
throw new phpmailerException($this->Lang('invalid_address').': '.$address);
|
||||
}
|
||||
echo $this->Lang('invalid_address').': '.$address;
|
||||
return false;
|
||||
}
|
||||
if ($kind != 'ReplyTo') {
|
||||
if (!isset($this->all_recipients[strtolower($address)])) {
|
||||
array_push($this->$kind, array($address, $name));
|
||||
$this->all_recipients[strtolower($address)] = true;
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
if (!array_key_exists(strtolower($address), $this->ReplyTo)) {
|
||||
$this->ReplyTo[strtolower($address)] = array($address, $name);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the From and FromName properties
|
||||
* @param string $address
|
||||
* @param string $name
|
||||
* @return boolean
|
||||
*/
|
||||
public function SetFrom($address, $name = '', $auto = 1) {
|
||||
$address = trim($address);
|
||||
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
|
||||
if (!self::ValidateAddress($address)) {
|
||||
$this->SetError($this->Lang('invalid_address').': '. $address);
|
||||
if ($this->exceptions) {
|
||||
throw new phpmailerException($this->Lang('invalid_address').': '.$address);
|
||||
}
|
||||
echo $this->Lang('invalid_address').': '.$address;
|
||||
return false;
|
||||
}
|
||||
$this->From = $address;
|
||||
$this->FromName = $name;
|
||||
if ($auto) {
|
||||
if (empty($this->ReplyTo)) {
|
||||
$this->AddAnAddress('ReplyTo', $address, $name);
|
||||
}
|
||||
if (empty($this->Sender)) {
|
||||
$this->Sender = $address;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @link http://www.hexillion.com/samples/#Regex Original pattern found here
|
||||
* @param string $address The email address to check
|
||||
* @return boolean
|
||||
* @static
|
||||
* @access public
|
||||
*/
|
||||
public static function ValidateAddress($address) {
|
||||
if (function_exists('filter_var')) { //Introduced in PHP 5.2
|
||||
if(filter_var($address, FILTER_VALIDATE_EMAIL) === FALSE) {
|
||||
return false;
|
||||
} else {
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
return preg_match('/^(?:[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+\.)*[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+@(?:(?:(?:[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!\.)){0,61}[a-zA-Z0-9_-]?\.)+[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!$)){0,61}[a-zA-Z0-9_]?)|(?:\[(?:(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\.){3}(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\]))$/', $address);
|
||||
}
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// METHODS, MAIL SENDING
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return bool
|
||||
*/
|
||||
public function Send() {
|
||||
try {
|
||||
if(!$this->PreSend()) return false;
|
||||
return $this->PostSend();
|
||||
} catch (phpmailerException $e) {
|
||||
$this->SetError($e->getMessage());
|
||||
if ($this->exceptions) {
|
||||
throw $e;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
protected function PreSend() {
|
||||
try {
|
||||
if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
|
||||
throw new phpmailerException($this->Lang('provide_address'), self::STOP_CRITICAL);
|
||||
}
|
||||
|
||||
// Set whether the message is multipart/alternative
|
||||
if(!empty($this->AltBody)) {
|
||||
$this->ContentType = 'multipart/alternative';
|
||||
}
|
||||
|
||||
$this->error_count = 0; // reset errors
|
||||
$this->SetMessageType();
|
||||
//Refuse to send an empty message
|
||||
if (empty($this->Body)) {
|
||||
throw new phpmailerException($this->Lang('empty_message'), self::STOP_CRITICAL);
|
||||
}
|
||||
|
||||
$this->MIMEHeader = $this->CreateHeader();
|
||||
$this->MIMEBody = $this->CreateBody();
|
||||
|
||||
|
||||
// digitally sign with DKIM if enabled
|
||||
if ($this->DKIM_domain && $this->DKIM_private) {
|
||||
$header_dkim = $this->DKIM_Add($this->MIMEHeader, $this->EncodeHeader($this->SecureHeader($this->Subject)), $this->MIMEBody);
|
||||
$this->MIMEHeader = str_replace("\r\n", "\n", $header_dkim) . $this->MIMEHeader;
|
||||
}
|
||||
|
||||
return true;
|
||||
} catch (phpmailerException $e) {
|
||||
$this->SetError($e->getMessage());
|
||||
if ($this->exceptions) {
|
||||
throw $e;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
protected function PostSend() {
|
||||
try {
|
||||
// Choose the mailer and send through it
|
||||
switch($this->Mailer) {
|
||||
case 'sendmail':
|
||||
return $this->SendmailSend($this->MIMEHeader, $this->MIMEBody);
|
||||
case 'smtp':
|
||||
return $this->SmtpSend($this->MIMEHeader, $this->MIMEBody);
|
||||
default:
|
||||
return $this->MailSend($this->MIMEHeader, $this->MIMEBody);
|
||||
}
|
||||
|
||||
} catch (phpmailerException $e) {
|
||||
$this->SetError($e->getMessage());
|
||||
if ($this->exceptions) {
|
||||
throw $e;
|
||||
}
|
||||
echo $e->getMessage()."\n";
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends mail using the $Sendmail program.
|
||||
* @param string $header The message headers
|
||||
* @param string $body The message body
|
||||
* @access protected
|
||||
* @return bool
|
||||
*/
|
||||
protected function SendmailSend($header, $body) {
|
||||
if ($this->Sender != '') {
|
||||
$sendmail = sprintf("%s -oi -f %s -t", escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
|
||||
} else {
|
||||
$sendmail = sprintf("%s -oi -t", escapeshellcmd($this->Sendmail));
|
||||
}
|
||||
if ($this->SingleTo === true) {
|
||||
foreach ($this->SingleToArray as $key => $val) {
|
||||
if(!@$mail = popen($sendmail, 'w')) {
|
||||
throw new phpmailerException($this->Lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
|
||||
}
|
||||
fputs($mail, "To: " . $val . "\n");
|
||||
fputs($mail, $header);
|
||||
fputs($mail, $body);
|
||||
$result = pclose($mail);
|
||||
// implement call back function if it exists
|
||||
$isSent = ($result == 0) ? 1 : 0;
|
||||
$this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body);
|
||||
if($result != 0) {
|
||||
throw new phpmailerException($this->Lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if(!@$mail = popen($sendmail, 'w')) {
|
||||
throw new phpmailerException($this->Lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
|
||||
}
|
||||
fputs($mail, $header);
|
||||
fputs($mail, $body);
|
||||
$result = pclose($mail);
|
||||
// implement call back function if it exists
|
||||
$isSent = ($result == 0) ? 1 : 0;
|
||||
$this->doCallback($isSent, $this->to, $this->cc, $this->bcc, $this->Subject, $body);
|
||||
if($result != 0) {
|
||||
throw new phpmailerException($this->Lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends mail using the PHP mail() function.
|
||||
* @param string $header The message headers
|
||||
* @param string $body The message body
|
||||
* @access protected
|
||||
* @return bool
|
||||
*/
|
||||
protected function MailSend($header, $body) {
|
||||
$toArr = array();
|
||||
foreach($this->to as $t) {
|
||||
$toArr[] = $this->AddrFormat($t);
|
||||
}
|
||||
$to = implode(', ', $toArr);
|
||||
|
||||
if (empty($this->Sender)) {
|
||||
$params = "-oi -f %s";
|
||||
} else {
|
||||
$params = sprintf("-oi -f %s", $this->Sender);
|
||||
}
|
||||
if ($this->Sender != '' and !ini_get('safe_mode')) {
|
||||
$old_from = ini_get('sendmail_from');
|
||||
ini_set('sendmail_from', $this->Sender);
|
||||
if ($this->SingleTo === true && count($toArr) > 1) {
|
||||
foreach ($toArr as $key => $val) {
|
||||
$rt = @mail($val, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params);
|
||||
// implement call back function if it exists
|
||||
$isSent = ($rt == 1) ? 1 : 0;
|
||||
$this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body);
|
||||
}
|
||||
} else {
|
||||
$rt = @mail($to, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params);
|
||||
// implement call back function if it exists
|
||||
$isSent = ($rt == 1) ? 1 : 0;
|
||||
$this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body);
|
||||
}
|
||||
} else {
|
||||
if ($this->SingleTo === true && count($toArr) > 1) {
|
||||
foreach ($toArr as $key => $val) {
|
||||
$rt = @mail($val, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params);
|
||||
// implement call back function if it exists
|
||||
$isSent = ($rt == 1) ? 1 : 0;
|
||||
$this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body);
|
||||
}
|
||||
} else {
|
||||
$rt = @mail($to, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header);
|
||||
// implement call back function if it exists
|
||||
$isSent = ($rt == 1) ? 1 : 0;
|
||||
$this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body);
|
||||
}
|
||||
}
|
||||
if (isset($old_from)) {
|
||||
ini_set('sendmail_from', $old_from);
|
||||
}
|
||||
if(!$rt) {
|
||||
throw new phpmailerException($this->Lang('instantiate'), self::STOP_CRITICAL);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends mail via SMTP using PhpSMTP
|
||||
* Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
|
||||
* @param string $header The message headers
|
||||
* @param string $body The message body
|
||||
* @uses SMTP
|
||||
* @access protected
|
||||
* @return bool
|
||||
*/
|
||||
protected function SmtpSend($header, $body) {
|
||||
require_once $this->PluginDir . 'class.smtp.php';
|
||||
$bad_rcpt = array();
|
||||
|
||||
if(!$this->SmtpConnect()) {
|
||||
throw new phpmailerException($this->Lang('smtp_connect_failed'), self::STOP_CRITICAL);
|
||||
}
|
||||
$smtp_from = ($this->Sender == '') ? $this->From : $this->Sender;
|
||||
if(!$this->smtp->Mail($smtp_from)) {
|
||||
throw new phpmailerException($this->Lang('from_failed') . $smtp_from, self::STOP_CRITICAL);
|
||||
}
|
||||
|
||||
// Attempt to send attach all recipients
|
||||
foreach($this->to as $to) {
|
||||
if (!$this->smtp->Recipient($to[0])) {
|
||||
$bad_rcpt[] = $to[0];
|
||||
// implement call back function if it exists
|
||||
$isSent = 0;
|
||||
$this->doCallback($isSent, $to[0], '', '', $this->Subject, $body);
|
||||
} else {
|
||||
// implement call back function if it exists
|
||||
$isSent = 1;
|
||||
$this->doCallback($isSent, $to[0], '', '', $this->Subject, $body);
|
||||
}
|
||||
}
|
||||
foreach($this->cc as $cc) {
|
||||
if (!$this->smtp->Recipient($cc[0])) {
|
||||
$bad_rcpt[] = $cc[0];
|
||||
// implement call back function if it exists
|
||||
$isSent = 0;
|
||||
$this->doCallback($isSent, '', $cc[0], '', $this->Subject, $body);
|
||||
} else {
|
||||
// implement call back function if it exists
|
||||
$isSent = 1;
|
||||
$this->doCallback($isSent, '', $cc[0], '', $this->Subject, $body);
|
||||
}
|
||||
}
|
||||
foreach($this->bcc as $bcc) {
|
||||
if (!$this->smtp->Recipient($bcc[0])) {
|
||||
$bad_rcpt[] = $bcc[0];
|
||||
// implement call back function if it exists
|
||||
$isSent = 0;
|
||||
$this->doCallback($isSent, '', '', $bcc[0], $this->Subject, $body);
|
||||
} else {
|
||||
// implement call back function if it exists
|
||||
$isSent = 1;
|
||||
$this->doCallback($isSent, '', '', $bcc[0], $this->Subject, $body);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (count($bad_rcpt) > 0 ) { //Create error message for any bad addresses
|
||||
$badaddresses = implode(', ', $bad_rcpt);
|
||||
throw new phpmailerException($this->Lang('recipients_failed') . $badaddresses);
|
||||
}
|
||||
if(!$this->smtp->Data($header . $body)) {
|
||||
throw new phpmailerException($this->Lang('data_not_accepted'), self::STOP_CRITICAL);
|
||||
}
|
||||
if($this->SMTPKeepAlive == true) {
|
||||
$this->smtp->Reset();
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initiates a connection to an SMTP server.
|
||||
* Returns false if the operation failed.
|
||||
* @uses SMTP
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function SmtpConnect() {
|
||||
if(is_null($this->smtp)) {
|
||||
$this->smtp = new SMTP();
|
||||
}
|
||||
|
||||
$this->smtp->do_debug = $this->SMTPDebug;
|
||||
$hosts = explode(';', $this->Host);
|
||||
$index = 0;
|
||||
$connection = $this->smtp->Connected();
|
||||
|
||||
// Retry while there is no connection
|
||||
try {
|
||||
while($index < count($hosts) && !$connection) {
|
||||
$hostinfo = array();
|
||||
if (preg_match('/^(.+):([0-9]+)$/', $hosts[$index], $hostinfo)) {
|
||||
$host = $hostinfo[1];
|
||||
$port = $hostinfo[2];
|
||||
} else {
|
||||
$host = $hosts[$index];
|
||||
$port = $this->Port;
|
||||
}
|
||||
|
||||
$tls = ($this->SMTPSecure == 'tls');
|
||||
$ssl = ($this->SMTPSecure == 'ssl');
|
||||
|
||||
if ($this->smtp->Connect(($ssl ? 'ssl://':'').$host, $port, $this->Timeout)) {
|
||||
|
||||
$hello = ($this->Helo != '' ? $this->Helo : $this->ServerHostname());
|
||||
$this->smtp->Hello($hello);
|
||||
|
||||
if ($tls) {
|
||||
if (!$this->smtp->StartTLS()) {
|
||||
throw new phpmailerException($this->Lang('tls'));
|
||||
}
|
||||
|
||||
//We must resend HELO after tls negotiation
|
||||
$this->smtp->Hello($hello);
|
||||
}
|
||||
|
||||
$connection = true;
|
||||
if ($this->SMTPAuth) {
|
||||
if (!$this->smtp->Authenticate($this->Username, $this->Password)) {
|
||||
throw new phpmailerException($this->Lang('authenticate'));
|
||||
}
|
||||
}
|
||||
}
|
||||
$index++;
|
||||
if (!$connection) {
|
||||
throw new phpmailerException($this->Lang('connect_host'));
|
||||
}
|
||||
}
|
||||
} catch (phpmailerException $e) {
|
||||
$this->smtp->Reset();
|
||||
throw $e;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the active SMTP session if one exists.
|
||||
* @return void
|
||||
*/
|
||||
public function SmtpClose() {
|
||||
if(!is_null($this->smtp)) {
|
||||
if($this->smtp->Connected()) {
|
||||
$this->smtp->Quit();
|
||||
$this->smtp->Close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the language for all class error messages.
|
||||
* Returns false if it cannot load the language file. The default language is English.
|
||||
* @param string $langcode ISO 639-1 2-character language code (e.g. Portuguese: "br")
|
||||
* @param string $lang_path Path to the language file directory
|
||||
* @access public
|
||||
*/
|
||||
function SetLanguage($langcode = 'en', $lang_path = 'language/') {
|
||||
//Define full set of translatable strings
|
||||
$PHPMAILER_LANG = array(
|
||||
'provide_address' => 'You must provide at least one recipient email address.',
|
||||
'mailer_not_supported' => ' mailer is not supported.',
|
||||
'execute' => 'Could not execute: ',
|
||||
'instantiate' => 'Could not instantiate mail function.',
|
||||
'authenticate' => 'SMTP Error: Could not authenticate.',
|
||||
'from_failed' => 'The following From address failed: ',
|
||||
'recipients_failed' => 'SMTP Error: The following recipients failed: ',
|
||||
'data_not_accepted' => 'SMTP Error: Data not accepted.',
|
||||
'connect_host' => 'SMTP Error: Could not connect to SMTP host.',
|
||||
'file_access' => 'Could not access file: ',
|
||||
'file_open' => 'File Error: Could not open file: ',
|
||||
'encoding' => 'Unknown encoding: ',
|
||||
'signing' => 'Signing Error: ',
|
||||
'smtp_error' => 'SMTP server error: ',
|
||||
'empty_message' => 'Message body empty',
|
||||
'invalid_address' => 'Invalid address',
|
||||
'variable_set' => 'Cannot set or reset variable: '
|
||||
);
|
||||
//Overwrite language-specific strings. This way we'll never have missing translations - no more "language string failed to load"!
|
||||
$l = true;
|
||||
if ($langcode != 'en') { //There is no English translation file
|
||||
$l = @include $lang_path.'phpmailer.lang-'.$langcode.'.php';
|
||||
}
|
||||
$this->language = $PHPMAILER_LANG;
|
||||
return ($l == true); //Returns false if language not found
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the current array of language strings
|
||||
* @return array
|
||||
*/
|
||||
public function GetTranslations() {
|
||||
return $this->language;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// METHODS, MESSAGE CREATION
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Creates recipient headers.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function AddrAppend($type, $addr) {
|
||||
$addr_str = $type . ': ';
|
||||
$addresses = array();
|
||||
foreach ($addr as $a) {
|
||||
$addresses[] = $this->AddrFormat($a);
|
||||
}
|
||||
$addr_str .= implode(', ', $addresses);
|
||||
$addr_str .= $this->LE;
|
||||
|
||||
return $addr_str;
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats an address correctly.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function AddrFormat($addr) {
|
||||
if (empty($addr[1])) {
|
||||
return $this->SecureHeader($addr[0]);
|
||||
} else {
|
||||
return $this->EncodeHeader($this->SecureHeader($addr[1]), 'phrase') . " <" . $this->SecureHeader($addr[0]) . ">";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps message for use with mailers that do not
|
||||
* automatically perform wrapping and for quoted-printable.
|
||||
* Original written by philippe.
|
||||
* @param string $message The message to wrap
|
||||
* @param integer $length The line length to wrap to
|
||||
* @param boolean $qp_mode Whether to run in Quoted-Printable mode
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function WrapText($message, $length, $qp_mode = false) {
|
||||
$soft_break = ($qp_mode) ? sprintf(" =%s", $this->LE) : $this->LE;
|
||||
// If utf-8 encoding is used, we will need to make sure we don't
|
||||
// split multibyte characters when we wrap
|
||||
$is_utf8 = (strtolower($this->CharSet) == "utf-8");
|
||||
|
||||
$message = $this->FixEOL($message);
|
||||
if (substr($message, -1) == $this->LE) {
|
||||
$message = substr($message, 0, -1);
|
||||
}
|
||||
|
||||
$line = explode($this->LE, $message);
|
||||
$message = '';
|
||||
for ($i = 0 ;$i < count($line); $i++) {
|
||||
$line_part = explode(' ', $line[$i]);
|
||||
$buf = '';
|
||||
for ($e = 0; $e<count($line_part); $e++) {
|
||||
$word = $line_part[$e];
|
||||
if ($qp_mode and (strlen($word) > $length)) {
|
||||
$space_left = $length - strlen($buf) - 1;
|
||||
if ($e != 0) {
|
||||
if ($space_left > 20) {
|
||||
$len = $space_left;
|
||||
if ($is_utf8) {
|
||||
$len = $this->UTF8CharBoundary($word, $len);
|
||||
} elseif (substr($word, $len - 1, 1) == "=") {
|
||||
$len--;
|
||||
} elseif (substr($word, $len - 2, 1) == "=") {
|
||||
$len -= 2;
|
||||
}
|
||||
$part = substr($word, 0, $len);
|
||||
$word = substr($word, $len);
|
||||
$buf .= ' ' . $part;
|
||||
$message .= $buf . sprintf("=%s", $this->LE);
|
||||
} else {
|
||||
$message .= $buf . $soft_break;
|
||||
}
|
||||
$buf = '';
|
||||
}
|
||||
while (strlen($word) > 0) {
|
||||
$len = $length;
|
||||
if ($is_utf8) {
|
||||
$len = $this->UTF8CharBoundary($word, $len);
|
||||
} elseif (substr($word, $len - 1, 1) == "=") {
|
||||
$len--;
|
||||
} elseif (substr($word, $len - 2, 1) == "=") {
|
||||
$len -= 2;
|
||||
}
|
||||
$part = substr($word, 0, $len);
|
||||
$word = substr($word, $len);
|
||||
|
||||
if (strlen($word) > 0) {
|
||||
$message .= $part . sprintf("=%s", $this->LE);
|
||||
} else {
|
||||
$buf = $part;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$buf_o = $buf;
|
||||
$buf .= ($e == 0) ? $word : (' ' . $word);
|
||||
|
||||
if (strlen($buf) > $length and $buf_o != '') {
|
||||
$message .= $buf_o . $soft_break;
|
||||
$buf = $word;
|
||||
}
|
||||
}
|
||||
}
|
||||
$message .= $buf . $this->LE;
|
||||
}
|
||||
|
||||
return $message;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds last character boundary prior to maxLength in a utf-8
|
||||
* quoted (printable) encoded string.
|
||||
* Original written by Colin Brown.
|
||||
* @access public
|
||||
* @param string $encodedText utf-8 QP text
|
||||
* @param int $maxLength find last character boundary prior to this length
|
||||
* @return int
|
||||
*/
|
||||
public function UTF8CharBoundary($encodedText, $maxLength) {
|
||||
$foundSplitPos = false;
|
||||
$lookBack = 3;
|
||||
while (!$foundSplitPos) {
|
||||
$lastChunk = substr($encodedText, $maxLength - $lookBack, $lookBack);
|
||||
$encodedCharPos = strpos($lastChunk, "=");
|
||||
if ($encodedCharPos !== false) {
|
||||
// Found start of encoded character byte within $lookBack block.
|
||||
// Check the encoded byte value (the 2 chars after the '=')
|
||||
$hex = substr($encodedText, $maxLength - $lookBack + $encodedCharPos + 1, 2);
|
||||
$dec = hexdec($hex);
|
||||
if ($dec < 128) { // Single byte character.
|
||||
// If the encoded char was found at pos 0, it will fit
|
||||
// otherwise reduce maxLength to start of the encoded char
|
||||
$maxLength = ($encodedCharPos == 0) ? $maxLength :
|
||||
$maxLength - ($lookBack - $encodedCharPos);
|
||||
$foundSplitPos = true;
|
||||
} elseif ($dec >= 192) { // First byte of a multi byte character
|
||||
// Reduce maxLength to split at start of character
|
||||
$maxLength = $maxLength - ($lookBack - $encodedCharPos);
|
||||
$foundSplitPos = true;
|
||||
} elseif ($dec < 192) { // Middle byte of a multi byte character, look further back
|
||||
$lookBack += 3;
|
||||
}
|
||||
} else {
|
||||
// No encoded character found
|
||||
$foundSplitPos = true;
|
||||
}
|
||||
}
|
||||
return $maxLength;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the body wrapping.
|
||||
* @access public
|
||||
* @return void
|
||||
*/
|
||||
public function SetWordWrap() {
|
||||
if($this->WordWrap < 1) {
|
||||
return;
|
||||
}
|
||||
|
||||
switch($this->message_type) {
|
||||
case 'alt':
|
||||
case 'alt_inline':
|
||||
case 'alt_attach':
|
||||
case 'alt_inline_attach':
|
||||
$this->AltBody = $this->WrapText($this->AltBody, $this->WordWrap);
|
||||
break;
|
||||
default:
|
||||
$this->Body = $this->WrapText($this->Body, $this->WordWrap);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Assembles message header.
|
||||
* @access public
|
||||
* @return string The assembled header
|
||||
*/
|
||||
public function CreateHeader() {
|
||||
$result = '';
|
||||
|
||||
// Set the boundaries
|
||||
$uniq_id = md5(uniqid(time()));
|
||||
$this->boundary[1] = 'b1_' . $uniq_id;
|
||||
$this->boundary[2] = 'b2_' . $uniq_id;
|
||||
$this->boundary[3] = 'b3_' . $uniq_id;
|
||||
|
||||
$result .= $this->HeaderLine('Date', self::RFCDate());
|
||||
if($this->Sender == '') {
|
||||
$result .= $this->HeaderLine('Return-Path', trim($this->From));
|
||||
} else {
|
||||
$result .= $this->HeaderLine('Return-Path', trim($this->Sender));
|
||||
}
|
||||
|
||||
// To be created automatically by mail()
|
||||
if($this->Mailer != 'mail') {
|
||||
if ($this->SingleTo === true) {
|
||||
foreach($this->to as $t) {
|
||||
$this->SingleToArray[] = $this->AddrFormat($t);
|
||||
}
|
||||
} else {
|
||||
if(count($this->to) > 0) {
|
||||
$result .= $this->AddrAppend('To', $this->to);
|
||||
} elseif (count($this->cc) == 0) {
|
||||
$result .= $this->HeaderLine('To', 'undisclosed-recipients:;');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$from = array();
|
||||
$from[0][0] = trim($this->From);
|
||||
$from[0][1] = $this->FromName;
|
||||
$result .= $this->AddrAppend('From', $from);
|
||||
|
||||
// sendmail and mail() extract Cc from the header before sending
|
||||
if(count($this->cc) > 0) {
|
||||
$result .= $this->AddrAppend('Cc', $this->cc);
|
||||
}
|
||||
|
||||
// sendmail and mail() extract Bcc from the header before sending
|
||||
if((($this->Mailer == 'sendmail') || ($this->Mailer == 'mail')) && (count($this->bcc) > 0)) {
|
||||
$result .= $this->AddrAppend('Bcc', $this->bcc);
|
||||
}
|
||||
|
||||
if(count($this->ReplyTo) > 0) {
|
||||
$result .= $this->AddrAppend('Reply-to', $this->ReplyTo);
|
||||
}
|
||||
|
||||
// mail() sets the subject itself
|
||||
if($this->Mailer != 'mail') {
|
||||
$result .= $this->HeaderLine('Subject', $this->EncodeHeader($this->SecureHeader($this->Subject)));
|
||||
}
|
||||
|
||||
if($this->MessageID != '') {
|
||||
$result .= $this->HeaderLine('Message-ID', $this->MessageID);
|
||||
} else {
|
||||
$result .= sprintf("Message-ID: <%s@%s>%s", $uniq_id, $this->ServerHostname(), $this->LE);
|
||||
}
|
||||
$result .= $this->HeaderLine('X-Priority', $this->Priority);
|
||||
if($this->XMailer) {
|
||||
$result .= $this->HeaderLine('X-Mailer', $this->XMailer);
|
||||
} else {
|
||||
$result .= $this->HeaderLine('X-Mailer', 'PHPMailer '.$this->Version.' (http://code.google.com/a/apache-extras.org/p/phpmailer/)');
|
||||
}
|
||||
|
||||
if($this->ConfirmReadingTo != '') {
|
||||
$result .= $this->HeaderLine('Disposition-Notification-To', '<' . trim($this->ConfirmReadingTo) . '>');
|
||||
}
|
||||
|
||||
// Add custom headers
|
||||
for($index = 0; $index < count($this->CustomHeader); $index++) {
|
||||
$result .= $this->HeaderLine(trim($this->CustomHeader[$index][0]), $this->EncodeHeader(trim($this->CustomHeader[$index][1])));
|
||||
}
|
||||
if (!$this->sign_key_file) {
|
||||
$result .= $this->HeaderLine('MIME-Version', '1.0');
|
||||
$result .= $this->GetMailMIME();
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the message MIME.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function GetMailMIME() {
|
||||
$result = '';
|
||||
switch($this->message_type) {
|
||||
case 'plain':
|
||||
$result .= $this->HeaderLine('Content-Transfer-Encoding', $this->Encoding);
|
||||
$result .= $this->TextLine('Content-Type: '.$this->ContentType.'; charset="'.$this->CharSet.'"');
|
||||
break;
|
||||
case 'inline':
|
||||
$result .= $this->HeaderLine('Content-Type', 'multipart/related;');
|
||||
$result .= $this->TextLine("\tboundary=\"" . $this->boundary[1] . '"');
|
||||
break;
|
||||
case 'attach':
|
||||
case 'inline_attach':
|
||||
case 'alt_attach':
|
||||
case 'alt_inline_attach':
|
||||
$result .= $this->HeaderLine('Content-Type', 'multipart/mixed;');
|
||||
$result .= $this->TextLine("\tboundary=\"" . $this->boundary[1] . '"');
|
||||
break;
|
||||
case 'alt':
|
||||
case 'alt_inline':
|
||||
$result .= $this->HeaderLine('Content-Type', 'multipart/alternative;');
|
||||
$result .= $this->TextLine("\tboundary=\"" . $this->boundary[1] . '"');
|
||||
break;
|
||||
}
|
||||
|
||||
if($this->Mailer != 'mail') {
|
||||
$result .= $this->LE.$this->LE;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assembles the message body. Returns an empty string on failure.
|
||||
* @access public
|
||||
* @return string The assembled message body
|
||||
*/
|
||||
public function CreateBody() {
|
||||
$body = '';
|
||||
|
||||
if ($this->sign_key_file) {
|
||||
$body .= $this->GetMailMIME();
|
||||
}
|
||||
|
||||
$this->SetWordWrap();
|
||||
|
||||
switch($this->message_type) {
|
||||
case 'plain':
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
break;
|
||||
case 'inline':
|
||||
$body .= $this->GetBoundary($this->boundary[1], '', '', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->AttachAll("inline", $this->boundary[1]);
|
||||
break;
|
||||
case 'attach':
|
||||
$body .= $this->GetBoundary($this->boundary[1], '', '', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->AttachAll("attachment", $this->boundary[1]);
|
||||
break;
|
||||
case 'inline_attach':
|
||||
$body .= $this->TextLine("--" . $this->boundary[1]);
|
||||
$body .= $this->HeaderLine('Content-Type', 'multipart/related;');
|
||||
$body .= $this->TextLine("\tboundary=\"" . $this->boundary[2] . '"');
|
||||
$body .= $this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[2], '', '', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->AttachAll("inline", $this->boundary[2]);
|
||||
$body .= $this->LE;
|
||||
$body .= $this->AttachAll("attachment", $this->boundary[1]);
|
||||
break;
|
||||
case 'alt':
|
||||
$body .= $this->GetBoundary($this->boundary[1], '', 'text/plain', '');
|
||||
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[1], '', 'text/html', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->EndBoundary($this->boundary[1]);
|
||||
break;
|
||||
case 'alt_inline':
|
||||
$body .= $this->GetBoundary($this->boundary[1], '', 'text/plain', '');
|
||||
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->TextLine("--" . $this->boundary[1]);
|
||||
$body .= $this->HeaderLine('Content-Type', 'multipart/related;');
|
||||
$body .= $this->TextLine("\tboundary=\"" . $this->boundary[2] . '"');
|
||||
$body .= $this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[2], '', 'text/html', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->AttachAll("inline", $this->boundary[2]);
|
||||
$body .= $this->LE;
|
||||
$body .= $this->EndBoundary($this->boundary[1]);
|
||||
break;
|
||||
case 'alt_attach':
|
||||
$body .= $this->TextLine("--" . $this->boundary[1]);
|
||||
$body .= $this->HeaderLine('Content-Type', 'multipart/alternative;');
|
||||
$body .= $this->TextLine("\tboundary=\"" . $this->boundary[2] . '"');
|
||||
$body .= $this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[2], '', 'text/plain', '');
|
||||
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[2], '', 'text/html', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->EndBoundary($this->boundary[2]);
|
||||
$body .= $this->LE;
|
||||
$body .= $this->AttachAll("attachment", $this->boundary[1]);
|
||||
break;
|
||||
case 'alt_inline_attach':
|
||||
$body .= $this->TextLine("--" . $this->boundary[1]);
|
||||
$body .= $this->HeaderLine('Content-Type', 'multipart/alternative;');
|
||||
$body .= $this->TextLine("\tboundary=\"" . $this->boundary[2] . '"');
|
||||
$body .= $this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[2], '', 'text/plain', '');
|
||||
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->TextLine("--" . $this->boundary[2]);
|
||||
$body .= $this->HeaderLine('Content-Type', 'multipart/related;');
|
||||
$body .= $this->TextLine("\tboundary=\"" . $this->boundary[3] . '"');
|
||||
$body .= $this->LE;
|
||||
$body .= $this->GetBoundary($this->boundary[3], '', 'text/html', '');
|
||||
$body .= $this->EncodeString($this->Body, $this->Encoding);
|
||||
$body .= $this->LE.$this->LE;
|
||||
$body .= $this->AttachAll("inline", $this->boundary[3]);
|
||||
$body .= $this->LE;
|
||||
$body .= $this->EndBoundary($this->boundary[2]);
|
||||
$body .= $this->LE;
|
||||
$body .= $this->AttachAll("attachment", $this->boundary[1]);
|
||||
break;
|
||||
}
|
||||
|
||||
if ($this->IsError()) {
|
||||
$body = '';
|
||||
} elseif ($this->sign_key_file) {
|
||||
try {
|
||||
$file = tempnam('', 'mail');
|
||||
file_put_contents($file, $body); //TODO check this worked
|
||||
$signed = tempnam("", "signed");
|
||||
if (@openssl_pkcs7_sign($file, $signed, "file://".$this->sign_cert_file, array("file://".$this->sign_key_file, $this->sign_key_pass), NULL)) {
|
||||
@unlink($file);
|
||||
@unlink($signed);
|
||||
$body = file_get_contents($signed);
|
||||
} else {
|
||||
@unlink($file);
|
||||
@unlink($signed);
|
||||
throw new phpmailerException($this->Lang("signing").openssl_error_string());
|
||||
}
|
||||
} catch (phpmailerException $e) {
|
||||
$body = '';
|
||||
if ($this->exceptions) {
|
||||
throw $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $body;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the start of a message boundary.
|
||||
* @access protected
|
||||
* @return string
|
||||
*/
|
||||
protected function GetBoundary($boundary, $charSet, $contentType, $encoding) {
|
||||
$result = '';
|
||||
if($charSet == '') {
|
||||
$charSet = $this->CharSet;
|
||||
}
|
||||
if($contentType == '') {
|
||||
$contentType = $this->ContentType;
|
||||
}
|
||||
if($encoding == '') {
|
||||
$encoding = $this->Encoding;
|
||||
}
|
||||
$result .= $this->TextLine('--' . $boundary);
|
||||
$result .= sprintf("Content-Type: %s; charset=\"%s\"", $contentType, $charSet);
|
||||
$result .= $this->LE;
|
||||
$result .= $this->HeaderLine('Content-Transfer-Encoding', $encoding);
|
||||
$result .= $this->LE;
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the end of a message boundary.
|
||||
* @access protected
|
||||
* @return string
|
||||
*/
|
||||
protected function EndBoundary($boundary) {
|
||||
return $this->LE . '--' . $boundary . '--' . $this->LE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the message type.
|
||||
* @access protected
|
||||
* @return void
|
||||
*/
|
||||
protected function SetMessageType() {
|
||||
$this->message_type = array();
|
||||
if($this->AlternativeExists()) $this->message_type[] = "alt";
|
||||
if($this->InlineImageExists()) $this->message_type[] = "inline";
|
||||
if($this->AttachmentExists()) $this->message_type[] = "attach";
|
||||
$this->message_type = implode("_", $this->message_type);
|
||||
if($this->message_type == "") $this->message_type = "plain";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a formatted header line.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function HeaderLine($name, $value) {
|
||||
return $name . ': ' . $value . $this->LE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a formatted mail line.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function TextLine($value) {
|
||||
return $value . $this->LE;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// CLASS METHODS, ATTACHMENTS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Adds an attachment from a path on the filesystem.
|
||||
* Returns false if the file could not be found
|
||||
* or accessed.
|
||||
* @param string $path Path to the attachment.
|
||||
* @param string $name Overrides the attachment name.
|
||||
* @param string $encoding File encoding (see $Encoding).
|
||||
* @param string $type File extension (MIME) type.
|
||||
* @return bool
|
||||
*/
|
||||
public function AddAttachment($path, $name = '', $encoding = 'base64', $type = 'application/octet-stream') {
|
||||
try {
|
||||
if ( !@is_file($path) ) {
|
||||
throw new phpmailerException($this->Lang('file_access') . $path, self::STOP_CONTINUE);
|
||||
}
|
||||
$filename = basename($path);
|
||||
if ( $name == '' ) {
|
||||
$name = $filename;
|
||||
}
|
||||
|
||||
$this->attachment[] = array(
|
||||
0 => $path,
|
||||
1 => $filename,
|
||||
2 => $name,
|
||||
3 => $encoding,
|
||||
4 => $type,
|
||||
5 => false, // isStringAttachment
|
||||
6 => 'attachment',
|
||||
7 => 0
|
||||
);
|
||||
|
||||
} catch (phpmailerException $e) {
|
||||
$this->SetError($e->getMessage());
|
||||
if ($this->exceptions) {
|
||||
throw $e;
|
||||
}
|
||||
echo $e->getMessage()."\n";
|
||||
if ( $e->getCode() == self::STOP_CRITICAL ) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the current array of attachments
|
||||
* @return array
|
||||
*/
|
||||
public function GetAttachments() {
|
||||
return $this->attachment;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attaches all fs, string, and binary attachments to the message.
|
||||
* Returns an empty string on failure.
|
||||
* @access protected
|
||||
* @return string
|
||||
*/
|
||||
protected function AttachAll($disposition_type, $boundary) {
|
||||
// Return text of body
|
||||
$mime = array();
|
||||
$cidUniq = array();
|
||||
$incl = array();
|
||||
|
||||
// Add all attachments
|
||||
foreach ($this->attachment as $attachment) {
|
||||
// CHECK IF IT IS A VALID DISPOSITION_FILTER
|
||||
if($attachment[6] == $disposition_type) {
|
||||
// Check for string attachment
|
||||
$bString = $attachment[5];
|
||||
if ($bString) {
|
||||
$string = $attachment[0];
|
||||
} else {
|
||||
$path = $attachment[0];
|
||||
}
|
||||
|
||||
$inclhash = md5(serialize($attachment));
|
||||
if (in_array($inclhash, $incl)) { continue; }
|
||||
$incl[] = $inclhash;
|
||||
$filename = $attachment[1];
|
||||
$name = $attachment[2];
|
||||
$encoding = $attachment[3];
|
||||
$type = $attachment[4];
|
||||
$disposition = $attachment[6];
|
||||
$cid = $attachment[7];
|
||||
if ( $disposition == 'inline' && isset($cidUniq[$cid]) ) { continue; }
|
||||
$cidUniq[$cid] = true;
|
||||
|
||||
$mime[] = sprintf("--%s%s", $boundary, $this->LE);
|
||||
$mime[] = sprintf("Content-Type: %s; name=\"%s\"%s", $type, $this->EncodeHeader($this->SecureHeader($name)), $this->LE);
|
||||
$mime[] = sprintf("Content-Transfer-Encoding: %s%s", $encoding, $this->LE);
|
||||
|
||||
if($disposition == 'inline') {
|
||||
$mime[] = sprintf("Content-ID: <%s>%s", $cid, $this->LE);
|
||||
}
|
||||
|
||||
$mime[] = sprintf("Content-Disposition: %s; filename=\"%s\"%s", $disposition, $this->EncodeHeader($this->SecureHeader($name)), $this->LE.$this->LE);
|
||||
|
||||
// Encode as string attachment
|
||||
if($bString) {
|
||||
$mime[] = $this->EncodeString($string, $encoding);
|
||||
if($this->IsError()) {
|
||||
return '';
|
||||
}
|
||||
$mime[] = $this->LE.$this->LE;
|
||||
} else {
|
||||
$mime[] = $this->EncodeFile($path, $encoding);
|
||||
if($this->IsError()) {
|
||||
return '';
|
||||
}
|
||||
$mime[] = $this->LE.$this->LE;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$mime[] = sprintf("--%s--%s", $boundary, $this->LE);
|
||||
|
||||
return implode("", $mime);
|
||||
}
|
||||
|
||||
/**
|
||||
* Encodes attachment in requested format.
|
||||
* Returns an empty string on failure.
|
||||
* @param string $path The full path to the file
|
||||
* @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
|
||||
* @see EncodeFile()
|
||||
* @access protected
|
||||
* @return string
|
||||
*/
|
||||
protected function EncodeFile($path, $encoding = 'base64') {
|
||||
try {
|
||||
if (!is_readable($path)) {
|
||||
throw new phpmailerException($this->Lang('file_open') . $path, self::STOP_CONTINUE);
|
||||
}
|
||||
if (function_exists('get_magic_quotes')) {
|
||||
function get_magic_quotes() {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
|
||||
$magic_quotes = get_magic_quotes_runtime();
|
||||
set_magic_quotes_runtime(0);
|
||||
}
|
||||
$file_buffer = file_get_contents($path);
|
||||
$file_buffer = $this->EncodeString($file_buffer, $encoding);
|
||||
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
|
||||
set_magic_quotes_runtime($magic_quotes);
|
||||
}
|
||||
return $file_buffer;
|
||||
} catch (Exception $e) {
|
||||
$this->SetError($e->getMessage());
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Encodes string to requested format.
|
||||
* Returns an empty string on failure.
|
||||
* @param string $str The text to encode
|
||||
* @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function EncodeString($str, $encoding = 'base64') {
|
||||
$encoded = '';
|
||||
switch(strtolower($encoding)) {
|
||||
case 'base64':
|
||||
$encoded = chunk_split(base64_encode($str), 76, $this->LE);
|
||||
break;
|
||||
case '7bit':
|
||||
case '8bit':
|
||||
$encoded = $this->FixEOL($str);
|
||||
//Make sure it ends with a line break
|
||||
if (substr($encoded, -(strlen($this->LE))) != $this->LE)
|
||||
$encoded .= $this->LE;
|
||||
break;
|
||||
case 'binary':
|
||||
$encoded = $str;
|
||||
break;
|
||||
case 'quoted-printable':
|
||||
$encoded = $this->EncodeQP($str);
|
||||
break;
|
||||
default:
|
||||
$this->SetError($this->Lang('encoding') . $encoding);
|
||||
break;
|
||||
}
|
||||
return $encoded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode a header string to best (shortest) of Q, B, quoted or none.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function EncodeHeader($str, $position = 'text') {
|
||||
$x = 0;
|
||||
|
||||
switch (strtolower($position)) {
|
||||
case 'phrase':
|
||||
if (!preg_match('/[\200-\377]/', $str)) {
|
||||
// Can't use addslashes as we don't know what value has magic_quotes_sybase
|
||||
$encoded = addcslashes($str, "\0..\37\177\\\"");
|
||||
if (($str == $encoded) && !preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $str)) {
|
||||
return ($encoded);
|
||||
} else {
|
||||
return ("\"$encoded\"");
|
||||
}
|
||||
}
|
||||
$x = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
|
||||
break;
|
||||
case 'comment':
|
||||
$x = preg_match_all('/[()"]/', $str, $matches);
|
||||
// Fall-through
|
||||
case 'text':
|
||||
default:
|
||||
$x += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
|
||||
break;
|
||||
}
|
||||
|
||||
if ($x == 0) {
|
||||
return ($str);
|
||||
}
|
||||
|
||||
$maxlen = 75 - 7 - strlen($this->CharSet);
|
||||
// Try to select the encoding which should produce the shortest output
|
||||
if (strlen($str)/3 < $x) {
|
||||
$encoding = 'B';
|
||||
if (function_exists('mb_strlen') && $this->HasMultiBytes($str)) {
|
||||
// Use a custom function which correctly encodes and wraps long
|
||||
// multibyte strings without breaking lines within a character
|
||||
$encoded = $this->Base64EncodeWrapMB($str);
|
||||
} else {
|
||||
$encoded = base64_encode($str);
|
||||
$maxlen -= $maxlen % 4;
|
||||
$encoded = trim(chunk_split($encoded, $maxlen, "\n"));
|
||||
}
|
||||
} else {
|
||||
$encoding = 'Q';
|
||||
$encoded = $this->EncodeQ($str, $position);
|
||||
$encoded = $this->WrapText($encoded, $maxlen, true);
|
||||
$encoded = str_replace('='.$this->LE, "\n", trim($encoded));
|
||||
}
|
||||
|
||||
$encoded = preg_replace('/^(.*)$/m', " =?".$this->CharSet."?$encoding?\\1?=", $encoded);
|
||||
$encoded = trim(str_replace("\n", $this->LE, $encoded));
|
||||
|
||||
return $encoded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a string contains multibyte characters.
|
||||
* @access public
|
||||
* @param string $str multi-byte text to wrap encode
|
||||
* @return bool
|
||||
*/
|
||||
public function HasMultiBytes($str) {
|
||||
if (function_exists('mb_strlen')) {
|
||||
return (strlen($str) > mb_strlen($str, $this->CharSet));
|
||||
} else { // Assume no multibytes (we can't handle without mbstring functions anyway)
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @access public
|
||||
* @param string $str multi-byte text to wrap encode
|
||||
* @return string
|
||||
*/
|
||||
public function Base64EncodeWrapMB($str) {
|
||||
$start = "=?".$this->CharSet."?B?";
|
||||
$end = "?=";
|
||||
$encoded = "";
|
||||
|
||||
$mb_length = mb_strlen($str, $this->CharSet);
|
||||
// Each line must have length <= 75, including $start and $end
|
||||
$length = 75 - strlen($start) - strlen($end);
|
||||
// Average multi-byte ratio
|
||||
$ratio = $mb_length / strlen($str);
|
||||
// Base64 has a 4:3 ratio
|
||||
$offset = $avgLength = floor($length * $ratio * .75);
|
||||
|
||||
for ($i = 0; $i < $mb_length; $i += $offset) {
|
||||
$lookBack = 0;
|
||||
|
||||
do {
|
||||
$offset = $avgLength - $lookBack;
|
||||
$chunk = mb_substr($str, $i, $offset, $this->CharSet);
|
||||
$chunk = base64_encode($chunk);
|
||||
$lookBack++;
|
||||
}
|
||||
while (strlen($chunk) > $length);
|
||||
|
||||
$encoded .= $chunk . $this->LE;
|
||||
}
|
||||
|
||||
// Chomp the last linefeed
|
||||
$encoded = substr($encoded, 0, -strlen($this->LE));
|
||||
return $encoded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode string to quoted-printable.
|
||||
* Only uses standard PHP, slow, but will always work
|
||||
* @access public
|
||||
* @param string $string the text to encode
|
||||
* @param integer $line_max Number of chars allowed on a line before wrapping
|
||||
* @return string
|
||||
*/
|
||||
public function EncodeQPphp( $input = '', $line_max = 76, $space_conv = false) {
|
||||
$hex = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
|
||||
$lines = preg_split('/(?:\r\n|\r|\n)/', $input);
|
||||
$eol = "\r\n";
|
||||
$escape = '=';
|
||||
$output = '';
|
||||
while( list(, $line) = each($lines) ) {
|
||||
$linlen = strlen($line);
|
||||
$newline = '';
|
||||
for($i = 0; $i < $linlen; $i++) {
|
||||
$c = substr( $line, $i, 1 );
|
||||
$dec = ord( $c );
|
||||
if ( ( $i == 0 ) && ( $dec == 46 ) ) { // convert first point in the line into =2E
|
||||
$c = '=2E';
|
||||
}
|
||||
if ( $dec == 32 ) {
|
||||
if ( $i == ( $linlen - 1 ) ) { // convert space at eol only
|
||||
$c = '=20';
|
||||
} else if ( $space_conv ) {
|
||||
$c = '=20';
|
||||
}
|
||||
} elseif ( ($dec == 61) || ($dec < 32 ) || ($dec > 126) ) { // always encode "\t", which is *not* required
|
||||
$h2 = floor($dec/16);
|
||||
$h1 = floor($dec%16);
|
||||
$c = $escape.$hex[$h2].$hex[$h1];
|
||||
}
|
||||
if ( (strlen($newline) + strlen($c)) >= $line_max ) { // CRLF is not counted
|
||||
$output .= $newline.$escape.$eol; // soft line break; " =\r\n" is okay
|
||||
$newline = '';
|
||||
// check if newline first character will be point or not
|
||||
if ( $dec == 46 ) {
|
||||
$c = '=2E';
|
||||
}
|
||||
}
|
||||
$newline .= $c;
|
||||
} // end of for
|
||||
$output .= $newline.$eol;
|
||||
} // end of while
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @see EncodeQPphp()
|
||||
* @access public
|
||||
* @param string $string the text to encode
|
||||
* @param integer $line_max Number of chars allowed on a line before wrapping
|
||||
* @param boolean $space_conv Dummy param for compatibility with existing EncodeQP function
|
||||
* @return string
|
||||
* @author Marcus Bointon
|
||||
*/
|
||||
public function EncodeQP($string, $line_max = 76, $space_conv = false) {
|
||||
if (function_exists('quoted_printable_encode')) { //Use native function if it's available (>= PHP5.3)
|
||||
return quoted_printable_encode($string);
|
||||
}
|
||||
$filters = stream_get_filters();
|
||||
if (!in_array('convert.*', $filters)) { //Got convert stream filter?
|
||||
return $this->EncodeQPphp($string, $line_max, $space_conv); //Fall back to old implementation
|
||||
}
|
||||
$fp = fopen('php://temp/', 'r+');
|
||||
$string = preg_replace('/\r\n?/', $this->LE, $string); //Normalise line breaks
|
||||
$params = array('line-length' => $line_max, 'line-break-chars' => $this->LE);
|
||||
$s = stream_filter_append($fp, 'convert.quoted-printable-encode', STREAM_FILTER_READ, $params);
|
||||
fputs($fp, $string);
|
||||
rewind($fp);
|
||||
$out = stream_get_contents($fp);
|
||||
stream_filter_remove($s);
|
||||
$out = preg_replace('/^\./m', '=2E', $out); //Encode . if it is first char on a line, workaround for bug in Exchange
|
||||
fclose($fp);
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode string to q encoding.
|
||||
* @link http://tools.ietf.org/html/rfc2047
|
||||
* @param string $str the text to encode
|
||||
* @param string $position Where the text is going to be used, see the RFC for what that means
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function EncodeQ($str, $position = 'text') {
|
||||
// There should not be any EOL in the string
|
||||
$encoded = preg_replace('/[\r\n]*/', '', $str);
|
||||
|
||||
switch (strtolower($position)) {
|
||||
case 'phrase':
|
||||
$encoded = preg_replace("/([^A-Za-z0-9!*+\/ -])/e", "'='.sprintf('%02X', ord('\\1'))", $encoded);
|
||||
break;
|
||||
case 'comment':
|
||||
$encoded = preg_replace("/([\(\)\"])/e", "'='.sprintf('%02X', ord('\\1'))", $encoded);
|
||||
case 'text':
|
||||
default:
|
||||
// Replace every high ascii, control =, ? and _ characters
|
||||
//TODO using /e (equivalent to eval()) is probably not a good idea
|
||||
$encoded = preg_replace('/([\000-\011\013\014\016-\037\075\077\137\177-\377])/e',
|
||||
"'='.sprintf('%02X', ord(stripslashes('\\1')))", $encoded);
|
||||
break;
|
||||
}
|
||||
|
||||
// Replace every spaces to _ (more readable than =20)
|
||||
$encoded = str_replace(' ', '_', $encoded);
|
||||
|
||||
return $encoded;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @param string $string String attachment data.
|
||||
* @param string $filename Name of the attachment.
|
||||
* @param string $encoding File encoding (see $Encoding).
|
||||
* @param string $type File extension (MIME) type.
|
||||
* @return void
|
||||
*/
|
||||
public function AddStringAttachment($string, $filename, $encoding = 'base64', $type = 'application/octet-stream') {
|
||||
// Append to $attachment array
|
||||
$this->attachment[] = array(
|
||||
0 => $string,
|
||||
1 => $filename,
|
||||
2 => basename($filename),
|
||||
3 => $encoding,
|
||||
4 => $type,
|
||||
5 => true, // isStringAttachment
|
||||
6 => 'attachment',
|
||||
7 => 0
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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".
|
||||
* @param string $path Path to the attachment.
|
||||
* @param string $cid Content ID of the attachment. Use this to identify
|
||||
* the Id for accessing the image in an HTML form.
|
||||
* @param string $name Overrides the attachment name.
|
||||
* @param string $encoding File encoding (see $Encoding).
|
||||
* @param string $type File extension (MIME) type.
|
||||
* @return bool
|
||||
*/
|
||||
public function AddEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = 'application/octet-stream') {
|
||||
|
||||
if ( !@is_file($path) ) {
|
||||
$this->SetError($this->Lang('file_access') . $path);
|
||||
return false;
|
||||
}
|
||||
|
||||
$filename = basename($path);
|
||||
if ( $name == '' ) {
|
||||
$name = $filename;
|
||||
}
|
||||
|
||||
// Append to $attachment array
|
||||
$this->attachment[] = array(
|
||||
0 => $path,
|
||||
1 => $filename,
|
||||
2 => $name,
|
||||
3 => $encoding,
|
||||
4 => $type,
|
||||
5 => false, // isStringAttachment
|
||||
6 => 'inline',
|
||||
7 => $cid
|
||||
);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public function AddStringEmbeddedImage($string, $cid, $filename = '', $encoding = 'base64', $type = 'application/octet-stream') {
|
||||
// Append to $attachment array
|
||||
$this->attachment[] = array(
|
||||
0 => $string,
|
||||
1 => $filename,
|
||||
2 => basename($filename),
|
||||
3 => $encoding,
|
||||
4 => $type,
|
||||
5 => true, // isStringAttachment
|
||||
6 => 'inline',
|
||||
7 => $cid
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if an inline attachment is present.
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function InlineImageExists() {
|
||||
foreach($this->attachment as $attachment) {
|
||||
if ($attachment[6] == 'inline') {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
public function AttachmentExists() {
|
||||
foreach($this->attachment as $attachment) {
|
||||
if ($attachment[6] == 'attachment') {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
public function AlternativeExists() {
|
||||
return strlen($this->AltBody)>0;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// CLASS METHODS, MESSAGE RESET
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Clears all recipients assigned in the TO array. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearAddresses() {
|
||||
foreach($this->to as $to) {
|
||||
unset($this->all_recipients[strtolower($to[0])]);
|
||||
}
|
||||
$this->to = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all recipients assigned in the CC array. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearCCs() {
|
||||
foreach($this->cc as $cc) {
|
||||
unset($this->all_recipients[strtolower($cc[0])]);
|
||||
}
|
||||
$this->cc = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all recipients assigned in the BCC array. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearBCCs() {
|
||||
foreach($this->bcc as $bcc) {
|
||||
unset($this->all_recipients[strtolower($bcc[0])]);
|
||||
}
|
||||
$this->bcc = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all recipients assigned in the ReplyTo array. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearReplyTos() {
|
||||
$this->ReplyTo = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all recipients assigned in the TO, CC and BCC
|
||||
* array. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearAllRecipients() {
|
||||
$this->to = array();
|
||||
$this->cc = array();
|
||||
$this->bcc = array();
|
||||
$this->all_recipients = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all previously set filesystem, string, and binary
|
||||
* attachments. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearAttachments() {
|
||||
$this->attachment = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all custom headers. Returns void.
|
||||
* @return void
|
||||
*/
|
||||
public function ClearCustomHeaders() {
|
||||
$this->CustomHeader = array();
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// CLASS METHODS, MISCELLANEOUS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Adds the error message to the error container.
|
||||
* @access protected
|
||||
* @return void
|
||||
*/
|
||||
protected function SetError($msg) {
|
||||
$this->error_count++;
|
||||
if ($this->Mailer == 'smtp' and !is_null($this->smtp)) {
|
||||
$lasterror = $this->smtp->getError();
|
||||
if (!empty($lasterror) and array_key_exists('smtp_msg', $lasterror)) {
|
||||
$msg .= '<p>' . $this->Lang('smtp_error') . $lasterror['smtp_msg'] . "</p>\n";
|
||||
}
|
||||
}
|
||||
$this->ErrorInfo = $msg;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the proper RFC 822 formatted date.
|
||||
* @access public
|
||||
* @return string
|
||||
* @static
|
||||
*/
|
||||
public static function RFCDate() {
|
||||
$tz = date('Z');
|
||||
$tzs = ($tz < 0) ? '-' : '+';
|
||||
$tz = abs($tz);
|
||||
$tz = (int)($tz/3600)*100 + ($tz%3600)/60;
|
||||
$result = sprintf("%s %s%04d", date('D, j M Y H:i:s'), $tzs, $tz);
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the server hostname or 'localhost.localdomain' if unknown.
|
||||
* @access protected
|
||||
* @return string
|
||||
*/
|
||||
protected function ServerHostname() {
|
||||
if (!empty($this->Hostname)) {
|
||||
$result = $this->Hostname;
|
||||
} elseif (isset($_SERVER['SERVER_NAME'])) {
|
||||
$result = $_SERVER['SERVER_NAME'];
|
||||
} else {
|
||||
$result = 'localhost.localdomain';
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a message in the appropriate language.
|
||||
* @access protected
|
||||
* @return string
|
||||
*/
|
||||
protected function Lang($key) {
|
||||
if(count($this->language) < 1) {
|
||||
$this->SetLanguage('en'); // set the default language
|
||||
}
|
||||
|
||||
if(isset($this->language[$key])) {
|
||||
return $this->language[$key];
|
||||
} else {
|
||||
return 'Language string failed to load: ' . $key;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if an error occurred.
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function IsError() {
|
||||
return ($this->error_count > 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes every end of line from CR or LF to CRLF.
|
||||
* @access public
|
||||
* @return string
|
||||
*/
|
||||
public function FixEOL($str) {
|
||||
$str = str_replace("\r\n", "\n", $str);
|
||||
$str = str_replace("\r", "\n", $str);
|
||||
$str = str_replace("\n", $this->LE, $str);
|
||||
return $str;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a custom header.
|
||||
* @access public
|
||||
* @return void
|
||||
*/
|
||||
public function AddCustomHeader($custom_header) {
|
||||
$this->CustomHeader[] = explode(':', $custom_header, 2);
|
||||
}
|
||||
|
||||
/**
|
||||
* Evaluates the message and returns modifications for inline images and backgrounds
|
||||
* @access public
|
||||
* @return $message
|
||||
*/
|
||||
public function MsgHTML($message, $basedir = '') {
|
||||
preg_match_all("/(src|background)=\"(.*)\"/Ui", $message, $images);
|
||||
if(isset($images[2])) {
|
||||
foreach($images[2] as $i => $url) {
|
||||
// do not change urls for absolute images (thanks to corvuscorax)
|
||||
if (!preg_match('#^[A-z]+://#', $url)) {
|
||||
$filename = basename($url);
|
||||
$directory = dirname($url);
|
||||
($directory == '.') ? $directory='': '';
|
||||
$cid = 'cid:' . md5($filename);
|
||||
$ext = pathinfo($filename, PATHINFO_EXTENSION);
|
||||
$mimeType = self::_mime_types($ext);
|
||||
if ( strlen($basedir) > 1 && substr($basedir, -1) != '/') { $basedir .= '/'; }
|
||||
if ( strlen($directory) > 1 && substr($directory, -1) != '/') { $directory .= '/'; }
|
||||
if ( $this->AddEmbeddedImage($basedir.$directory.$filename, md5($filename), $filename, 'base64', $mimeType) ) {
|
||||
$message = preg_replace("/".$images[1][$i]."=\"".preg_quote($url, '/')."\"/Ui", $images[1][$i]."=\"".$cid."\"", $message);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
$this->IsHTML(true);
|
||||
$this->Body = $message;
|
||||
$textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s', '', $message)));
|
||||
if (!empty($textMsg) && empty($this->AltBody)) {
|
||||
$this->AltBody = html_entity_decode($textMsg);
|
||||
}
|
||||
if (empty($this->AltBody)) {
|
||||
$this->AltBody = 'To view this email message, open it in a program that understands HTML!' . "\n\n";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the MIME type of the embedded or inline image
|
||||
* @param string File extension
|
||||
* @access public
|
||||
* @return string MIME type of ext
|
||||
* @static
|
||||
*/
|
||||
public static function _mime_types($ext = '') {
|
||||
$mimes = array(
|
||||
'hqx' => 'application/mac-binhex40',
|
||||
'cpt' => 'application/mac-compactpro',
|
||||
'doc' => 'application/msword',
|
||||
'bin' => 'application/macbinary',
|
||||
'dms' => 'application/octet-stream',
|
||||
'lha' => 'application/octet-stream',
|
||||
'lzh' => 'application/octet-stream',
|
||||
'exe' => 'application/octet-stream',
|
||||
'class' => 'application/octet-stream',
|
||||
'psd' => 'application/octet-stream',
|
||||
'so' => 'application/octet-stream',
|
||||
'sea' => 'application/octet-stream',
|
||||
'dll' => 'application/octet-stream',
|
||||
'oda' => 'application/oda',
|
||||
'pdf' => 'application/pdf',
|
||||
'ai' => 'application/postscript',
|
||||
'eps' => 'application/postscript',
|
||||
'ps' => 'application/postscript',
|
||||
'smi' => 'application/smil',
|
||||
'smil' => 'application/smil',
|
||||
'mif' => 'application/vnd.mif',
|
||||
'xls' => 'application/vnd.ms-excel',
|
||||
'ppt' => 'application/vnd.ms-powerpoint',
|
||||
'wbxml' => 'application/vnd.wap.wbxml',
|
||||
'wmlc' => 'application/vnd.wap.wmlc',
|
||||
'dcr' => 'application/x-director',
|
||||
'dir' => 'application/x-director',
|
||||
'dxr' => 'application/x-director',
|
||||
'dvi' => 'application/x-dvi',
|
||||
'gtar' => 'application/x-gtar',
|
||||
'php' => 'application/x-httpd-php',
|
||||
'php4' => 'application/x-httpd-php',
|
||||
'php3' => 'application/x-httpd-php',
|
||||
'phtml' => 'application/x-httpd-php',
|
||||
'phps' => 'application/x-httpd-php-source',
|
||||
'js' => 'application/x-javascript',
|
||||
'swf' => 'application/x-shockwave-flash',
|
||||
'sit' => 'application/x-stuffit',
|
||||
'tar' => 'application/x-tar',
|
||||
'tgz' => 'application/x-tar',
|
||||
'xhtml' => 'application/xhtml+xml',
|
||||
'xht' => 'application/xhtml+xml',
|
||||
'zip' => 'application/zip',
|
||||
'mid' => 'audio/midi',
|
||||
'midi' => 'audio/midi',
|
||||
'mpga' => 'audio/mpeg',
|
||||
'mp2' => 'audio/mpeg',
|
||||
'mp3' => 'audio/mpeg',
|
||||
'aif' => 'audio/x-aiff',
|
||||
'aiff' => 'audio/x-aiff',
|
||||
'aifc' => 'audio/x-aiff',
|
||||
'ram' => 'audio/x-pn-realaudio',
|
||||
'rm' => 'audio/x-pn-realaudio',
|
||||
'rpm' => 'audio/x-pn-realaudio-plugin',
|
||||
'ra' => 'audio/x-realaudio',
|
||||
'rv' => 'video/vnd.rn-realvideo',
|
||||
'wav' => 'audio/x-wav',
|
||||
'bmp' => 'image/bmp',
|
||||
'gif' => 'image/gif',
|
||||
'jpeg' => 'image/jpeg',
|
||||
'jpg' => 'image/jpeg',
|
||||
'jpe' => 'image/jpeg',
|
||||
'png' => 'image/png',
|
||||
'tiff' => 'image/tiff',
|
||||
'tif' => 'image/tiff',
|
||||
'css' => 'text/css',
|
||||
'html' => 'text/html',
|
||||
'htm' => 'text/html',
|
||||
'shtml' => 'text/html',
|
||||
'txt' => 'text/plain',
|
||||
'text' => 'text/plain',
|
||||
'log' => 'text/plain',
|
||||
'rtx' => 'text/richtext',
|
||||
'rtf' => 'text/rtf',
|
||||
'xml' => 'text/xml',
|
||||
'xsl' => 'text/xml',
|
||||
'mpeg' => 'video/mpeg',
|
||||
'mpg' => 'video/mpeg',
|
||||
'mpe' => 'video/mpeg',
|
||||
'qt' => 'video/quicktime',
|
||||
'mov' => 'video/quicktime',
|
||||
'avi' => 'video/x-msvideo',
|
||||
'movie' => 'video/x-sgi-movie',
|
||||
'doc' => 'application/msword',
|
||||
'word' => 'application/msword',
|
||||
'xl' => 'application/excel',
|
||||
'eml' => 'message/rfc822'
|
||||
);
|
||||
return (!isset($mimes[strtolower($ext)])) ? 'application/octet-stream' : $mimes[strtolower($ext)];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set (or reset) Class Objects (variables)
|
||||
*
|
||||
* Usage Example:
|
||||
* $page->set('X-Priority', '3');
|
||||
*
|
||||
* @access public
|
||||
* @param string $name Parameter Name
|
||||
* @param mixed $value Parameter Value
|
||||
* NOTE: will not work with arrays, there are no arrays to set/reset
|
||||
* @todo Should this not be using __set() magic function?
|
||||
*/
|
||||
public function set($name, $value = '') {
|
||||
try {
|
||||
if (isset($this->$name) ) {
|
||||
$this->$name = $value;
|
||||
} else {
|
||||
throw new phpmailerException($this->Lang('variable_set') . $name, self::STOP_CRITICAL);
|
||||
}
|
||||
} catch (Exception $e) {
|
||||
$this->SetError($e->getMessage());
|
||||
if ($e->getCode() == self::STOP_CRITICAL) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Strips newlines to prevent header injection.
|
||||
* @access public
|
||||
* @param string $str String
|
||||
* @return string
|
||||
*/
|
||||
public function SecureHeader($str) {
|
||||
$str = str_replace("\r", '', $str);
|
||||
$str = str_replace("\n", '', $str);
|
||||
return trim($str);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the private key file and password to sign the message.
|
||||
*
|
||||
* @access public
|
||||
* @param string $key_filename Parameter File Name
|
||||
* @param string $key_pass Password for private key
|
||||
*/
|
||||
public function Sign($cert_filename, $key_filename, $key_pass) {
|
||||
$this->sign_cert_file = $cert_filename;
|
||||
$this->sign_key_file = $key_filename;
|
||||
$this->sign_key_pass = $key_pass;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the private key file and password to sign the message.
|
||||
*
|
||||
* @access public
|
||||
* @param string $key_filename Parameter File Name
|
||||
* @param string $key_pass Password for private key
|
||||
*/
|
||||
public function DKIM_QP($txt) {
|
||||
$tmp = '';
|
||||
$line = '';
|
||||
for ($i = 0; $i < strlen($txt); $i++) {
|
||||
$ord = ord($txt[$i]);
|
||||
if ( ((0x21 <= $ord) && ($ord <= 0x3A)) || $ord == 0x3C || ((0x3E <= $ord) && ($ord <= 0x7E)) ) {
|
||||
$line .= $txt[$i];
|
||||
} else {
|
||||
$line .= "=".sprintf("%02X", $ord);
|
||||
}
|
||||
}
|
||||
return $line;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate DKIM signature
|
||||
*
|
||||
* @access public
|
||||
* @param string $s Header
|
||||
*/
|
||||
public function DKIM_Sign($s) {
|
||||
$privKeyStr = file_get_contents($this->DKIM_private);
|
||||
if ($this->DKIM_passphrase != '') {
|
||||
$privKey = openssl_pkey_get_private($privKeyStr, $this->DKIM_passphrase);
|
||||
} else {
|
||||
$privKey = $privKeyStr;
|
||||
}
|
||||
if (openssl_sign($s, $signature, $privKey)) {
|
||||
return base64_encode($signature);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate DKIM Canonicalization Header
|
||||
*
|
||||
* @access public
|
||||
* @param string $s Header
|
||||
*/
|
||||
public function DKIM_HeaderC($s) {
|
||||
$s = preg_replace("/\r\n\s+/", " ", $s);
|
||||
$lines = explode("\r\n", $s);
|
||||
foreach ($lines as $key => $line) {
|
||||
list($heading, $value) = explode(":", $line, 2);
|
||||
$heading = strtolower($heading);
|
||||
$value = preg_replace("/\s+/", " ", $value) ; // Compress useless spaces
|
||||
$lines[$key] = $heading.":".trim($value) ; // Don't forget to remove WSP around the value
|
||||
}
|
||||
$s = implode("\r\n", $lines);
|
||||
return $s;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate DKIM Canonicalization Body
|
||||
*
|
||||
* @access public
|
||||
* @param string $body Message Body
|
||||
*/
|
||||
public function DKIM_BodyC($body) {
|
||||
if ($body == '') return "\r\n";
|
||||
// stabilize line endings
|
||||
$body = str_replace("\r\n", "\n", $body);
|
||||
$body = str_replace("\n", "\r\n", $body);
|
||||
// END stabilize line endings
|
||||
while (substr($body, strlen($body) - 4, 4) == "\r\n\r\n") {
|
||||
$body = substr($body, 0, strlen($body) - 2);
|
||||
}
|
||||
return $body;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the DKIM header, body, as new header
|
||||
*
|
||||
* @access public
|
||||
* @param string $headers_line Header lines
|
||||
* @param string $subject Subject
|
||||
* @param string $body Body
|
||||
*/
|
||||
public function DKIM_Add($headers_line, $subject, $body) {
|
||||
$DKIMsignatureType = 'rsa-sha1'; // Signature & hash algorithms
|
||||
$DKIMcanonicalization = 'relaxed/simple'; // Canonicalization of header/body
|
||||
$DKIMquery = 'dns/txt'; // Query method
|
||||
$DKIMtime = time() ; // Signature Timestamp = seconds since 00:00:00 - Jan 1, 1970 (UTC time zone)
|
||||
$subject_header = "Subject: $subject";
|
||||
$headers = explode($this->LE, $headers_line);
|
||||
foreach($headers as $header) {
|
||||
if (strpos($header, 'From:') === 0) {
|
||||
$from_header = $header;
|
||||
} elseif (strpos($header, 'To:') === 0) {
|
||||
$to_header = $header;
|
||||
}
|
||||
}
|
||||
$from = str_replace('|', '=7C', $this->DKIM_QP($from_header));
|
||||
$to = str_replace('|', '=7C', $this->DKIM_QP($to_header));
|
||||
$subject = str_replace('|', '=7C', $this->DKIM_QP($subject_header)) ; // Copied header fields (dkim-quoted-printable
|
||||
$body = $this->DKIM_BodyC($body);
|
||||
$DKIMlen = strlen($body) ; // Length of body
|
||||
$DKIMb64 = base64_encode(pack("H*", sha1($body))) ; // Base64 of packed binary SHA-1 hash of body
|
||||
$ident = ($this->DKIM_identity == '')? '' : " i=" . $this->DKIM_identity . ";";
|
||||
$dkimhdrs = "DKIM-Signature: v=1; a=" . $DKIMsignatureType . "; q=" . $DKIMquery . "; l=" . $DKIMlen . "; s=" . $this->DKIM_selector . ";\r\n".
|
||||
"\tt=" . $DKIMtime . "; c=" . $DKIMcanonicalization . ";\r\n".
|
||||
"\th=From:To:Subject;\r\n".
|
||||
"\td=" . $this->DKIM_domain . ";" . $ident . "\r\n".
|
||||
"\tz=$from\r\n".
|
||||
"\t|$to\r\n".
|
||||
"\t|$subject;\r\n".
|
||||
"\tbh=" . $DKIMb64 . ";\r\n".
|
||||
"\tb=";
|
||||
$toSign = $this->DKIM_HeaderC($from_header . "\r\n" . $to_header . "\r\n" . $subject_header . "\r\n" . $dkimhdrs);
|
||||
$signed = $this->DKIM_Sign($toSign);
|
||||
return "X-PHPMAILER-DKIM: phpmailer.worxware.com\r\n".$dkimhdrs.$signed."\r\n";
|
||||
}
|
||||
|
||||
protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body) {
|
||||
if (!empty($this->action_function) && function_exists($this->action_function)) {
|
||||
$params = array($isSent, $to, $cc, $bcc, $subject, $body);
|
||||
call_user_func_array($this->action_function, $params);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class phpmailerException extends Exception {
|
||||
public function errorMessage() {
|
||||
$errorMsg = '<strong>' . $this->getMessage() . "</strong><br />\n";
|
||||
return $errorMsg;
|
||||
}
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,410 @@
|
||||
<?php
|
||||
/*~ class.pop3.php
|
||||
.---------------------------------------------------------------------------.
|
||||
| Software: PHPMailer - PHP email class |
|
||||
| Version: 5.2 |
|
||||
| Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ |
|
||||
| ------------------------------------------------------------------------- |
|
||||
| Admin: Jim Jagielski (project admininistrator) |
|
||||
| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net |
|
||||
| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
|
||||
| : Jim Jagielski (jimjag) jimjag@gmail.com |
|
||||
| Founder: Brent R. Matzelle (original founder) |
|
||||
| Copyright (c) 2010-2011, Jim Jagielski. All Rights Reserved. |
|
||||
| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
|
||||
| Copyright (c) 2001-2003, Brent R. Matzelle |
|
||||
| ------------------------------------------------------------------------- |
|
||||
| License: Distributed under the Lesser General Public License (LGPL) |
|
||||
| http://www.gnu.org/copyleft/lesser.html |
|
||||
| This program is distributed in the hope that it will be useful - WITHOUT |
|
||||
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
||||
| FITNESS FOR A PARTICULAR PURPOSE. |
|
||||
'---------------------------------------------------------------------------'
|
||||
*/
|
||||
|
||||
/**
|
||||
* PHPMailer - PHP POP Before SMTP Authentication Class
|
||||
* NOTE: Designed for use with PHP version 5 and up
|
||||
* @package PHPMailer
|
||||
* @author Andy Prevost
|
||||
* @author Marcus Bointon
|
||||
* @author Jim Jagielski
|
||||
* @copyright 2010 - 2011 Jim Jagielski
|
||||
* @copyright 2004 - 2009 Andy Prevost
|
||||
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
|
||||
* @version $Id: class.pop3.php 450 2010-06-23 16:46:33Z coolbru $
|
||||
*/
|
||||
|
||||
/**
|
||||
* POP Before SMTP Authentication Class
|
||||
* Version 5.2.0
|
||||
*
|
||||
* Author: Richard Davey (rich@corephp.co.uk)
|
||||
* Modifications: Andy Prevost
|
||||
* License: LGPL, see PHPMailer License
|
||||
*
|
||||
* Specifically for PHPMailer to allow POP before SMTP authentication.
|
||||
* Does not yet work with APOP - if you have an APOP account, contact Richard Davey
|
||||
* and we can test changes to this script.
|
||||
*
|
||||
* This class is based on the structure of the SMTP class originally authored by Chris Ryan
|
||||
*
|
||||
* This class is rfc 1939 compliant and implements all the commands
|
||||
* required for POP3 connection, authentication and disconnection.
|
||||
*
|
||||
* @package PHPMailer
|
||||
* @author Richard Davey
|
||||
*/
|
||||
|
||||
class POP3 {
|
||||
/**
|
||||
* Default POP3 port
|
||||
* @var int
|
||||
*/
|
||||
public $POP3_PORT = 110;
|
||||
|
||||
/**
|
||||
* Default Timeout
|
||||
* @var int
|
||||
*/
|
||||
public $POP3_TIMEOUT = 30;
|
||||
|
||||
/**
|
||||
* POP3 Carriage Return + Line Feed
|
||||
* @var string
|
||||
*/
|
||||
public $CRLF = "\r\n";
|
||||
|
||||
/**
|
||||
* Displaying Debug warnings? (0 = now, 1+ = yes)
|
||||
* @var int
|
||||
*/
|
||||
public $do_debug = 2;
|
||||
|
||||
/**
|
||||
* POP3 Mail Server
|
||||
* @var string
|
||||
*/
|
||||
public $host;
|
||||
|
||||
/**
|
||||
* POP3 Port
|
||||
* @var int
|
||||
*/
|
||||
public $port;
|
||||
|
||||
/**
|
||||
* POP3 Timeout Value
|
||||
* @var int
|
||||
*/
|
||||
public $tval;
|
||||
|
||||
/**
|
||||
* POP3 Username
|
||||
* @var string
|
||||
*/
|
||||
public $username;
|
||||
|
||||
/**
|
||||
* POP3 Password
|
||||
* @var string
|
||||
*/
|
||||
public $password;
|
||||
|
||||
/**
|
||||
* Sets the POP3 PHPMailer Version number
|
||||
* @var string
|
||||
*/
|
||||
public $Version = '5.2';
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// PROPERTIES, PRIVATE AND PROTECTED
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
private $pop_conn;
|
||||
private $connected;
|
||||
private $error; // Error log array
|
||||
|
||||
/**
|
||||
* Constructor, sets the initial values
|
||||
* @access public
|
||||
* @return POP3
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->pop_conn = 0;
|
||||
$this->connected = false;
|
||||
$this->error = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Combination of public events - connect, login, disconnect
|
||||
* @access public
|
||||
* @param string $host
|
||||
* @param integer $port
|
||||
* @param integer $tval
|
||||
* @param string $username
|
||||
* @param string $password
|
||||
*/
|
||||
public function Authorise ($host, $port = false, $tval = false, $username, $password, $debug_level = 0) {
|
||||
$this->host = $host;
|
||||
|
||||
// If no port value is passed, retrieve it
|
||||
if ($port == false) {
|
||||
$this->port = $this->POP3_PORT;
|
||||
} else {
|
||||
$this->port = $port;
|
||||
}
|
||||
|
||||
// If no port value is passed, retrieve it
|
||||
if ($tval == false) {
|
||||
$this->tval = $this->POP3_TIMEOUT;
|
||||
} else {
|
||||
$this->tval = $tval;
|
||||
}
|
||||
|
||||
$this->do_debug = $debug_level;
|
||||
$this->username = $username;
|
||||
$this->password = $password;
|
||||
|
||||
// Refresh the error log
|
||||
$this->error = null;
|
||||
|
||||
// Connect
|
||||
$result = $this->Connect($this->host, $this->port, $this->tval);
|
||||
|
||||
if ($result) {
|
||||
$login_result = $this->Login($this->username, $this->password);
|
||||
|
||||
if ($login_result) {
|
||||
$this->Disconnect();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// We need to disconnect regardless if the login succeeded
|
||||
$this->Disconnect();
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Connect to the POP3 server
|
||||
* @access public
|
||||
* @param string $host
|
||||
* @param integer $port
|
||||
* @param integer $tval
|
||||
* @return boolean
|
||||
*/
|
||||
public function Connect ($host, $port = false, $tval = 30) {
|
||||
// Are we already connected?
|
||||
if ($this->connected) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
On Windows this will raise a PHP Warning error if the hostname doesn't exist.
|
||||
Rather than supress it with @fsockopen, let's capture it cleanly instead
|
||||
*/
|
||||
|
||||
set_error_handler(array(&$this, 'catchWarning'));
|
||||
|
||||
// Connect to the POP3 server
|
||||
$this->pop_conn = fsockopen($host, // POP3 Host
|
||||
$port, // Port #
|
||||
$errno, // Error Number
|
||||
$errstr, // Error Message
|
||||
$tval); // Timeout (seconds)
|
||||
|
||||
// Restore the error handler
|
||||
restore_error_handler();
|
||||
|
||||
// Does the Error Log now contain anything?
|
||||
if ($this->error && $this->do_debug >= 1) {
|
||||
$this->displayErrors();
|
||||
}
|
||||
|
||||
// Did we connect?
|
||||
if ($this->pop_conn == false) {
|
||||
// It would appear not...
|
||||
$this->error = array(
|
||||
'error' => "Failed to connect to server $host on port $port",
|
||||
'errno' => $errno,
|
||||
'errstr' => $errstr
|
||||
);
|
||||
|
||||
if ($this->do_debug >= 1) {
|
||||
$this->displayErrors();
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
// Increase the stream time-out
|
||||
|
||||
// Check for PHP 4.3.0 or later
|
||||
if (version_compare(phpversion(), '5.0.0', 'ge')) {
|
||||
stream_set_timeout($this->pop_conn, $tval, 0);
|
||||
} else {
|
||||
// Does not work on Windows
|
||||
if (substr(PHP_OS, 0, 3) !== 'WIN') {
|
||||
socket_set_timeout($this->pop_conn, $tval, 0);
|
||||
}
|
||||
}
|
||||
|
||||
// Get the POP3 server response
|
||||
$pop3_response = $this->getResponse();
|
||||
|
||||
// Check for the +OK
|
||||
if ($this->checkResponse($pop3_response)) {
|
||||
// The connection is established and the POP3 server is talking
|
||||
$this->connected = true;
|
||||
return true;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Login to the POP3 server (does not support APOP yet)
|
||||
* @access public
|
||||
* @param string $username
|
||||
* @param string $password
|
||||
* @return boolean
|
||||
*/
|
||||
public function Login ($username = '', $password = '') {
|
||||
if ($this->connected == false) {
|
||||
$this->error = 'Not connected to POP3 server';
|
||||
|
||||
if ($this->do_debug >= 1) {
|
||||
$this->displayErrors();
|
||||
}
|
||||
}
|
||||
|
||||
if (empty($username)) {
|
||||
$username = $this->username;
|
||||
}
|
||||
|
||||
if (empty($password)) {
|
||||
$password = $this->password;
|
||||
}
|
||||
|
||||
$pop_username = "USER $username" . $this->CRLF;
|
||||
$pop_password = "PASS $password" . $this->CRLF;
|
||||
|
||||
// Send the Username
|
||||
$this->sendString($pop_username);
|
||||
$pop3_response = $this->getResponse();
|
||||
|
||||
if ($this->checkResponse($pop3_response)) {
|
||||
// Send the Password
|
||||
$this->sendString($pop_password);
|
||||
$pop3_response = $this->getResponse();
|
||||
|
||||
if ($this->checkResponse($pop3_response)) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect from the POP3 server
|
||||
* @access public
|
||||
*/
|
||||
public function Disconnect () {
|
||||
$this->sendString('QUIT');
|
||||
|
||||
fclose($this->pop_conn);
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// Private Methods
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Get the socket response back.
|
||||
* $size is the maximum number of bytes to retrieve
|
||||
* @access private
|
||||
* @param integer $size
|
||||
* @return string
|
||||
*/
|
||||
private function getResponse ($size = 128) {
|
||||
$pop3_response = fgets($this->pop_conn, $size);
|
||||
|
||||
return $pop3_response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a string down the open socket connection to the POP3 server
|
||||
* @access private
|
||||
* @param string $string
|
||||
* @return integer
|
||||
*/
|
||||
private function sendString ($string) {
|
||||
$bytes_sent = fwrite($this->pop_conn, $string, strlen($string));
|
||||
|
||||
return $bytes_sent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the POP3 server response for +OK or -ERR
|
||||
* @access private
|
||||
* @param string $string
|
||||
* @return boolean
|
||||
*/
|
||||
private function checkResponse ($string) {
|
||||
if (substr($string, 0, 3) !== '+OK') {
|
||||
$this->error = array(
|
||||
'error' => "Server reported an error: $string",
|
||||
'errno' => 0,
|
||||
'errstr' => ''
|
||||
);
|
||||
|
||||
if ($this->do_debug >= 1) {
|
||||
$this->displayErrors();
|
||||
}
|
||||
|
||||
return false;
|
||||
} else {
|
||||
return true;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* If debug is enabled, display the error message array
|
||||
* @access private
|
||||
*/
|
||||
private function displayErrors () {
|
||||
echo '<pre>';
|
||||
|
||||
foreach ($this->error as $single_error) {
|
||||
print_r($single_error);
|
||||
}
|
||||
|
||||
echo '</pre>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes over from PHP for the socket warning handler
|
||||
* @access private
|
||||
* @param integer $errno
|
||||
* @param string $errstr
|
||||
* @param string $errfile
|
||||
* @param integer $errline
|
||||
*/
|
||||
private function catchWarning ($errno, $errstr, $errfile, $errline) {
|
||||
$this->error[] = array(
|
||||
'error' => "Connecting to the POP3 server raised a PHP warning: ",
|
||||
'errno' => $errno,
|
||||
'errstr' => $errstr
|
||||
);
|
||||
}
|
||||
|
||||
// End of class
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,817 @@
|
||||
<?php
|
||||
/*~ class.smtp.php
|
||||
.---------------------------------------------------------------------------.
|
||||
| Software: PHPMailer - PHP email class |
|
||||
| Version: 5.2 |
|
||||
| Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ |
|
||||
| ------------------------------------------------------------------------- |
|
||||
| Admin: Jim Jagielski (project admininistrator) |
|
||||
| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net |
|
||||
| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
|
||||
| : Jim Jagielski (jimjag) jimjag@gmail.com |
|
||||
| Founder: Brent R. Matzelle (original founder) |
|
||||
| Copyright (c) 2010-2011, Jim Jagielski. All Rights Reserved. |
|
||||
| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
|
||||
| Copyright (c) 2001-2003, Brent R. Matzelle |
|
||||
| ------------------------------------------------------------------------- |
|
||||
| License: Distributed under the Lesser General Public License (LGPL) |
|
||||
| http://www.gnu.org/copyleft/lesser.html |
|
||||
| This program is distributed in the hope that it will be useful - WITHOUT |
|
||||
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
||||
| FITNESS FOR A PARTICULAR PURPOSE. |
|
||||
'---------------------------------------------------------------------------'
|
||||
*/
|
||||
|
||||
/**
|
||||
* PHPMailer - PHP SMTP email transport class
|
||||
* NOTE: Designed for use with PHP version 5 and up
|
||||
* @package PHPMailer
|
||||
* @author Andy Prevost
|
||||
* @author Marcus Bointon
|
||||
* @copyright 2004 - 2008 Andy Prevost
|
||||
* @author Jim Jagielski
|
||||
* @copyright 2010 - 2011 Jim Jagielski
|
||||
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
|
||||
* @version $Id: class.smtp.php 450 2010-06-23 16:46:33Z coolbru $
|
||||
*/
|
||||
|
||||
/**
|
||||
* SMTP is rfc 821 compliant and implements all the rfc 821 SMTP
|
||||
* commands except TURN which will always return a not implemented
|
||||
* error. SMTP also provides some utility methods for sending mail
|
||||
* to an SMTP server.
|
||||
* original author: Chris Ryan
|
||||
*/
|
||||
|
||||
class SMTP {
|
||||
/**
|
||||
* SMTP server port
|
||||
* @var int
|
||||
*/
|
||||
public $SMTP_PORT = 25;
|
||||
|
||||
/**
|
||||
* SMTP reply line ending
|
||||
* @var string
|
||||
*/
|
||||
public $CRLF = "\r\n";
|
||||
|
||||
/**
|
||||
* Sets whether debugging is turned on
|
||||
* @var bool
|
||||
*/
|
||||
public $do_debug; // the level of debug to perform
|
||||
|
||||
/**
|
||||
* Sets VERP use on/off (default is off)
|
||||
* @var bool
|
||||
*/
|
||||
public $do_verp = false;
|
||||
|
||||
/**
|
||||
* Sets the SMTP PHPMailer Version number
|
||||
* @var string
|
||||
*/
|
||||
public $Version = '5.2';
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// PROPERTIES, PRIVATE AND PROTECTED
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
private $smtp_conn; // the socket to the server
|
||||
private $error; // error if any on the last call
|
||||
private $helo_rply; // the reply the server sent to us for HELO
|
||||
|
||||
/**
|
||||
* Initialize the class so that the data is in a known state.
|
||||
* @access public
|
||||
* @return void
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->smtp_conn = 0;
|
||||
$this->error = null;
|
||||
$this->helo_rply = null;
|
||||
|
||||
$this->do_debug = 0;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// CONNECTION FUNCTIONS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Connect to the server specified on the port specified.
|
||||
* If the port is not specified use the default SMTP_PORT.
|
||||
* If tval is specified then a connection will try and be
|
||||
* established with the server for that number of seconds.
|
||||
* If tval is not specified the default is 30 seconds to
|
||||
* try on the connection.
|
||||
*
|
||||
* SMTP CODE SUCCESS: 220
|
||||
* SMTP CODE FAILURE: 421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Connect($host, $port = 0, $tval = 30) {
|
||||
// set the error val to null so there is no confusion
|
||||
$this->error = null;
|
||||
|
||||
// make sure we are __not__ connected
|
||||
if($this->connected()) {
|
||||
// already connected, generate error
|
||||
$this->error = array("error" => "Already connected to a server");
|
||||
return false;
|
||||
}
|
||||
|
||||
if(empty($port)) {
|
||||
$port = $this->SMTP_PORT;
|
||||
}
|
||||
|
||||
// connect to the smtp server
|
||||
$this->smtp_conn = @fsockopen($host, // the host of the server
|
||||
$port, // the port to use
|
||||
$errno, // error number if any
|
||||
$errstr, // error message if any
|
||||
$tval); // give up after ? secs
|
||||
// verify we connected properly
|
||||
if(empty($this->smtp_conn)) {
|
||||
$this->error = array("error" => "Failed to connect to server",
|
||||
"errno" => $errno,
|
||||
"errstr" => $errstr);
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": $errstr ($errno)" . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// SMTP server can take longer to respond, give longer timeout for first read
|
||||
// Windows does not have support for this timeout function
|
||||
if(substr(PHP_OS, 0, 3) != "WIN")
|
||||
socket_set_timeout($this->smtp_conn, $tval, 0);
|
||||
|
||||
// get any announcement
|
||||
$announce = $this->get_lines();
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $announce . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initiate a TLS communication with the server.
|
||||
*
|
||||
* SMTP CODE 220 Ready to start TLS
|
||||
* SMTP CODE 501 Syntax error (no parameters allowed)
|
||||
* SMTP CODE 454 TLS not available due to temporary reason
|
||||
* @access public
|
||||
* @return bool success
|
||||
*/
|
||||
public function StartTLS() {
|
||||
$this->error = null; # to avoid confusion
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array("error" => "Called StartTLS() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
fputs($this->smtp_conn,"STARTTLS" . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 220) {
|
||||
$this->error =
|
||||
array("error" => "STARTTLS not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// Begin encrypted connection
|
||||
if(!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs SMTP authentication. Must be run after running the
|
||||
* Hello() method. Returns true if successfully authenticated.
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Authenticate($username, $password) {
|
||||
// Start authentication
|
||||
fputs($this->smtp_conn,"AUTH LOGIN" . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($code != 334) {
|
||||
$this->error =
|
||||
array("error" => "AUTH not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// Send encoded username
|
||||
fputs($this->smtp_conn, base64_encode($username) . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($code != 334) {
|
||||
$this->error =
|
||||
array("error" => "Username not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// Send encoded password
|
||||
fputs($this->smtp_conn, base64_encode($password) . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($code != 235) {
|
||||
$this->error =
|
||||
array("error" => "Password not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if connected to a server otherwise false
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Connected() {
|
||||
if(!empty($this->smtp_conn)) {
|
||||
$sock_status = socket_get_status($this->smtp_conn);
|
||||
if($sock_status["eof"]) {
|
||||
// the socket is valid but we are not connected
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> NOTICE:" . $this->CRLF . "EOF caught while checking if connected";
|
||||
}
|
||||
$this->Close();
|
||||
return false;
|
||||
}
|
||||
return true; // everything looks good
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the socket and cleans up the state of the class.
|
||||
* It is not considered good to use this function without
|
||||
* first trying to use QUIT.
|
||||
* @access public
|
||||
* @return void
|
||||
*/
|
||||
public function Close() {
|
||||
$this->error = null; // so there is no confusion
|
||||
$this->helo_rply = null;
|
||||
if(!empty($this->smtp_conn)) {
|
||||
// close the connection and cleanup
|
||||
fclose($this->smtp_conn);
|
||||
$this->smtp_conn = 0;
|
||||
}
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// SMTP COMMANDS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Issues a data command and sends the msg_data to the server
|
||||
* finializing the mail transaction. $msg_data is the message
|
||||
* that is to be send with the headers. Each header needs to be
|
||||
* on a single line followed by a <CRLF> with the message headers
|
||||
* and the message body being seperated by and additional <CRLF>.
|
||||
*
|
||||
* Implements rfc 821: DATA <CRLF>
|
||||
*
|
||||
* SMTP CODE INTERMEDIATE: 354
|
||||
* [data]
|
||||
* <CRLF>.<CRLF>
|
||||
* SMTP CODE SUCCESS: 250
|
||||
* SMTP CODE FAILURE: 552,554,451,452
|
||||
* SMTP CODE FAILURE: 451,554
|
||||
* SMTP CODE ERROR : 500,501,503,421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Data($msg_data) {
|
||||
$this->error = null; // so no confusion is caused
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called Data() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
fputs($this->smtp_conn,"DATA" . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 354) {
|
||||
$this->error =
|
||||
array("error" => "DATA command not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/* the server is ready to accept data!
|
||||
* according to rfc 821 we should not send more than 1000
|
||||
* including the CRLF
|
||||
* characters on a single line so we will break the data up
|
||||
* into lines by \r and/or \n then if needed we will break
|
||||
* each of those into smaller lines to fit within the limit.
|
||||
* in addition we will be looking for lines that start with
|
||||
* a period '.' and append and additional period '.' to that
|
||||
* line. NOTE: this does not count towards limit.
|
||||
*/
|
||||
|
||||
// normalize the line breaks so we know the explode works
|
||||
$msg_data = str_replace("\r\n","\n",$msg_data);
|
||||
$msg_data = str_replace("\r","\n",$msg_data);
|
||||
$lines = explode("\n",$msg_data);
|
||||
|
||||
/* we need to find a good way to determine is headers are
|
||||
* in the msg_data or if it is a straight msg body
|
||||
* currently I am assuming rfc 822 definitions of msg headers
|
||||
* and if the first field of the first line (':' sperated)
|
||||
* does not contain a space then it _should_ be a header
|
||||
* and we can process all lines before a blank "" line as
|
||||
* headers.
|
||||
*/
|
||||
|
||||
$field = substr($lines[0],0,strpos($lines[0],":"));
|
||||
$in_headers = false;
|
||||
if(!empty($field) && !strstr($field," ")) {
|
||||
$in_headers = true;
|
||||
}
|
||||
|
||||
$max_line_length = 998; // used below; set here for ease in change
|
||||
|
||||
while(list(,$line) = @each($lines)) {
|
||||
$lines_out = null;
|
||||
if($line == "" && $in_headers) {
|
||||
$in_headers = false;
|
||||
}
|
||||
// ok we need to break this line up into several smaller lines
|
||||
while(strlen($line) > $max_line_length) {
|
||||
$pos = strrpos(substr($line,0,$max_line_length)," ");
|
||||
|
||||
// Patch to fix DOS attack
|
||||
if(!$pos) {
|
||||
$pos = $max_line_length - 1;
|
||||
$lines_out[] = substr($line,0,$pos);
|
||||
$line = substr($line,$pos);
|
||||
} else {
|
||||
$lines_out[] = substr($line,0,$pos);
|
||||
$line = substr($line,$pos + 1);
|
||||
}
|
||||
|
||||
/* if processing headers add a LWSP-char to the front of new line
|
||||
* rfc 822 on long msg headers
|
||||
*/
|
||||
if($in_headers) {
|
||||
$line = "\t" . $line;
|
||||
}
|
||||
}
|
||||
$lines_out[] = $line;
|
||||
|
||||
// send the lines to the server
|
||||
while(list(,$line_out) = @each($lines_out)) {
|
||||
if(strlen($line_out) > 0)
|
||||
{
|
||||
if(substr($line_out, 0, 1) == ".") {
|
||||
$line_out = "." . $line_out;
|
||||
}
|
||||
}
|
||||
fputs($this->smtp_conn,$line_out . $this->CRLF);
|
||||
}
|
||||
}
|
||||
|
||||
// message data has been sent
|
||||
fputs($this->smtp_conn, $this->CRLF . "." . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 250) {
|
||||
$this->error =
|
||||
array("error" => "DATA not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends the HELO command to the smtp server.
|
||||
* This makes sure that we and the server are in
|
||||
* the same known state.
|
||||
*
|
||||
* Implements from rfc 821: HELO <SP> <domain> <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 250
|
||||
* SMTP CODE ERROR : 500, 501, 504, 421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Hello($host = '') {
|
||||
$this->error = null; // so no confusion is caused
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called Hello() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
// if hostname for HELO was not specified send default
|
||||
if(empty($host)) {
|
||||
// determine appropriate default to send to server
|
||||
$host = "localhost";
|
||||
}
|
||||
|
||||
// Send extended hello first (RFC 2821)
|
||||
if(!$this->SendHello("EHLO", $host)) {
|
||||
if(!$this->SendHello("HELO", $host)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a HELO/EHLO command.
|
||||
* @access private
|
||||
* @return bool
|
||||
*/
|
||||
private function SendHello($hello, $host) {
|
||||
fputs($this->smtp_conn, $hello . " " . $host . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER: " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 250) {
|
||||
$this->error =
|
||||
array("error" => $hello . " not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->helo_rply = $rply;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts a mail transaction from the email address specified in
|
||||
* $from. Returns true if successful or false otherwise. If True
|
||||
* the mail transaction is started and then one or more Recipient
|
||||
* commands may be called followed by a Data command.
|
||||
*
|
||||
* Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 250
|
||||
* SMTP CODE SUCCESS: 552,451,452
|
||||
* SMTP CODE SUCCESS: 500,501,421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Mail($from) {
|
||||
$this->error = null; // so no confusion is caused
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called Mail() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
$useVerp = ($this->do_verp ? "XVERP" : "");
|
||||
fputs($this->smtp_conn,"MAIL FROM:<" . $from . ">" . $useVerp . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 250) {
|
||||
$this->error =
|
||||
array("error" => "MAIL not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends the quit command to the server and then closes the socket
|
||||
* if there is no error or the $close_on_error argument is true.
|
||||
*
|
||||
* Implements from rfc 821: QUIT <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 221
|
||||
* SMTP CODE ERROR : 500
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Quit($close_on_error = true) {
|
||||
$this->error = null; // so there is no confusion
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called Quit() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
// send the quit command to the server
|
||||
fputs($this->smtp_conn,"quit" . $this->CRLF);
|
||||
|
||||
// get any good-bye messages
|
||||
$byemsg = $this->get_lines();
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $byemsg . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
$rval = true;
|
||||
$e = null;
|
||||
|
||||
$code = substr($byemsg,0,3);
|
||||
if($code != 221) {
|
||||
// use e as a tmp var cause Close will overwrite $this->error
|
||||
$e = array("error" => "SMTP server rejected quit command",
|
||||
"smtp_code" => $code,
|
||||
"smtp_rply" => substr($byemsg,4));
|
||||
$rval = false;
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $e["error"] . ": " . $byemsg . $this->CRLF . '<br />';
|
||||
}
|
||||
}
|
||||
|
||||
if(empty($e) || $close_on_error) {
|
||||
$this->Close();
|
||||
}
|
||||
|
||||
return $rval;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends the command RCPT to the SMTP server with the TO: argument of $to.
|
||||
* Returns true if the recipient was accepted false if it was rejected.
|
||||
*
|
||||
* Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 250,251
|
||||
* SMTP CODE FAILURE: 550,551,552,553,450,451,452
|
||||
* SMTP CODE ERROR : 500,501,503,421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Recipient($to) {
|
||||
$this->error = null; // so no confusion is caused
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called Recipient() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
fputs($this->smtp_conn,"RCPT TO:<" . $to . ">" . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 250 && $code != 251) {
|
||||
$this->error =
|
||||
array("error" => "RCPT not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends the RSET command to abort and transaction that is
|
||||
* currently in progress. Returns true if successful false
|
||||
* otherwise.
|
||||
*
|
||||
* Implements rfc 821: RSET <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 250
|
||||
* SMTP CODE ERROR : 500,501,504,421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Reset() {
|
||||
$this->error = null; // so no confusion is caused
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called Reset() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
fputs($this->smtp_conn,"RSET" . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 250) {
|
||||
$this->error =
|
||||
array("error" => "RSET failed",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts a mail transaction from the email address specified in
|
||||
* $from. Returns true if successful or false otherwise. If True
|
||||
* the mail transaction is started and then one or more Recipient
|
||||
* commands may be called followed by a Data command. This command
|
||||
* will send the message to the users terminal if they are logged
|
||||
* in and send them an email.
|
||||
*
|
||||
* Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 250
|
||||
* SMTP CODE SUCCESS: 552,451,452
|
||||
* SMTP CODE SUCCESS: 500,501,502,421
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function SendAndMail($from) {
|
||||
$this->error = null; // so no confusion is caused
|
||||
|
||||
if(!$this->connected()) {
|
||||
$this->error = array(
|
||||
"error" => "Called SendAndMail() without being connected");
|
||||
return false;
|
||||
}
|
||||
|
||||
fputs($this->smtp_conn,"SAML FROM:" . $from . $this->CRLF);
|
||||
|
||||
$rply = $this->get_lines();
|
||||
$code = substr($rply,0,3);
|
||||
|
||||
if($this->do_debug >= 2) {
|
||||
echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
|
||||
if($code != 250) {
|
||||
$this->error =
|
||||
array("error" => "SAML not accepted from server",
|
||||
"smtp_code" => $code,
|
||||
"smtp_msg" => substr($rply,4));
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* This is an optional command for SMTP that this class does not
|
||||
* support. This method is here to make the RFC821 Definition
|
||||
* complete for this class and __may__ be implimented in the future
|
||||
*
|
||||
* Implements from rfc 821: TURN <CRLF>
|
||||
*
|
||||
* SMTP CODE SUCCESS: 250
|
||||
* SMTP CODE FAILURE: 502
|
||||
* SMTP CODE ERROR : 500, 503
|
||||
* @access public
|
||||
* @return bool
|
||||
*/
|
||||
public function Turn() {
|
||||
$this->error = array("error" => "This method, TURN, of the SMTP ".
|
||||
"is not implemented");
|
||||
if($this->do_debug >= 1) {
|
||||
echo "SMTP -> NOTICE: " . $this->error["error"] . $this->CRLF . '<br />';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current error
|
||||
* @access public
|
||||
* @return array
|
||||
*/
|
||||
public function getError() {
|
||||
return $this->error;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////
|
||||
// INTERNAL FUNCTIONS
|
||||
/////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Read in as many lines as possible
|
||||
* either before eof or socket timeout occurs on the operation.
|
||||
* With SMTP we can tell if we have more lines to read if the
|
||||
* 4th character is '-' symbol. If it is a space then we don't
|
||||
* need to read anything else.
|
||||
* @access private
|
||||
* @return string
|
||||
*/
|
||||
private function get_lines() {
|
||||
$data = "";
|
||||
while($str = @fgets($this->smtp_conn,515)) {
|
||||
if($this->do_debug >= 4) {
|
||||
echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
|
||||
echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';
|
||||
}
|
||||
$data .= $str;
|
||||
if($this->do_debug >= 4) {
|
||||
echo "SMTP -> get_lines(): \$data is \"$data\"" . $this->CRLF . '<br />';
|
||||
}
|
||||
// if 4th character is a space, we are done reading, break the loop
|
||||
if(substr($str,3,1) == " ") { break; }
|
||||
}
|
||||
return $data;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,92 @@
|
||||
;; phpDocumentor parse configuration file
|
||||
;;
|
||||
;; This file is designed to cut down on repetitive typing on the command-line or web interface
|
||||
;; You can copy this file to create a number of configuration files that can be used with the
|
||||
;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini. The web
|
||||
;; interface will automatically generate a list of .ini files that can be used.
|
||||
;;
|
||||
;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs
|
||||
;;
|
||||
;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
|
||||
;;
|
||||
;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>
|
||||
;;
|
||||
;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them
|
||||
|
||||
[Parse Data]
|
||||
;; title of all the documentation
|
||||
;; legal values: any string
|
||||
title = PHPMailer Documentation
|
||||
|
||||
;; parse files that start with a . like .bash_profile
|
||||
;; legal values: true, false
|
||||
hidden = false
|
||||
|
||||
;; show elements marked @access private in documentation by setting this to on
|
||||
;; legal values: on, off
|
||||
parseprivate = on
|
||||
|
||||
;; parse with javadoc-like description (first sentence is always the short description)
|
||||
;; legal values: on, off
|
||||
javadocdesc = off
|
||||
|
||||
;; add any custom @tags separated by commas here
|
||||
;; legal values: any legal tagname separated by commas.
|
||||
;customtags = mytag1,mytag2
|
||||
|
||||
;; This is only used by the XML:DocBook/peardoc2 converter
|
||||
defaultcategoryname = Documentation
|
||||
|
||||
;; what is the main package?
|
||||
;; legal values: alphanumeric string plus - and _
|
||||
defaultpackagename = PHPMailer
|
||||
|
||||
;; output any parsing information? set to on for cron jobs
|
||||
;; legal values: on
|
||||
;quiet = on
|
||||
|
||||
;; parse a PEAR-style repository. Do not turn this on if your project does
|
||||
;; not have a parent directory named "pear"
|
||||
;; legal values: on/off
|
||||
;pear = on
|
||||
|
||||
;; where should the documentation be written?
|
||||
;; legal values: a legal path
|
||||
target = ./phpdoc
|
||||
|
||||
;; limit output to the specified packages, even if others are parsed
|
||||
;; legal values: package names separated by commas
|
||||
;packageoutput = package1,package2
|
||||
|
||||
;; comma-separated list of files to parse
|
||||
;; legal values: paths separated by commas
|
||||
;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
|
||||
filename = *.php
|
||||
|
||||
;; comma-separated list of directories to parse
|
||||
;; legal values: directory paths separated by commas
|
||||
;directory = /path1,/path2,.,..,subdirectory
|
||||
;directory = /home/jeichorn/cvs/pear
|
||||
;;directory = .
|
||||
|
||||
;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
|
||||
;templatebase = /path/to/my/templates
|
||||
|
||||
;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
|
||||
;; legal values: any wildcard strings separated by commas
|
||||
;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
|
||||
ignore = templates_c/,*HTML/default/*,spec/,*CVS*,*.txt,docs/,phpdoc/,examples/,test/
|
||||
|
||||
;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
|
||||
;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
|
||||
;; HTML:frames:earthli,
|
||||
;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
|
||||
;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
|
||||
;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
|
||||
;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
|
||||
;;output=HTML:frames:earthli
|
||||
output=HTML:Smarty:HandS
|
||||
|
||||
;; turn this option on if you want highlighted source code for every file
|
||||
;; legal values: on/off
|
||||
sourcecode = on
|
||||
@@ -0,0 +1,92 @@
|
||||
;; phpDocumentor parse configuration file
|
||||
;;
|
||||
;; This file is designed to cut down on repetitive typing on the command-line or web interface
|
||||
;; You can copy this file to create a number of configuration files that can be used with the
|
||||
;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini. The web
|
||||
;; interface will automatically generate a list of .ini files that can be used.
|
||||
;;
|
||||
;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs
|
||||
;;
|
||||
;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
|
||||
;;
|
||||
;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>
|
||||
;;
|
||||
;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them
|
||||
|
||||
[Parse Data]
|
||||
;; title of all the documentation
|
||||
;; legal values: any string
|
||||
title = PHPMailer Documentation
|
||||
|
||||
;; parse files that start with a . like .bash_profile
|
||||
;; legal values: true, false
|
||||
hidden = false
|
||||
|
||||
;; show elements marked @access private in documentation by setting this to on
|
||||
;; legal values: on, off
|
||||
parseprivate = on
|
||||
|
||||
;; parse with javadoc-like description (first sentence is always the short description)
|
||||
;; legal values: on, off
|
||||
javadocdesc = off
|
||||
|
||||
;; add any custom @tags separated by commas here
|
||||
;; legal values: any legal tagname separated by commas.
|
||||
;customtags = mytag1,mytag2
|
||||
|
||||
;; This is only used by the XML:DocBook/peardoc2 converter
|
||||
defaultcategoryname = Documentation
|
||||
|
||||
;; what is the main package?
|
||||
;; legal values: alphanumeric string plus - and _
|
||||
defaultpackagename = PHPMailer
|
||||
|
||||
;; output any parsing information? set to on for cron jobs
|
||||
;; legal values: on
|
||||
;quiet = on
|
||||
|
||||
;; parse a PEAR-style repository. Do not turn this on if your project does
|
||||
;; not have a parent directory named "pear"
|
||||
;; legal values: on/off
|
||||
;pear = on
|
||||
|
||||
;; where should the documentation be written?
|
||||
;; legal values: a legal path
|
||||
target = ./phpdoc
|
||||
|
||||
;; limit output to the specified packages, even if others are parsed
|
||||
;; legal values: package names separated by commas
|
||||
;packageoutput = package1,package2
|
||||
|
||||
;; comma-separated list of files to parse
|
||||
;; legal values: paths separated by commas
|
||||
;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
|
||||
filename = *.php
|
||||
|
||||
;; comma-separated list of directories to parse
|
||||
;; legal values: directory paths separated by commas
|
||||
;directory = /path1,/path2,.,..,subdirectory
|
||||
;directory = /home/jeichorn/cvs/pear
|
||||
;;directory = .
|
||||
|
||||
;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
|
||||
;templatebase = /path/to/my/templates
|
||||
|
||||
;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
|
||||
;; legal values: any wildcard strings separated by commas
|
||||
;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
|
||||
ignore = templates_c/,*HTML/default/*,spec/,*CVS*,*.txt,docs/,phpdoc/,examples/,test/
|
||||
|
||||
;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
|
||||
;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
|
||||
;; HTML:frames:earthli,
|
||||
;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
|
||||
;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
|
||||
;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
|
||||
;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
|
||||
;;output=HTML:frames:earthli
|
||||
output=HTML:Smarty:HandS
|
||||
|
||||
;; turn this option on if you want highlighted source code for every file
|
||||
;; legal values: on/off
|
||||
sourcecode = on
|
||||
Reference in New Issue
Block a user