MontegoScriptsWiki - New pages [en]

Downloads Core File Edits

2011-06-24T02:07:30Z

Montego: Created page with "Home>Downloads>New Installation>Core File Edits {{TOC}} '''NOTE: these edits are not standalone. You should not try to a..."

[[Main_Page|Home]]>[[Downloads|Downloads]]>[[Downloads_Installation|New Installation]]>Core File Edits

{{TOC}}

'''NOTE: these edits are not standalone. You should not try to attempt to install/upgrade the {{TNDL}} module just from these edits, but rather from either the [[Downloads Installation|New Installation]] or [[Downloads Upgrade|Upgrade Installation]] instructions. This note is here in case you reached here through the [[Downloads|main Downloads help page]].'''

For now, please follow the instructions provided in the distribution. We will eventually port those over to the Wiki.

Downloads Configuration

2011-06-24T02:04:53Z

Montego: Created page with "Home>Downloads>Configuration Instructions {{TOC}} ==Introduction== TBD"

[[Main_Page|Home]]>[[Downloads|Downloads]]>Configuration Instructions
{{TOC}}

==Introduction==

TBD

Downloads Upgrade

2011-06-24T02:04:02Z

Montego: Created page with "Home>Downloads>Upgrade Installation {{TOC}} ==Overview== TBD ==Backup, Backup, Backup== Always, always, always back up your site files and databa..."

[[Main_Page|Home]]>[[Downloads|Downloads]]>Upgrade Installation

{{TOC}}

==Overview==

TBD

==Backup, Backup, Backup==

Always, always, always back up your site files and database. Most web hosts provide some form of control panel that you can log into and perform common administration tasks such as submitting a full site backup, files and databases. It is always good practice to produce these back-ups so that you may quickly restore back to your previous condition in case you mess something up.

