diff --git a/dist/iekserver/modules/ready/mailsystem/LICENSE.txt b/dist/iekserver/modules/ready/mailsystem/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..d159169d1050894d3ea3b98e1c965c4058208fe1 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +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 give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 Program +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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), 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 Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. 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 program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/dist/iekserver/modules/ready/mailsystem/README.html b/dist/iekserver/modules/ready/mailsystem/README.html new file mode 100644 index 0000000000000000000000000000000000000000..eac67a0a40c034764b522c3c82e34565a64e296b --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/README.html @@ -0,0 +1,113 @@ +<h2 id="mail-system"><a href="http://drupal.org/project/mailsystem">Mail System</a></h2> +<p>Provides an Administrative UI and Developers API for safely updating the <a href="http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8">mail_system</a> configuration variable.</p> +<h3 id="administrative-ui">Administrative UI</h3> +<p>The administrative interface is at <code>admin/config/system/mailsystem</code>. A <a href="http://drupal.org/node/1134044">screenshot</a> is available.</p> +<h3 id="used-by">Used by:</h3> +<ul> + <li><a href="http://drupal.org/project/htmlmail">HTML Mail</a></li> + <li><a href="http://drupal.org/project/mimemail">Mime Mail 7.x-1.x-dev</a></li> + <li><a href="http://drupal.org/project/postmark">Postmark 7.x-1.x</a></li> +</ul> +<h3 id="developers-api">Developers API</h3> +<p>A module <code>example</code> with a <a href="http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8"><code>MailSystemInterface</code></a> implementation called <code>ExampleMailSystem</code> should add the following in its <code>example.install</code> file:</p> +<pre> +<code>/** + * Implements hook_enable(). + */ +function example_enable() { + mailsystem_set(array('example' => 'ExampleMailSystem')); +} +/** + * Implements hook_disable(). + */ +function example_disable() { + mailsystem_clear(array('example' => 'ExampleMailSystem')); +} +</code> +</pre> +<p>The above settings allow mail sent by <code>example</code> to use <code>ExampleMailSystem</code>. To make <code>ExampleMailSystem</code> the site-wide default for sending mail:</p> +<pre> +<code>mailsystem_set(array(mailsystem_default_id() => 'ExampleMailSystem')); +</code> +</pre> +<p>To restore the default mail system:</p> +<pre> +<code>mailsystem_set(array(mailsystem_default_id() => mailsystem_default_value())); +</code> +</pre> +<p>Or simply:</p> +<pre> +<code>mailsystem_set(mailsystem_defaults()); +</code> +</pre> +<p>If module <code>example</code> relies on dependency <code>foo</code> and its <code>FooMailSystem</code> class, then the <code>example.install</code> code should like like this:</p> +<pre> +<code>/** + * Implements hook_enable(). + */ +function example_enable() { + mailsystem_set(array('example' => 'FooMailSystem')); +} +/** + * Implements hook_disable(). + */ +function example_disable() { + mailsystem_clear(array('example' => '')); +} +</code> +</pre> +<p>If module <code>example</code> only wants to use <code>FooMailSystem</code> when sending emails with a key of <code>examail</code>, then the <code>example.install</code> code should look like this:</p> +<pre> +<code>/** + * Implements hook_enable(). + */ +function example_enable() { + mailsystem_set(array('example_examail' => 'FooMailSystem')); +} +/** + * Implements hook_disable(). + */ +function example_disable() { + mailsystem_clear(array('example_examail' => '')); +} +</code> +</pre> +<h4 id="new-in-2.x-branch"><em>(New in 2.x branch)</em></h4> +<p>To change the site-wide defaults to use the <code>FooMailSystem</code> for formatting messages and the <code>BarMailSystem</code> for sending them:</p> +<pre> +<code>mailsystem_set( + array( + mailsystem_default_id() => array( + 'format' => 'FooMailSystem', + 'mail' => 'BarMailSystem', + ), + ) +); +</code> +</pre> +<p>To change the site-wide defaults to use the <code>FooMailSystem</code> for sending messages, while continuing to use the current system for formatting them:</p> +<pre> +<code>mailsystem_set( + array( + mailsystem_default_id() => array( + 'mail' => 'FooMailsystem', + ), + ) +); +</code> +</pre> +<h3 id="references">References</h3> +<dl> + <dt><strong><a href="http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8"><code>drupal_mail_system()</code> API documentation</a></strong>:</dt> + <dd> + <p><a href="http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8">api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system</a></p> + </dd> + <dt><strong><a href="http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8"><code>MailSystemInterface</code> API documentation</a></strong>:</dt> + <dd> + <p><a href="http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8">api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface</a></p> + </dd> + <dt><strong><a href="http://drupal.org/node/900794">Creating HTML formatted mails in Drupal 7</a></strong>:</dt> + <dd> + <p><a href="http://drupal.org/node/900794">drupal.org/node/900794</a></p> + </dd> +</dl> diff --git a/dist/iekserver/modules/ready/mailsystem/README.markdown b/dist/iekserver/modules/ready/mailsystem/README.markdown new file mode 100644 index 0000000000000000000000000000000000000000..7175ef7c3c04515e536d3ba26f1212191d987b6a --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/README.markdown @@ -0,0 +1,118 @@ +## [Mail System](http://drupal.org/project/mailsystem) + +Provides an Administrative UI and Developers API for safely updating the +[mail_system](http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8) +configuration variable. + +### Administrative UI + +The administrative interface is at `admin/config/system/mailsystem`. +A [screenshot](http://drupal.org/node/1134044) is available. + +### Used by: + +* [HTML Mail](http://drupal.org/project/htmlmail) +* [Mime Mail 7.x-1.x-dev](http://drupal.org/project/mimemail) +* [Postmark 7.x-1.x](http://drupal.org/project/postmark) + +### Developers API + +A module `example` with a +[`MailSystemInterface`](http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8) +implementation called `ExampleMailSystem` should add the following in its +`example.install` file: + + /** + * Implements hook_enable(). + */ + function example_enable() { + mailsystem_set(array('example' => 'ExampleMailSystem')); + } + + /** + * Implements hook_disable(). + */ + function example_disable() { + mailsystem_clear(array('example' => 'ExampleMailSystem')); + } + +The above settings allow mail sent by `example` to use `ExampleMailSystem`. To make +`ExampleMailSystem` the site-wide default for sending mail: + + mailsystem_set(array(mailsystem_default_id() => 'ExampleMailSystem')); + +To restore the default mail system: + + mailsystem_set(array(mailsystem_default_id() => mailsystem_default_value())); + +Or simply: + + mailsystem_set(mailsystem_defaults()); + +If module `example` relies on dependency `foo` and its `FooMailSystem` class, then +the `example.install` code should like like this: + + /** + * Implements hook_enable(). + */ + function example_enable() { + mailsystem_set(array('example' => 'FooMailSystem')); + } + + /** + * Implements hook_disable(). + */ + function example_disable() { + mailsystem_clear(array('example' => '')); + } + +If module `example` only wants to use `FooMailSystem` when sending emails with a key +of `examail`, then the `example.install` code should look like this: + + /** + * Implements hook_enable(). + */ + function example_enable() { + mailsystem_set(array('example_examail' => 'FooMailSystem')); + } + + /** + * Implements hook_disable(). + */ + function example_disable() { + mailsystem_clear(array('example_examail' => '')); + } + +#### *(New in 2.x branch)* + +To change the site-wide defaults to use the `FooMailSystem` for formatting messages and the `BarMailSystem` for sending them: + + mailsystem_set( + array( + mailsystem_default_id() => array( + 'format' => 'FooMailSystem', + 'mail' => 'BarMailSystem', + ), + ) + ); + +To change the site-wide defaults to use the `FooMailSystem` for sending messages, while continuing to use the current system for formatting them: + + mailsystem_set( + array( + mailsystem_default_id() => array( + 'mail' => 'FooMailsystem', + ), + ) + ); + +### References + +**[`drupal_mail_system()` API documentation](http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8)**: +: [api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system](http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8) + +**[`MailSystemInterface` API documentation](http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8)**: +: [api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface](http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8) + +**[Creating HTML formatted mails in Drupal 7](http://drupal.org/node/900794)**: +: [drupal.org/node/900794](http://drupal.org/node/900794) diff --git a/dist/iekserver/modules/ready/mailsystem/README.txt b/dist/iekserver/modules/ready/mailsystem/README.txt new file mode 100644 index 0000000000000000000000000000000000000000..f91f544022f3dcf9e7f57330742462b6c38f1cd1 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/README.txt @@ -0,0 +1,134 @@ +[1]Mail System + + Provides an Administrative UI and Developers API for safely updating + the [2]mail_system configuration variable. + + Administrative UI + + The administrative interface is at admin/config/system/mailsystem. A + [3]screenshot is available. + + Used by: + + * [4]HTML Mail + * [5]Mime Mail 7.x-1.x-dev + * [6]Postmark 7.x-1.x + + Developers API + + A module example with a [7]MailSystemInterface implementation called + ExampleMailSystem should add the following in its example.install file: +/** + * Implements hook_enable(). + */ +function example_enable() { + mailsystem_set(array('example' => 'ExampleMailSystem')); +} +/** + * Implements hook_disable(). + */ +function example_disable() { + mailsystem_clear(array('example' => 'ExampleMailSystem')); +} + + + The above settings allow mail sent by example to use ExampleMailSystem. + To make ExampleMailSystem the site-wide default for sending mail: +mailsystem_set(array(mailsystem_default_id() => 'ExampleMailSystem')); + + + To restore the default mail system: +mailsystem_set(array(mailsystem_default_id() => mailsystem_default_value())); + + + Or simply: +mailsystem_set(mailsystem_defaults()); + + + If module example relies on dependency foo and its FooMailSystem class, + then the example.install code should like like this: +/** + * Implements hook_enable(). + */ +function example_enable() { + mailsystem_set(array('example' => 'FooMailSystem')); +} +/** + * Implements hook_disable(). + */ +function example_disable() { + mailsystem_clear(array('example' => '')); +} + + + If module example only wants to use FooMailSystem when sending emails + with a key of examail, then the example.install code should look like + this: +/** + * Implements hook_enable(). + */ +function example_enable() { + mailsystem_set(array('example_examail' => 'FooMailSystem')); +} +/** + * Implements hook_disable(). + */ +function example_disable() { + mailsystem_clear(array('example_examail' => '')); +} + + + (New in 2.x branch) + + To change the site-wide defaults to use the FooMailSystem for + formatting messages and the BarMailSystem for sending them: +mailsystem_set( + array( + mailsystem_default_id() => array( + 'format' => 'FooMailSystem', + 'mail' => 'BarMailSystem', + ), + ) +); + + + To change the site-wide defaults to use the FooMailSystem for sending + messages, while continuing to use the current system for formatting + them: +mailsystem_set( + array( + mailsystem_default_id() => array( + 'mail' => 'FooMailsystem', + ), + ) +); + + + References + + [8]drupal_mail_system() API documentation: + [9]api.drupal.org/api/drupal/includes--mail.inc/function/drupal_ + mail_system + + [10]MailSystemInterface API documentation: + [11]api.drupal.org/api/drupal/includes--mail.inc/interface/MailS + ystemInterface + + [12]Creating HTML formatted mails in Drupal 7: + [13]drupal.org/node/900794 + +References + + 1. http://drupal.org/project/mailsystem + 2. http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8 + 3. http://drupal.org/node/1134044 + 4. http://drupal.org/project/htmlmail + 5. http://drupal.org/project/mimemail + 6. http://drupal.org/project/postmark + 7. http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8 + 8. http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8 + 9. http://api.drupal.org/api/drupal/includes--mail.inc/function/drupal_mail_system/8 + 10. http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8 + 11. http://api.drupal.org/api/drupal/includes--mail.inc/interface/MailSystemInterface/8 + 12. http://drupal.org/node/900794 + 13. http://drupal.org/node/900794 diff --git a/dist/iekserver/modules/ready/mailsystem/composer.json b/dist/iekserver/modules/ready/mailsystem/composer.json new file mode 100644 index 0000000000000000000000000000000000000000..b01e4fda3973739b6dd944636638e1821363e199 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/composer.json @@ -0,0 +1,8 @@ +{ + "name": "drupal/mailsystem", + "description": "Mail System", + "type": "drupal-module", + "license": "GPL-2.0+", + "minimum-stability": "dev", + "require": { } +} diff --git a/dist/iekserver/modules/ready/mailsystem/config/install/mailsystem.settings.yml b/dist/iekserver/modules/ready/mailsystem/config/install/mailsystem.settings.yml new file mode 100644 index 0000000000000000000000000000000000000000..256c9d8afdec80c7bdcbe6eaf8c790bc8b968595 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/config/install/mailsystem.settings.yml @@ -0,0 +1,4 @@ +theme: 'current' +defaults: + sender: 'php_mail' + formatter: 'php_mail' diff --git a/dist/iekserver/modules/ready/mailsystem/config/schema/mailsystem.schema.yml b/dist/iekserver/modules/ready/mailsystem/config/schema/mailsystem.schema.yml new file mode 100644 index 0000000000000000000000000000000000000000..207f5869dc18b0a3b4d4e7b7bb761e1a6ad9ddda --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/config/schema/mailsystem.schema.yml @@ -0,0 +1,33 @@ +mailsystem.settings: + type: config_object + label: Mail System settings + mapping: + theme: + type: string + label: Selected theme + defaults: + type: mapping + label: Default settings + mapping: + sender: + type: string + label: The sender of an email + formatter: + type: string + label: The formatter used for emails + modules: + type: sequence + label: List of modules + sequence: + type: sequence + label: List of keys for a given module + sequence: + type: mapping + label: Per module/key setting. + mapping: + sender: + type: string + label: The sender of an email + formatter: + type: string + label: The formatter used for emails diff --git a/dist/iekserver/modules/ready/mailsystem/html_to_text.inc b/dist/iekserver/modules/ready/mailsystem/html_to_text.inc new file mode 100644 index 0000000000000000000000000000000000000000..805bffffed685af6e5c4fe8f7b7dd1efcd1ffe63 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/html_to_text.inc @@ -0,0 +1,744 @@ +<?php +/** + * @file + * Copy of drupal_html_to_text improvements from issue #299138. + */ + +use Drupal\Core\Site\Settings; + +/** + * Perform format=flowed soft wrapping for mail (RFC 3676). + * + * We use delsp=yes wrapping, but only break non-spaced languages when + * absolutely necessary to avoid compatibility issues. + * + * We deliberately use Settings::get('mail_line_endings', PHP_EOL) + * rather than "\r\n". + * + * @param $text + * The plain text to process. + * @param array $options + * (optional) An array containing one or more of the following keys: + * - indent: A string to indent the text with. Only '>' characters are + * repeated on subsequent wrapped lines. Others are replaced by spaces. + * - max: The maximum length at which to wrap each line. Defaults to 80. + * - stuff: Whether to space-stuff special lines. Defaults to TRUE. + * - hard: Whether to enforce the maximum line length even if no convenient + * space character is available. Defaults to FALSE. + * - pad: A string to use for padding short lines to 'max' characters. If + * more than one character, only the last will be repeated. + * - break: The line break sequence to insert. The default is one of the + * following: + * - "\r\n": Windows, when $text does not contain a space character. + * - "\n": Non-Windows, when $text does not contain a space character. + * - " \r\n": On Windows, when $text contains at least one space. + * - " \n": Non-Windows, when $text contains at least one space. + * + * @see drupal_mail() + */ +function mailsystem_wrap_mail($text, array $options = array()) { + static $defaults; + if (!isset($defaults)) { + $defaults = array( + 'indent' => '', + 'pad' => '', + 'pad_repeat' => '', + 'max' => 80, + 'stuff' => TRUE, + 'hard' => FALSE, + 'eol' => Settings::get('mail_line_endings', PHP_EOL), + ); + } + $options += $defaults; + if (!isset($options['break'])) { + // Allow soft-wrap spaces only when $text contains at least one space. + $options['break'] = (strpos($text, ' ') === FALSE ? '' : ' ') . $defaults['eol']; + } + $options['wrap'] = $options['max'] - drupal_strlen($options['indent']); + if ($options['pad']) { + $options['pad_repeat'] = drupal_substr($options['pad'], -1, 1); + } + // The 'clean' indent is applied to all lines after the first one. + $options['clean'] = _mailsystem_html_to_text_clean($options['indent']); + // Wrap lines according to RFC 3676. + $lines = explode($defaults['eol'], $text); + array_walk($lines, '_mailsystem_wrap_mail_line', $options); + // Expand the lines array on newly-inserted line breaks. + $lines = explode($defaults['eol'], implode($defaults['eol'], $lines)); + // Apply indentation, space-stuffing, and padding. + array_walk($lines, '_mailsystem_indent_mail_line', $options); + return implode($defaults['eol'], $lines); +} + +/** + * Transform an HTML string into plain text, preserving the structure of the + * markup. Useful for preparing the body of a node to be sent by e-mail. + * + * The output will be suitable for use as 'format=flowed; delsp=yes' text + * (RFC 3676) and can be passed directly to drupal_mail() for sending. + * + * We deliberately use Settings::get('mail_line_endings', PHP_EOL) + * rather than "\r\n". + * + * This function provides suitable alternatives for the following tags: + * + * <a> <address> <b> <blockquote> <br /> <caption> <cite> <dd> <div> <dl> <dt> + * <em> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <ol> <p> <pre> <strong> + * <table> <tbody> <td> <tfoot> <thead> <tr> <u> <ul> + * + * The following tag attributes are supported: + * - <a href=...>: Hyperlink destination urls. + * - <li value=...>: Ordered list item numbers. + * - <ol start=...>: Ordered list start number. + * + * @param $string + * The string to be transformed. + * @param $allowed_tags + * (optional) If supplied, a list of tags that will be transformed. If + * omitted, all supported tags are transformed. + * + * @return + * The transformed string. + * + * @see drupal_mail() + */ +function mailsystem_html_to_text($string, $allowed_tags = NULL) { + $eol = Settings::get('mail_line_endings', PHP_EOL); + // Cache list of supported tags. + static $supported_tags; + if (!isset($supported_tags)) { + $supported_tags = array( + 'a', 'address', 'b', 'blockquote', 'br', 'cite', 'dd', 'div', 'dl', + 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'li', + 'ol', 'p', 'pre', 'strong', 'table', 'td', 'tr', 'u', 'ul', + ); + } + + // Make sure only supported tags are kept. + $allowed_tags = isset($allowed_tags) ? array_intersect($supported_tags, $allowed_tags) : $supported_tags; + + // Parse $string into a DOM tree. + $dom = filter_dom_load($string); + $notes = array(); + // Recursively convert the DOM tree into plain text. + $text = _mailsystem_html_to_text($dom->documentElement, $allowed_tags, $notes); + // Hard-wrap at 1000 characters (including the line break sequence) + // and space-stuff special lines. + $text = mailsystem_wrap_mail($text, array('max' => 1000 - strlen($eol), 'hard' => TRUE)); + // Change non-breaking spaces back to regular spaces, and trim line breaks. + // chr(160) is the non-breaking space character. + $text = str_replace(chr(160), ' ', trim($text, $eol)); + // Add footnotes; + if ($notes) { + // Add a blank line before the footnote list. + $text .= $eol; + foreach ($notes as $url => $note) { + $text .= $eol . '[' . $note . '] ' . $url; + } + } + return $text; +} + +/** + * Helper function for drupal_html_to_text(). + * + * Recursively converts $node to text, wrapping and indenting as necessary. + * + * @param $node + * The source DOMNode. + * @param $allowed_tags + * A list of tags that will be transformed. + * @param array &$notes + * A writeable array of footnote reference numbers, keyed by their + * respective hyperlink destination urls. + * @param $line_length + * The maximum length of a line, for wrapping. Defaults to 80 characters. + * @param array $parents + * The list of ancestor tags, from nearest to most distant. Defaults to an + * empty array(). + * @param $count + * The number to use for the next list item within an ordered list. Defaults + * to 1. + */ +function _mailsystem_html_to_text(DOMNode $node, array $allowed_tags, array &$notes, $line_length = 80, array $parents = array(), &$count = NULL) { + if (!isset($count)) { + $count = 1; + } + $eol = Settings::get('mail_line_endings', PHP_EOL); + if ($node->nodeType === XML_TEXT_NODE) { + // For text nodes, we just copy the text content. + $text = $node->textContent; + // Convert line breaks and trim trailing spaces. + $text = preg_replace('/ *\r?\n/', $eol, $text); + if (in_array('pre', $parents)) { + // Within <pre> tags, all spaces become non-breaking. + // chr(160) is the non-breaking space character. + $text = str_replace(' ', chr(160), $text); + } + else { + // Outside <pre> tags, collapse whitespace. + $text = preg_replace('/[[:space:]]+/', ' ', $text); + } + return $text; + } + // Non-text node. + $tag = ''; + $text = ''; + $child_text = ''; + $child_count = 1; + $indent = ''; + $prefix = ''; + $suffix = ''; + $pad = ''; + if (isset($node->tagName) && in_array($node->tagName, $allowed_tags)) { + $tag = $node->tagName; + switch ($tag) { + // Turn links with valid hrefs into footnotes. + case 'a': + $test = !empty($node->attributes); + $test = $test && ($href = $node->attributes->getNamedItem('href')); + $test = $test && ($url = url(preg_replace('|^' . base_path() . '|', '', $href->nodeValue), array('absolute' => TRUE))); + $test = $test && valid_url($url); + if ($test) { + // Only add links that have not already been added. + if (isset($notes[$url])) { + $note = $notes[$url]; + } + else { + $note = count($notes) + 1; + $notes[$url] = $note; + } + $suffix = ' [' . $note . ']'; + } + break; + + // Generic block-level tags. + case 'address': + case 'caption': + case 'div': + case 'p': + case 'pre': + // Start on a new line except as the first child of a list item. + if (!isset($parents[0]) || $parents[0] !== 'li' || !$node->isSameNode($node->parentNode->firstChild)) { + $text = $eol; + } + $suffix = $eol; + break; + + // Forced line break. + case 'br': + $text = $eol; + break; + + // Boldface by wrapping with "*" characters. + case 'b': + case 'strong': + $prefix = '*'; + $suffix = '*'; + break; + + // Italicize by wrapping with "/" characters. + case 'cite': + case 'em': + case 'i': + $prefix = '/'; + $suffix = '/'; + break; + + // Underline by wrapping with "_" characters. + case 'u': + $prefix = '_'; + $suffix = '_'; + break; + + // Blockquotes are indented by "> " at each level. + case 'blockquote': + $text = $eol; + // chr(160) is the non-breaking space character. + $indent = '>' . chr(160); + $suffix = $eol; + break; + + // Dictionary definitions are indented by four spaces. + case 'dd': + // chr(160) is the non-breaking space character. + $indent = chr(160) . chr(160) . chr(160) . chr(160); + $suffix = $eol; + break; + + // Dictionary list. + case 'dl': + // Start on a new line as the first child of a list item. + if (!isset($parents[0]) || $parents[0] !== 'li' || !$node->isSameNode($node->parentNode->firstChild)) { + $text = $eol; + } + $suffix = $eol; + break; + + // Dictionary term. + case 'dt': + $suffix = $eol; + break; + + // Header level 1 is prefixed by eight "=" characters. + case 'h1': + $text = "$eol$eol"; + // chr(160) is the non-breaking space character. + $indent = '========' . chr(160); + $pad = chr(160) . '='; + $suffix = $eol; + break; + + // Header level 2 is prefixed by six "-" characters. + case 'h2': + $text = "$eol$eol"; + // chr(160) is the non-breaking space character. + $indent = '------' . chr(160); + $pad = chr(160) . '-'; + $suffix = $eol; + break; + + // Header level 3 is prefixed by four "." characters and a space. + case 'h3': + $text = "$eol$eol"; + // chr(160) is the non-breaking space character. + $indent = '....' . chr(160); + $suffix = $eol; + break; + + // Header level 4 is prefixed by three "." characters and a space. + case 'h4': + $text = "$eol$eol"; + // chr(160) is the non-breaking space character. + $indent = '...' . chr(160); + $suffix = $eol; + break; + + // Header level 5 is prefixed by two "." character and a space. + case 'h5': + $text = "$eol$eol"; + // chr(160) is the non-breaking space character. + $indent = '..' . chr(160); + $suffix = $eol; + break; + + // Header level 6 is prefixed by one "." character and a space. + case 'h6': + $text = "$eol$eol"; + // chr(160) is the non-breaking space character. + $indent = '.' . chr(160); + $suffix = $eol; + break; + + // Horizontal rulers become a line of "-" characters. + case 'hr': + $text = $eol; + $child_text = '-'; + $pad = '-'; + $suffix = $eol; + break; + + // List items are treated differently depending on the parent tag. + case 'li': + // Ordered list item. + if (reset($parents) === 'ol') { + // Check the value attribute. + $test = !empty($node->attributes); + $test = $test && ($value = $node->attributes->getNamedItem('value')); + if ($test) { + $count = $value->nodeValue; + } + // chr(160) is the non-breaking space character. + $indent = ($count < 10 ? chr(160) : '') . chr(160) . "$count)" . chr(160); + $count++; + } + // Unordered list item. + else { + // chr(160) is the non-breaking space character. + $indent = chr(160) . '*' . chr(160); + } + $suffix = $eol; + break; + + // Ordered lists. + case 'ol': + // Start on a new line as the first child of a list item. + if (!isset($parents[0]) || $parents[0] !== 'li' || !$node->isSameNode($node->parentNode->firstChild)) { + $text = $eol; + } + // Check the start attribute. + $test = !empty($node->attributes); + $test = $test && ($value = $node->attributes->getNamedItem('start')); + if ($test) { + $child_count = $value->nodeValue; + } + break; + + // Tables require special handling. + case 'table': + return _mailsystem_html_to_text_table($node, $allowed_tags, $notes, $line_length); + + // Separate adjacent table cells by two non-breaking spaces. + case 'td': + if (!empty($node->nextSibling)) { + // chr(160) is the non-breaking space character. + $suffix = chr(160) . chr(160); + } + break; + + // End each table row with a newline. + case 'tr': + $suffix = $eol; + break; + + // Unordered lists. + case 'ul': + // Start on a new line as the first child of a list item. + if (!isset($parents[0]) || $parents[0] !== 'li' || !$node->isSameNode($node->parentNode->firstChild)) { + $text = $eol; + } + break; + + default: + // Coder review complains if there is no default case. + break; + } + // Only add allowed tags to the $parents array. + array_unshift($parents, $tag); + } + // Copy each child node to output. + if ($node->hasChildNodes()) { + foreach ($node->childNodes as $child) { + $child_text .= _mailsystem_html_to_text($child, $allowed_tags, $notes, $line_length - drupal_strlen($indent), $parents, $child_count); } + } + // We only add prefix and suffix if the child nodes were non-empty. + if ($child_text > '') { + // We capitalize the contents of h1 and h2 tags. + if ($tag === 'h1' || $tag === 'h2') { + $child_text = drupal_strtoupper($child_text); + } + // Don't add a newline to an existing newline. + if ($suffix === $eol && drupal_substr($child_text, - drupal_strlen($eol)) === $eol) { + $suffix = ''; + } + // Trim spaces around newlines except with <pre> or inline tags. + if (!in_array($tag, array('a', 'b', 'cite', 'em', 'i', 'pre', 'strong', 'u'))) { + $child_text = preg_replace('/ *' . $eol . ' */', $eol, $child_text); + } + // Soft-wrap at effective line length, but don't space-stuff. + $child_text = mailsystem_wrap_mail( + $prefix . $child_text, + array( + // chr(160) is the non-breaking space character. + 'break' => chr(160) . $eol, + 'indent' => $indent, + 'max' => $line_length, + 'pad' => $pad, + 'stuff' => FALSE, + ) + ) . $suffix; + if ($tag === 'pre') { + // Perform RFC-3676 soft-wrapping. + // chr(160) is the non-breaking space character. + $child_text = str_replace(chr(160), ' ', $child_text); + $child_text = mailsystem_wrap_mail( + $child_text, + array('max' => $line_length, 'stuff' => FALSE) + ); + // chr(160) is the non-breaking space character. + $child_text = str_replace(' ', chr(160), $child_text); + } + $text .= $child_text; + } + return $text; +} + +/** + * Helper function for _mailsystem_html_to_text(). + * + * Renders a <table> DOM Node into plain text. Attributes such as rowspan, + * colspan, padding, border, etc. are ignored. + * + * @param DOMNode $node + * The DOMNode corresponding to the <table> tag and its contents. + * @param $allowed_tags + * The list of allowed tags passed to _mailsystem_html_to_text(). + * @param array &$notes + * A writeable array of footnote reference numbers, keyed by their + * respective hyperlink destination urls. + * @param $table_width + * The desired maximum table width, after word-wrapping each table cell. + * + * @return + * A plain text representation of the table. + * + * @see _mailsystem_html_to_text() + */ +function _mailsystem_html_to_text_table(DOMNode $node, $allowed_tags = NULL, array &$notes = array(), $table_width = 80) { + $eol = Settings::get('mail_line_endings', PHP_EOL); + $header = array(); + $footer = array(); + $body = array(); + $text = $eol; + $current = $node; + while (TRUE) { + if (isset($current->tagName)) { + switch ($current->tagName) { + case 'caption': // The table caption is added first. + $text = _mailsystem_html_to_text($current, $allowed_tags, $notes, $table_width); + break; + + case 'tr': + switch ($current->parentNode->tagName) { + case 'thead': + $header[] = $current; + break; + + case 'tfoot': + $footer[] = $current; + break; + + default: // Either 'tbody' or 'table' + $body[] = $current; + break; + } + break; + + default: + if ($current->hasChildNodes()) { + $current = $current->firstChild; + continue 2; + } + } + } + do { + if ($current->nextSibling) { + $current = $current->nextSibling; + continue 2; + } + $current = $current->parentNode; + } while ($current && !$current->isSameNode($node)); + break; + } + // Merge the thead, tbody, and tfoot sections together. + if ($rows = array_merge($header, $body, $footer)) { + $num_rows = count($rows); + // First just count the number of columns. + $num_cols = 0; + foreach ($rows as $row) { + $row_cols = 0; + foreach ($row->childNodes as $cell) { + if (isset($cell->tagName) && in_array($cell->tagName, array('td', 'th'))) { + $row_cols++; + } + } + $num_cols = max($num_cols, $row_cols); + } + // If any columns were found, calculate each column height and width. + if ($num_cols) { + // Set up a binary search for best wrap width for each column. + $max = max($table_width - $num_cols - 1, 1); + $max_wraps = array_fill(0, $num_cols, $max); + $try = max(intval(($table_width - 1) / $num_cols - 1), 1); + $try_wraps = array_fill(0, $num_cols, $try); + $min_wraps = array_fill(0, $num_cols, 1); + // Start searching... + $change = FALSE; + do { + $change = FALSE; + $widths = array_fill(0, $num_cols, 0); + $heights = array_fill(0, $num_rows, 0); + $table = array_fill(0, $num_rows, array_fill(0, $num_cols, '')); + $breaks = array_fill(0, $num_cols, FALSE); + foreach ($rows as $i => $row) { + $j = 0; + foreach ($row->childNodes as $cell) { + if (!isset($cell->tagName) || !in_array($cell->tagName, array('td', 'th'))) { + // Skip text nodes. + continue; + } + // Render the cell contents. + $cell = _mailsystem_html_to_text($cell, $allowed_tags, $notes, $try_wraps[$j]); + // Trim leading line-breaks and trailing whitespace. + // chr(160) is the non-breaking space character. + $cell = rtrim(ltrim($cell, $eol), ' ' . $eol . chr(160)); + $table[$i][$j] = $cell; + if ($cell > '') { + // Split the cell into lines. + $lines = explode($eol, $cell); + // The row height is the maximum number of lines among all the + // cells in that row. + $heights[$i] = max($heights[$i], count($lines)); + foreach ($lines as $line) { + $this_width = drupal_strlen($line); + // The column width is the maximum line width among all the + // lines in that column. + if ($this_width > $widths[$j]) { + $widths[$j] = $this_width; + // If the longest line in a column contains at least one + // space character, then the table can be made narrower. + $breaks[$j] = strpos(' ', $line) !== FALSE; + } + } + } + $j++; + } + } + // Calculate the total table width; + $this_width = array_sum($widths) + $num_cols + 1; + if ($this_width > $table_width) { + // Wider than desired. + if (!in_array(TRUE, $breaks)) { + // If there are no more break points, then the table is already as + // narrow as it can get, so we're done. + break; + } + foreach ($try_wraps as $i => $wrap) { + $max_wraps[$i] = min($max_wraps[$i], $wrap); + if ($breaks[$i]) { + $new_wrap = intval(($min_wraps[$i] + $max_wraps[$i]) / 2); + $new_wrap = min($new_wrap, $widths[$i] - 1); + $new_wrap = max($new_wrap, $min_wraps[$i]); + } + else { + // There's no point in trying to make the column narrower than + // the widest un-wrappable line in the column. + $min_wraps[$i] = $widths[$i]; + $new_wrap = $widths[$i]; + } + if ($try_wraps[$i] > $new_wrap) { + $try_wraps[$i] = $new_wrap; + $change = TRUE; + } + } + } + elseif ($this_width < $table_width) { + // Narrower than desired. + foreach ($try_wraps as $i => $wrap) { + if ($min_wraps[$i] < $wrap) { + $min_wraps[$i] = $wrap; + } + $new_wrap = intval(($min_wraps[$i] + $max_wraps[$i]) / 2); + $new_wrap = max($new_wrap, $widths[$i] + 1); + $new_wrap = min($new_wrap, $max_wraps[$i]); + if ($try_wraps[$i] < $new_wrap) { + $try_wraps[$i] = $new_wrap; + $change = TRUE; + } + } + } + } while ($change); + // Pad each cell to column width and line height. + for ($i = 0; $i < $num_rows; $i++) { + if ($heights[$i]) { + for ($j = 0; $j < $num_cols; $j++) { + $cell = $table[$i][$j]; + // Pad each cell to the maximum number of lines in that row. + $lines = array_pad(explode($eol, $cell), $heights[$i], ''); + foreach ($lines as $k => $line) { + // Pad each line to the maximum width in that column. + $repeat = $widths[$j] - drupal_strlen($line); + if ($repeat > 0) { + // chr(160) is the non-breaking space character. + $lines[$k] .= str_repeat(chr(160), $repeat); + } + } + $table[$i][$j] = $lines; + } + } + } + // Generate the row separator line. + $separator = '+'; + for($i = 0; $i < $num_cols; $i++) { + $separator .= str_repeat('-', $widths[$i]) . '+'; + } + $separator .= $eol; + for ($i = 0; $i < $num_rows; $i++) { + $text .= $separator; + if (!$heights[$i]) { + continue; + } + $row = $table[$i]; + // For each row, iterate first by lines within the row. + for ($k = 0; $k < $heights[$i]; $k++) { + // Add a vertical-bar at the beginning of each row line. + $row_line = '|'; + $trimmed = ''; + // Within each row line, iterate by cells within that line. + for ($j = 0; $j < $num_cols; $j++) { + // Add a vertical bar at the end of each cell line. + $row_line .= $row[$j][$k] . '|'; + // chr(160) is the non-breaking space character. + $trimmed .= trim($row[$j][$k], ' ' . $eol . chr(160)); + } + if ($trimmed > '') { + // Only print rows that are non-empty. + $text .= $row_line . $eol; + } + } + } + // Final output ends with a row separator. + $text .= $separator; + } + } + // Make sure formatted table content doesn't line-wrap. + // chr(160) is the non-breaking space character. + return str_replace(' ', chr(160), $text); +} + +/** + * Helper function for array_walk in drupal_wrap_mail(). + * + * Inserts $values['break'] sequences to break up $line into parts of no more + * than $values['wrap'] characters. Only breaks at space characters, unless + * $values['hard'] is TRUE. + */ +function _mailsystem_wrap_mail_line(&$line, $key, $values) { + $line = wordwrap($line, $values['wrap'], $values['break'], $values['hard']); +} + +/** + * Helper function for array_walk in drupal_wrap_mail(). + * + * If $values['pad'] is non-empty, $values['indent'] will be added at the start + * of each line, and $values['pad'] at the end, repeating the last character of + * $values['pad'] until the line length equals $values['max']. + * + * If $values['pad'] is empty, $values['indent'] will be added at the start of + * the first line, and $values['clean'] at the start of subsequent lines. + * + * If $values['stuff'] is true, then an extra space character will be added at + * the start of any line beginning with a space, a '>', or the word 'From'. + * + * @see http://www.ietf.org/rfc/rfc3676.txt + */ +function _mailsystem_indent_mail_line(&$line, $key, $values) { + if ($line == '') { + return; + } + if ($values['pad']) { + $line = $values['indent'] . $line; + $count = $values['max'] - drupal_strlen($line) - drupal_strlen($values['pad']); + if ($count >= 0) { + $line .= $values['pad'] . str_repeat($values['pad_repeat'], $count); + } + } + else { + $line = $values[$key === 0 ? 'indent' : 'clean'] . $line; + } + if ($values['stuff']) { + // chr(160) is the non-breaking space character. + $line = preg_replace('/^(' . chr(160) . '| |>|From)/', ' $1', $line); + } +} + +/** + * Helper function for drupal_wrap_mail() and drupal_html_to_text(). + * + * Replace all non-quotation markers from a given piece of indentation with + * non-breaking space characters. + */ +function _mailsystem_html_to_text_clean($indent) { + // chr(160) is the non-breaking space character. + return preg_replace('/[^>]/', chr(160), $indent); +} diff --git a/dist/iekserver/modules/ready/mailsystem/mailsystem.info.yml b/dist/iekserver/modules/ready/mailsystem/mailsystem.info.yml new file mode 100644 index 0000000000000000000000000000000000000000..c0e184e86bc7f5af9229753109fddf1f7e9dee69 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/mailsystem.info.yml @@ -0,0 +1,15 @@ +package: 'Mail' +name: 'Mail System' +description: 'Provides a user interface for per-module and site-wide mail_system selection.' +type: module +# core: 8.x +configure: mailsystem.settings +dependencies: + - filter + - system (>=8.0.5) + +# Information added by Drupal.org packaging script on 2016-07-08 +version: '8.x-4.1' +core: '8.x' +project: 'mailsystem' +datestamp: 1467993737 diff --git a/dist/iekserver/modules/ready/mailsystem/mailsystem.links.menu.yml b/dist/iekserver/modules/ready/mailsystem/mailsystem.links.menu.yml new file mode 100644 index 0000000000000000000000000000000000000000..00a87465418dcc2d2c84104cc43a8849381c0ad9 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/mailsystem.links.menu.yml @@ -0,0 +1,6 @@ +mailsystem.settings: + title: Mail System + route_name: mailsystem.settings + parent: system.admin_config_system + description: 'Global Mail System configuration.' + weight: -20 diff --git a/dist/iekserver/modules/ready/mailsystem/mailsystem.module b/dist/iekserver/modules/ready/mailsystem/mailsystem.module new file mode 100644 index 0000000000000000000000000000000000000000..2ce3685a154471ebcf52b2045414768c8e33f80d --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/mailsystem.module @@ -0,0 +1,39 @@ +<?php + +/** + * @file + * Provide UI for controlling the mail_system variable. + */ + +/** + * Retrieves the key of the theme used to render the emails. + * + * @todo Add some kind of hook to let other modules alter this behavior. + */ +function mailsystem_get_mail_theme() { + $theme_key = \Drupal::theme()->getActiveTheme()->getName(); + $config = \Drupal::config('mailsystem.settings'); + $theme_config = \Drupal::config('system.theme'); + + $theme = $config->get('theme'); + switch ($theme) { + case 'default': + $theme = $theme_config->get('default'); + break; + case 'current': + $theme = $theme_key; + break; + case 'domain': + // Fetch the theme for the current domain. + // @todo: Reimplement this as soon as module port or similar module is around. + if (FALSE && \Drupal::moduleHandler()->moduleExists('domain_theme')) { + // Assign the selected theme, based on the active domain. + global $_domain; + $domain_theme = domain_theme_lookup($_domain['domain_id']); + // The above returns -1 on failure. + $theme = ($domain_theme != -1) ? $domain_theme['theme'] : $theme_key; + } + break; + } + return $theme; +} diff --git a/dist/iekserver/modules/ready/mailsystem/mailsystem.permissions.yml b/dist/iekserver/modules/ready/mailsystem/mailsystem.permissions.yml new file mode 100644 index 0000000000000000000000000000000000000000..28d7a9457713d88433aa086f5ea2a9a7fe061b9f --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/mailsystem.permissions.yml @@ -0,0 +1,3 @@ +administer_mailsystem: + title: Administer Mail System + description: Select the default, per-module, and per-mailing MailSystemInterface to use for formatting and sending email messages. diff --git a/dist/iekserver/modules/ready/mailsystem/mailsystem.routing.yml b/dist/iekserver/modules/ready/mailsystem/mailsystem.routing.yml new file mode 100644 index 0000000000000000000000000000000000000000..e69bcf594fd60479b237bb0d2cf0c2f111d0fb6c --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/mailsystem.routing.yml @@ -0,0 +1,7 @@ +mailsystem.settings: + path: '/admin/config/system/mailsystem' + defaults: + _form: 'Drupal\mailsystem\Form\AdminForm' + _title: 'Configure the Mail System' + requirements: + _permission: 'administer_mailsystem' diff --git a/dist/iekserver/modules/ready/mailsystem/src/Adapter.php b/dist/iekserver/modules/ready/mailsystem/src/Adapter.php new file mode 100644 index 0000000000000000000000000000000000000000..56dd77ba2e7ecf73f7a96ed522595e7cd45985ae --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/src/Adapter.php @@ -0,0 +1,53 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem\Adapter. + */ + +namespace Drupal\mailsystem; + +use Drupal\Core\Mail\MailInterface; + +/** + * Provides an adapter to send emails. + */ +class Adapter implements MailInterface { + + /** + * @var \Drupal\Core\Mail\MailInterface + */ + protected $instanceFormatter; + + /** + * @var \Drupal\Core\Mail\MailInterface + */ + protected $instanceSender; + + /** + * Constructor. + * + * @param \Drupal\Core\Mail\MailInterface $formatter + * The MailPlugin for formatting the email before sending. + * @param \Drupal\Core\Mail\MailInterface $sender + * The MailPlugin for sending the email. + */ + public function __construct(MailInterface $formatter, MailInterface $sender) { + $this->instanceFormatter = $formatter; + $this->instanceSender = $sender; + } + + /** + * {@inheritdoc} + */ + public function format(array $message) { + return $this->instanceFormatter->format($message); + } + + /** + * {@inheritdoc} + */ + public function mail(array $message) { + return $this->instanceSender->mail($message); + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/src/Form/AdminForm.php b/dist/iekserver/modules/ready/mailsystem/src/Form/AdminForm.php new file mode 100644 index 0000000000000000000000000000000000000000..da18a871ed6b0479109669b86bcd6bd545ecd9fc --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/src/Form/AdminForm.php @@ -0,0 +1,408 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem\Form\AdminForm. + */ + +namespace Drupal\mailsystem\Form; + +use Drupal\Core\Config\ConfigFactoryInterface; +use Drupal\Core\Extension\ModuleHandlerInterface; +use Drupal\Core\Extension\ThemeHandlerInterface; +use Drupal\Core\Form\ConfigFormBase; +use Drupal\Core\Form\FormStateInterface; +use Drupal\Core\Mail\MailManagerInterface; +use Drupal\Core\Url; +use Drupal\mailsystem\MailsystemManager; +use Symfony\Component\DependencyInjection\ContainerInterface; + +/** + * Mail System settings form. + */ +class AdminForm extends ConfigFormBase { + + /** + * @var \Drupal\Core\Mail\MailManagerInterface + */ + protected $mailManager; + + /** + * @var \Drupal\Core\Extension\ModuleHandlerInterface + */ + protected $moduleHandler; + + /** + * @var \Drupal\Core\Extension\ThemeHandlerInterface + */ + protected $themeHandler; + + /** + * Constructs a \Drupal\system\ConfigFormBase object. + * + * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory + * The factory for configuration objects. + * @param \Drupal\Core\Mail\MailManagerInterface $mail_manager + * The mail manager. + * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler + * The module handler. + * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler + * The theme handler. + */ + public function __construct(ConfigFactoryInterface $config_factory, MailManagerInterface $mail_manager, ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler) { + parent::__construct($config_factory); + $this->mailManager = $mail_manager; + $this->moduleHandler = $module_handler; + $this->themeHandler = $theme_handler; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('config.factory'), + $container->get('plugin.manager.mail'), + $container->get('module_handler'), + $container->get('theme_handler') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormID() { + return 'mailsystem_admin_form'; + } + + /** + * {@inheritdoc} + */ + protected function getEditableConfigNames() { + return array('mailsystem.settings'); + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state) { + $config = $this->config('mailsystem.settings'); + + $arguments = array( + ':interface' => Url::fromUri('https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Mail!MailInterface.php/interface/MailInterface/8')->toString(), + '@interface' => '\Drupal\Core\Mail\MailInterface', + ':format' => Url::fromUri('https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Mail!MailInterface.php/function/MailInterface%3A%3Aformat/8')->toString(), + '@format' => 'format()', + ':mail' => Url::fromUri('https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Mail!MailInterface.php/function/MailInterface%3A%3Amail/8')->toString(), + '@mail' => 'mail()', + ); + + // Default mail system. + $form['mailsystem'] = array( + '#type' => 'details', + '#title' => $this->t('Default Mail System'), + '#open' => TRUE, + '#tree' => TRUE, + ); + + // Default formatter plugin. + $form['mailsystem']['default_formatter'] = array( + '#type' => 'select', + '#title' => $this->t('Formatter'), + '#description' => $this->t('Select the standard plugin for formatting an email before sending it. This plugin implements <a href=":interface">@interface</a> and in special the <a href=":format">@format</a> function.', $arguments), + '#options' => $this->getOptions(), + '#default_value' => $config->get('defaults.formatter'), + ); + + // Default sender plugin. + $form['mailsystem']['default_sender'] = array( + '#type' => 'select', + '#title' => $this->t('Sender'), + '#description' => $this->t('Select the standard plugin for sending an email after formatting it. This plugin implements <a href=":interface">@interface</a> and in special the <a href=":mail">@mail</a> function.', $arguments), + '#options' => $this->getOptions(), + '#default_value' => $config->get('defaults.sender'), + ); + + // Default theme for formatting emails. + $form['mailsystem']['default_theme'] = array( + '#type' => 'select', + '#title' => $this->t('Theme to render the emails'), + '#description' => $this->t('Select the theme that will be used to render emails which are configured for this. This can be either the current theme, the default theme, the domain theme or any active theme.'), + '#options' => $this->getThemesList(), + '#default_value' => $config->get('theme'), + ); + + // Fieldset for custom module configuration. + $form['custom'] = array( + '#type' => 'details', + '#title' => $this->t('Module-specific configuration'), + '#open' => TRUE, + '#tree' => TRUE, + ); + + // Configuration for a new module. + $form['custom']['custom_module'] = array( + '#type' => 'select', + '#title' => $this->t('Module'), + '#options' => $this->getModulesList(), + '#empty_option' => $this->t('- Select -'), + ); + $form['custom']['custom_module_key'] = array( + '#type' => 'textfield', + '#title' => $this->t('Key'), + '#description' => $this->t('The key is used to identify specific mails if the module sends more than one. Leave empty to use the configuration for all mails sent by the selected module.'), + '#default_value' => '', + ); + $form['custom']['custom_formatter'] = array( + '#type' => 'select', + '#title' => $this->t('Formatter plugin'), + '#options' => $this->getOptions(), + '#empty_option' => $this->t('- Default -'), + ); + $form['custom']['custom_sender'] = array( + '#type' => 'select', + '#title' => $this->t('Sender plugin'), + '#options' => $this->getOptions(), + '#empty_option' => $this->t('- Default -'), + ); + + $form['custom']['add'] = array( + '#type' => 'submit', + '#value' => $this->t('Add'), + '#validate' => ['::validateAdd'], + '#submit' => ['::submitAdd'], + '#button_type' => 'primary', + ); + + // Show and change all custom configurations. + $form['custom']['modules'] = array( + '#type' => 'table', + '#header' => array( + 'module' => $this->t('Module'), + 'key' => $this->t('Key'), + 'formatter' => $this->t('Formatter'), + 'sender' => $this->t('Sender'), + 'remove' => $this->t('Remove'), + ), + '#empty' => $this->t('No specific configuration yet.'), + ); + + // Get all configured modules and show them in a list. + $modules = $config->get(MailsystemManager::MAILSYSTEM_MODULES_CONFIG) ?: []; + foreach ($modules as $module => $module_settings) { + if (is_array($module_settings) && $this->moduleHandler->moduleExists($module)) { + // Main table structure. + foreach ($module_settings as $key => $settings) { + + $module_key = $module . '.' . $key; + + $row = array( + 'module' => ['#markup' => $this->moduleHandler->getName($module)], + 'key' => ['#markup' => $key == 'none' ? t('All') : $key], + ); + + $row['formatter'] = array( + '#type' => 'select', + '#title' => $this->t('Formatter'), + '#title_display' => 'hidden', + '#options' => $this->getOptions(), + '#empty_option' => $this->t('- Default -'), + '#default_value' => isset($settings['formatter']) ? $settings['formatter'] : '', + ); + $row['sender'] = array( + '#type' => 'select', + '#title' => $this->t('Sender'), + '#title_display' => 'hidden', + '#options' => $this->getOptions(), + '#empty_option' => $this->t('- Default -'), + '#default_value' => isset($settings['sender']) ? $settings['sender'] : '', + ); + $row['remove'] = array( + '#type' => 'checkbox', + '#default_value' => $module_key, + ); + $form['custom']['modules'][$module_key] = $row; + } + } + } + + return parent::buildForm($form, $form_state); + } + + /** + * {@inheritdoc} + */ + public function validateAdd(array &$form, FormStateInterface $form_state) { + if ($form_state->getValue(['custom', 'custom_module']) == '') { + $form_state->setErrorByName('custom][custom_module', $this->t('The module is required.')); + } + + $config = $this->config('mailsystem.settings'); + $config_key = $this->getModuleKeyConfigPrefix($form_state->getValue(['custom', 'custom_module']), $form_state->getValue(['custom', 'custom_module_key'])); + if ($config->get($config_key)) { + $form_state->setErrorByName('custom][custom_module', $this->t('An entry for this combination exists already. Use the form below to update or remove it.')); + return; + } + + if (($form_state->getValue(['custom', 'custom_formatter']) == '') && ($form_state->getValue(['custom', 'custom_sender']) == '')) { + $form_state->setErrorByName('custom][custom_formatter', $this->t('At least a formatter or sender is required.')); + } + } + + /** + * {@inheritdoc} + */ + public function submitAdd(array &$form, FormStateInterface $form_state) { + // Create a new module configuration or update an existing one if a module + // is selected. + $module = $form_state->getValue(['custom', 'custom_module']); + $key = $form_state->getValue(['custom', 'custom_module_key']); + $formatter = $form_state->getValue(['custom', 'custom_formatter']); + $sender = $form_state->getValue(['custom', 'custom_sender']); + + // Create two configuration entries, one for the sending and one for the + // formatting. + // + // The configuration entries can be: + // modules.module.key.type -> Plugin for a special mail and send/format plugin + // modules.module.none.type -> Global plugin for the send/format plugin + $prefix = $this->getModuleKeyConfigPrefix($module, $key); + + $config = $this->config('mailsystem.settings'); + // Create the new custom module configuration. + if ($formatter) { + $config->set($prefix . '.' . MailsystemManager::MAILSYSTEM_TYPE_FORMATTING, $formatter); + } + if ($sender) { + $config->set($prefix . '.' . MailsystemManager::MAILSYSTEM_TYPE_SENDING, $sender); + } + $config->save(); + + drupal_set_message($this->t('The configuration has been added.')); + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $config = $this->config('mailsystem.settings'); + + // Set the defaults. + $config->set('defaults.formatter', $form_state->getValue(['mailsystem', 'default_formatter'])); + $config->set('defaults.sender', $form_state->getValue(['mailsystem', 'default_sender'])); + $config->set('theme', $form_state->getValue(['mailsystem', 'default_theme'])); + + // Update or remove the custom modules. + if ($form_state->hasValue(['custom', 'modules']) && is_array($form_state->getValue(['custom', 'modules']))) { + foreach ($form_state->getValue(['custom', 'modules'], []) as $module_key => $settings) { + $prefix = MailsystemManager::MAILSYSTEM_MODULES_CONFIG . '.' . $module_key; + if (!empty($settings['remove'])) { + // If the checkbox is checked, remove this row. + $config->clear($prefix); + } + else { + foreach ([MailsystemManager::MAILSYSTEM_TYPE_FORMATTING, MailsystemManager::MAILSYSTEM_TYPE_SENDING] as $type) { + if (!empty($settings[$type])) { + $config->set($prefix . '.' . $type, $settings[$type]); + } + else { + $config->clear($prefix . '.' . $type); + } + } + } + } + } + + // Finally save the configuration. + $config->save(); + parent::submitForm($form, $form_state); + } + + /** + * Returns a list with all mail plugins. + * + * @return string[] + * List of mail plugin labels, keyed by ID. + */ + protected function getOptions() { + $list = array(); + + // Append all MailPlugins. + foreach ($this->mailManager->getDefinitions() as $definition) { + $list[$definition['id']] = $definition['label']; + } + return $list; + } + + /** + * Returns a list with all themes. + * + * @return string[] + * List of theme options. + */ + protected function getThemesList() { + $theme_options = array( + 'current' => $this->t('Current'), + 'default' => $this->t('Default') + ); + if ($this->moduleHandler->moduleExists('domain_theme')) { + $theme_options['domain'] = $this->t('Domain Theme'); + } + foreach ($this->themeHandler->listInfo() as $name => $theme) { + if ($theme->status === 1) { + $theme_options[$name] = $theme->info['name']; + } + } + return $theme_options; + } + + /** + * Returns a list with all modules that send e-mails. + * + * Currently this is evaluated by the hook_mail implementation. + * + * @return string[] + * List of modules, keyed by the machine name. + * + */ + protected function getModulesList() { + $list = []; + foreach ($this->moduleHandler->getImplementations('mail') as $module) { + $list[$module] = $this->moduleHandler->getName($module); + } + asort($list); + + return $list; + } + + /** + * Returns a label from a mail plugin. + * + * @param string $plugin_id + * The plugin ID. + * + * @return string + * The label from a mail plugin. + */ + protected function getPluginLabel($plugin_id) { + $definition = $this->mailManager->getDefinition($plugin_id); + return isset($definition['label']) ? $definition['label'] : $this->t('Unknown Plugin'); + } + + /** + * Builds the module prefix for a given module and key pair. + * + * @param string $module + * The module name. + * @param string $key + * The mail key. + * + * @return string + * The config prefix for the settings array. + */ + protected function getModuleKeyConfigPrefix($module, $key) { + $module_key = $module . '.' . ($key ?: 'none'); + $config_key = MailsystemManager::MAILSYSTEM_MODULES_CONFIG . '.' . $module_key; + return $config_key; + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/src/MailsystemManager.php b/dist/iekserver/modules/ready/mailsystem/src/MailsystemManager.php new file mode 100644 index 0000000000000000000000000000000000000000..19723a7f2d4adb789fb61b770c72f14e617eef3d --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/src/MailsystemManager.php @@ -0,0 +1,180 @@ +<?php + +/** + * @file + * Contains \Drupal\mailsystem\MailsystemManager. + */ + +namespace Drupal\mailsystem; + +use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException; +use Drupal\Component\Utility\SafeMarkup; +use Drupal\Core\Mail\MailInterface; +use Drupal\Core\Mail\MailManager; +use Drupal\Core\Theme\ThemeInitializationInterface; +use Drupal\Core\Theme\ThemeManagerInterface; + +/** + * Factory for creating mail system objects based on BasePlugin's. + */ +class MailsystemManager extends MailManager { + + /** + * Constants used for the configuration. + */ + const MAILSYSTEM_TYPE_SENDING = 'sender'; + const MAILSYSTEM_TYPE_FORMATTING = 'formatter'; + const MAILSYSTEM_MODULES_CONFIG = 'modules'; + + /** + * @var \Drupal\Core\Theme\ThemeManagerInterface + */ + protected $themeManager; + + /** + * The theme initialization. + * + * @var \Drupal\Core\Theme\ThemeInitializationInterface + */ + protected $themeInitialization; + + /** + * Sets the theme manager for mailsystem. + * + * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager + * The theme manager. + */ + public function setThemeManager(ThemeManagerInterface $theme_manager) { + $this->themeManager = $theme_manager; + } + + /** + * Sets the theme initialization for mailsystem. + * + * @param \Drupal\Core\Theme\ThemeInitializationInterface $theme_initialization + * The theme initialization. + */ + public function setThemeInitialization(ThemeInitializationInterface $theme_initialization) { + $this->themeInitialization = $theme_initialization; + } + + /** + * {@inheritdoc} + */ + public function mail($module, $key, $to, $langcode, $params = array(), $reply = NULL, $send = TRUE) { + // Switch the theme to the configured mail theme. + $mail_theme = $this->getMailTheme(); + $current_active_theme = $this->themeManager->getActiveTheme(); + if ($mail_theme && $mail_theme != $current_active_theme->getName()) { + $this->themeManager->setActiveTheme($this->themeInitialization->initTheme($mail_theme)); + } + + try { + $message = parent::mail($module, $key, $to, $langcode, $params, $reply, $send); + } + finally { + // Revert the active theme, this is done inside a finally block so it is + // executed even if an exception is thrown during sending a mail. + if ($mail_theme != $current_active_theme->getName()) { + $this->themeManager->setActiveTheme($current_active_theme); + } + } + return $message; + } + + /** + * {@inheritdoc} + */ + public function getInstance(array $options) { + $module = isset($options['module']) ? $options['module'] : 'default'; + $key = isset($options['key']) ? $options['key'] : ''; + + return new Adapter( + $this->getPluginInstance($module, $key, static::MAILSYSTEM_TYPE_FORMATTING), + $this->getPluginInstance($module, $key, static::MAILSYSTEM_TYPE_SENDING) + ); + } + + /** + * Get a Mail-Plugin instance and return it. + * + * @param string $module + * Module name which is going to send and email. + * @param string $key + * (optional) The ID if the email which is being sent. + * @param string $type + * (optional) A subtype, like 'sending' or 'formatting'. + * Use \Drupal\mailsystem\MailsystemManager\MAILSYSTEM_TYPE_SENDING and + * \Drupal\mailsystem\MailsystemManager\MAILSYSTEM_TYPE_FORMATTING. + * + * @return \Drupal\Core\Mail\MailInterface + * A mail plugin instance. + * + * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException + */ + protected function getPluginInstance($module, $key = '', $type = '') { + $plugin_id = NULL; + + // List of message ids which can be configured. + $message_id_list = array( + self::MAILSYSTEM_MODULES_CONFIG . '.' . $module . '.' . $key . '.' . $type, + self::MAILSYSTEM_MODULES_CONFIG . '.' . $module . '.none.' . $type, + self::MAILSYSTEM_MODULES_CONFIG . '.' . $module . '.' . $type, + 'defaults.' . $type, + 'defaults' + ); + + $config = $this->configFactory->get('mailsystem.settings'); + + foreach($message_id_list as $message_id) { + $plugin_id = $config->get($message_id); + if (!is_null($plugin_id)) { + break; + } + } + + // If there is no instance cached, try to create one. + if (empty($this->instances[$plugin_id])) { + $plugin = $this->createInstance($plugin_id); + if ($plugin instanceof MailInterface) { + $this->instances[$plugin_id] = $plugin; + } + else { + throw new InvalidPluginDefinitionException($plugin_id, + SafeMarkup::format('Class %class does not implement interface %interface', + array('%class' => get_class($plugin), '%interface' => 'Drupal\Core\Mail\MailInterface') + ) + ); + } + } + return $this->instances[$plugin_id]; + } + + /** + * Retrieves the key of the theme used to render the emails. + */ + public function getMailTheme() { + $theme = $this->configFactory->get('mailsystem.settings')->get('theme'); + switch ($theme) { + case 'default': + $theme = $this->configFactory->get('system.theme')->get('default'); + break; + case 'current': + $theme = $this->themeManager->getActiveTheme()->getName(); + break; + case 'domain': + // Fetch the theme for the current domain. + // @todo: Reimplement this as soon as module port or similar module is around. + if (FALSE && \Drupal::moduleHandler()->moduleExists('domain_theme')) { + // Assign the selected theme, based on the active domain. + global $_domain; + $domain_theme = domain_theme_lookup($_domain['domain_id']); + // The above returns -1 on failure. + $theme = ($domain_theme != -1) ? $domain_theme['theme'] : $this->themeManager->getActiveTheme()->getName(); + } + break; + } + return $theme; + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/src/MailsystemServiceProvider.php b/dist/iekserver/modules/ready/mailsystem/src/MailsystemServiceProvider.php new file mode 100644 index 0000000000000000000000000000000000000000..029f609cb27b7b5c8cee2ee6aa6bfd316c4b71e0 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/src/MailsystemServiceProvider.php @@ -0,0 +1,37 @@ +<?php + +/** + * @file + * Contains \Drupal\mailsystem\MailsystemServiceProvider. + */ + +namespace Drupal\mailsystem; + +use Drupal\Core\DependencyInjection\ContainerBuilder; +use Drupal\Core\DependencyInjection\ServiceModifierInterface; +use Drupal\Core\DependencyInjection\ServiceProviderInterface; +use Symfony\Component\DependencyInjection\Reference; + +/** + * Defines the Mailsystem service provider. + */ +class MailsystemServiceProvider implements ServiceProviderInterface, ServiceModifierInterface { + + /** + * {@inheritdoc} + */ + public function register(ContainerBuilder $container) { + } + + /** + * {@inheritdoc} + */ + public function alter(ContainerBuilder $container) { + // Overrides mail-factory class to use our own mail manager. + $container->getDefinition('plugin.manager.mail') + ->setClass('Drupal\mailsystem\MailsystemManager') + ->addMethodCall('setThemeManager', [new Reference('theme.manager')]) + ->addMethodCall('setThemeInitialization', [new Reference('theme.initialization')]); + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/src/Tests/AdminFormSettingsTest.php b/dist/iekserver/modules/ready/mailsystem/src/Tests/AdminFormSettingsTest.php new file mode 100644 index 0000000000000000000000000000000000000000..6bfb47406a46ce66d1b45537478eca213e6f49b6 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/src/Tests/AdminFormSettingsTest.php @@ -0,0 +1,192 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem\Tests\AdminFormSettingsTest. + */ + +namespace Drupal\mailsystem\Tests; + +use Drupal\simpletest\WebTestBase; + +/** + * Tests the Administrator Settings UI. + * + * @group mailsystem + */ +class AdminFormSettingsTest extends WebTestBase { + + /** + * Modules to enable. + * + * @var array + */ + public static $modules = [ + 'mailsystem' + ]; + + /** + * Tests the Administrator Settings UI. + */ + public function testAdminMailSystemForm() { + // Unauthorized user should not have access. + $this->drupalGet('admin/config/system/mailsystem'); + $this->assertResponse(403); + + // Check the overview. + $user = $this->createUser(['administer_mailsystem']); + $this->drupalLogin($user); + $this->drupalGet(t('admin/config/system/mailsystem')); + $this->assertText(t('Mail System')); + // Check default theme options. + $this->assertOption('edit-mailsystem-default-theme', 'current'); + $this->assertOption('edit-mailsystem-default-theme', 'default'); + $this->assertOption('edit-mailsystem-default-theme', 'stable'); + $this->assertOption('edit-mailsystem-default-theme', 'classy'); + // Check custom module options labels. + $xpath = '//*[@id="edit-custom-custom-module"]'; + $this->assertTrue(strpos($this->xpath($xpath)[0]->asXml(), '>- Select -</option>')); + $this->assertTrue(strpos($this->xpath($xpath)[0]->asXml(), '>System</option>')); + $this->assertTrue(strpos($this->xpath($xpath)[0]->asXml(), '>User</option>')); + + // Configure the default Mail System. + $this->drupalPostForm(NULL, [ + 'mailsystem[default_formatter]' => 'test_mail_collector', + 'mailsystem[default_sender]' => 'test_mail_collector', + 'mailsystem[default_theme]' => 'current', + ], t('Save configuration')); + + // Configure a specific module configuration. + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_module_key]' => 'aaa', + 'custom[custom_formatter]' => 'test_mail_collector', + 'custom[custom_sender]' => 'test_mail_collector', + ], t('Add')); + $this->drupalGet(t('admin/config/system/mailsystem')); + $this->assertText('aaa'); + + // Add additional custom module settings, one with test_mail_collector and + // one with php_mail. + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_module_key]' => 'bbb', + 'custom[custom_formatter]' => 'test_mail_collector', + 'custom[custom_sender]' => 'test_mail_collector', + ], t('Add')); + $this->drupalGet(t('admin/config/system/mailsystem')); + $this->assertText('bbb'); + + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_module_key]' => 'ccc', + 'custom[custom_formatter]' => 'php_mail', + 'custom[custom_sender]' => 'php_mail', + ], t('Add')); + $this->drupalGet(t('admin/config/system/mailsystem')); + $this->assertText('ccc'); + + // Add a custom module settings, without specifying any key. + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_formatter]' => 'test_mail_collector', + 'custom[custom_sender]' => 'test_mail_collector', + ], t('Add')); + $this->assertText('All'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + // Try to add a custom module, first without setting the module, then + // without formatter nor sender, then just specifying a key. + $this->drupalPostForm(NULL, [ + 'custom[custom_module_key]' => 'ddd', + 'custom[custom_formatter]' => 'test_mail_collector', + 'custom[custom_sender]' => 'test_mail_collector', + ], t('Add')); + $this->assertNoText('ddd'); + $this->assertText('The module is required.'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_module_key]' => 'ddd', + ], t('Add')); + $this->assertNoText('ddd'); + $this->assertText('At least a formatter or sender is required.'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + $this->drupalPostForm(NULL, [ + 'custom[custom_module_key]' => 'ddd', + ], t('Add')); + $this->assertNoText('ddd'); + $this->assertText('The module is required.'); + $this->assertText('At least a formatter or sender is required.'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + // Checking the configuration. + $config = $this->config('mailsystem.settings'); + $this->assertEqual($config->get('theme'), 'current'); + $this->assertEqual($config->get('defaults.formatter'), 'test_mail_collector'); + $this->assertEqual($config->get('defaults.sender'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.aaa.formatter'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.aaa.sender'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.bbb.formatter'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.bbb.sender'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.ccc.formatter'), 'php_mail'); + $this->assertEqual($config->get('modules.system.ccc.sender'), 'php_mail'); + $this->assertEqual($config->get('modules.system.none.formatter'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.none.sender'), 'test_mail_collector'); + $this->assertNull($config->get('modules.system.ddd')); + + // Try to update the formatter of the module keyed as 'ccc' from the form. + $this->drupalPostForm(NULL, [ + 'custom[custom_module_key]' => 'ccc', + 'custom[custom_formatter]' => 'test_mail_collector', + ], t('Add')); + $this->assertText('The module is required.'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + // Try to update 'modules.system.ccc' formatter and sender from the form. + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_module_key]' => 'ccc', + 'custom[custom_formatter]' => 'test_mail_collector', + 'custom[custom_sender]' => 'test_mail_collector', + ], t('Add')); + $this->assertText('An entry for this combination exists already. Use the form below to update or remove it.'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + // Try to add a custom module with the same settings of an existing one, + // without formatter and sender. + $this->drupalPostForm(NULL, [ + 'custom[custom_module]' => 'system', + 'custom[custom_module_key]' => 'ccc', + ], t('Add')); + $this->assertText('An entry for this combination exists already. Use the form below to update or remove it.'); + $this->assertNoText('At least a formatter or sender is required.'); + $this->drupalGet(t('admin/config/system/mailsystem')); + + // Edit the second and third custom module formatter from the table. + $this->drupalPostForm(NULL, [ + 'custom[modules][system.bbb][formatter]' => 'php_mail', + 'custom[modules][system.ccc][formatter]' => 'test_mail_collector', + ], t('Save configuration')); + $config->set('modules.system.bbb.formatter', 'php_mail')->save(); + $config->set('modules.system.ccc.formatter', 'test_mail_collector')->save(); + $this->drupalGet(t('admin/config/system/mailsystem')); + $this->assertEqual($config->get('modules.system.aaa.formatter'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.bbb.formatter'), 'php_mail'); + $this->assertEqual($config->get('modules.system.ccc.formatter'), 'test_mail_collector'); + $this->assertEqual($config->get('modules.system.none.formatter'), 'test_mail_collector'); + + // Remove the first custom module. + $this->drupalPostForm(NULL, [ + 'custom[modules][system.aaa][remove]' => TRUE, + ], t('Save configuration')); + $config->clear('modules.system.aaa')->save(); + $this->drupalGet(t('admin/config/system/mailsystem')); + $this->assertNull($config->get('modules.system.aaa')); + $this->assertNotNull($config->get('modules.system.bbb')); + $this->assertNotNull($config->get('modules.system.ccc')); + $this->assertNotNull($config->get('modules.system.none')); + + } +} diff --git a/dist/iekserver/modules/ready/mailsystem/src/Tests/MailsystemTestThemeTest.php b/dist/iekserver/modules/ready/mailsystem/src/Tests/MailsystemTestThemeTest.php new file mode 100644 index 0000000000000000000000000000000000000000..1a24ed91c257bc5c14c488a840f84a51307bf8d5 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/src/Tests/MailsystemTestThemeTest.php @@ -0,0 +1,76 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem\Tests\MailsystemTestThemeTest. + */ + +namespace Drupal\mailsystem\Tests; + +use Drupal\simpletest\WebTestBase; + +/** + * Tests mail theme for formatting emails using a theme template. + * + * @group mailsystem + */ +class MailsystemTestThemeTest extends WebTestBase { + + /** + * Modules to enable. + * + * @var array + */ + public static $modules = [ + 'mailsystem', + 'mailsystem_test', + ]; + + /** + * The Mailsystem settings config object. + * + * @var \Drupal\Core\Config\Config + */ + protected $config; + + public function setUp() { + parent::setUp(); + $this->config = $this->config('mailsystem.settings'); + + + } + + /** + * Tests the mail theme. + */ + public function testMailTheme() { + + // Mail System uses its own configuration for the used mail plugins. + // Use the mail collector just like WebTestBase::initConfig(). + $this->config + ->set('defaults.sender', 'test_mail_collector') + ->set('defaults.formatter', 'test_mail_collector') + ->save(); + + // Send an email with the default setting (should NOT use the test theme). + $this->drupalGet('/mailsystem-test/theme'); + $mails = $this->drupalGetMails(); + + // Check the configuration and if the correct theme was used in mails. + $this->assertEqual($this->config->get('theme'), 'current'); + $this->assertTrue(strpos($mails[0]['body'], 'Anonymous (not verified)') !== FALSE); + + // Install the test theme and set it as the mail theme. + \Drupal::service('theme_handler')->install(array('mailsystem_test_theme')); + $this->config->set('theme', 'mailsystem_test_theme')->save(); + + // Send another email (now it should use the test theme). + $this->drupalGet('/mailsystem-test/theme'); + $mails = $this->drupalGetMails(); + + // Check the new configuration and ensure that our test theme and its + // implementation of the username template are used in mails. + $this->assertEqual($this->config->get('theme'), 'mailsystem_test_theme'); + $this->assertTrue(strpos($mails[1]['body'], 'Mailsystem test theme') !== FALSE); + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.info.yml b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.info.yml new file mode 100644 index 0000000000000000000000000000000000000000..8568b16094aa09123b02b69524d8e595a8eb651a --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.info.yml @@ -0,0 +1,13 @@ +name: Mailsystem Test +type: module +package: Mail +hidden: true +# core: 8.x +dependencies: + - mailsystem + +# Information added by Drupal.org packaging script on 2016-07-08 +version: '8.x-4.1' +core: '8.x' +project: 'mailsystem' +datestamp: 1467993737 diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.module b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.module new file mode 100644 index 0000000000000000000000000000000000000000..2da1ed6f7d6089b4324f4de29bd2afde761c9eef --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.module @@ -0,0 +1,25 @@ +<?php + +/** + * @file + * Enables the use of personal and site-wide contact forms. + */ + +use Drupal\user\Entity\User; + +/** + * Implements hook_mail(). + */ +function mailsystem_test_mail($key, &$message, $params) { + switch ($key) { + case 'theme_test': + $account = User::load(\Drupal::currentUser()->id()); + $username = array('#theme' => 'username', '#account' => $account); + + $message['subject'] = t('Testing mail theme.'); + $message['body'][] = (string) \Drupal::service('renderer')->renderPlain($username); + break; + } +} + + diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.routing.yml b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.routing.yml new file mode 100644 index 0000000000000000000000000000000000000000..fe2a6deeeb482b697fabb0172da429dbc3f4b6cf --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/mailsystem_test.routing.yml @@ -0,0 +1,9 @@ +mailsystem_test.theme: + path: '/mailsystem-test/theme' + defaults: + _title: 'Mailsystem theme' + _controller: '\Drupal\mailsystem_test\Controller\MailsystemTestController::sendMail' + options: + no_cache: 'TRUE' + requirements: + _access: 'TRUE' diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Controller/MailsystemTestController.php b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Controller/MailsystemTestController.php new file mode 100644 index 0000000000000000000000000000000000000000..335c845174eaf3488b1b26621794c3f77f34e9ec --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Controller/MailsystemTestController.php @@ -0,0 +1,34 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem_test\Controller\MailsystemTestController. + */ + +namespace Drupal\mailsystem_test\Controller; +use Symfony\Component\HttpFoundation\Response; + +/** + * A mailsystem test controller for use by tests in this file. + */ +class MailsystemTestController { + + /** + * Composes and optionally sends an email message. + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + */ + public function sendMail() { + + // Explicitly render something to initialize the theme registry to make + // sure that an initialized theme registry is properly switched. + $render = ['#theme' => 'item_list']; + \Drupal::service('renderer')->render($render); + + $module = 'mailsystem_test'; + $key = 'theme_test'; + $to = 'theme_test@example.com'; + $langcode = \Drupal::languageManager()->getDefaultLanguage()->getId(); + \Drupal::service('plugin.manager.mail')->mail($module, $key, $to, $langcode); + return new Response('', 204); + } +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/Dummy.php b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/Dummy.php new file mode 100644 index 0000000000000000000000000000000000000000..421a761baf5c8c3fffb5deda75c361fdbecd78e4 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/Dummy.php @@ -0,0 +1,48 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem_test\Plugin\Mail\Dummy. + */ + +namespace Drupal\mailsystem_test\Plugin\Mail; + +use Drupal\Core\Mail\MailInterface; + +/** + * Provides a 'Dummy' plugin to send emails. + * + * @Mail( + * id = "mailsystem_dummy", + * label = @Translation("Dummy Mail-Plugin"), + * description = @Translation("Dummy Plugin to debug the complete email on formatting and sending.") + * ) + */ +class Dummy implements MailInterface { + + /** + * {@inheritdoc} + */ + public function format(array $message) { + // TODO: Implement format() method. + \debug(array( + 'Subject' => $message['subject'], + 'Body' => $message['body'], + 'Headers' => $message['headers'], + ), 'Dummy: format()'); + return $message; + } + + /** + * {@inheritdoc} + */ + public function mail(array $message) { + // TODO: Implement mail() method. + \debug(array( + 'Subject' => $message['subject'], + 'Body' => $message['body'], + 'Headers' => $message['headers'], + ), 'Dummy: mail()'); + return TRUE; + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/DummyFormatter.php b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/DummyFormatter.php new file mode 100644 index 0000000000000000000000000000000000000000..662139b2c8f2eb30a358c4e9e28cd1b5df409227 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/DummyFormatter.php @@ -0,0 +1,42 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem_test\Plugin\Mail\DummyFormatter. + */ + +namespace Drupal\mailsystem_test\Plugin\Mail; + +use Drupal\Core\Mail\MailInterface; + +/** + * Provides a 'Dummy' plugin to format emails. + * + * @Mail( + * id = "mailsystem_dummyformatter", + * label = @Translation("Dummy Mailsystem formatter Plugin"), + * description = @Translation("Dummy Plugin to debug the email on formatting ,does not sending anything.") + * ) + */ +class DummyFormatter implements MailInterface { + + /** + * {@inheritdoc} + */ + public function format(array $message) { + // TODO: Implement format() method. + \debug(array( + 'Subject' => $message['subject'], + 'Body' => $message['body'], + 'Headers' => $message['headers'], + ), 'DummyFormatter: format()'); + return $message; + } + + /** + * {@inheritdoc} + */ + public function mail(array $message) { + return FALSE; + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/DummySender.php b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/DummySender.php new file mode 100644 index 0000000000000000000000000000000000000000..4f14400927ee3c27d976c16ff2998bda10889d18 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/modules/mailsystem_test/src/Plugin/Mail/DummySender.php @@ -0,0 +1,41 @@ +<?php +/** + * @file + * Contains \Drupal\mailsystem_test\Plugin\Mail\DummySender. + */ + +namespace Drupal\mailsystem_test\Plugin\Mail; + +use Drupal\Core\Mail\MailInterface; + +/** + * Provides a 'Dummy' plugin to format emails. + * + * @Mail( + * id = "mailsystem_dummysender", + * label = @Translation("Dummy Mailsystem sender Plugin"), + * description = @Translation("Dummy Plugin to debug the email instead of sending and does nothing on formatting.") + * ) + */ +class DummySender implements MailInterface { + /** + * {@inheritdoc} + */ + public function format(array $message) { + return $message; + } + + /** + * {@inheritdoc} + */ + public function mail(array $message) { + // TODO: Implement format() method. + \debug(array( + 'Subject' => $message['subject'], + 'Body' => $message['body'], + 'Headers' => $message['headers'], + ), 'DummySender: mail()'); + return $message; + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/src/Unit/AdapterTest.php b/dist/iekserver/modules/ready/mailsystem/tests/src/Unit/AdapterTest.php new file mode 100644 index 0000000000000000000000000000000000000000..7cae8eac0e6dbc8cdb60552197d65d88886c54a6 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/src/Unit/AdapterTest.php @@ -0,0 +1,116 @@ +<?php +/** + * @file + * Contains \Drupal\Tests\mailsystem\Unit\AdapterTest. + */ + +namespace Drupal\Tests\mailsystem\Unit; + +use Drupal\Core\Mail\MailInterface; +use Drupal\mailsystem\Adapter; +use Drupal\Tests\UnitTestCase; + +/** + * Test the adapter class from mailsystem which is used as the mail plugin. + * + * @group mailsystem + */ +class AdapterTest extends UnitTestCase { + + /** + * The Adapter we need to test. + * + * @var \Drupal\mailsystem\Adapter + */ + protected $adapter; + + /** + * Sender plugin instance. + * + * @var \Drupal\mailsystem_test\Plugin\Mail\Test + */ + protected $sender; + + /** + * Formatter plugin instance. + * + * @var \Drupal\mailsystem_test\Plugin\Mail\Test + */ + protected $formatter; + + /** + * {@inheritdoc} + */ + protected function setUp() { + $this->formatter = new Test(); + $this->sender = new Test(); + $this->adapter = new Adapter($this->formatter, $this->sender); + } + + /** + * Returns an empty message array to test with. + * + * @return array + * Associative array which holds an empty message to test with. + */ + protected function getEmptyMessage() { + return array( + 'subject' => 'test', + 'message' => 'message', + 'headers' => array(), + ); + } + + /** + * Test the right call to the formatting. + */ + public function testFormatting() { + $message = $this->adapter->format($this->getEmptyMessage()); + + $this->assertEquals(Test::TEST_SUBJECT, $message['subject'], 'Subject match'); + $this->assertEquals(Test::TEST_BODY, $message['body'], 'Body match'); + $this->assertEquals(array(Test::TEST_HEADER_NAME => Test::TEST_HEADER_VALUE), $message['headers'], 'Header match'); + } + + /** + * Test for successful and failed sending of a message through the Adapter. + */ + public function testSending() { + $message = $this->getEmptyMessage(); + + $this->assertFalse($this->adapter->mail($message), 'Sending message failed as expected'); + + $message['subject'] = Test::SEND_SUCCESS_SUBJECT; + $this->assertTrue($this->adapter->mail($message), 'Sending message successful as expected'); + } +} + +/** + * Provides a test plugin to send emails. + */ +class Test implements MailInterface { + const TEST_SUBJECT = 'Subject'; + const TEST_BODY = 'Vivamus varius commodo leo at eleifend. Nunc vestibulum dolor eget turpis pulvinar volutpat.'; + const TEST_HEADER_NAME = 'X-System'; + const TEST_HEADER_VALUE = 'D8 PHP Unit test'; + const SEND_SUCCESS_SUBJECT = 'Failed'; + + /** + * {@inheritdoc} + */ + public function format(array $message) { + return array( + 'subject' => self::TEST_SUBJECT, + 'body' => self::TEST_BODY, + 'headers' => array(self::TEST_HEADER_NAME => self::TEST_HEADER_VALUE), + ); + } + + /** + * {@inheritdoc} + */ + public function mail(array $message) { + return ($message['subject'] == self::SEND_SUCCESS_SUBJECT); + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/src/Unit/MailsystemManagerTest.php b/dist/iekserver/modules/ready/mailsystem/tests/src/Unit/MailsystemManagerTest.php new file mode 100644 index 0000000000000000000000000000000000000000..fc5303cd3580b4cd951636d9611b9a555898a3a9 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/src/Unit/MailsystemManagerTest.php @@ -0,0 +1,85 @@ +<?php +/** + * @file + * Contains \Drupal\Tests\mailsystem\Unit\MailsystemManagerTest. + */ + +namespace Drupal\Tests\mailsystem\Unit; + +use Drupal\Core\Render\RendererInterface; +use Drupal\Core\Theme\ThemeInitialization; +use Drupal\Core\Theme\ThemeManager; +use Drupal\mailsystem\MailsystemManager; +use Drupal\Tests\UnitTestCase; + +/** + * Test the MailsystemManager to return valid plugin instances based on the configuration. + * + * @group mailsystem + */ +class MailsystemManagerTest extends UnitTestCase { + /** + * Stores the configuration factory to test with. + * + * @var \Drupal\Core\Config\ConfigFactoryInterface + */ + protected $configFactory; + + /** + * The mailsystem manager. + * + * @var \Drupal\mailsystem\MailsystemManager + */ + protected $mailManager; + + /** + * {@inheritdoc} + */ + protected function setUp() { + // Create a configuration mock. + $this->configFactory = $this->getConfigFactoryStub(array( + 'mailsystem.settings' => array( + 'defaults' => array( + MailsystemManager::MAILSYSTEM_TYPE_FORMATTING => 'mailsystem_test', + MailsystemManager::MAILSYSTEM_TYPE_SENDING => 'mailsystem_test', + ), + MailsystemManager::MAILSYSTEM_MODULES_CONFIG => array( + 'module1' => array( + 'none' => array( + MailsystemManager::MAILSYSTEM_TYPE_FORMATTING => 'mailsystem_test', + MailsystemManager::MAILSYSTEM_TYPE_SENDING => 'mailsystem_test', + ) + ), + 'module2' => array( + 'mail_key' => array( + MailsystemManager::MAILSYSTEM_TYPE_FORMATTING => 'mailsystem_test', + MailsystemManager::MAILSYSTEM_TYPE_SENDING => 'mailsystem_test', + ) + ), + ), + ), + )); + + $namespaces = $this->getMock('\Traversable'); + $cache_backend = $this->getMock('\Drupal\Core\Cache\CacheBackendInterface'); + $module_handler = $this->getMock('\Drupal\Core\Extension\ModuleHandlerInterface'); + $logger_factory = $this->getMock('Drupal\Core\Logger\LoggerChannelFactoryInterface'); + $string_translation = $this->getMock('Drupal\Core\StringTranslation\TranslationInterface'); + + $theme_manager = $this->prophesize(ThemeManager::class); + $theme_initialization = $this->prophesize(ThemeInitialization::class); + + // The additional renderer argument only exists in 8.2.x, but the additional + // argument is ignored in 8.1.x. + $renderer = $this->prophesize(RendererInterface::class); + $this->mailManager = new MailsystemManager($namespaces, $cache_backend, $module_handler, $this->configFactory, $logger_factory, $string_translation, $renderer->reveal()); + + $this->mailManager->setThemeInitialization($theme_initialization->reveal()); + $this->mailManager->setThemeManager($theme_manager->reveal()); + } + + public function testGetInstances_Default() { + + } + +} diff --git a/dist/iekserver/modules/ready/mailsystem/tests/themes/mailsystem_test_theme/mailsystem_test_theme.info.yml b/dist/iekserver/modules/ready/mailsystem/tests/themes/mailsystem_test_theme/mailsystem_test_theme.info.yml new file mode 100644 index 0000000000000000000000000000000000000000..9da8f5c209a21f48e0f186823ef13e1fa10181a9 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/themes/mailsystem_test_theme/mailsystem_test_theme.info.yml @@ -0,0 +1,22 @@ +name: 'Mailsystem test theme' +type: theme +description: 'Theme for testing mailsystem' +# version: VERSION +# core: 8.x +regions: + sidebar_first: 'Left sidebar' + sidebar_second: 'Right sidebar' + content: Content + header: Header + footer: Footer + highlighted: Highlighted + help: Help +regions_hidden: + - sidebar_first + - sidebar_second + +# Information added by Drupal.org packaging script on 2016-07-08 +version: '8.x-4.1' +core: '8.x' +project: 'mailsystem' +datestamp: 1467993737 diff --git a/dist/iekserver/modules/ready/mailsystem/tests/themes/mailsystem_test_theme/templates/username.html.twig b/dist/iekserver/modules/ready/mailsystem/tests/themes/mailsystem_test_theme/templates/username.html.twig new file mode 100644 index 0000000000000000000000000000000000000000..43c081c667ed52d3a036f6b54a04fdc84191e395 --- /dev/null +++ b/dist/iekserver/modules/ready/mailsystem/tests/themes/mailsystem_test_theme/templates/username.html.twig @@ -0,0 +1,26 @@ +{# +/** + * @file + * Default theme implementation for displaying a username in a mail. + * + * Available variables: + * - account: The full account information for the user. + * - name: The user's name, sanitized. + * - extra: Additional text to append to the user's name, sanitized. + * - link_path: The path or URL of the user's profile page, home page, + * or other desired page to link to for more information about the user. + * - link_options: Options to pass to the url() function's $options parameter if + * linking the user's name to the user's page. + * - attributes: HTML attributes for the containing element. + * + * @see template_preprocess_username() + * + * @ingroup themeable + */ +#} +<p>Mailsystem test theme</p> +{% if link_path -%} + <a{{ attributes }}>{{ name }}{{ extra }}</a> +{%- else -%} + <span{{ attributes }}>{{ name }}{{ extra }}</span> +{%- endif -%} diff --git a/dist/iekserver/modules/ready/smtp/LICENSE.txt b/dist/iekserver/modules/ready/smtp/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..d159169d1050894d3ea3b98e1c965c4058208fe1 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +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 give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 Program +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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), 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 Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. 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 program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/dist/iekserver/modules/ready/smtp/README.txt b/dist/iekserver/modules/ready/smtp/README.txt new file mode 100644 index 0000000000000000000000000000000000000000..2ae3a916a4df2683120619b30fa39547b9cfe139 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/README.txt @@ -0,0 +1,42 @@ +SMTP Authentication Support module for Drupal 8.x. +This module adds SMTP functionality to Drupal. + +REQUIREMENTS +------------ +* Access to an SMTP server +* The following PHP extensions need to be installed: ereg, hash, date & pcre. + +* Optional: To connect to an SMTP server using SSL, you need to have the + openssl package installed on your server, and your webserver and PHP + installation need to have additional components installed and configured. + +INSTALLATION INSTRUCTIONS +------------------------- +1. Copy the files included in the tarball into a directory named "smtp" in + your Drupal /modules/ directory. +2. Login as site administrator. +3. Enable the SMTP Authentication Support module on the Manage -> Extend + page. +4. Fill in required settings on the Manage -> Configuration -> System -> + SMTP Authentication Support page. +5. Enjoy. + +NOTES +----- +This module sends email by connecting to an SMTP server. Therefore, you need +to have access to an SMTP server for this module to work. + +Drupal will often use the email address entered into Manage -> +Configuration -> Site information -> E-mail address as the from address. It is +important for this to be the correct address and some ISPs will block email that +comes from an invalid address. + +This module no longer uses the PHPMailer package as an external library, instead +a slimmed down version of the library have been relicensed and integrated with the +smtp module. + +Connecting to an SMTP server using SSL is possible only if PHP's openssl +extension is working. If the SMTP module detects openssl is available it +will display the options in the modules settings page. + +Sending mail to Gmail requires SSL or TLS. diff --git a/dist/iekserver/modules/ready/smtp/composer.json b/dist/iekserver/modules/ready/smtp/composer.json new file mode 100644 index 0000000000000000000000000000000000000000..160b4f3eb11710d474b08de0152da323acfee2a8 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/composer.json @@ -0,0 +1,10 @@ +{ + "name": "drupal/smtp", + "description": "Allow for site emails to be sent through an SMTP server of your choice.", + "type": "drupal-module", + "homepage": "https://www.drupal.org/project/smtp", + "support": { + "issues": "https://www.drupal.org/project/issues/smtp" + }, + "license": "GPL-2.0" +} \ No newline at end of file diff --git a/dist/iekserver/modules/ready/smtp/config/install/smtp.settings.yml b/dist/iekserver/modules/ready/smtp/config/install/smtp.settings.yml new file mode 100644 index 0000000000000000000000000000000000000000..fc05ca35578d693ead8acb66671d68e9b9872634 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/config/install/smtp.settings.yml @@ -0,0 +1,13 @@ +smtp_on: false +smtp_host: '' +smtp_hostbackup: '' +smtp_port: '25' +smtp_protocol: 'standard' +smtp_username: '' +smtp_password: '' +smtp_from: '' +smtp_fromname: '' +smtp_allowhtml: '' +smtp_test_address: '' +smtp_debugging: false +prev_mail_system: 'php_mail' diff --git a/dist/iekserver/modules/ready/smtp/config/schema/smtp.schema.yml b/dist/iekserver/modules/ready/smtp/config/schema/smtp.schema.yml new file mode 100644 index 0000000000000000000000000000000000000000..d94e0cdbad6609f404ee2c458f1c75d024e02a76 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/config/schema/smtp.schema.yml @@ -0,0 +1,43 @@ +smtp.settings: + type: config_object + label: 'SMTP config.' + mapping: + smtp_on: + type: boolean + label: 'Turn this module on or off' + smtp_host: + type: text + label: 'SMTP server' + smtp_hostbackup: + type: text + label: 'SMTP backup server' + smtp_port: + type: text + label: 'SMTP port' + smtp_protocol: + type: text + label: 'Use encrypted protocol' + smtp_username: + type: text + label: 'Username' + smtp_password: + type: text + label: 'Password' + smtp_from: + type: email + label: 'E-mail from address' + smtp_fromname: + type: text + label: 'E-mail from name' + smtp_allowhtml: + type: text + label: 'Allow to send e-mails formated as HTML' + smtp_test_address: + type: email + label: 'E-mail address to send a test e-mail to' + smtp_debugging: + type: boolean + label: 'Enable debugging' + prev_mail_system: + type: text + label: 'Previous mail system' diff --git a/dist/iekserver/modules/ready/smtp/smtp.info.yml b/dist/iekserver/modules/ready/smtp/smtp.info.yml new file mode 100644 index 0000000000000000000000000000000000000000..f0eed004a34b7279f1c80d6671bea94740cf75d9 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/smtp.info.yml @@ -0,0 +1,12 @@ +name: SMTP Authentication Support +description: "Allow for site emails to be sent through an SMTP server of your choice." +package: Mail +type: module +# core: 8.x +configure: smtp.config + +# Information added by Drupal.org packaging script on 2016-11-26 +version: '8.x-1.0-beta2' +core: '8.x' +project: 'smtp' +datestamp: 1480196584 diff --git a/dist/iekserver/modules/ready/smtp/smtp.install b/dist/iekserver/modules/ready/smtp/smtp.install new file mode 100644 index 0000000000000000000000000000000000000000..389f2507a9565f5cd7d56c9b29b48e6427990101 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/smtp.install @@ -0,0 +1,24 @@ +<?php + +/** + * @file + * The installation instructions for the SMTP Authentication Support. + */ + +/** + * Implements hook_uninstall(). + */ +function smtp_uninstall() { + $config = \Drupal::service('config.factory'); + $smtp_config = $config->getEditable('smtp.settings'); + + // Restore previous mail system. + $default_system_mail = 'php_mail'; + $mail_config = $config->getEditable('system.mail'); + $default_interface = (!$smtp_config->get('prev_mail_system')) ? $smtp_config->get('prev_mail_system') : $default_system_mail; + $mail_config ->set('interface.default', $default_interface) + ->save(); + + // Cleaning garbage. + $smtp_config->delete(); +} diff --git a/dist/iekserver/modules/ready/smtp/smtp.links.menu.yml b/dist/iekserver/modules/ready/smtp/smtp.links.menu.yml new file mode 100644 index 0000000000000000000000000000000000000000..1413bbfe26e99ad02da0e8639c72988c98f7930a --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/smtp.links.menu.yml @@ -0,0 +1,6 @@ +smtp.config: + title: SMTP Authentication Support + route_name: smtp.config + parent: system.admin_config_system + description: 'Allow for site emails to be sent through an SMTP server of your choice.' + weight: -20 diff --git a/dist/iekserver/modules/ready/smtp/smtp.module b/dist/iekserver/modules/ready/smtp/smtp.module new file mode 100644 index 0000000000000000000000000000000000000000..115a1562f8f075a74312cd33f7115a8203c6670e --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/smtp.module @@ -0,0 +1,106 @@ +<?php + +/** + * @file + * Enables Drupal to send e-mail directly to an SMTP server. + * + * This module uses a customized extract of the PHPMailer + * library (originally by Brent R. Matzelle, now maintained + * by Codeworx Tech.) relicensed from LGPL to GPL, included + * as a part of the module. + * + * Overriding mail handling in Drupal to make SMTP the default + * transport layer, requires to change the 'system.mail.interface' + * default value array('default' => 'Drupal\Core\Mail\PhpMail'). + * This module uses array('default' => 'SMTPMailSystem'). + */ + +/** + * Implements hook_help(). + */ +function smtp_help($path, $arg) { + switch ($path) { + case 'admin/help#smtp': + return t('Allow for site emails to be sent through an SMTP server of your choice.'); + } +} + +/** + * Implements hook_menu(). + */ +function smtp_menu() { + $items['admin/config/system/smtp'] = array( + 'title' => 'SMTP Authentication Support', + 'description' => 'Allow for site emails to be sent through an SMTP server of your choice.', + 'route_name' => 'smtp.config', + ); + return $items; +} + +/** + * Implements hook_permission(). + */ +function smtp_permission() { + return array( + 'administer smtp module' => array( + 'title' => t('Administer SMTP Authentication Support module'), + 'description' => t('Perform administration tasks for SMTP Authentication Support module.') + ), + ); +} + + +/** + * Implements hook_mail(). + */ +function smtp_mail($key, &$message, $params) { + if ($key == 'smtp-test') { + $message['subject'] = $params['subject']; + $message['body'] = $params['body']; + } +} + +/** + * Implementation of hook_queue_info(). + */ +function smtp_queue_info() { + $queues['smtp_send_queue'] = array( + 'worker callback' => 'smtp_send_queue_runner', + 'cron' => array( + 'time' => 60, // This is the max run time per cron run in seconds. + ), + ); + return $queues; +} + +/** + * smtp_send_queue queuer. + */ +function smtp_send_queue($mailerObj) { + $queue = Drupal::queue('smtp_send_queue'); + $queue->createItem($mailerObj); +} + +function smtp_send_queue_runner($variables) { + _smtp_mailer_send($variables); +} + +function _smtp_mailer_send($variables) { + $mailer = $variables['mailer']; + $to = $variables['to']; + $from = $variables['from']; + + $logger = \Drupal::logger('smtp'); + + // Let the people know what is going on. + $logger->info('Sending mail to: @to', array('@to' => $to)); + + // Try to send e-mail. If it fails, set watchdog entry. + if (!$mailer->Send()) { + $logger->error('Error sending e-mail from @from to @to: @error_message', array('@from' => $from, '@to' => $to, '@error_message' => $mailer->ErrorInfo)); + return FALSE; + } + + $mailer->SmtpClose(); + return TRUE; +} diff --git a/dist/iekserver/modules/ready/smtp/smtp.routing.yml b/dist/iekserver/modules/ready/smtp/smtp.routing.yml new file mode 100644 index 0000000000000000000000000000000000000000..23a37e35431cc5fad185da078ddc8097e1830b73 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/smtp.routing.yml @@ -0,0 +1,7 @@ +smtp.config: + path: '/admin/config/system/smtp' + defaults: + _title: 'SMTP Authentication Support' + _form: 'Drupal\smtp\Form\SMTPConfigForm' + requirements: + _permission: 'administer smtp module' diff --git a/dist/iekserver/modules/ready/smtp/src/Form/SMTPConfigForm.php b/dist/iekserver/modules/ready/smtp/src/Form/SMTPConfigForm.php new file mode 100644 index 0000000000000000000000000000000000000000..7d7b61de51b92a5c3e92ee0916bd1d21327f71c5 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/src/Form/SMTPConfigForm.php @@ -0,0 +1,293 @@ +<?php + +namespace Drupal\smtp\Form; + +use Drupal\Core\Form\ConfigFormBase; +use Drupal\Core\Form\FormStateInterface; +use Drupal\smtp\Plugin\Mail\SMTPMailSystem; + +/** + * Implements the SMTP admin settings form. + */ +class SMTPConfigForm extends ConfigFormBase { + + /** + * {@inheritdoc}. + */ + public function getFormID() { + return 'smtp_admin_settings'; + } + + /** + * {@inheritdoc}. + */ + public function buildForm(array $form, FormStateInterface $form_state) { + $config = $this->configFactory->get('smtp.settings'); + + if ($config->get('smtp_on')) { + drupal_set_message(t('SMTP module is active.')); + } + else { + drupal_set_message(t('SMTP module is INACTIVE.')); + } + drupal_set_message(t('Disabled fields are overridden in site-specific configuration file.'), 'warning'); + + $form['onoff'] = array( + '#type' => 'details', + '#title' => t('Install options'), + '#open' => TRUE, + ); + $form['onoff']['smtp_on'] = array( + '#type' => 'radios', + '#title' => t('Turn this module on or off'), + '#default_value' => $config->get('smtp_on') ? 'on' : 'off', + '#options' => array('on' => t('On'), 'off' => t('Off')), + '#description' => t('To uninstall this module you must turn it off here first.'), + '#disabled' => $this->isOverridden('smtp_on'), + ); + $form['server'] = array( + '#type' => 'details', + '#title' => t('SMTP server settings'), + '#open' => TRUE, + ); + $form['server']['smtp_host'] = array( + '#type' => 'textfield', + '#title' => t('SMTP server'), + '#default_value' => $config->get('smtp_host'), + '#description' => t('The address of your outgoing SMTP server.'), + '#disabled' => $this->isOverridden('smtp_host'), + ); + $form['server']['smtp_hostbackup'] = array( + '#type' => 'textfield', + '#title' => t('SMTP backup server'), + '#default_value' => $config->get('smtp_hostbackup'), + '#description' => t('The address of your outgoing SMTP backup server. If the primary server can\'t be found this one will be tried. This is optional.'), + '#disabled' => $this->isOverridden('smtp_hostbackup'), + ); + $form['server']['smtp_port'] = array( + '#type' => 'number', + '#title' => t('SMTP port'), + '#size' => 6, + '#maxlength' => 6, + '#default_value' => $config->get('smtp_port'), + '#description' => t('The default SMTP port is 25, if that is being blocked try 80. Gmail uses 465. See :url for more information on configuring for use with Gmail.', array(':url' => 'http://gmail.google.com/support/bin/answer.py?answer=13287')), + '#disabled' => $this->isOverridden('smtp_port'), + ); + // Only display the option if openssl is installed. + if (function_exists('openssl_open')) { + $encryption_options = array( + 'standard' => t('No'), + 'ssl' => t('Use SSL'), + 'tls' => t('Use TLS'), + ); + $encryption_description = t('This allows connection to an SMTP server that requires SSL encryption such as Gmail.'); + } + // If openssl is not installed, use normal protocol. + else { + $config->set('smtp_protocol', 'standard'); + $encryption_options = array('standard' => t('No')); + $encryption_description = t('Your PHP installation does not have SSL enabled. See the :url page on php.net for more information. Gmail requires SSL.', array(':url' => 'http://php.net/openssl')); + } + $form['server']['smtp_protocol'] = array( + '#type' => 'select', + '#title' => t('Use encrypted protocol'), + '#default_value' => $config->get('smtp_protocol'), + '#options' => $encryption_options, + '#description' => $encryption_description, + '#disabled' => $this->isOverridden('smtp_protocol'), + ); + + $form['auth'] = array( + '#type' => 'details', + '#title' => t('SMTP Authentication'), + '#description' => t('Leave blank if your SMTP server does not require authentication.'), + '#open' => TRUE, + ); + $form['auth']['smtp_username'] = array( + '#type' => 'textfield', + '#title' => t('Username'), + '#default_value' => $config->get('smtp_username'), + '#description' => t('SMTP Username.'), + '#disabled' => $this->isOverridden('smtp_username'), + ); + $form['auth']['smtp_password'] = array( + '#type' => 'password', + '#title' => t('Password'), + '#default_value' => $config->get('smtp_password'), + '#description' => t('SMTP password. If you have already entered your password before, you should leave this field blank, unless you want to change the stored password. Please note that this password will be stored as plain-text inside Drupal\'s core configuration variables.'), + '#disabled' => $this->isOverridden('smtp_password'), + ); + + $form['email_options'] = array( + '#type' => 'details', + '#title' => t('E-mail options'), + '#open' => TRUE, + ); + $form['email_options']['smtp_from'] = array( + '#type' => 'textfield', + '#title' => t('E-mail from address'), + '#default_value' => $config->get('smtp_from'), + '#description' => t('The e-mail address that all e-mails will be from.'), + '#disabled' => $this->isOverridden('smtp_from'), + ); + $form['email_options']['smtp_fromname'] = array( + '#type' => 'textfield', + '#title' => t('E-mail from name'), + '#default_value' => $config->get('smtp_fromname'), + '#description' => t('The name that all e-mails will be from. If left blank will use a default of: @name', + ['@name' => $this->configFactory->get('system.site')->get('name')]), + '#disabled' => $this->isOverridden('smtp_fromname'), + ); + $form['email_options']['smtp_allowhtml'] = array( + '#type' => 'checkbox', + '#title' => t('Allow to send e-mails formatted as HTML'), + '#default_value' => $config->get('smtp_allowhtml'), + '#description' => t('Checking this box will allow HTML formatted e-mails to be sent with the SMTP protocol.'), + '#disabled' => $this->isOverridden('smtp_allowhtml'), + ); + + $form['email_test'] = array( + '#type' => 'details', + '#title' => t('Send test e-mail'), + '#open' => TRUE, + ); + $form['email_test']['smtp_test_address'] = array( + '#type' => 'textfield', + '#title' => t('E-mail address to send a test e-mail to'), + '#default_value' => '', + '#description' => t('Type in an address to have a test e-mail sent there.'), + ); + + $form['smtp_debugging'] = array( + '#type' => 'checkbox', + '#title' => t('Enable debugging'), + '#default_value' => $config->get('smtp_debugging'), + '#description' => t('Checking this box will print SMTP messages from the server for every e-mail that is sent.'), + '#disabled' => $this->isOverridden('smtp_debugging'), + ); + + return parent::buildForm($form, $form_state); + } + + /** + * Check if config variable is overridden by the settings.php. + * + * @param string $name + * STMP settings key. + * + * @return bool + */ + protected function isOverridden($name) { + $original = $this->configFactory->getEditable('smtp.settings')->get($name); + $current = $this->configFactory->get('smtp.settings')->get($name); + return $original != $current; + } + + /** + * {@inheritdoc} + */ + public function validateForm(array &$form, FormStateInterface $form_state) { + $values = $form_state->getValues(); + + if ($values['smtp_on'] == 'on' && $values['smtp_host'] == '') { + $form_state->setErrorByName('smtp_host', $this->t('You must enter an SMTP server address.')); + } + + if ($values['smtp_on'] == 'on' && $values['smtp_port'] == '') { + $form_state->setErrorByName('smtp_port', $this->t('You must enter an SMTP port number.')); + } + + if ($values['smtp_from'] && !\Drupal::service('email.validator')->isValid($values['smtp_from'])) { + $form_state->setErrorByName('smtp_from', $this->t('The provided from e-mail address is not valid.')); + } + + if ($values['smtp_test_address'] && !\Drupal::service('email.validator')->isValid($values['smtp_test_address'])) { + $form_state->setErrorByName('smtp_test_address', $this->t('The provided test e-mail address is not valid.')); + } + + // If username is set empty, we must set both username/password empty as well. + if (empty($values['smtp_username'])) { + $values['smtp_password'] = ''; + } + // A little hack. When form is presented, the password is not shown (Drupal way of doing). + // So, if user submits the form without changing the password, we must prevent it from being reset. + elseif (empty($values['smtp_password'])) { + $form_state->unsetValue('smtp_password'); + } + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $values = $form_state->getValues(); + $config = $this->configFactory->getEditable('smtp.settings'); + $mail_config = $this->configFactory->getEditable('system.mail'); + $mail_system = $mail_config->get('interface.default'); + + // Updating config vars. + if (isset($values['smtp_password']) && !$this->isOverridden('smtp_password')) { + $config->set('smtp_password', $values['smtp_password']); + } + if (!$this->isOverridden('smtp_on')) { + $config->set('smtp_on', $values['smtp_on'] == 'on')->save(); + } + $config_keys = [ + 'smtp_host', + 'smtp_hostbackup', + 'smtp_port', + 'smtp_protocol', + 'smtp_username', + 'smtp_from', + 'smtp_fromname', + 'smtp_allowhtml', + 'smtp_debugging', + ]; + foreach ($config_keys as $name) { + if (!$this->isOverridden($name)) { + $config->set($name, $values[$name])->save(); + } + } + + // Set as default mail system if module is enabled. + if ($config->get('smtp_on')) { + if ($mail_system != 'SMTPMailSystem') { + $config->set('prev_mail_system', $mail_system); + } + $mail_system = 'SMTPMailSystem'; + $mail_config->set('interface.default', $mail_system)->save(); + } + else { + $mail_system = $config->get('prev_mail_system'); + $mail_config->set('interface.default', $mail_system)->save(); + } + + // If an address was given, send a test e-mail message. + if ($test_address = $values['smtp_test_address']) { + $params['subject'] = t('Drupal SMTP test e-mail'); + $params['body'] = array(t('If you receive this message it means your site is capable of using SMTP to send e-mail.')); + $account = \Drupal::currentUser(); + // If module is off, send the test message with SMTP by temporarily overriding. + if (!$config->get('smtp_on')) { + $original = $mail_config->get('interface'); + $mail_system = 'SMTPMailSystem'; + $mail_config->set('interface.default', $mail_system)->save(); + } + \Drupal::service('plugin.manager.mail')->mail('smtp', 'smtp-test', $test_address, $account->getPreferredLangcode(), $params); + if (!$config->get('smtp_on')) { + $mail_config->set('interface', $original)->save(); + } + drupal_set_message(t('A test e-mail has been sent to @email via SMTP. You may want to check the log for any error messages.', ['@email' => $test_address])); + } + + parent::submitForm($form, $form_state); + } + + /** + * {@inheritdoc} + * + * @todo - Flesh this out. + */ + public function getEditableConfigNames() {} + +} diff --git a/dist/iekserver/modules/ready/smtp/src/PHPMailer/PHPMailer.php b/dist/iekserver/modules/ready/smtp/src/PHPMailer/PHPMailer.php new file mode 100644 index 0000000000000000000000000000000000000000..ed0761df5245d76cf34b2bf8af413ee95e608bfc --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/src/PHPMailer/PHPMailer.php @@ -0,0 +1,2329 @@ +<?php + +/*~ class.phpmailer.php +Orginal release information: +.---------------------------------------------------------------------------. +| Software: PHPMailer - PHP email class | +| Version: 5.1 | +| Contact: via sourceforge.net support pages (also www.worxware.com) | +| Info: http://phpmailer.sourceforge.net | +| Support: http://sourceforge.net/projects/phpmailer/ | +| ------------------------------------------------------------------------- | +| Admin: Andy Prevost (project admininistrator) | +| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net | +| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net | +| Founder: Brent R. Matzelle (original founder) | +| 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. | +| ------------------------------------------------------------------------- | +| We offer a number of paid services (www.worxware.com): | +| - Web Hosting on highly optimized fast and secure servers | +| - Technology Consulting | +| - Oursourcing (highly qualified programmers and graphic designers) | +'---------------------------------------------------------------------------' +*/ + +namespace Drupal\smtp\PHPMailer; + +use Drupal\smtp\PHPMailer\SMTP; +use Drupal\smtp\Plugin\Exception\PHPMailerException; + +/** + * PHPMailer - PHP email transport class + * NOTE: Requires PHP version 5 or later + * @package PHPMailer + * @author Andy Prevost + * @author Marcus Bointon + * @copyright 2004 - 2009 Andy Prevost + */ + +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 = ''; + + /** + * 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 + * 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.1'; + + ///////////////////////////////////////////////// + // PROPERTIES, PRIVATE AND PROTECTED + ///////////////////////////////////////////////// + + private $smtp = NULL; + private $to = array(); + private $cc = array(); + private $bcc = array(); + private $ReplyTo = array(); + private $all_recipients = array(); + private $attachment = array(); + private $CustomHeader = array(); + private $message_type = ''; + private $boundary = array(); + private $error_count = 0; + private $sign_cert_file = ""; + private $sign_key_file = ""; + private $sign_key_pass = ""; + private $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 = $this->is_html = 'text/html'; + } + else { + $this->ContentType = $this->is_html = '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 private + */ + private function AddAnAddress($kind, $address, $name = '') { + if (!preg_match('/^(to|cc|bcc|ReplyTo)$/', $kind)) { + echo '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(t('Invalid address') . ': ' . $address); + if ($this->exceptions) { + throw new phpmailerException(t('Invalid address') . ': ' . $address); + } + echo t('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(t('Invalid address') . ': ' . $address); + if ($this->exceptions) { + throw new phpmailerException(t('Invalid address') . ': ' . $address); + } + echo t('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 ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) { + throw new phpmailerException(t('You must provide at least one recipient email 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(); + $header = $this->CreateHeader(); + $body = $this->CreateBody(); + + if (empty($this->Body)) { + throw new phpmailerException(t('Message body empty'), self::STOP_CRITICAL); + } + + // digitally sign with DKIM if enabled + if ($this->DKIM_domain && $this->DKIM_private) { + $header_dkim = $this->DKIM_Add($header, $this->Subject, $body); + $header = str_replace("\r\n", "\n", $header_dkim) . $header; + } + + // Choose the mailer and send through it + switch ($this->Mailer) { + case 'sendmail': + return $this->SendmailSend($header, $body); + case 'smtp': + return $this->SmtpSend($header, $body); + default: + return $this->MailSend($header, $body); + } + + } 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(t('Could not execute: !smail', array('!smail' => $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(t('Could not execute: !smail', array('!smail' => $this->Sendmail)), self::STOP_CRITICAL); + } + } + } + else { + if (!@$mail = popen($sendmail, 'w')) { + throw new phpmailerException(t('Could not execute: !smail', array('!smail' => $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(t('Could not execute: !smail', array('!smail' => $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); + + $params = sprintf("-oi -f %s", $this->Sender); + if ($this->Sender != '' && strlen(ini_get('safe_mode'))< 1) { + $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(t('Could not instantiate mail function.'), 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) { + $bad_rcpt = array(); + + if (!$this->SmtpConnect()) { + throw new phpmailerException(t('SMTP Error: Could not connect to SMTP host.'), self::STOP_CRITICAL); + } + $smtp_from = ($this->Sender == '') ? $this->From : $this->Sender; + if (!$this->smtp->Mail($smtp_from)) { + throw new phpmailerException(t('The following From address failed: !from', array('!from' => $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(t('SMTP Error: The following recipients failed: @bad', array('@bad' => $badaddresses))); + } + if (!$this->smtp->Data($header . $body)) { + throw new phpmailerException(t('SMTP Error: 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(t('StartTLS not supported by server or could not initiate session.')); + } + + //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(t('SMTP Error: Could not authenticate.')); + } + } + } + $index++; + if (!$connection) { + throw new phpmailerException(t('SMTP Error: Could not connect to SMTP 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(); + } + } + } + + ///////////////////////////////////////////////// + // 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_attachments': + $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(REQUEST_TIME)); + $this->boundary[1] = 'b1_' . $uniq_id; + $this->boundary[2] = 'b2_' . $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); + $result .= $this->HeaderLine('X-Mailer', 'PHPMailer ' . $this->Version . ' (phpmailer.sourceforge.net)'); + + 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 .= sprintf("Content-Type: %s; charset=\"%s\"", $this->ContentType, $this->CharSet); + break; + case 'attachments': + case 'alt_attachments': + if ($this->InlineImageExists()) { + $result .= sprintf("Content-Type: %s;%s\ttype=\"text/html\";%s\tboundary=\"%s\"%s", 'multipart/related', $this->LE, $this->LE, $this->boundary[1], $this->LE); + } + else { + $result .= $this->HeaderLine('Content-Type', 'multipart/mixed;'); + $result .= $this->TextLine("\tboundary=\"" . $this->boundary[1] . '"'); + } + break; + case 'alt': + $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 '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 'plain': + $body .= $this->EncodeString($this->Body, $this->Encoding); + break; + case 'attachments': + if ($this->is_html) { + $body .= $this->GetBoundary($this->boundary[1], '', $this->is_html, ''); + } + else { + $body .= $this->GetBoundary($this->boundary[1], '', '', ''); + } + $body .= $this->EncodeString($this->Body, $this->Encoding); + $body .= $this->LE; + $body .= $this->AttachAll(); + break; + case 'alt_attachments': + $body .= sprintf("--%s%s", $this->boundary[1], $this->LE); + $body .= sprintf("Content-Type: %s;%s" . "\tboundary=\"%s\"%s", 'multipart/alternative', $this->LE, $this->boundary[2], $this->LE . $this->LE); + $body .= $this->GetBoundary($this->boundary[2], '', 'text/plain', '') . $this->LE; // Create text body + $body .= $this->EncodeString($this->AltBody, $this->Encoding); + $body .= $this->LE . $this->LE; + $body .= $this->GetBoundary($this->boundary[2], '', 'text/html', '') . $this->LE; // Create the HTML body + $body .= $this->EncodeString($this->Body, $this->Encoding); + $body .= $this->LE . $this->LE; + $body .= $this->EndBoundary($this->boundary[2]); + $body .= $this->AttachAll(); + 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(t('Signing Error: !err', array('!err' => openssl_error_string()))); + } + } catch (phpmailerException $e) { + $body = ''; + if ($this->exceptions) { + throw $e; + } + } + } + + return $body; + } + + /** + * Returns the start of a message boundary. + * @access private + */ + private 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 private + */ + private function EndBoundary($boundary) { + return $this->LE . '--' . $boundary . '--' . $this->LE; + } + + /** + * Sets the message type. + * @access private + * @return void + */ + private function SetMessageType() { + if (count($this->attachment) < 1 && strlen($this->AltBody) < 1) { + $this->message_type = 'plain'; + } + else { + if (count($this->attachment) > 0) { + $this->message_type = 'attachments'; + } + if (strlen($this->AltBody) > 0 && count($this->attachment) < 1) { + $this->message_type = 'alt'; + } + if (strlen($this->AltBody) > 0 && count($this->attachment) > 0) { + $this->message_type = 'alt_attachments'; + } + } + } + + /** + * 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(t('Could not access file: @nofile', array('@nofile' => $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 private + * @return string + */ + private function AttachAll() { + // Return text of body + $mime = array(); + $cidUniq = array(); + $incl = array(); + + // Add all attachments + foreach ($this->attachment as $attachment) { + // Check for string attachment + $bString = $attachment[5]; + if ($bString) { + $string = $attachment[0]; + } + else { + $path = $attachment[0]; + } + + if (in_array($attachment[0], $incl)) { + continue; + } + + $filename = $attachment[1]; + $name = $attachment[2]; + $encoding = $attachment[3]; + $type = $attachment[4]; + $disposition = $attachment[6]; + $cid = $attachment[7]; + $incl[] = $attachment[0]; + + if ($disposition == 'inline' && isset($cidUniq[$cid])) { + continue; + } + + $cidUniq[$cid] = TRUE; + + $mime[] = sprintf("--%s%s", $this->boundary[1], $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", $this->boundary[1], $this->LE); + + return join('', $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 private + * @return string + */ + private function EncodeFile($path, $encoding = 'base64') { + try { + if (!is_readable($path)) { + throw new phpmailerException(t('File Error: Could not open file: @nofile', array('@nofile' => $path)), self::STOP_CONTINUE); + } + if (function_exists('get_magic_quotes')) { + function get_magic_quotes() { + return FALSE; + } + } + $magic_quotes = get_magic_quotes_runtime(); + if ($magic_quotes) { + if (version_compare(PHP_VERSION, '5.3.0', '<')) { + set_magic_quotes_runtime(0); + } + else { + ini_set('magic_quotes_runtime', 0); + } + } + $file_buffer = file_get_contents($path); + $file_buffer = $this->EncodeString($file_buffer, $encoding); + if ($magic_quotes) { + if (version_compare(PHP_VERSION, '5.3.0', '<')) { + set_magic_quotes_runtime($magic_quotes); + } + else { + ini_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(t('Unknown encoding: @enc', array('@enc' => $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'; + } + elseif ( $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_callback("/([^A-Za-z0-9!*+\/ -])/", function($matches) { + return sprintf('%02X', ord($matches[1])); + }, $encoded); + break; + case 'comment': + $encoded = preg_replace_callback("/([\(\)\"])/", function($matches) { + return sprintf('%02X', ord($matches[1])); + }, $encoded); + case 'text': + default: + // Replace every high ascii, control =, ? and _ characters + $encoded = preg_replace_callback('/([\000-\011\013\014\016-\037\075\077\137\177-\377])/', function($matches) { + return sprintf('%02X', ord($matches[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(t('Could not access file: @nofile', array('@nofile' => $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; + } + + /** + * 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; + } + + ///////////////////////////////////////////////// + // 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>' . t('SMTP server error: @lasterror', array('@lasterror' => $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 private + * @return string + */ + private 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 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 private + * @return string + */ + private 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(t('Cannot set or reset variable: @name', array('@name' => $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 = REQUEST_TIME; // Signature Timestamp = seconds since 00:00:00 - Jan 1, 1970 (UTC time zone) + $subject_header = "Subject: $subject"; + $headers = explode("\r\n", $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); + } + } +} diff --git a/dist/iekserver/modules/ready/smtp/src/PHPMailer/SMTP.php b/dist/iekserver/modules/ready/smtp/src/PHPMailer/SMTP.php new file mode 100644 index 0000000000000000000000000000000000000000..00e548d2e63ea60d571c71b2d89d1d441fac8c89 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/src/PHPMailer/SMTP.php @@ -0,0 +1,813 @@ +<?php + +/*~ class.smtp.php +Orginal release information: +.---------------------------------------------------------------------------. +| Software: PHPMailer - PHP email class | +| Version: 5.1 | +| Contact: via sourceforge.net support pages (also www.codeworxtech.com) | +| Info: http://phpmailer.sourceforge.net | +| Support: http://sourceforge.net/projects/phpmailer/ | +| ------------------------------------------------------------------------- | +| Admin: Andy Prevost (project admininistrator) | +| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net | +| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net | +| Founder: Brent R. Matzelle (original founder) | +| 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. | +| ------------------------------------------------------------------------- | +| We offer a number of paid services (www.codeworxtech.com): | +| - Web Hosting on highly optimized fast and secure servers | +| - Technology Consulting | +| - Oursourcing (highly qualified programmers and graphic designers) | +'---------------------------------------------------------------------------' +*/ + +/** + * 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 + */ + +namespace Drupal\smtp\PHPMailer; + +/** + * 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; + + ///////////////////////////////////////////////// + // 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; + } +} diff --git a/dist/iekserver/modules/ready/smtp/src/Plugin/Exception/PHPMailerException.php b/dist/iekserver/modules/ready/smtp/src/Plugin/Exception/PHPMailerException.php new file mode 100644 index 0000000000000000000000000000000000000000..0ba1185fb00e4afb2f473f5b45593a0cb91357dd --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/src/Plugin/Exception/PHPMailerException.php @@ -0,0 +1,10 @@ +<?php + +namespace Drupal\smtp\Plugin\Exception; + +class phpmailerException extends \Exception { + public function errorMessage() { + $errorMsg = '<strong>' . $this->getMessage() . "</strong><br />\n"; + return $errorMsg; + } +} diff --git a/dist/iekserver/modules/ready/smtp/src/Plugin/Mail/SMTPMailSystem.php b/dist/iekserver/modules/ready/smtp/src/Plugin/Mail/SMTPMailSystem.php new file mode 100644 index 0000000000000000000000000000000000000000..2579303e4e99c5909b6c996f5a54aff1b4f60dc1 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/src/Plugin/Mail/SMTPMailSystem.php @@ -0,0 +1,638 @@ +<?php + +namespace Drupal\smtp\Plugin\Mail; + +use Drupal\Component\Utility\Unicode; +use Drupal\Core\Logger\LoggerChannelFactoryInterface; +use Drupal\Core\Mail\MailFormatHelper; +use Drupal\Core\Mail\MailInterface; +use Drupal\Core\Plugin\ContainerFactoryPluginInterface; +use Drupal\smtp\PHPMailer\PHPMailer; +use Psr\Log\LoggerInterface; +use Symfony\Component\DependencyInjection\ContainerInterface; + +/** + * Modify the drupal mail system to use smtp when sending emails. + * Include the option to choose between plain text or HTML + * + * @Mail( + * id = "SMTPMailSystem", + * label = @Translation("SMTP Mailer"), + * description = @Translation("Sends the message, using SMTP.") + * ) + */ +class SMTPMailSystem implements MailInterface, ContainerFactoryPluginInterface { + protected $AllowHtml; + protected $smtpConfig; + + /** + * Logger + * @var LoggerInterface + */ + protected $logger; + + /** + * Constructs a SMPTMailSystem object. + * @param array $configuration + * @param $plugin_id + * @param $plugin_definition + * @param \Psr\Log\LoggerInterface $logger + */ + public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerChannelFactoryInterface $logger) { + $this->smtpConfig = \Drupal::config('smtp.settings'); + $this->logger = $logger; + } + + /** + * Creates an instance of the plugin. + * + * @param \Symfony\Component\DependencyInjection\ContainerInterface $container + * The container to pull out services used in the plugin. + * @param array $configuration + * A configuration array containing information about the plugin instance. + * @param string $plugin_id + * The plugin ID for the plugin instance. + * @param mixed $plugin_definition + * The plugin implementation definition. + * + * @return static + * Returns an instance of this plugin. + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static($configuration, $plugin_id, $plugin_definition, $container->get('logger.factory')); + } + + /** + * Concatenate and wrap the e-mail body for either + * plain-text or HTML emails. + * + * @param $message + * A message array, as described in hook_mail_alter(). + * + * @return + * The formatted $message. + */ + public function format(array $message) { + $this->AllowHtml = $this->smtpConfig->get('smtp_allowhtml'); + // Join the body array into one string. + $message['body'] = implode("\n\n", $message['body']); + if ($this->AllowHtml == 0) { + // Convert any HTML to plain-text. + $message['body'] = MailFormatHelper::htmlToText($message['body']); + // Wrap the mail body for sending. + $message['body'] = MailFormatHelper::wrapMail($message['body']); + } + return $message; + } + + /** + * Send the e-mail message. + * + * @see drupal_mail() + * + * @param $message + * A message array, as described in hook_mail_alter(). + * @return + * TRUE if the mail was successfully accepted, otherwise FALSE. + */ + public function mail(array $message) { + $to = $message['to']; + $from = $message['from']; + $body = $message['body']; + $headers = $message['headers']; + $subject = $message['subject']; + + // Create a new PHPMailer object - autoloaded from registry. + $mailer = new PHPMailer(); + + // Turn on debugging, if requested. + if ($this->smtpConfig->get('smtp_debugging') == 1) { + $mailer->SMTPDebug = TRUE; + } + + // Set the from name. + $from_name = $this->smtpConfig->get('smtp_fromname'); + if (empty($from_name)) { + // If value is not defined in settings, use site_name. + $from_name = \Drupal::config('system.site')->get('name'); + } + + // Set SMTP module email from. + if (\Drupal::service('email.validator')->isValid($this->smtpConfig->get('smtp_from'))) { + $from = $this->smtpConfig->get('smtp_from'); + $headers['Sender'] = $from; + $headers['Return-Path'] = $from; + $headers['Reply-To'] = $from; + } + + // Defines the From value to what we expect. + $mailer->From = $from; + $mailer->FromName = $from_name; + $mailer->Sender = $from; + + // Create the list of 'To:' recipients. + $torecipients = explode(',', $to); + foreach ($torecipients as $torecipient) { + $to_comp = $this->_get_components($torecipient); + $mailer->AddAddress($to_comp['email'], $to_comp['name']); + } + + // Parse the headers of the message and set the PHPMailer object's settings + // accordingly. + foreach ($headers as $key => $value) { + //watchdog('error', 'Key: ' . $key . ' Value: ' . $value); + switch (strtolower($key)) { + case 'from': + if ($from == NULL or $from == '') { + // If a from value was already given, then set based on header. + // Should be the most common situation since drupal_mail moves the + // from to headers. + $from = $value; + $mailer->From = $value; + // then from can be out of sync with from_name ! + $mailer->FromName = ''; + $mailer->Sender = $value; + } + break; + case 'content-type': + // Parse several values on the Content-type header, storing them in an array like + // key=value -> $vars['key']='value' + $vars = explode(';', $value); + foreach ($vars as $i => $var) { + if ($cut = strpos($var, '=')) { + $new_var = trim(strtolower(substr($var, $cut + 1))); + $new_key = trim(substr($var, 0, $cut)); + unset($vars[$i]); + $vars[$new_key] = $new_var; + } + } + // Set the charset based on the provided value, otherwise set it to UTF-8 (which is Drupals internal default). + $mailer->CharSet = isset($vars['charset']) ? $vars['charset'] : 'UTF-8'; + // If $vars is empty then set an empty value at index 0 to avoid a PHP warning in the next statement + $vars[0] = isset($vars[0])?$vars[0]:''; + + switch ($vars[0]) { + case 'text/plain': + // The message includes only a plain text part. + $mailer->IsHTML(FALSE); + $content_type = 'text/plain'; + break; + case 'text/html': + // The message includes only an HTML part. + $mailer->IsHTML(TRUE); + $content_type = 'text/html'; + break; + case 'multipart/related': + // Get the boundary ID from the Content-Type header. + $boundary = $this->_get_substring($value, 'boundary', '"', '"'); + + // The message includes an HTML part w/inline attachments. + $mailer->ContentType = $content_type = 'multipart/related; boundary="' . $boundary . '"'; + break; + case 'multipart/alternative': + // The message includes both a plain text and an HTML part. + $mailer->ContentType = $content_type = 'multipart/alternative'; + + // Get the boundary ID from the Content-Type header. + $boundary = $this->_get_substring($value, 'boundary', '"', '"'); + break; + case 'multipart/mixed': + // The message includes one or more attachments. + $mailer->ContentType = $content_type = 'multipart/mixed'; + + // Get the boundary ID from the Content-Type header. + $boundary = $this->_get_substring($value, 'boundary', '"', '"'); + break; + default: + // Everything else is unsuppored by PHPMailer. + drupal_set_message(t('The %header of your message is not supported by PHPMailer and will be sent as text/plain instead.', array('%header' => "Content-Type: $value")), 'error'); + $this->logger->error(t('The %header of your message is not supported by PHPMailer and will be sent as text/plain instead.', array('%header' => "Content-Type: $value"))); + + // Force the Content-Type to be text/plain. + $mailer->IsHTML(FALSE); + $content_type = 'text/plain'; + } + break; + + case 'reply-to': + // Only add a "reply-to" if it's not the same as "return-path". + if ($value != $headers['Return-Path']) { + $reply_to_comp = $this->_get_components($value); + $mailer->AddReplyTo($reply_to_comp['email'], $reply_to_comp['name']); + } + break; + + case 'content-transfer-encoding': + $mailer->Encoding = $value; + break; + + case 'return-path': + $mailer->Sender = $value; + break; + + case 'mime-version': + case 'x-mailer': + // Let PHPMailer specify these. + break; + + case 'errors-to': + $mailer->AddCustomHeader('Errors-To: ' . $value); + break; + + case 'cc': + $ccrecipients = explode(',', $value); + foreach ($ccrecipients as $ccrecipient) { + $cc_comp = $this->_get_components($ccrecipient); + $mailer->AddCC($cc_comp['email'], $cc_comp['name']); + } + break; + + case 'bcc': + $bccrecipients = explode(',', $value); + foreach ($bccrecipients as $bccrecipient) { + $bcc_comp = $this->_get_components($bccrecipient); + $mailer->AddBCC($bcc_comp['email'], $bcc_comp['name']); + } + break; + + default: + // The header key is not special - add it as is. + $mailer->AddCustomHeader($key . ': ' . $value); + } + } + + /** + * TODO + * Need to figure out the following. + * + * Add one last header item, but not if it has already been added. + * $errors_to = FALSE; + * foreach ($mailer->CustomHeader as $custom_header) { + * if ($custom_header[0] = '') { + * $errors_to = TRUE; + * } + * } + * if ($errors_to) { + * $mailer->AddCustomHeader('Errors-To: '. $from); + * } + */ + // Add the message's subject. + $mailer->Subject = $subject; + + // Processes the message's body. + switch ($content_type) { + case 'multipart/related': + $mailer->Body = $body; + // TODO: Figure out if there is anything more to handling this type. + break; + + case 'multipart/alternative': + // Split the body based on the boundary ID. + $body_parts = $this->_boundary_split($body, $boundary); + foreach ($body_parts as $body_part) { + // If plain/text within the body part, add it to $mailer->AltBody. + if (strpos($body_part, 'text/plain')) { + // Clean up the text. + $body_part = trim($this->_remove_headers(trim($body_part))); + // Include it as part of the mail object. + $mailer->AltBody = $body_part; + } + // If plain/html within the body part, add it to $mailer->Body. + elseif (strpos($body_part, 'text/html')) { + // Clean up the text. + $body_part = trim($this->_remove_headers(trim($body_part))); + // Include it as part of the mail object. + $mailer->Body = $body_part; + } + } + break; + + case 'multipart/mixed': + // Split the body based on the boundary ID. + $body_parts = $this->_boundary_split($body, $boundary); + + // Determine if there is an HTML part for when adding the plain text part. + $text_plain = FALSE; + $text_html = FALSE; + foreach ($body_parts as $body_part) { + if (strpos($body_part, 'text/plain')) { + $text_plain = TRUE; + } + if (strpos($body_part, 'text/html')) { + $text_html = TRUE; + } + } + + foreach ($body_parts as $body_part) { + // If test/plain within the body part, add it to either + // $mailer->AltBody or $mailer->Body, depending on whether there is + // also a text/html part ot not. + if (strpos($body_part, 'multipart/alternative')) { + // Get boundary ID from the Content-Type header. + $boundary2 = $this->_get_substring($body_part, 'boundary', '"', '"'); + // Clean up the text. + $body_part = trim($this->_remove_headers(trim($body_part))); + // Split the body based on the boundary ID. + $body_parts2 = $this->_boundary_split($body_part, $boundary2); + + foreach ($body_parts2 as $body_part2) { + // If plain/text within the body part, add it to $mailer->AltBody. + if (strpos($body_part2, 'text/plain')) { + // Clean up the text. + $body_part2 = trim($this->_remove_headers(trim($body_part2))); + // Include it as part of the mail object. + $mailer->AltBody = $body_part2; + $mailer->ContentType = 'multipart/mixed'; + } + // If plain/html within the body part, add it to $mailer->Body. + elseif (strpos($body_part2, 'text/html')) { + // Get the encoding. + $body_part2_encoding = $this->_get_substring($body_part2, 'Content-Transfer-Encoding', ' ', "\n"); + // Clean up the text. + $body_part2 = trim($this->_remove_headers(trim($body_part2))); + // Check whether the encoding is base64, and if so, decode it. + if (Unicode::strtolower($body_part2_encoding) == 'base64') { + // Include it as part of the mail object. + $mailer->Body = base64_decode($body_part2); + // Ensure the whole message is recoded in the base64 format. + $mailer->Encoding = 'base64'; + } + else { + // Include it as part of the mail object. + $mailer->Body = $body_part2; + } + $mailer->ContentType = 'multipart/mixed'; + } + } + } + // If text/plain within the body part, add it to $mailer->Body. + elseif (strpos($body_part, 'text/plain')) { + // Clean up the text. + $body_part = trim($this->_remove_headers(trim($body_part))); + + if ($text_html) { + $mailer->AltBody = $body_part; + $mailer->IsHTML(TRUE); + $mailer->ContentType = 'multipart/mixed'; + } + else { + $mailer->Body = $body_part; + $mailer->IsHTML(FALSE); + $mailer->ContentType = 'multipart/mixed'; + } + } + // If text/html within the body part, add it to $mailer->Body. + elseif (strpos($body_part, 'text/html')) { + // Clean up the text. + $body_part = trim($this->_remove_headers(trim($body_part))); + // Include it as part of the mail object. + $mailer->Body = $body_part; + $mailer->IsHTML(TRUE); + $mailer->ContentType = 'multipart/mixed'; + } + // Add the attachment. + elseif (strpos($body_part, 'Content-Disposition: attachment;') && !isset($message['params']['attachments'])) { + $file_path = $this->_get_substring($body_part, 'filename=', '"', '"'); + $file_name = $this->_get_substring($body_part, ' name=', '"', '"'); + $file_encoding = $this->_get_substring($body_part, 'Content-Transfer-Encoding', ' ', "\n"); + $file_type = $this->_get_substring($body_part, 'Content-Type', ' ', ';'); + + if (file_exists($file_path)) { + if (!$mailer->AddAttachment($file_path, $file_name, $file_encoding, $file_type)) { + drupal_set_message(t('Attahment could not be found or accessed.')); + } + } + else { + // Clean up the text. + $body_part = trim($this->_remove_headers(trim($body_part))); + + if (Unicode::strtolower($file_encoding) == 'base64') { + $attachment = base64_decode($body_part); + } + elseif (Unicode::strtolower($file_encoding) == 'quoted-printable') { + $attachment = quoted_printable_decode($body_part); + } + else { + $attachment = $body_part; + } + + $attachment_new_filename = \Drupal::service('file_system')->tempnam('temporary://', 'smtp'); + $file_path = file_save_data($attachment, $attachment_new_filename, FILE_EXISTS_REPLACE); + $real_path = \Drupal::service('file_system')->realpath($file_path->uri); + + if (!$mailer->AddAttachment($real_path, $file_name)) { + drupal_set_message(t('Attachment could not be found or accessed.')); + } + } + } + } + break; + + default: + $mailer->Body = $body; + break; + } + + // Process mimemail attachments, which are prepared in mimemail_mail(). + if (isset($message['params']['attachments'])) { + foreach ($message['params']['attachments'] as $attachment) { + if (isset($attachment['filecontent'])) { + $mailer->AddStringAttachment($attachment['filecontent'], $attachment['filename'], 'base64', $attachment['filemime']); + } + if (isset($attachment['filepath'])) { + $filename = isset($attachment['filename']) ? $attachment['filename'] : basename($attachment['filepath']); + $filemime = isset($attachment['filemime']) ? $attachment['filemime'] : file_get_mimetype($attachment['filepath']); + $mailer->AddAttachment($attachment['filepath'], $filename, 'base64', $filemime); + } + } + } + + // Set the authentication settings. + $username = $this->smtpConfig->get('smtp_username'); + $password = $this->smtpConfig->get('smtp_password'); + + // If username and password are given, use SMTP authentication. + if ($username != '' && $password != '') { + $mailer->SMTPAuth = TRUE; + $mailer->Username = $username; + $mailer->Password = $password; + } + + + // Set the protocol prefix for the smtp host. + switch ($this->smtpConfig->get('smtp_protocol')) { + case 'ssl': + $mailer->SMTPSecure = 'ssl'; + break; + + case 'tls': + $mailer->SMTPSecure = 'tls'; + break; + + default: + $mailer->SMTPSecure = ''; + } + + + // Set other connection settings. + $mailer->Host = $this->smtpConfig->get('smtp_host') . ';' . $this->smtpConfig->get('smtp_hostbackup'); + $mailer->Port = $this->smtpConfig->get('smtp_port'); + $mailer->Mailer = 'smtp'; + + $mailerArr = array( + 'mailer' => $mailer, + 'to' => $to, + 'from' => $from, + ); + if ($this->smtpConfig->get('smtp_queue')) { + $this->logger->info(t('Queue sending mail to: @to', array('@to' => $to))); + smtp_send_queue($mailerArr); + } + else { + return _smtp_mailer_send($mailerArr); + } + + return TRUE; + } + + /** + * Splits the input into parts based on the given boundary. + * + * Swiped from Mail::MimeDecode, with modifications based on Drupal's coding + * standards and this bug report: http://pear.php.net/bugs/bug.php?id=6495 + * + * @param input + * A string containing the body text to parse. + * @param boundary + * A string with the boundary string to parse on. + * @return + * An array containing the resulting mime parts + */ + protected function _boundary_split($input, $boundary) { + $parts = array(); + $bs_possible = substr($boundary, 2, -2); + $bs_check = '\"' . $bs_possible . '\"'; + + if ($boundary == $bs_check) { + $boundary = $bs_possible; + } + + $tmp = explode('--' . $boundary, $input); + + for ($i = 1; $i < count($tmp); $i++) { + if (trim($tmp[$i])) { + $parts[] = $tmp[$i]; + } + } + + return $parts; + } // End of _smtp_boundary_split(). + + /** + * Strips the headers from the body part. + * + * @param input + * A string containing the body part to strip. + * @return + * A string with the stripped body part. + */ + protected function _remove_headers($input) { + $part_array = explode("\n", $input); + + // will strip these headers according to RFC2045 + $headers_to_strip = array( 'Content-Type', 'Content-Transfer-Encoding', 'Content-ID', 'Content-Disposition'); + $pattern = '/^(' . implode('|', $headers_to_strip) . '):/'; + + while (count($part_array) > 0) { + + // ignore trailing spaces/newlines + $line = rtrim($part_array[0]); + + // if the line starts with a known header string + if (preg_match($pattern, $line)) { + $line = rtrim(array_shift($part_array)); + // remove line containing matched header. + + // if line ends in a ';' and the next line starts with four spaces, it's a continuation + // of the header split onto the next line. Continue removing lines while we have this condition. + while (substr($line, -1) == ';' && count($part_array) > 0 && substr($part_array[0], 0, 4) == ' ') { + $line = rtrim(array_shift($part_array)); + } + } + else { + // no match header, must be past headers; stop searching. + break; + } + } + + $output = implode("\n", $part_array); + return $output; + } // End of _smtp_remove_headers(). + + /** + * Returns a string that is contained within another string. + * + * Returns the string from within $source that is some where after $target + * and is between $beginning_character and $ending_character. + * + * @param $source + * A string containing the text to look through. + * @param $target + * A string containing the text in $source to start looking from. + * @param $beginning_character + * A string containing the character just before the sought after text. + * @param $ending_character + * A string containing the character just after the sought after text. + * @return + * A string with the text found between the $beginning_character and the + * $ending_character. + */ + protected function _get_substring($source, $target, $beginning_character, $ending_character) { + $search_start = strpos($source, $target) + 1; + $first_character = strpos($source, $beginning_character, $search_start) + 1; + $second_character = strpos($source, $ending_character, $first_character) + 1; + $substring = substr($source, $first_character, $second_character - $first_character); + $string_length = strlen($substring) - 1; + + if ($substring[$string_length] == $ending_character) { + $substring = substr($substring, 0, $string_length); + } + + return $substring; + } // End of _smtp_get_substring(). + + /** + * Returns an array of name and email address from a string. + * + * @param $input + * A string that contains different possible combinations of names and + * email address. + * @return + * An array containing a name and an email address. + */ + protected function _get_components($input) { + $components = array( + 'input' => $input, + 'name' => '', + 'email' => '', + ); + + // If the input is a valid email address in its entirety, then there is + // nothing to do, just return that. + if (\Drupal::service('email.validator')->isValid(trim($input))) { + $components['email'] = trim($input); + return $components; + } + + // Check if $input has one of the following formats, extract what we can: + // some name <address@example.com> + // "another name" <address@example.com> + // <address@example.com> + if (preg_match('/^"?([^"\t\n]*)"?\s*<([^>\t\n]*)>$/', trim($input), $matches)) { + $components['name'] = trim($matches[1]); + $components['email'] = trim($matches[2]); + } + + return $components; + } +} diff --git a/dist/iekserver/modules/ready/smtp/src/Tests/SmtpTest.php b/dist/iekserver/modules/ready/smtp/src/Tests/SmtpTest.php new file mode 100644 index 0000000000000000000000000000000000000000..0a5edb2231ece8cbfb6a1c14dda70f33ac2be931 --- /dev/null +++ b/dist/iekserver/modules/ready/smtp/src/Tests/SmtpTest.php @@ -0,0 +1,35 @@ +<?php + +namespace Drupal\smtp\Tests; + +use Drupal\simpletest\WebTestBase; + +/** + * Tests the Drupal 8 SMTP module functionality + * + * @group SMTP + */ +class SmtpTest extends WebTestBase { + + /** + * Modules to install + * + * @var array + */ + public static $modules = array('smtp'); + + /** + * Perform any initial set up tasks that run before every test method + */ + public function setUp() { + parent::setUp(); + } + + /** + * Tests that the '/' path returns 200 + */ + public function testSiteIsLive() { + $this->drupalGet(''); + $this->assertResponse(200); + } +}