Another helpful tip that we learned rather quickly is to create a development/test environment right on your local PC/laptop to mirror that of your production site. There are entire [http://en.wikipedia.org/wiki/WAMP WAMP]/[http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP] environments available today, such as [http://www.apachefriends.org/en/xampp.html XAMPP from Apache Friends], which make this incredibly easy. This type of set up gives you an opportunity to test all of your site updates off-line prior to going live. Call it a dry-run, trial-run, or just being smart, whatever you like.

==Upgrade Steps==

We will eventually place the upgrade instructions here and remove from the distribution, but for now, read the README.txt file FIRST and then UPGRADES.txt.

Downloads Installation

2011-06-24T02:01:22Z

Montego: /* Instructions for NEW Installations */

[[Main_Page|Home]]>[[Downloads|Downloads]]>New Installation
{{TOC}}

==Introduction==

TBD

==Installation Overview or "Quick Start"==

TBD

==Instructions for NEW Installations==

<div style="padding:0.3em;margin-bottom:0.3em;border:2px solid #a00;background-color:#f0f0f0">The below instructions are only applicable to a non-{{RN}} site. The {{TNDL}} was integrated into the {{RN}} package starting with version 2.50.00. It is our opinion that one should upgrade to the latest version of {{RN}} (which at this writing is 2.50.00) in order to get the advantage of all the great security and bug fixes that have been made up to this release. Therefore, we will only be providing [[Downloads Upgrade]] instructions for the {{RN}} system, not new installation instructions.</div>

===Step 1: Backup, Backup, Backup===

Always, always, always back up your site files and database. Most web hosts provide some form of control panel that you can log into and perform common administration tasks such as submitting a full site backup, files and databases. It is always good practice to produce these back-ups so that you may quickly restore back to your previous condition in case you mess something up.

Another helpful tip that we learned rather quickly is to create a development/test environment right on your local PC/laptop to mirror that of your production site. There are entire [http://en.wikipedia.org/wiki/WAMP WAMP]/[http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP] environments available today, such as [http://www.apachefriends.org/en/xampp.html XAMPP from Apache Friends], which make this incredibly easy. This type of set up gives you an opportunity to test all of your site updates off-line prior to going live. Call it a dry-run, trial-run, or just being smart, whatever you like. :-)

===Step 2: Extract Files===

Extract the distribution archive to a temporary location on your PC in preparation for upload (but do not upload just yet).

===Step 3: Core File Updates===

Pull down to your local PC (using your favorite FTP client) the following files as you may need to make edits to these:

mainfile.php
modules/Search/index.php
modules/Your_Account/includes/ui-l10downloads.php (only RavenNuke(tm))
modules/Top/index.php

{{UC}}

Downloads Release Information

2011-06-24T01:53:45Z

Montego: /* Change Log */

[[Main_Page|Home]]>[[Downloads|Downloads]]>Release Information
{{TOC}}

==Where to Get the Current Release==

The latest release may be obtained from this download page link: [http://montegoscripts.com/downloads-cat24.html {{TNDL}}].

==Features==

Follow the link to the latest list of Features for a bulleted list of [[Downloads Introduction#Features|Features]].

==Change Log==

Come visit the [http://mantis.montegoservices.com/changelog_page.php?project_id=17 Downloads On-Line Change Log]. All version's issues are kept here along with public details. All you need to do is click on the Anonymous link.

==Product Roadmap==

Similar to the Change Log, you may also view our product roadmap via our direct dynamic issue tracker tool. Come visit the [http://mantis.montegoservices.com/roadmap_page.php?version_id=18 Downloads On-Line Roadmap]. All future version's issues are kept here along with public details. All you need to do is click on the Anonymous link.

==License (GPL2)==

The {{TNDL}} module is licensed under the [http://www.gnu.org/ GNU/GPL], under [[GPL Version 2]].

==Warranties and Liabilities==

Need we really say it? The {{TNDL}} module is Open Source! It is FREE! You are free to modify if for your own use as well as re-distribute it as long as you OBEY the [[GPL Version 2|license]]! No warranties are made and the author(s), contributor(s), etc., nor Montego Scripts or montegoscripts.com accepts ANY LIABILITY whatsoever. Use and abuse at your own risk, but please be respectful of the authors and contributors of this work and give credit where credit is due!

For on-going development status check out the above Roadmap and for Community-based Support Forums at [http://montegoscripts.com/forums.html Montego Scripts]

Downloads Authors and Contributors

2011-06-24T01:48:18Z

Montego: Created page with "Home>Downloads>Authors and Contributors {{TOC}} ==Credits for Original Works== As was mentioned in Downloads Introduction..."

[[Main_Page|Home]]>[[Downloads|Downloads]]>Authors and Contributors
{{TOC}}

==Credits for Original Works==

As was mentioned in [[Downloads_Introduction|Downloads Introduction]], the {{TNDL}} module was the original product of NukeScripts Network (NSN)'s owner Bob Marion.

===NukeScripts Network (NSN)===

The original credit goes to Bob Marion of NSN with the creation of this great module along with other fine modules for PHP-Nuke!

<pre>
/********************************************************/
/* NSN GR Downloads */
/* By: NukeScripts Network (webmaster@nukescripts.net) */
/* http://www.nukescripts.net */
/* Copyright © 2000-2005 by NukeScripts Network */
/********************************************************/
</pre>

The {{TNDL}} has undergone through a complete overhaul, but all of the original features are intact... only better.

===Additional Credits/Thanks===

To the following folks for their continual support, wealth of good ideas and endless encouragement:

* Palbin from the RavenNuke(tm) Team
* Guardian from http://www.code-authors.com
* kguske from http://nukeSEO.com
* Raven from http://www.ravenphpscripts.com
* and the entire RavenNuke(tm) Team both past and present.

Downloads Introduction

2011-06-24T01:42:37Z

Montego: /* Features */

[[Main_Page|Home]]>[[Downloads|Downloads]]>Introduction
{{TOC}}

==What is the {{TNDL}} Module?==

The {{TNDL}} module is a full featured replacement to the core {{RN}} Downloads module.

==History of this Module==

Bob Marion of NukeScripts Network (NSN) was the original author of this fine
module. Once he had NSN Groups released, he started to re-write / develop
modules like Downloads, News, Subscriptions, etc. to take advantage of the
additional permission granularity. Bob cared and fed this great module
from 2000 to 2005.

In 2006, Bob was heading in a different direction with NSN Depository and
Bob gave NSN Gr Downloads to montego to continue with development and
support. Unfortunately, montego got busy with RavenNuke(tm) development and
product management and had to put all his own personal development on hold.

Montego retired from the RavenNuke(tm) Team in June of 2010 and after some
rest, he began to program again. The 1.1.0 release of TegoNuke(tm)/NSN
Downloads is the first rendition putting his own "stamp" to the original
package with bug fixes, 100% XHTML compliance, security patching, etc. This
is also a "transition" release from the NSN branding to his own TegoNuke(tm),
hence the joint branding with this "cornerstone" release.

==Features==

As of this writing, the Downloads module has these features:

* Multi-column display of downloads (standard *Nuke Downloads module was a simple list style)
* No unnecessary commenting, rating, etc. features that no-one really wants/needs! :-)
* Makes use of nukeWYSIWYG for download description for full HTML (allowed) capabilities
* Create unlimited categories and assign downloads to these categories
* Configure any given category to allow file uploads, user/guest download submissions with administrator review and approval
* Flexible access permissions, one of: Anonymous, Registered Users only, Administrators only, or a Group (NSN Groups or {{RN}})
* Built-in anti-leaching - don't let others directly link to your downloads and leach your bandwidth!
* Comes with four great blocks
* Administration utility for configuration rather than modifying PHP script files
* Includes UTF-8 support
* Advanced installer
* Integrated with the [[Mailer|{{TNML}}]]
* 100% XHTML 1.0 Transitional compliance throughout

While {{TNDL}} may be used on non-{{RN}} set ups, that is not its intended CMS to run on. It may work as is, or require only slight tweaks, but you're on your own if you are not using {{RN}}.

==Resource Requirements Needed==

You MUST be using PHP version 5.2 or greater to use this script. It will NOT run on anything lower than this. You may also want to enable the Tidy extension (ask your host if you are not able to do this) prior to upgrade or new installation in order to help cleanse your download descriptive data to be 100% XHTML 1.0 Transitional compliant. In addition, your {{RN}} database user must have table create/update permissions.

Downloads

2011-06-24T01:32:59Z

Montego: Created page with "Home>{{TNDL}} Welcome to {{TNDL}}'s Wiki pages! The following pages serve to explain the said Download module, how to install, administration/configuration, and s..."

[[Main_Page|Home]]>{{TNDL}}

Welcome to {{TNDL}}'s Wiki pages! The following pages serve to explain the said Download module, how to install, administration/configuration, and some recipes for success, among other things.

Here are the current topics:

* [[Downloads Introduction|Introduction]] - What is the Downloads module, key features and software requirements
* [[Downloads Release Information|Release Information]] - Where to find the download, change log, road map license and support
* [[Downloads Authors and Contributors|Authors and Contributors]] - Credits
* [[Downloads Installation|New Installations]] - Need we say more?
* [[Downloads Upgrade|Upgrade Instructions]] - Only needed if you are upgrading from a previous release
* [[Downloads Configuration|Configuration Instructions]] - Applicable to all releases
* [[Downloads Core File Edits|Core File Edits]] - Only here for reference purposes, please follow the full new/upgrade instructions instead!

You may obtain the {{TNDL}} module for [http://www.ravenphpscripts.com {{RN}}] from [http://montegoscripts.com Montego Scripts]. At Montego Scripts, you will find the [http://montegoscripts.com/downloads-cat24.html Downloads], [http://montegoscripts.com/article-topic-18.html News Articles], and [http://montegoscripts.com/forum-20.html Support Forums].

Mailer RavenNuke Edits

2010-11-27T15:36:06Z

Montego: Created page with 'Home>Mailer>New Installation>Core File Edits>{{RN}} The edits for {{RN}} are not difficult (just like…'

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>{{RN}}

The edits for {{RN}} are not difficult (just like all the others), however, what you need to note is that we are only providing UPGRADE code changes. What do we mean by this? Given all the security and other bug fixes that have been made to the old PHP-Nuke code that is in {{RN}}, we just cannot in good conscience patronize edits for versions less than 2.40.00 (and the mailer was incorporated into {{RN}} at version 2.20.00). It just wouldn't be right. You NEED TO STAY CURRENT on your {{RN}} system! Get the latest {{RN}} version always at [http://www.ravenphpscripts.com RavenPHPScripts].

Do to the nature of the {{TNML}} coding, the original {{RN}} edits are still valid - we have maintained backwards compatibility for the most part. However, '''one MUST make the changes to the ''[[Mailer_New_Mainfile_Edits|mainfile.php]]'' script''' in order to avoid PHP errors/warnings!

If you run a search to look for the lines which have TNML_IS_ACTIVE in them, one finds all of the following (line numbers could be different in your installation):

<pre>
modules\Advertising\index.php(292): if (defined('TNML_IS_ACTIVE')) {
modules\Content\var\cpfunc.php(326): } elseif(defined('TNML_IS_ACTIVE')) {
modules\Content\var\friend.php(95): } elseif(defined('TNML_IS_ACTIVE')) {
modules\Feedback\index.php(140): if (defined('TNML_IS_ACTIVE')) {
modules\GCalendar\common.inc.php(685): if (defined('TNML_IS_ACTIVE')) {
modules\Groups\admin\NSNGroupsUsersEmailSend.php(70): if (defined('TNML_IS_ACTIVE')) {
modules\Groups\includes\nsngr_func.php(48): if (defined('TNML_IS_ACTIVE')) {
modules\HTML_Newsletter\admin\functions.php(405): if (defined('TNML_IS_ACTIVE')) {
modules\Journal\friend.php(71): if (defined('TNML_IS_ACTIVE')) {
modules\News\friend.php(126): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\admin\PJReportUpdate.php(52): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\admin\PJReportUpdate.php(60): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\admin\PJRequestUpdate.php(34): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\admin\PJRequestUpdate.php(41): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\public\PJReportCommentInsert.php(64): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\public\PJReportCommentInsert.php(72): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\public\PJReportInsert.php(66): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\public\PJRequestCommentInsert.php(61): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\public\PJRequestCommentInsert.php(69): if (defined('TNML_IS_ACTIVE')) {
modules\Project_Tracking\public\PJRequestInsert.php(66): if (defined('TNML_IS_ACTIVE')) {
modules\Recommend_Us\index.php(141): if (defined('TNML_IS_ACTIVE')) {
modules\Resend_Email\index.php(113): if (defined('TNML_IS_ACTIVE')) {
modules\Submit_News\index.php(285): if (defined('TNML_IS_ACTIVE') and validate_mail($notify_from) !== false) {
modules\Web_Links\admin\index.php(1358): if (defined('TNML_IS_ACTIVE')) {
modules\Your_Account\includes\functions.php(104): if (defined('TNML_IS_ACTIVE')) {
</pre>

Simply modify the part of the if statement which looks like this:

<source lang="php">
if (defined('TNML_IS_ACTIVE'))
</source>

To this instead:

<source lang="php">
if (TNML_IS_ACTIVE)
</source>

Yes, it is that simple. Do this on each of the above lines of code for the given scripts.

Lastly, one should/could also modify the [[Mailer_NukeSentinel_Edits|{{NS}} Core File Edits]] to utilize the latest {{TNML}} coding.

Mailer NukeSentinel Edits

2010-11-27T13:25:25Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>{{NS}}

The edits for {{NS}} are not difficult (just like all the others), however, what you need to note is that we are only providing UPGRADE code changes. What do we mean by this? Given how important {{NS}} is for the security of your *nuke site, we just cannot in good conscience patronize edits for versions less than 2.6.00. It just wouldn't be right. You NEED TO STAY CURRENT on your {{NS}} system! Get the latest {{NS}} version always at [http://www.ravenphpscripts.com RavenPHPScripts].

If you are a {{RN}} user, again, latest versions where {{NS}} is already at 2.6.xx or greater, the edits are really simple: you do not need to do them unless you are the {{NS}} / {{RN}} Team and are needing to get up to the latest {{TNML}} core file edit standards. But, if you are one of these team members upgrading the code, or if you just like to have the latest-and-greatest to be prepared for further {{TNML}} updates ahead of the game, these instructions are for you. ;-)

If you run a search to look for the lines which have TNML_IS_ACTIVE in them, one finds all of the following (line numbers could be different in your installation):

<pre>
admin\modules\nukesentinel\ABAuthEditSave.php(26): if (defined('TNML_IS_ACTIVE')) {
admin\modules\nukesentinel\ABAuthResend.php(20): if (defined('TNML_IS_ACTIVE')) {
admin\modules\nukesentinel\ABAuthScan.php(41): if (defined('TNML_IS_ACTIVE')) {
admin\modules\nukesentinel\ABConfigAdmin.php(98): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigAuthor.php(98): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigClike.php(98): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigFilter.php(98): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigFlood.php(104): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigHarvester.php(99): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigReferer.php(99): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigRequest.php(99): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigScript.php(98): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigString.php(99): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
admin\modules\nukesentinel\ABConfigUnion.php(98): if (defined('TNML_IS_ACTIVE')) { $mailtest = true; } else { $mailtest = @mail(); }
includes\nukesentinel.php(950): if (defined('TNML_IS_ACTIVE')) {
</pre>

Simply modify the part of the if statement which looks like this:

<source lang="php">
if (defined('TNML_IS_ACTIVE'))
</source>

To this instead:

<source lang="php">
if (TNML_IS_ACTIVE)
</source>

Yes, it is that simple. Do this on each of the above lines of code for the given scripts.

Disabling Site Temporarily Using NukeSentinel

2010-11-20T17:41:02Z

Montego:

[[Main_Page|Home]]>[[:Category:FAQ_Misc|Back to FAQ Page]]

[[File:Nukesentinel_siteswitch.png‎|right|{{NS}} Site Switch Showing How to Disable]]

There are times during the course of maintaining / operating a *nuke site where one would like to disable user access to the site while still allowing an admin user to access the site and perform whatever they need to do. With the 2.6.xx line of {{NS}} and above this is as easy as setting the '''Site Enabled''' "switch" to '''Site Disabled'''. Then, once you are finished, you may simply change it back to '''Site Enabled''' again. Here is what the {{NS}} switch looks like (to the right).

Now the site will display a "Site is down for maintenance" type message when either anonymous or a registered/logged in user hits the site until this switch setting is reversed. A previously logged in admin will still see a fully operational site with just a "Site Disabled" message at the very top as a reminder that he/she will need to re-enable the site once they are done with their maintenance activity.

[[Category:FAQ Misc]]

RavenNuke(tm)/PHP-Nuke Hacks

2010-11-16T23:14:40Z

Montego: moved RavenNuke(tm)/PHP-Nuke Hacks to RavenNuke-PHP-Nuke Hacks: In appropriate URL

[[Main_Page|Home]]>{{RN}}/PHP-Nuke Hacks

Here are some hacks that we have found useful over the years:

* [[Give_Non-SuperUsers_Access_to_a_System_Level_Feature|Give Non-SuperUsers Access to a System Level Feature]] - the example given is for Messages

Enjoy.

Mailer New Theme Sample Edits

2010-11-16T22:47:45Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>themes/xxxxxx/theme.php

{{TNML_DISCLAIMER}}

{{TOC}}

There are too many themes out there to know exactly how each formats their mail headers / etc. Usually the only mailing that is done from themes is
in function themeheader() and is used to send to a banner client when their number of impressions have been reached (thus, their banners will no longer
be shown).

Here is a sample "template" of a change, this one taken from the "fisubice" theme:

==Open File==

Open the following file to edit:

<pre>themes/YourTheme/theme.php</pre>

==Modify Ad "Impressions Reached" Mail Send Code If Exists in Theme==

FIND THIS CODE BLOCK USUALLY WITHIN FUNCTION themeheader():

<source lang="php">
mail($to, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH (MINIMUM REPLACEMENT):

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$mailsuccess = tnml_fMailer($to, $subject, $message, $from, '');
} else {
$mailsuccess = mail($to, $subject, $message, "From: $from\r\nX-Mailer: PHP/" . phpversion());
}
//mail($to, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());;
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Your Account Edits

2010-11-16T22:46:57Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Your_Account/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Your_Acount/index.php</pre>

==Modify finishNewUser() Function Code==

FIND THIS CODE BLOCK ('''ONE INSTANCE''') WITHIN FUNCTION finishNewUser():

<source lang="php">
mail($user_email, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($user_email, $username));
$mailsuccess = tnml_fMailer($to, $subject, $message, $adminmail, $sitename);
} else {
$mailsuccess = mail($user_email, $subject, $message, 'From: '."$sitename <$from>\r\n".'X-Mailer: PHP/' . phpversion());
}
//mail($user_email, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

==Modify mail_password() Function Code==

FIND THIS CODE BLOCK ('''TWO INSTANCES''') WITHIN FUNCTION mail_password():

<source lang="php">
mail($user_email, $subject, $message, "From: $adminmail\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($user_email, $username));
$mailsuccess = tnml_fMailer($to, $subject, $message, $adminmail, $sitename);
} else {
$mailsuccess = mail($user_email, $subject, $message, 'From: '."$sitename <$adminmail>\r\n".'X-Mailer: PHP/' . phpversion());
}
//mail($user_email, $subject, $message, "From: $adminmail\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Your Account Admin Edits

2010-11-16T22:46:21Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Your_Account/admin/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Your_Acount/admin/index.php</pre>

==Modify updateUser() Function Code==

FIND THIS CODE BLOCK ('''THREE INSTANCES''') WITHIN FUNCTION updateUser():

<source lang="php">
mail($row2[user_email], $subject, $body, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($row2['user_email'], $row2['username']));
$mailsuccess = tnml_fMailer($to, $subject, $body, $adminmail, $sitename);
} else {
$mailsuccess = mail($row2['user_email'], $subject, $body, "From: $from\r\nX-Mailer: PHP/" . phpversion());
}
//mail($row2[user_email], $subject, $body, "From: $from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Web Links Edits

2010-11-16T22:45:36Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Web_Links/admin/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Web_Links/admin/index.php</pre>

==Modify Link Acceptance Email Function Code==
FIND THIS CODE BLOCK HERE:

<source lang="php">
mail($email, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
global $adminmail;
if (TNML_IS_ACTIVE) {
$to = array(array($email, $name));
$mailsuccess = tnml_fMailer($to, $subject, $message, $adminmail, $sitename);
} else {
$mailsuccess = mail($email, $subject, $message, "From: $sitename <$adminmail>\r\nX-Mailer: PHP/" . phpversion());
}
//mail($email, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Submit News Edits

2010-11-16T22:44:42Z

Montego: /* Modify the Article Submit Code */

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Submit_News/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Submit_News/index.php</pre>

==Modify the Article Submit Code==

FIND THIS CODE BLOCK HERE:

<source lang="php">
mail($notify_email, $notify_subject, $notify_message, "From: $notify_from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$mailsuccess = tnml_fMailer($notify_email, $notify_subject, $notify_message, $notify_from, $sitename);
} else {
$mailsuccess = mail($notify_email, $notify_subject, $notify_message, "From: $sitename <$notify_from>\r\nX-Mailer: PHP/" . phpversion());
}
//mail($notify_email, $notify_subject, $notify_message, "From: $notify_from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

{{TNML_RNVER1}}

For {{RN}}, the code is a little different. It should end up looking like this:

<source lang="php">
/*
* TegoNuke Mailer added by montego for 2.20.00
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE and validate_mail($notify_from) !== false) {
$mailsuccess = tnml_fMailer($notify_email, $notify_subject, $notify_message, $notify_from, $sitename);
} else {
$mailsuccess = mail($notify_email, $notify_subject, $notify_message, "From: $sitename <$notify_from>\nX-Mailer: PHP/" . phpversion());
}
/*
* end of TegoNuke Mailer add
*/
</source>

It has the extra email validation routine in there.

Mailer New News Edits

2010-11-16T22:43:57Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/News/friend.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/News/friend.php</pre>

==Modify Send Article To Friend Code==

FIND THIS CODE BLOCK HERE:

<source lang="php">
mail($fmail, $subject, $message, "From: \"$yname\" <$ymail>\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($fmail, $fname));
$mailsuccess = tnml_fMailer($to, $subject, $message, $ymail, $yname);
} else {
$mailsuccess = mail($fmail, $subject, $message, "From: $yname <$ymail>\r\nX-Mailer: PHP/" . phpversion());
}
//mail($fmail, $subject, $message, "From: \"$yname\" <$ymail>\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Recommend Us Edits

2010-11-16T22:42:35Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Recommend_Us/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Recommend_Us/index.php</pre>

==Modify the Send of Recommendation Email Code==

FIND THIS CODE BLOCK:

<source lang="php">
mail($fmail, $subject, $message, "From: \"$yname\" <$ymail>\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($fmail, $fname));
$mailsuccess = tnml_fMailer($to, $subject, $message, $ymail, $yname);
} else {
$mailsuccess = mail($fmail, $subject, $message, "From: $yname <$ymail>\r\nX-Mailer: PHP/" . phpversion());
}
//mail($fmail, $subject, $message, "From: \"$yname\" <$ymail>\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Journal Edits

2010-11-16T22:41:28Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Journal/friend.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Journal/friend.php</pre>

==Modify the Send to Friend Code==

FIND THIS CODE BLOCK HERE:

<source lang="php">
mail($fmail, $subject, $message, "From: \"$yname\" <$ymail>\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($fmail, $fname));
$mailsuccess = tnml_fMailer($to, $subject, $message, $ymail, $yname);
} else {
$mailsuccess = mail($fmail, $subject, $message, "From: $yname <$ymail>\r\nReply-To: $ymail\r\nX-Mailer: PHP/" . phpversion());
}
//mail($fmail, $subject, $message, "From: \"$yname\" <$ymail>\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Feedback Edits

2010-11-16T22:40:33Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Feedback/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following file to edit:

<pre>modules/Feedback/index.php</pre>

FIND THIS CODE BLOCK:

<source lang="php">
mail($to, $subject, $msg, $mailheaders);
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$mailsuccess = tnml_fMailer($to, $subject, $msg, $sender_email, $sender_name);
} else {
$mailsuccess = mail($to, $subject, $msg, $mailheaders);
}
//mail($to, $subject, $msg, $mailheaders);
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Advertising Edits

2010-11-16T22:38:15Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>modules/Advertising/index.php

{{TNML_DISCLAIMER}}

{{TOC}}

These instructions were originally written for {{RN}} 2.30.00 and above installations where the Advertising module was brought into the system. It is possible that these edits are close enough to a stock PHP-Nuke Advertising module that came after 7.6 (cannot recall exactly when the Advertising module was added to PHP-Nuke), but you may still need to reconcile your edits as such.

==Open File==

Open the following script:

<pre>modules/Advertising/index.php</pre>

==Modify How Ad Statistics Are Sent==

FIND THIS CODE BLOCK HERE:

<source lang="php">
mail($email, $subject, $message, "From: $from\r\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
$from = "$adminmail"; // montego: was not providing a valid "from" email address before, so changed
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($email, $name));
$mailsuccess = tnml_fMailer($to, $subject, $message, $from, $sitename);
} else {
$mailsuccess = mail($email, $subject, $message, "From: $sitename <$from>\r\nX-Mailer: PHP/" . phpversion());
}
if ($mailsuccess) {
echo "<center><br />"
. "<b>"._STATSSENT." $email</b><br />"
. _GOBACK;
} else {
echo '<center><br />'._STATSSENTERROR.'<br /><br />'."\n"
. _GOBACK;
}
// mail($email, $subject, $message, "From: $from\r\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Newsletter Edits

2010-11-16T22:36:54Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>admin/modules/newsletter.php

{{TNML_DISCLAIMER}}

{{TOC}}

{{RN}} installations of version 2.30.00 and greater can ignore these instructions as the PHP-Nuke Newsletter module was replaced by the more functional HTML Newsletter module which already has this embedded and the older code should still work.

==Open File==

Open the following script:

<pre>
admin/modules/newsletter.php
</pre>

==Replace newsletter_send() Function==

FIND THIS CODE BLOCK (The Entire Function):

<source lang="php">
function newsletter_send($title, $content) {
global $user_prefix, $sitename, $db, $nukeurl, $adminmail, $admin_file;
$send_html_messages = "yes";
$from = $adminmail;
$subject = "[$sitename Newsletter]: " . stripslashes($title) . "";
$content = stripslashes($content);
$content = "$sitename " . _NEWSLETTER . "\n\n\n$content\n\n- $sitename " . _STAFF . "\n\n\n\n\n\n" . _NLUNSUBSCRIBE . "";
$result = $db->sql_query("SELECT user_email from " . $user_prefix . "_users where newsletter='1'");
while ($row = $db->sql_fetchrow($result)) {
$user_email = $row['user_email'];
$xheaders = "From: " . $sitename . " <" . $adminmail . ">\n";
$xheaders .= "X-Sender: <" . $adminmail . ">\n";
$xheaders .= "X-Mailer: PHP\n"; // mailer
$xheaders .= "X-Priority: 6\n"; // Urgent message!
if ($send_html_messages == "yes") {
$xheaders .= "Content-Type: text/html; charset=iso-8859-1\n"; // Mime type
}
mail("$user_email","$subject","$content",$xheaders);
}
Header("Location: ".$admin_file.".php?op=newsletter_sent");
}
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
function newsletter_send($title, $content) {
global $user_prefix, $sitename, $db, $nukeurl, $adminmail, $admin_file;
$send_html_messages = "yes";
$from = $adminmail;
$subject = "[$sitename Newsletter]: " . stripslashes($title) . "";
$content = stripslashes($content);
$content = "$sitename " . _NEWSLETTER . "\n\n\n$content\n\n- $sitename " . _STAFF . "\n\n\n\n\n\n" . _NLUNSUBSCRIBE . "";
$xheaders = "From: $sitename <$adminmail>\r\n";
$xheaders .= "X-Sender: <" . $adminmail . ">\r\n";
$xheaders .= "X-Mailer: PHP\r\n"; // mailer
$xheaders .= "X-Priority: 3\r\n"; // Change the 3 to 6 to make it "Urgent"
if ($send_html_messages == "yes") {
$encode = 1;
$xheaders .= "Content-Type: text/html; charset=iso-8859-1\n"; // Mime type
} else {
$encode = 0;
$xheaders .= "Content-Type: text/plain; charset=iso-8859-1\n"; // Mime type
}
$tnml_asTo = array();
$result = $db->sql_query("SELECT user_email, username from " . $user_prefix . "_users where newsletter='1'");
while ($row = $db->sql_fetchrow($result)) {
$tnml_asTo[] = array($row['user_email'], $row['username']);
}
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$params = array('html' => $encode, 'batch' => 1);
$mailsuccess = tnml_fMailer($tnml_asTo, $subject, $content, $adminmail, $sitename, $params);
} else {
foreach($tnml_asTo as $to) {
$to2 = $to[1] . ' <' . $to[0] . '>';
$mailsuccess = mail($to2, $subject, $content, $xheaders);
}
}
Header("Location: ".$admin_file.".php?op=newsletter_sent");
}
/*
* end of TegoNuke(tm) Mailer replace function
*/
</source>

==Replace massmail() Function==

FIND THIS CODE BLOCK (The Entire Function):

<source lang="php">
function massmail_send($title, $content) {
global $user_prefix, $sitename, $db, $nukeurl, $adminmail, $admin_file;
$send_html_messages = "yes";
$from = $adminmail;
$subject = "[$sitename]: $title";
$content = stripslashes($content);
$content = "" . _FROM . ": $sitename\n\n\n\n$content\n\n\n\n- $sitename " . _STAFF . "\n\n\n\n" . _MASSEMAILMSG . "";
$result = $db->sql_query("SELECT user_email from " . $user_prefix . "_users where user_id != '1'");
while ($row = $db->sql_fetchrow($result)) {
$user_email = $row['user_email'];
$xheaders = "From: " . $sitename . " <" . $adminmail . ">\n";
$xheaders .= "X-Sender: <" . $adminmail . ">\n";
$xheaders .= "X-Mailer: PHP\n"; // mailer
$xheaders .= "X-Priority: 6\n"; // Urgent message!
if ($send_html_messages == "yes") {
$xheaders .= "Content-Type: text/html; charset=iso-8859-1\n"; // Mime type
}
mail("$user_email","$subject","$content",$xheaders);
}
Header("Location: ".$admin_file.".php?op=massmail_sent");
}
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
function massmail_send($title, $content) {
global $user_prefix, $sitename, $db, $nukeurl, $adminmail, $admin_file;
$send_html_messages = "yes";
$from = $adminmail;
$subject = "[$sitename]: $title";
$content = stripslashes($content);
$content = "" . _FROM . ": $sitename\n\n\n\n$content\n\n\n\n- $sitename " . _STAFF . "\n\n\n\n" . _MASSEMAILMSG . "";
$xheaders = "From: " . $sitename . " <" . $adminmail . ">\n";
$xheaders .= "X-Sender: <" . $adminmail . ">\n";
$xheaders .= "X-Mailer: PHP\n"; // mailer
$xheaders .= "X-Priority: 6\n"; // Urgent message!
if ($send_html_messages == "yes") {
$encode = 1;
$xheaders .= "Content-Type: text/html; charset=iso-8859-1\n"; // Mime type
} else {
$encode = 0;
$xheaders .= "Content-Type: text/plain; charset=iso-8859-1\n"; // Mime type
}
$tnml_asTo = array();
$result = $db->sql_query("SELECT user_email, username from " . $user_prefix . "_users where user_id != '1'");
while ($row = $db->sql_fetchrow($result)) {
$tnml_asTo[] = array($row['user_email'], $row['username']);
}
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$params = array('html' => $encode, 'batch' => 1);
$mailsuccess = tnml_fMailer($tnml_asTo, $subject, $content, $adminmail, $sitename, $params);
} else {
foreach($tnml_asTo as $to) {
$to2 = $to[1] . ' <' . $to[0] . '>';
$mailsuccess = mail($to2, $subject, $content, $xheaders);
}
}
Header("Location: ".$admin_file.".php?op=massmail_sent");
}
/*
* end of TegoNuke(tm) Mailer replace function
*/
</source>

Mailer New Banners Edits

2010-11-16T22:35:47Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>banners.php

{{TNML_DISCLAIMER}}

{{TOC}}

Here are the required edits for this script:

==Open File==

Open the following script:

<pre>
modules/banners.php
</pre>

==Modify viewbanner() Function==

FIND THIS CODE BLOCK WITHIN FUNCTION viewbanner():

<source lang="php">
mail($to, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to2 = array(array($c_email, $c_contact));
$mailsuccess = tnml_fMailer($to2, $subject, $message, $adminmail, $sitename);
} else {
$mailsuccess = mail($to, $subject, $message, "From: $from\r\nX-Mailer: PHP/" . phpversion());
}
//mail($to, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

==Modify EmailStats() Function==

FIND THIS CODE BLOCK WITHIN FUNCTION EmailStats():

<source lang="php">
$subject = "Your Banner Statistics at " . $sitename . "";
$message = "Following are the complete stats for your advertising investment at $sitename:\n\n\nClient Name: $name\nBanner ID: $bid\nBanner Image: $imageurl\nBanner URL: $clickurl\n\nImpressions Purchased: $imptotal\nImpressions Made: $impmade\nImpressions Left: $left\nClicks Received: $clicks\nClicks Percent: $percent%\n\n\nReport Generated on: $fecha";
$from = "$sitename";
mail($email, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
global $sitename, $adminmail;
$subject = "Your Banner Statistics at " . $sitename . "";
$message = "Following are the complete stats for your advertising investment at $sitename:\n\n\nClient Name: $name\nBanner ID: $bid\nBanner Image: $imageurl\nBanner URL: $clickurl\n\nImpressions Purchased: $imptotal\nImpressions Made: $impmade\nImpressions Left: $left\nClicks Received: $clicks\nClicks Percent: $percent%\n\n\nReport Generated on: $fecha";
$from = "$sitename <$adminmail>";
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($email, $name));
$mailsuccess = tnml_fMailer($to, $subject, $message, $adminmail, $sitename);
} else {
$mailsuccess = mail($email, $subject, $message, "From: $from\r\nX-Mailer: PHP/" . phpversion());
}
//mail($email, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

Mailer New Mainfile Edits

2010-11-16T22:35:00Z

Montego: /* Ensure Mailer Helper Function is Loaded */

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>[[Mailer Core File Edits|Core File Edits]]>mainfile.php

{{TNML_DISCLAIMER}}

{{TOC}}
This edit is what brings the {{TNML}} into operation. Without the first change listed here, the Mailer is never called into action. The required edits follow.

==Open File==

Open the following script off your *nuke web root:

<pre>mainfile.php</pre>

==Ensure Mailer Helper Function is Loaded==

If you cannot find the below code, than you are behind on your patch levels. See [[Mailer_New_Mainfile_Edits#Alternate_Edits|Alternate Edits]] section down below for other possible versions of this.

FIND CODE:

<source lang="php">
@require_once(INCLUDE_PATH.'db/db.php');
@require_once(INCLUDE_PATH.'includes/sql_layer.php');
@require_once(INCLUDE_PATH.'includes/ipban.php');
if (file_exists(INCLUDE_PATH.'includes/custom_files/custom_mainfile.php')) {
@include_once(INCLUDE_PATH.'includes/custom_files/custom_mainfile.php');
}
</source>

AFTER THE ABOVE ADD THESE LINES:

<source lang="php">
/**
* TegoNuke(tm) Mailer
*/
include_once(INCLUDE_PATH . 'includes/tegonuke/mailer/mailer.php');

/*
* NOTE: NukeSentinel and NSN Groups MUST come after as both use the PHP mail() function for their operations.
* Actually, any script that could send an email out must be loaded AFTER TegoNuke(tm) Mailer.
*
* end of TegoNuke(tm) Mailer add
*/
</source>

==Modify validate_mail Function Code==

FIND THIS CODE BLOCK:

<source lang="php">
function validate_mail($email) {
if(strlen($email) < 7 || !preg_match("/\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*/", $email)) {
//include_once("header.php");
OpenTable();
echo _ERRORINVEMAIL;
CloseTable();
//include_once("footer.php");
}
else {
return $email;
}
}
</source>

REPLACE WITH (OR IF YOU DO NOT HAVE THE ABOVE FUNCTION IN mailfile.php, THEN ADD):

<source lang="php">
function validate_mail($email) {
if(strlen($email) < 7 || !preg_match("/\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*/", $email)) {
// These next 3 lines have been commented out by Raven on 1/14/2007.
// Reason being, this function should only validate the email and return to the calling script.
// The calling script should handle the validation results.
// OpenTable();
// echo _ERRORINVEMAIL;
// CloseTable();
return false;
} else {
return $email;
}
}
</source>

==Modify paid() Function==

FIND THIS CODE WITHIN FUNCTION paid():

<source lang="php">
mail($row['user_email'], $subject, $body, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to = array(array($row['user_email'], $row['username']));
$mailsuccess = tnml_fMailer($to, $subject, $body, $adminmail, $sitename);
} else {
$mailsuccess = mail($row['user_email'], $subject, $body, "From: $from\r\nX-Mailer: PHP/" . phpversion());
}
//mail($row['user_email'], $subject, $body, "From: $from\nX-Mailer: PHP/" . phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

==Modify ads() Function==

Do not be concerned if your version of PHP-Nuke does not have this function. This goes with the Advertising module which came in later nukes and {{RN}} with version 2.30.00.

FIND THIS CODE WITHIN FUNCTION ads():

<source lang="php">
mail($to, $subject, $message, 'From: '."$from\n".'X-Mailer: PHP/'.phpversion());
</source>

REPLACE WITH:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$to2 = array(array($c_email, $c_contact));
$mailsuccess = tnml_fMailer($to2, $subject, $body, $adminmail, $sitename);
} else {
$mailsuccess = mail($to, $subject, $message, 'From: '."$from\r\n".'X-Mailer: PHP/'.phpversion());
}
//mail($to, $subject, $message, 'From: '."$from\n".'X-Mailer: PHP/'.phpversion());
/*
* end of TegoNuke(tm) Mailer add
*/
</source>

This concludes the edits for this script.

==Alternate Edits==

If your set of includes in ''mainfile.php'' are anything other than the above or the below then you may need to post your code block in the forums and we'll do our best to help you sort it out.

IF YOU HAVE THIS:

<source lang="php">
if (defined('FORUM_ADMIN')) {
@require_once("../../../config.php");
@require_once("../../../db/db.php");
@require_once("../../../includes/sql_layer.php");
if (file_exists("../../../includes/custom_files/custom_mainfile.php")) { @include_once("../../../includes/custom_files/custom_mainfile.php"); }
@require_once("../../../includes/ipban.php");
if (defined('NUKE_HEADER') && file_exists("../../../includes/custom_files/custom_head.php")) { @include_once("../../../includes/custom_files/custom_head.php"); }
if (defined('NUKE_HEADER') && file_exists("../../../includes/custom_files/custom_header.php")) { @include_once("../../../includes/custom_files/custom_header.php"); }
} elseif (defined('INSIDE_MOD')) {
@require_once("../../config.php");
@require_once("../../db/db.php");
@require_once("../../includes/sql_layer.php");
if (file_exists("../../includes/custom_files/custom_mainfile.php")) { @include_once("../../includes/custom_files/custom_mainfile.php"); }
@require_once("../../includes/ipban.php");
if (defined('NUKE_HEADER') && file_exists("../../includes/custom_files/custom_head.php")) { @include_once("../../includes/custom_files/custom_head.php"); }
if (defined('NUKE_HEADER') && file_exists("../../includes/custom_files/custom_header.php")) { @include_once("../../includes/custom_files/custom_header.php"); }
} else {
@require_once("config.php");
@require_once("db/db.php");
@require_once("includes/sql_layer.php");
if (file_exists("includes/custom_files/custom_mainfile.php")) { @include_once("includes/custom_files/custom_mainfile.php"); }
@require_once("includes/ipban.php");
if (defined('NUKE_HEADER') && file_exists("includes/custom_files/custom_head.php")) { @include_once("includes/custom_files/custom_head.php"); }
if (defined('NUKE_HEADER') && file_exists("includes/custom_files/custom_header.php")) { @include_once("includes/custom_files/custom_header.php"); }
}
</source>

REPLACE WITH:

<source lang="php">
if (defined('FORUM_ADMIN')) {
if (!defined('INCLUDE_PATH')) define('INCLUDE_PATH', '../../../');
@require_once("../../../config.php");
@require_once("../../../db/db.php");
@require_once("../../../includes/sql_layer.php");
if (file_exists("../../../includes/custom_files/custom_mainfile.php")) { @include_once("../../../includes/custom_files/custom_mainfile.php"); }
@require_once("../../../includes/ipban.php");
if (defined('NUKE_HEADER') && file_exists("../../../includes/custom_files/custom_head.php")) { @include_once("../../../includes/custom_files/custom_head.php"); }
if (defined('NUKE_HEADER') && file_exists("../../../includes/custom_files/custom_header.php")) { @include_once("../../../includes/custom_files/custom_header.php"); }
} elseif (defined('INSIDE_MOD')) {
if (!defined('INCLUDE_PATH')) define('INCLUDE_PATH', '../../');
@require_once("../../config.php");
@require_once("../../db/db.php");
@require_once("../../includes/sql_layer.php");
if (file_exists("../../includes/custom_files/custom_mainfile.php")) { @include_once("../../includes/custom_files/custom_mainfile.php"); }
@require_once("../../includes/ipban.php");
if (defined('NUKE_HEADER') && file_exists("../../includes/custom_files/custom_head.php")) { @include_once("../../includes/custom_files/custom_head.php"); }
if (defined('NUKE_HEADER') && file_exists("../../includes/custom_files/custom_header.php")) { @include_once("../../includes/custom_files/custom_header.php"); }
} else {
if (!defined('INCLUDE_PATH')) define('INCLUDE_PATH', './');
@require_once("config.php");
@require_once("db/db.php");
@require_once("includes/sql_layer.php");
if (file_exists("includes/custom_files/custom_mainfile.php")) { @include_once("includes/custom_files/custom_mainfile.php"); }
@require_once("includes/ipban.php");
if (defined('NUKE_HEADER') && file_exists("includes/custom_files/custom_head.php")) { @include_once("includes/custom_files/custom_head.php"); }
if (defined('NUKE_HEADER') && file_exists("includes/custom_files/custom_header.php")) { @include_once("includes/custom_files/custom_header.php"); }
}
</source>

Mailer Core File Edits

2010-11-16T22:14:12Z

Montego:

[[Main_Page|Home]]>[[Mailer|Mailer]]>[[Mailer_Installation|New Installation]]>Core File Edits
{{TOC}}

'''NOTE: these edits are not standalone. You should not try to attempt to install/upgrade the {{TNML}} just from these edits, but rather from either the [[Mailer Installation|New Installation]] or [[Mailer Upgrade|Upgrade Installation]] instructions. This note is here in case you reached here through the [[Mailer|main Mailer help page]].'''

Now, in order to have *nuke use the {{TNML}} rather than the basic PHP mail() function that is built in, one must edit your core files which have these mail() function calls in them.

Click on each file to see what edits are required:

* [[Mailer New Mainfile Edits|mainfile.php]] --> This should be your first script to tackle and test!
* [[Mailer New Banners Edits|banners.php]]
* [[Mailer New Newsletter Edits|admin/modules/newsletter.php]]
* [[Mailer New Advertising Edits|modules/Advertising/index.php]] --> In case you decided to incorporate anyways on top of {{RN}} :-(
* [[Mailer New Feedback Edits|modules/Feedback/index.php]]
* [[Mailer New Journal Edits|modules/Journal/friend.php]]
* [[Mailer New News Edits|modules/News/friend.php]]
* [[Mailer New Recommend Us Edits|modules/Recommend_Us/index.php]]
* [[Mailer New Submit News Edits|modules/Submit_News/index.php]]
* [[Mailer New Web Links Edits|modules/Web_Links/admin/index.php]]
* [[Mailer New Your Account Admin Edits|modules/Your_Account/admin.php]]
* [[Mailer New Your Account Edits|modules/Your_Account/index.php]]
* [[Mailer New Theme Sample Edits|themes/theme.php]] --> Just an example of what you might run into code-wise

'''REMEMBER: These are just EXAMPLES to use as reference as you search out and make your updates.''' The edits are not difficult, but you'll need to search through your *nuke files looking for calls to the PHP function '''mail()''' (try searching for the string "mail(" and "mail (" and you will find them).

{{TNML_RNVER1}}

A special note to admins of {{RN}} installations: as of the versions above (and possibly later - you'll have to check) the original implemented {{TNML}} code will continue to work as the mailer was made backward compatible. However, in order to keep up with possible future mailer changes, it would be a good idea to also review the [[Mailer RavenNuke Edits|{{RN}} Core File Edits]] page.

{{TNML_NSVER}}

A special note to admins of {{RN}} and {{NS}} installations: as of the versions above (and possibly later - you'll have to check) the original implemented {{TNML}} code will continue to work as the mailer was made backward compatible. However, in order to keep up with possible future possible mailer changes, it would be a good idea to also review the [[Mailer NukeSentinel Edits|{{NS}} Core File Edits]] page.

Mailer Configuration

2010-11-13T22:27:23Z

Montego: /* General Mailer Options */

[[Main_Page|Home]]>[[Mailer|Mailer]]>Configuration Instructions
{{TOC}}

==Introduction==

[[File:Tnml_admin_applet.png|left|Mailer Administration Control Panel Graphic]]
The {{TNML}} comes with its own database table to store its configuration settings as well as an system administration module to manage those settings. You must log into your *nuke site with an Admin user that has SuperUser capability so that the link/icon at the left is visible. Just clicking on that TegoNuke Mailer link/icon will bring up its admin module.

Configuration settings are grouped into three major groups:

# Activate Mailer - this is where the Mailer can be switched on or off
# General Mailer Options - this is where the send method is chosen and other Mailer-wide settings are entered
# Send Method Options - depending upon which send method is chosen, a different set of settings are presented for entry

Each of these setting groups are explained in more detail below, but first some general administration module usage aids.

==General Administration Module Usage Tips==

At the top of the administration module (see below graphic), there are two links worth mentioning. The first is the '''Site Administration''' link. When this link is clicked it takes you back to the main *nuke Administration Control Panel. The second link titled '''About TegoNuke Mailer''' takes you to the module/hack credits.

[[File:Tnml_admin_header.png|none|Mailer Administration Control Panel Graphic]]

The {{TNML}} comes with extensive help text built right into the on-line administration module. If you hover your cursor over the white-on-red-background icon that is next to any of the configuration options, a little window pop-ups with descriptive help text. For example, if you hover your cursor over the sample given at the top, your cursor changes into a large question-mark and the text should look like this:

[[File:Tnml_admin_helppopup.png|none|Mailer Administration Control Panel Graphic]]

Now onto detailed explanation of each of the available options.

==Activate Mailer Settings==

The main Activate Mailer Settings section looks like this:

[[File:Tnml_admin_activate.png|none|TegoNuke Mailer Administration Activate Mailer Settings]]

Choosing '''No''' essentially disables the Mailer and the code will just revert back to the original *nuke core mail code. Choosing '''Yes''' enables the Mailer and it will use the current enabled settings (see below).

It would be best to enter all your desired configuration settings first and then activate the mailer. You may also wish to complete all your core file edits (see installation/upgrade instructions) prior to activating the mailer - not necessary, just a suggestion if you are extra paranoid.

==General Mailer Options==

This section of options apply to the entire Mailer and it looks like this:

[[File:Tnml_admin_general.png|none|TegoNuke Mailer Administration General Options]]

The '''Send Method''' is what will control how the mailer will send email and make the appropriate options for the chosen method accessible from drop down lists. If you choose '''SMTP''', you will have the opportunity to enter your SMTP server URL and port as well as whether you wish to use authentication and/or encryption; these options will be explained in far more detail below under the [[Mailer_Configuration#SMTP_Configuration_Settings|SMTP Configuration Settings]].

'''NOTE: Authenticated and encrypted SMTP is the recommended setup as long as your web host provides for these two connection/send options.''' You will need to check with your host to find out what client connections are allowed (more on this below under the SMTP-specific settings).

If you are not able to use SMTP, either '''Sendmail''' or '''PHP Mail()''' options are your only other options. To be quite honest, these options really should not be needed for a real hosted environment. However, if you need them, they are there.

An '''Email Bounce Address''' setting is available for your use. If this setting is left blank, no ''Return-Path'' address will be provided on your email sends. Most web host accounts (at least the non-free ones) will allow you to set up more than one email address. It is recommended that you set up a separate email account to collect your bounced emails. If you follow this recommendation then enter that email address here. This way, you can check on that email account, after a large batch send for example, and see which of your *nuke user's email addresses are no longer valid. Sound useful? We thought so... ;-) '''For ANY email address you set up''', make sure it is from your domain. The author of the Swift Mailer library has an excellent article entitled [http://swiftmailer.org/wikidocs/v3/tips/spam How to (legitimately) minimize being seen as spam] that we highly recommend you reading if you plan on doing a lot of email sending.

The {{TNML}} provides extensive debug messaging capabilities as well as error catching. The '''Debug Level''' setting is where you would come if you were experiencing issues with your email sending through the Mailer or would like to test everything right up through the email connection, but just not perform the final send. The default setting is '''OFF''' where all errors and debug messages are suppressed.

If you set this to '''ON, WITH SEND''', a logged in admin (and ONLY a logged in admin, no-one else will see any messages), will see comprehensive messages on the returned web page at every stage of Mailer operations. Use this option if you are not getting email messages being sent/received. If you would like to see all the error and debug messaging right up through the mail server connection but do not want the actual send to take place, use the '''ON, NO SEND''' option setting.

Once you have configured these settings, you are ready to fill out the settings for your chosen Send Method (SMTP and Sendmail only as PHP Mail() has no additional settings).

==Send Method Options==

===SMTP Configuration Settings===

The [http://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol '''SMTP''' send method] is the recommended option. With it, you will be able to take advantage of settings and facilities available on most web hosts including authenticated SMTP and connections encrypted with [http://en.wikipedia.org/wiki/Transport_Layer_Security SSL or TLS]. You will need to make sure that these settings are available on your web host first, of course. The configuration settings for this send method look like this:

[[File:Tnml_admin_smtp2.png|none|TegoNuke Mailer Administration SMTP Configuration Settings]]

[[File:Cpanel_email_accounts.png‎|right|cPanel Email Accounts icon]]
Most web hosting accounts will provide some form of "control panel" where you are able to add mail accounts, set mail account passwords, and to see what your client connection settings should be. If none is provided, you will have to check with your web host as to what are the proper settings.

For example, cPanel is one such control panels, and under the Mail settings section, there is an icon like the one at the right. Next to the mail account there is an option to '''Configure Email Client'''. Under there, you are looking for these types of settings:

* Mail Server Username:
* Outgoing Mail Server:
* Supported Outgoing Mail Protocols: SMTP, SMTPS (SSL/TLS)

Each of the configuration options are described next in more detail and the above sample settings will be referenced as well to help you get the configuration right. '''Keep this in mind: think of this as if you were configuring an Outlook or Thunderbird or any other mail client''', and configuring the client's ability to '''send''' mail through that mail account with your hosting provider.

* '''Server''' - this is the ''Outgoing Mail Server'' that your mail account is on. It is the SMTP outgoing server.
* '''Helo''' - this is usually the same as the '''Server'''. If making these the same does not work, check with your web host as to the proper Helo value.
* '''Port''' - this is the port that the connection needs to be made to. For non-encrypted connections, the default is usually '''25'''. For encrypted connections, the port is usually '''465'''. The ''Outgoing Mail Server'' line above in our example will usually have the port number tacked onto the end and there will be two lines, one for non-encrypted (if available) and the other for encrypted (if available).
* '''Authentication''' - most web hosts will require that you use an authenticated connection (our default), and you will need to provide both the ''Username'' and ''Password'' from your outgoing mail account for this. If you are not going to use authenticated SMTP, simply click on the '''No''' option and leave the ''Username'' and ''Password'' fields blank. '''NOTE: the ''Username'' can be a little bit tricky'''. If you were able to log into your control panel and get the exact format to use, great, use that. But, if you do not have the exact format, you could try either '''user+yourdomain.tld''' or just '''user''' or maybe '''user@yourdomain.tld'''. If none of these work, you'll need to check with your web host for the proper values to use.
* '''Use Encryption''' - if your web host provides this for your account, we would highly recommend using it, '''especially if your *nuke site runs on a different server than your mail server'''. Yes, that is right, it is possible to run these are different servers and in fact, this is how one can run a local copy of your site on your PC/laptop and still be able to test email sends! If you want to use encryption, select the '''Yes''' option and then select your Encryption Method. If you do not want to use encryption, then select the '''No''' option (no need to modify the Encryption Method setting). '''Make sure you use the right port above if you are using encryption.'''
* '''Encryption Method''' - if you have elected to use encryption, you will need to choose either SSL or TLS. Either one is fine, just choose the one that is available for your web host's ''Supported Outgoing Mail Protocols''. Our preference would be TLS over SSL.

At this point, you should be done configuring your SMTP settings and you could activate the Mailer and perform a test send (see below section entitled [[Mailer_Configuration#How_to_Test_Your_Configuration|How to Test Your Configuration]]).

===Sendmail Configuration Settings===

The '''Sendmail''' configuration settings look like this:

[[File:Tnml_admin_sendmail.png‎|none|TegoNuke Mailer Administration Sendmail Configuration Settings]]

In most setups the default location for the Sendmail daemon will work. If it does not, you may need to check with your web host as to the correct location of the binary as well as any needed command line options to be passed. The bottom line is that this setting requires the '''absolute path to the sendmail binary''' in order to work properly.

The [http://www.sendmail.com/sm/open_source/ Sendmail open source community] is very strong. If you need to use this method of sending emails (highly doubtful) and you run into any issues with how it is set up, it is possible that the community could help. Extensive documentation also exists on the provided site link.

'''NOTE:''' although we have not tried, it may also be possible to use Sendmail under-the-covers so to speak, if your host or environment allows it, by configuring the mailer to use SMTP and use '''localhost''' (or its IP address) and '''port 25''' IF the Sendmail daemon is set up to accept these types of connections. However, most hosting providers and even internal company policies may refuse this type of set up as there are many known exploits to the Sendmail daemon.

At this point, you should be done configuring your Sendmail settings and you could activate the Mailer and perform a test send (see below section entitled [[Mailer_Configuration#How_to_Test_Your_Configuration|How to Test Your Configuration]]).

===PHP Mail===

So, why are there no specific settings for the PHP Mail() option? Well, quite frankly, there just aren't any special options/settings required. So why use the {{TNML}} PHP Mail() option as opposed to the existing core mail() feature within *nuke? The {{TNML}} gives you the ability to use an email bounce mail address and also the ability to debug your mail issues.

Just so it is clear, this option has not been tested extensively as the recommended send method is authenticated and encrypted SMTP. There are also Swift Mailer forum threads which document PHP configuration deficiencies of web hosts which may cause the Mailer not to function properly or could even result in being flagged as a spammer on some ISPs (due to poor php.ini configuration on outgoing emails).

==How to Test Your Configuration==

The absolute easiest way to test your {{TNML}} configuration settings is to activate the Mailer and use the *nuke Feedback module to send you, the admin, a test feedback comment. If everything is configured properly (and your core file edits for this module are correct), you should have a Feedback message in your admin's email account after a bit. You can even check the email headers using your email client to see if all the appropriate From, To, Reply-To, and Return-Path (only if you elected to configure the ''Email Bounce Address'') headers are correct.

If you would like test a batch send email, like what the Newsletter module does, it gets a bit more complicated. If you are using the HTML Newsletter module from [http://montegoscripts.com Montego Scripts] with the NSN Groups hack installed (these are already embedded in {{RN}}), you could create a couple of dummy users with valid email addresses, assign them to a NSN Group, and then use either the HTML Newsletter or the NSN Group administration Send to Group feature to perform a batch send to this "dummy" test group. Each user in the group should get a separate email directly addressed to them (i.e., only one email address on the To line) with all the correct email headers.

==Language Configuration==

The {{TNML}} does support the native *nuke method of providing different literal language translations provided that a language file for your desired language is available. As of this writing, the [[Mailer_Authors_and_Contributors#Language_File_Translations|list of supported languages]] is rather small.

If you would like to provide a translation for a specific language feel free to communicate as such through the various feedback/forum/PM options available at [http://montegoscripts.com Montego Scripts]. To create a new translation is easy. Copy the existing '''lang-english.php''' script from ''language/tegonuke/mailer'' to a new '''lang-xxxxxxxxx.php''' file replacing the x's with the language name and start translating the text in that new file accordingly.

==Warranty/Disclaimer==

Review [[Mailer_Release_Information#Warranties_and_Liabilities|Mailer Warranties and Liabilities]]. We're serious about this. Use at your own risk and respect those whom you send to. Don't SPAM!

Mailer Upgrade

2010-11-13T22:27:12Z

Montego: /* Step 1: Extract Mailer Files and Deploy */

[[Main_Page|Home]]>[[Mailer|Mailer]]>Upgrade Instructions

{{TOC}}

==Overview==

There has only been two releases so far, so these instructions are written specifically for an upgrade from {{TNML}} version 1.0.0 to 1.1.0. It is our intent that database changes will only be implemented between major releases (so from 1.0 to 1.1 for example - this release) and the {{TNML}} is written such that it will handle the database table upgrade automatically the first time the new script is executed.

Major releases could also include some re-factoring of the underlying scripts, so more upgrade work needs to be done, which may also incur a slight outage to your site but this will be kept to a minimum. All attempts are made so that previous [[Mailer Core File Edits|Core File Edits]] will work with newer versions of the {{TNML}}, however, these edits, as always, should still be compared with your implemented edits and updated as new mailer versions are deployed just to avoid any unforeseen site impacts.

As additional versions of the {{TNML}} are released, new steps will be added to this Wiki page to help guide you through your upgrade. In addition, if your site has {{NS}} installed (the latest version is ALWAYS best!), you may want to temporarily disable your site during the Mailer File Upgrade step. See our FAQ on [[Disabling Site Temporarily Using NukeSentinel]] for how to do this.

==Backup, Backup, Backup==

Always, always, always back up your site files and database. Most web hosts provide some form of control panel that you can log into and perform common administration tasks such as submitting a full site backup, files and databases. It is always good practice to produce these back-ups so that you may quickly restore back to your previous condition in case you mess something up.

Another helpful tip that we learned rather quickly is to create a development/test environment right on your local PC/laptop to mirror that of your production site. There are entire [http://en.wikipedia.org/wiki/WAMP WAMP]/[http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP] environments available today, such as [http://www.apachefriends.org/en/xampp.html XAMPP from Apache Friends], which make this incredibly easy. This type of set up gives you an opportunity to test all of your site updates off-line prior to going live. Call it a dry-run, trial-run, or just being smart, whatever you like.

==Upgrade Steps==

===Step 1: Extract Mailer Files and Deploy===

Do the following:

# Extract the distribution archive to your local PC
# On your target site to deploy, it would be best to first remove the following directories/files ('''if you were planning on disabling your site via {{NS}}, now would be the time to do it if you have not done so already'''):
#* Remove directory '''includes/tegonuke/mailer/Swift'''
#* Remove file '''includes/tegonuke/mailer/Swift.php'''
#* Remove file '''includes/tegonuke/mailer/EasySwift.php'''
# Now copy all of the files that are under the '''html''' directory to the root of your *nuke site (i.e., to where mainfile.php resides) so:
<pre>
html/ ---> PHP-Nuke_root/
</pre>

You should now be able to upgrade your database table and configure your new {{TNML}} settings if you so desire.

'''NOTE:''' at this point in time, if you are upgrading from a previous installation of the {{TNML}} and you have your PHP settings such that PHP errors are displayed, you could see some errors related to the TNML_IS_ACTIVE constant. Even if you have ''$display_errors'' set to ''false'' in ''config.php'', you may still see a PHP error. '''You should NEVER run a production site with PHP errors turned on to where they get displayed'''. Once you complete the core file edits for ''mainfile.php'', these PHP errors will go away.

===Step 2: Upgrade Tables and Configuration===

Make sure the script '''includes/tegonuke/mailer/mailer.php''' has the following switch set to "true" like this:

<source lang="php">
define('TNML_CHECK_TABLE', true);
</source>

If it is not, change it and re-upload it.

[[File:Tnml_admin_applet.png|right|Mailer Administration Control Panel Graphic]]

Now log into the Administration Control Panel (i.e., admin.php) and click on the "TegoNuke Mailer" icon/link (shown to the right); the mailer configuration table will be upgraded automatically with all the '''new''' default settings basically disabled (so no impact to current site operations) until the core file edits are complete and you are ready to test.

Once the new Mailer code is executed once with this set to '''true''', the table(s) are updated and you may change this line to '''false''' and the table check will no longer be executed (i.e., saves a few database calls).

===Step 3: Configure New Settings===

New options for method [[Mailer_Configuration#SMTP_Configuration_Settings|SMTP]] were added so you might want to review those settings and make any desired changes. Use the provided pop-up help icons to see helpful hints for each configuration setting or click on the above link to a page with more specific details around configuration. The settings for [[Mailer_Configuration#PHP_Mail|PHP Mail()]] and [[Mailer_Configuration#Sendmail_Configuration_Settings|Sendmail]] have not changed since the initial 1.0.0 release (and probably never will).

===Step 4: Review and Revise Core File Edits===

If you recall from your initial installation of the {{TNML}}, certain core *nuke files needed to be modified in order to have the email sends go through the Mailer rather than the standard PHP mail() function. The most important core file edit to make would be for the mainfile.php script. I would review and update that one FIRST and re-upload it. This will ensure proper site functioning right away. '''If you had used {{NS}} to disable your site, you could reverse that now, after mainfile.php is updated'''.

You should now compare each of the scripts and edits on our [[Mailer Core File Edits]] page to your current script files and make any necessary adjustments that you see. The edits were relatively minor in nature (except mainfile.php) and essentially were about simply changing from this one line of code:

<source lang="php">
if (defined('TNML_IS_ACTIVE')) {
</source>

To this code:

<source lang="php">
if (TNML_IS_ACTIVE) {
</source>

That is pretty much it for core file edit differences!

===Step 5: You Are Done: Almost===

It costs money to run a web site and to host the downloads, these instructions and to provide a means for community support. Don't kid yourself: while Open Source is "free" to YOU, it is NOT free to the ones providing it. Besides, why not show your appreciation and give the author(s) of Open Source scripts the little bit of motivation they need to continue to plug on and produce other scripts that you may need/want in the future.

Please support your starving Open Source programmer by making a small, but very much appreciated, donation! :-) Just follow the "Make Donation" link or through the block on the Home Page of http://montegoscripts.com. Thank you!

Mailer Installation and Configuration

2010-11-11T12:48:02Z

Montego: /* Step 5: Upload and Test Installation */

[[Main_Page|Home]]>[[Mailer|Mailer]]>New Installation
{{TOC}}

==Introduction==

When it comes to the installation of hacks for existing software packages (like {{RN}} and PHP-Nuke in this case), some installations are extremely easy, while others require quite a few changes. Given the number of places within these two CMS' where emails are sent, quite a few changes are needed throughout the system, however the changes to be made for each are not that complex. What could make it more challenging are the differences in code between versions of the CMS.

Our installation instructions are such that we give you the complete changes needed for a given version and in this case PHP-Nuke 7.6. It is up to the installer to reconcile what we hope to be only minor variations in the code as we just do not have the resources to manage separate instructions for every possible combination/version. Sorry.

The instructions that follow are for brand new installations ONLY. If you are upgrading from an earlier version of {{TNML}}, you will need to go to our [[Mailer Upgrade]] instructions instead.

==Installation Overview or "Quick Start"==

For those of you who like an overview of the installation process or do not want the more verbose instructions, we present a quick summary of the steps below. However, we still encourage you to also read the more verbose instructions so that nothing is missed.

* Backup your site files and database - although, new installations will not overwrite anything (better safe than sorry)
* Extract the distribution archive and upload what is under the '''html''' directory to the root of your *nuke site
* [[Mailer Configuration|Configure]] initial {{TNML}} settings - via administration control panel
* Perform the required [[Mailer Core File Edits|edits for the core *nuke files]]
* Upload/Test (or Test/Upload!) your edits - look for blank white pages (you made a syntax error) and successful email sends
* Support your open source software programmer!

Again, the above is very high-level. The below will give more complete installation instructions.

==Instructions for NEW Installations==

<div style="padding:0.3em;margin-bottom:0.3em;border:2px solid #a00;background-color:#f0f0f0">The below instructions are only applicable to a non-{{RN}} site. The {{TNML}} was integrated into the {{RN}} package starting with version 2.30.00. It is our opinion that one should upgrade to the latest version of {{RN}} (which at this writing is 2.40.01) in order to get the advantage of all the great security and bug fixes that have been made up to this release. Therefore, we will only be providing [[Mailer Upgrade]] instructions for the {{RN}} system, not new installation instructions.</div>

===Step 1: Backup, Backup, Backup===

Always, always, always back up your site files and database. Most web hosts provide some form of control panel that you can log into and perform common administration tasks such as submitting a full site backup, files and databases. It is always good practice to produce these back-ups so that you may quickly restore back to your previous condition in case you mess something up.

Another helpful tip that we learned rather quickly is to create a development/test environment right on your local PC/laptop to mirror that of your production site. There are entire [http://en.wikipedia.org/wiki/WAMP WAMP]/[http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP] environments available today, such as [http://www.apachefriends.org/en/xampp.html XAMPP from Apache Friends], which make this incredibly easy. This type of set up gives you an opportunity to test all of your site updates off-line prior to going live. Call it a dry-run, trial-run, or just being smart, whatever you like. :-)

===Step 2: Extract Mailer Files and Upload===

Extract the distribution archive to a temporary location on your PC. Copy all of the files that are under the '''html''' directory to the root of your *nuke web site (i.e., where mainfile.php resides); this package will not overwrite any core *nuke site files. So, do this:

<pre>
html/ ---> PHP-Nuke_root/
</pre>

===Step 3: Configure Initial Mailer Settings===
[[File:Tnml_admin_applet.png|right|Mailer Administration Control Panel Graphic]]

Click on the "TegoNuke Mailer" icon/link (shown to the right) within the System Administration section and the mailer configuration table will be built automatically with all the default settings which is basically disabled (so no impact to current site operations as the {{TNML}} is essentially by-passed) until the core file edits are complete and you are ready to test.

The Mailer comes defaulted to being Inactive as well as defaulted to use PHP's native mail() function. You have three options at this time for configuring the mailer: [[Mailer_Configuration#PHP_Mail|PHP Mail()]] (the default), [[Mailer_Configuration#SMTP_Configuration_Settings|SMTP]] (most likely option you will choose), or [[Mailer_Configuration#Sendmail_Configuration_Settings|Sendmail]]. To use SMTP or Sendmail you may need to check with your host as to the proper settings for these.

Use the provided pop-up help icons to see helpful hints for each configuration setting or click on the above links for each option to see a page with more specific details around configuration for the desired option. Extensive [[Mailer_Configuration|Configuration Instructions]] are provided on this site (just click the provided link).

'''NOTE: the Forums, for now, still have its own configuration option to use the default of PHP mail() or SMTP'''. If you intend upon using SMTP, you must also configure the Forums separately using the ACP -> Forums -> Configuration -> SMTP Options. At some point, we hope to provide core file edits for the Forums as well.

===Step 4: Core File Updates===

Now you have to edit several core *nuke files in order to utilize the {{TNML}} rather than the current PHP mail() function calls. We maintain only one version of core file edits to serve as examples for the Community, namely PHP-Nuke 7.6 (as {{RN}} since 2.30.00 already has the mailer incorporated). If this is not your particular version of PHP-Nuke or if your variant of *nuke system didn't come from 7.6 (the last most stable and secure version along with the latest [http://www.nukeresources.com Nuke patchset]), you will have to reconcile the differences yourself as we only have time to manage the edits for these few versions.

Very detailed examples of the edits required are found in our [[Mailer_Core_File_Edits|Mailer Core File Edits]] page. However, '''the basic edits go something like this:'''

Find a line with the PHP mail() function in it. Say you found the following:

<source lang="php">
mail($to, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());
</source>

The minimal replacement would look like this:

<source lang="php">
/*
* TegoNuke(tm) Mailer
*/
$mailsuccess = false;
if (TNML_IS_ACTIVE) {
$mailsuccess = tnml_fMailer($to, $subject, $message, $from, '');
} else {
$mailsuccess = mail($to, $subject, $message, "From: $from\r\nX-Mailer: PHP/" . phpversion());
}
//mail($to, $subject, $message, "From: $from\nX-Mailer: PHP/" . phpversion());;
</source>

If you run into any issues, the includes/tegonuke/mailer/mailer.php script is well commented as to what parameters are needed and how to pass them.

===Step 5: Upload and Test Installation===

If you followed our advice in using a local copy of your operational site on your PC, then test each of the scripts that you modified. You should receive no blank white pages when you click into each of the modules above. Then it is a matter of uploading each of the modified scripts to your production site and run a final test. Again, should get no white pages. Also at this time you should be able to [[Mailer_Configuration#How_to_Test_Your_Configuration|test the send method]] that you configured in Step 4 above.

===Step 6: You Are Done: Almost===

It costs money to run a web site and to host the downloads, these instructions and to provide a means for community support. Don't kid yourself: while Open Source is "free" to YOU, it is NOT free to the ones providing it. Besides, why not show your appreciation and give the author(s) of Open Source scripts the little bit of motivation they need to continue to plug on and produce other scripts that you may need/want in the future.

Please support your starving Open Source programmer by making a small, but very much appreciated, donation! :-) Just follow the "Make Donation" link or through the block on the Home Page of http://montegoscripts.com. Thank you!

==NukeSentinel(tm) Support==

As of the time of this writing, [http://www.ravenphpscripts.com/modules.php?name=Downloads&d_op=viewdownload&cid=14#cat NukeSentinel(tm)] was at version 2.6.01 and support for the {{TNML}} was built into it! We would not recommend running a *nuke site without it. However, come to think of it, we just wouldn't run anything other than {{RN}} which has it already fully integrated and supported.

Enjoy!

Mailer Authors and Contributors

2010-11-10T13:09:31Z

Montego: /* Additional Credits/Thanks */

[[Main_Page|Home]]>[[Mailer|Mailer]]>Authors and Contributors
{{TOC}}

==Credits for Original Works==

As was mentioned in [[Mailer_Introduction#Why_a_New_Mailer_Bundling.3F|Why a New Mailer Bundling?]], the {{TNML}} was inspired by other products. These three in particular I would like to thank for their great contributions to the *nuke community as well as PHP community:

===PHPNukeMailer===

This fine script was one of the first, if not THE first, solution made available to the problem of [[Mailer_Introduction#Why_is_the_Mailer_Needed.3F|web hosts removing the PHP mail() function]]. [http://dev.exuberanza.com PHPNukeMailer] was the inspiration for the administration applet. Here are its original credits:

<pre>
/*****************************************************/
/* PhpNukeMailer v1.0.9 (Apr-11-2007) */
/* By: Jonathan Estrella (kiedis.axl@gmail.com) */
/* http://www.slaytanic.tk */
/* Copyright © 2004-2007 by Jonathan Estrella */
/*****************************************************/
</pre>

The {{TNML}} has evolved significantly since then, but the great idea of having an administration tool to configure the Mailer was Jonathan's original idea.

===Swift Mailer===

I was reviewing [http://phpmailer.worxware.com/ PHPMailer] as the underlying PHPNukeMailer and found ('''at the time - no longer the case''') that it was no longer in active development and support, so I went looking for other good email script libraries. Through a review of [http://www.nuke-evolution.com/ NukeEvolution], I ran into the [http://swiftmailer.org/ Swift Mailer]. It was in active development and support, looked quite robust, and had all the features that I could ever want in a library of its kind. Here are the current credits:

<pre>
/**
* Swift Mailer Core Component.
* @copyright Chris Corbyn <chris@w3style.co.uk>
* @author Chris Corbyn <chris@w3style.co.uk>
* @package Swift
* @version 4.0.6
* @license GNU Lesser General Public License
*/
</pre>

Unfortunately, it appears that development has gone stale again as its been at version 4.0.6 for quite some time now. Most unfortunate. However, the script author is still relatively active in his Google Group set up for support purposes. We'll have to keep a close watch on this script library; hopefully development picks up again.

===NukeEvolution===

[http://www.nuke-evolution.com/ NukeEvolution] was how I ended up finding the Swift Mailer. Thanks [http://www.techn0crat.com/ Technocrat] for the great find!

==Language File Translations==

Our thanks go out to the following folks for their non-English translations:

{| border="1" cellpadding="5" cellspacing="0"
| align="center" | '''Language'''
| align="center" | '''Author'''
| align="center" | '''Version(s)'''
| align="center" | '''Web Site'''
|-
| align="left" | Spanish
| align="left" | Jonathan Estrella
| align="left" | 1.0.0, 1.1.0
| align="left" | http://dev.exuberanza.com.
|}

==Additional Credits/Thanks==

'''And last but not least''', to the following folks for their continual support, wealth of good ideas and endless encouragement:

Guardian from http://www.code-authors.com
kguske from http://nukeSEO.com
Raven from http://www.ravenphpscripts.com
and the entire RavenNuke(tm) Team both past and present.