Menu
▾
▴
[Xoops-svn] SF.net SVN: xoops-svn:[12904] XoopsModules/xnewsletter/branches/luciorota/ xnewsletter
|
From: <luc...@us...> - 2014-12-13 17:45:21
|
Revision: 12904
http://sourceforge.net/p/xoops/svn/12904
Author: luciorota
Date: 2014-12-13 17:45:11 +0000 (Sat, 13 Dec 2014)
Log Message:
-----------
administrator can run the cron.php script from administrative tasks page
update help files adding new features
Modified Paths:
--------------
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/admin/task.php
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/cron.php
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/admin.php
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help.html
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/modinfo.php
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/xoops_version.php
Added Paths:
-----------
XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help3.html
Modified: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/admin/task.php
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/admin/task.php 2014-12-13 15:49:41 UTC (rev 12903)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/admin/task.php 2014-12-13 17:45:11 UTC (rev 12904)
@@ -46,8 +46,10 @@
$taskAdmin->addItemButton(_AM_XNEWSLETTER_TASK_SHOW_ALL, '?op=list_tasks', 'view_detailed');
}
$taskCount = $xnewsletter->getHandler('task')->getCount();
- if ($taskCount) {
+ if ($taskCount > 0) {
+ $taskAdmin->addItemButton(_AM_XNEWSLETTER_TASK_RUN_CRON_NOW, '?op=run_cron_now', 'exec');
$taskAdmin->addItemButton(_AM_XNEWSLETTER_TASK_DELETE_ALL, '?op=delete_tasks', 'delete');
+
}
echo $taskAdmin->renderButton();
//
@@ -255,7 +257,7 @@
xoops_cp_header();
// render confirm form
xoops_confirm(
- array('ok' => true, 'task_id' => $task_id, 'op' => 'delete_task'),
+ array('ok' => true, 'op' => 'delete_task', 'task_id' => $task_id),
$_SERVER['REQUEST_URI'],
sprintf(_AM_XNEWSLETTER_FORMSUREDEL, $taskObj->getVar('task'))
);
@@ -306,4 +308,31 @@
include_once __DIR__ . '/admin_footer.php';
}
break;
+
+ case 'run_cron_now':
+ if (xnewsletterRequest::getBool('ok', false, 'POST') == true) {
+ if (!$GLOBALS['xoopsSecurity']->check()) {
+ redirect_header($currentFile, 3, implode(',', $GLOBALS['xoopsSecurity']->getErrors()));
+ }
+ // render start here
+ xoops_cp_header();
+ include_once XOOPS_ROOT_PATH . '/modules/xnewsletter/include/functions.task.php';
+ // execute all pending tasks
+ $result_exec = xnewsletter_executeTasks($xnewsletter->getConfig('xn_send_in_packages'), 0);
+ if ($result_exec != '') {
+ $newsletter->getHandler('protocol')->protocol(0, 0, 'Cron: ' . $result_exec, _XNEWSLETTER_PROTOCOL_STATUS_CRON, array('%result_exec' => $result_exec), true);
+ }
+ redirect_header($currentFile, 3, "result cron: {$result_exec}");
+ } else {
+ // render start here
+ xoops_cp_header();
+ // render confirm form
+ xoops_confirm(
+ array('ok' => true, $task_id, 'op' => 'run_cron_now'),
+ $_SERVER['REQUEST_URI'],
+ _AM_XNEWSLETTER_FORMSURERUNCRONNOW
+ );
+ include_once __DIR__ . '/admin_footer.php';
+ }
+ break;
}
Modified: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/cron.php
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/cron.php 2014-12-13 15:49:41 UTC (rev 12903)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/cron.php 2014-12-13 17:45:11 UTC (rev 12904)
@@ -38,24 +38,5 @@
if ($result_exec != '') {
$newsletter->getHandler('protocol')->protocol(0, 0, 'Cron: ' . $result_exec, _XNEWSLETTER_PROTOCOL_STATUS_CRON, array('%result_exec' => $result_exec), true);
-/*
- // you can enable the block for creating protocol for cron
- $protocolObj = $xnewsletter->getHandler('protocol')->create();
- $protocolObj->setVar('protocol_letter_id', 0);
- $protocolObj->setVar('protocol_subscriber_id', 0);
- $protocolObj->setVar('protocol_status', 'Cron: ' . $result_exec); // old style
- $protocolObj->setVar('protocol_status_str_id', _XNEWSLETTER_PROTOCOL_STATUS_CRON); // new from v1.3
- $protocolObj->setVar('protocol_status_vars', array('%result_exec' => $result_exec)); // new from v1.3
- $protocolObj->setVar('protocol_success', true);
- $protocolObj->setVar('protocol_submitter', 0);
- $protocolObj->setVar('protocol_created', time());
-
- if ($xnewsletter->getHandler('protocol')->insert($protocolObj)) {
- // create protocol is ok
- // NOP
- } else {
- echo $protocolObj->getHtmlErrors();
- }
-*/
}
echo "<br/>result cron: {$result_exec}";
Modified: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/admin.php
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/admin.php 2014-12-13 15:49:41 UTC (rev 12903)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/admin.php 2014-12-13 17:45:11 UTC (rev 12904)
@@ -405,15 +405,15 @@
<br /><br />
Available smarty-vars are:
<ul>
- <li><{$salutation}> or <{$sex}>: the subscriber Salutation field</li>
- <li><{$firstname}>: the subscriber First name field</li>
- <li><{$lastname}>: the subscriber Last name field</li>
- <li><{$email}> or <{$subscr_email}>: the subscriber Email field</li>
+ <li><{$salutation}> or <{$sex}>: the subscriber "Salutation" (subscr_sex) field</li>
+ <li><{$firstname}>: the subscriber "First name" (subscr_firstname) field</li>
+ <li><{$lastname}>: the subscriber "Last name" (subscr_lastname) field</li>
+ <li><{$email}> or <{$subscr_email}>: the subscriber "Email" (subscr_email) field</li>
</ul>
<ul>
- <li><{$letter_id}>: the newsletter id</li>
- <li><{$title}>: the newsletter Title field</li>
- <li><{$content}>: the newsletter Content field</li>
+ <li><{$letter_id}>: the newsletter "id" (letter_id) field</li>
+ <li><{$title}>: the newsletter "Title" (letter_title) field</li>
+ <li><{$content}>: the newsletter "Content" (letter_content) field</li>
<li><{$attachments}>: attachments array
<br />
<span style="font-size:0.9em">
@@ -512,7 +512,10 @@
define('_AM_XNEWSLETTER_TASK_ACTIONS_EXECUTE', "Execute now");
define('_AM_XNEWSLETTER_TASK_SHOW_ALL', "Show all");
define('_AM_XNEWSLETTER_TASK_DELETE_ALL', "Delete all tasks");
+define('_AM_XNEWSLETTER_TASK_RUN_CRON_NOW', "Execute now "cron.php"");
+define('_AM_XNEWSLETTER_FORMSURERUNCRONNOW', "Are you sure you want to execute: <span class='bold red'>"cron.php"</span>");
+
//Buttons
define('_AM_XNEWSLETTER_NEWTEMPLATE', "Add New Template");
define('_AM_XNEWSLETTER_TEMPLATELIST', "List Template");
Modified: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help.html
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help.html 2014-12-13 15:49:41 UTC (rev 12903)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help.html 2014-12-13 17:45:11 UTC (rev 12904)
@@ -44,196 +44,14 @@
- Newsletter are based on templates<br />
- Detailed handling of permissions for groups and newsletter (subscribe, write, send)<br />
- Send: send test mail, resend to all subscribers or only to subscribers, where sending failed<br />
- - Sending newsletters to unlimited number of recipients or in packages with certain number of recipients by using cronjob<br />
+ - Sending newsletters to unlimited number of recipients or in packages with certain number of recipients by using <a href="http://en.wikipedia.org/wiki/Cron">cronjob</a><br />
- Bounced email handler for handling Bounced emails in case of invalid e-mail-addresses<br />
- - Optionally synchronisation with mailing lists (e.g. majordomo)<br />
+ - Optionally synchronisation with mailing lists (e.g. <a href="http://en.wikipedia.org/wiki/Majordomo_%28software%29">majordomo</a>)<br />
- Maintenance function included<br />
- Creating protocol for the important steps<br />
<br />
</p>
- <h4 class="odd">Install/uninstall</h4>
- <p class="even">
- No special measures necessary, follow the standard installation process - extract the /xnewsletter folder into the
- ../modules directory. Install the module through Admin -> Modules. If you need detailed
- instructions on how to install a module, please see the <a href="http://goo.gl/adT2i">XOOPS Operations
- Manual</a>.<br /><br /></p>
- <h4 class="odd">Tutorial</h4>
- <!-- -----Help Content ---------- -->
-
-
-
<h5 class="odd">Basic information</h5>
- <p class="even">The module is based on PHPMailer and PHPMailer-BMH
+ <p class="even">The module is based on <a href="https://github.com/PHPMailer/PHPMailer">PHPMailer</a> and <a href="http://phpmailer.worxware.com/index.php?pg=bmh">PHPMailer-BMH</a>.
<br /><br /></p>
-
- <h5 class="odd">(Un) subscriptions to newsletters</h5>
- <p class="even">
- You can define for each newsletter and for each group, whether for (un) subscription or change a confirmation email with activation key is necessary or not (use double-option).<br />
- <br /><br /></p>
-
- <h5 class="odd">Accounts</h5>
- <p class="even">
- You can use one or more email-account; sending with php mail, php sendmail, smtp is possible.<br />
- There is a feature for testing pop3 and imap accounts.<br />
- <br />
- Pay attention: functions like testing account, sending emails, start Bounced email handler,... work not with local server (you get white page without any error).<br />
- <br /><br /></p>
-
- <h5 class="odd">Newsletter categories</h5>
- <p class="even">
- You can handle one or more newsletter categories.<br />
- It is possible to set permissions "read", "create", "admin" and "list subscribers" for each newsletter cat.<br />
- <br /><br /></p>
-
- <h5 class="odd">Create a newsletter</h5>
- <p class="even">
- The newsletter can be created with each text editor which is installed in current xoops core (e.g. TinyMCE). <br />
- For each newsletter you can use different templates (see also 'Newsletter templates').<br />
- You can define one or more newsletter categories for your newsletter.<br />
- You can add 5 files maximum as attachment to each newsletter.<br /><br />
- Optionally you can also copy an older newsletter and edit or send it as a new one.<br /><br />
- The type of text editor, allows mime-types and size of mail attachments can be set in module preferences.<br />
- <br /><br /></p>
-
- <h5 class="odd">Newsletter templates</h5>
- <p class="even">
- The newsletters are template based.<br />
- The templates are stored as files in language/{yourlanguage}/templates or stored in database.<br />
- To create a new template you can:
- <ol>
- <li>make a new template html-file in in language/{yourlanguage}/templates folder and to put in the smarty-vars;</li>
- <li>from admin side create a new template item and to put in the smarty-vars.</li>
- </ol>
- <br />
- This module uses the Xoops <a href="http://www.smarty.net/">Smarty template engine</a> to render the email letter.<br /><br />
- Available smarty-vars are:
- <ul>
- <li><{$salutation}> or <{$sex}>: the subscriber Salutation field</li>
- <li><{$firstname}>: the subscriber First name field</li>
- <li><{$lastname}>: the subscriber Last name field</li>
- <li><{$email}> or <{$subscr_email}>: the subscriber Email field</li>
- </ul>
- <ul>
- <li><{$title}>: the newsletter Title field</li>
- <li><{$content}>: the newsletter Content field</li>
- </ul>
- <ul>
- <li><{$date}>: the sending date as timestamp integer <br /><span style="font-size:0.9em">(e.g.: <{$date|date_format:"%Y/%m/%d"}> will output the date formatted as 2001/01/04)</span></li>
- <li><{$unsubscribe_url}>: the unsubscribe url</li>
- </ul>
- <ul>
- <ul>
- <li><{$xoops_url}>: the site main url (e.g. http://localhost/)</li>
- <li><{$xoops_langcode}>: the site langcode (e.g. en)</li>
- <li><{$xoops_charset}>: the site cherset (e.g. UTF-8)</li>
- </ul>
- <br /><br /></p>
-
- <h5 class="odd">Sending newsletter</h5>
- <p class="even">
- You can show a preview of a newsletter before sending.<br />
- You can send the newsletter for testing to a defined email-address.<br />
- The newsletters will be sent subscriber by subscriber.<br />
- For each sending action a protocol will be created.<br />
- If one or more send failed, you can see it in the protocol.<br />
- You can restart sending procedure. You can send it again to all subscribers or send it only to the subscribers, where sending procedure failed).<br />
- <br />
- You can send all emails immediately or limit emails send in one package.<br />
- The number of emails and the minutes until next sending can be defined in module preferences (e.g. 200 emails all 60 minutes).<br />
- The first package will be sent immediately. To start the next sending procedure you need an external cronjob, which is calling "../modules/xnewsletter/cron.php". Xoops cannot do this with current version (2.5.5).<br />
- <br />
- Pay attention: functions like testing account, sending emails, start Bounced email handler,... work not with local server (you get white page).<br />
- <br /><br /></p>
-
- <h5 class="odd">Task list</h5>
- <p class="even">
- If you limit emails send in one package, you can see all newsletters waiting for next cronjob and the time, when cronjob can send the newsletter.<br />
- If you do not use this option, this list must always be empty.<br />
- Normally the tab "Task list" is hidden, if this option is disabled.<br />
- <br /><br /></p>
-
- <h5 class="odd">Handle mailing lists</h5>
- <p class="even">
- If you have an existing mailing list, you can synchronize the (un) subscriptions of one newsletter category with one mailing list.<br />
- I use majordomo beside this newsletter module because then I can also send an email from my email-client to the newsletter recipients.<br />
- One of the disadvantages of mailing lists is, that, if one person is registered in two or more mailing lists and you send a one newsletter to all mailing lists, this person gets the same newsletter more than one time. With xNewsletter he gets only one newsletter.<br />
- <br />
- <br />Normally the tab "Mailing list" is hidden, if this option is disabled.<br />
- <br />
- <b>xNewsletter cannot create mailing lists</b>.
- <br /><br /></p>
-
- <h5 class="odd">Bounced email handler (BMH)</h5>
- <p class="even">
- If you send newsletters, there will always be some emails not delivered to recipient (Bounced email), because email is no more valid, mailbox is full, and so on.<br />
- To handle this event and to react on this, you can use BMH.<br />
- You can activate BMH for each account.<br />
- Mails, which are detected as Bounced emails by BMH, can be deleted or moved in a special folder, you have to define.<br />
- Possible actions for Bounced emails:<br />
- -- no action (only store)<br />
- -- quit temporary the subscriptions of this email-address<br />
- -- delete the subscriptions of this email-address<br />
- <br />
- <br />
- <h6 class="odd">Types of Bounced emails</h6>
- <span style="text-decoration: underline;">bounce type hard:</span>
- This means that there is a permanent error when sending a mail, e.g. unknown recipient, unknown domain, and so on.<br />
- This mails will be deleted after detection, so it is recommended using the move hard option (the email will be only moved in this folder, you can check this mail later, if you want).<br />
- <br />
- <span style="text-decoration: underline;">bounce type soft:</span><br />
- This means that there is a temporary problem with sending a mail, e.g. mailbox full, server not available, and so on.<br />
- This mails will not be deleted after detection, but it is recommended using the move soft option in order to keep your basic in box clean.<br />
- <br />
- Pay attention: functions like testing account, sending emails, start Bounced email handler,... work not with local server (you get white page).<br />
- <br /><br /></p>
-
- <h5 class="odd">Maintenance</h5>
- <p class="even">
- This module has a maintain function, which can repair several faults in the data.<br />
- <br /><br /></p>
-
- <h5 class="odd">Import</h5>
- <p class="even">
- You can import data with various plug-ins:
- <ul>
- <li>csv</li>
- <li>module rmbulletin</li>
- <li>module smartpartner</li>
- <li>module weblinks</li>
- <li>module evennews</li>
- <li>module subscribers</li>
- <li>users from xoops users</li>
- </ul>
- The import tool works in this way:<br />
- - Adding email to the list of subscribers<br />
- - Subscribe this email to one newsletter cat<br />
- Before you run import tool therefore, please create first minimum one newsletter cat, otherwise the email cannot be subscribed to a cat and the import fails.<br />
- You have the possibility<br />
- - to import the E-Mail-Addresses without any check (recommended for big import data sets) or<br />
- - after reading data you can decide for each email<br />
- -- whether you want to make a subscription or not<br />
- -- to which newsletter you want to make the subscription<br />
- If an email is already registered, import of this email should be skipped (default action, do not touch existing registrations).
- <br />
- Sample files (sample1col.csv, sample4col.csv) for csv-import you can find in ../xnewsletter/plugins/
- <br /><br />
- <b>Attention:</b>In case of registrations/subscription with this import tool there will not be sent an email notification to the email owner.<br />
- <br /><br />
- <b>Importation of big email lists:</b><br />
- To avoid cache overflow during importation, there are two limits:<br />
- - first limit: only 100000 lines (e.g. of a csv-file) can be stored in temporary import table<br />
- - second limit: you can finally import data from temporary import table in packages of max. 25000<br />
- <br />
- For import of more than 100k emails following procedure can be done:<br />
- - run first import email 1 to 100000
- - import finally emails in packages of 25k
- - run second import emails 100001 to 200000 (select option "skip existing subscriptions")
- - import finally in packages of 25k
- and so on.<br />
- If file size is not too big to upload, you can repeat as often you want.<br />
- <br /><br />
- If you get somewhere a white page, it is no problem because if option "skip existing subscriptions" is selected the import procedure restart at the first not imported email-address.<br />
- Reduce number of importing emails or package size and try again.<br />
- <br /><br /></p>
-
</div>
Added: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help3.html
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help3.html (rev 0)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/help/help3.html 2014-12-13 17:45:11 UTC (rev 12904)
@@ -0,0 +1,232 @@
+<?php
+/**
+ * ****************************************************************************
+ * - A Project by Developers TEAM For Xoops - ( http://www.xoops.org )
+ * ****************************************************************************
+ * XNEWSLETTER - MODULE FOR XOOPS
+ * Copyright (c) 2007 - 2012
+ * goffy ( )
+ *
+ * You may not change or alter any portion of this comment or credits
+ * of supporting developers from this source code or any supporting
+ * source code which is considered copyrighted (c) material of the
+ * original comment or credit authors.
+ *
+ * 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.
+ * ---------------------------------------------------------------------------
+ * @copyright goffy ( )
+ * @license gpl 2.0
+ * @package xnewsletter
+ * @author goffy ( )
+ *
+ * Version : 1 Mon 2012/11/05 14:31:32 : Exp $
+ * ****************************************************************************
+ */
+
+<div id="help-template" class="outer">
+ <h1 class="head">Help:
+ <a class="ui-corner-all tooltip" href="<{$xoops_url}>/modules/xnewsletter/admin/index.php"
+ title="Back to the administration of xNewsletter"> xNewsletter <img src="<{xoAdminIcons home.png}>"
+ alt="Back to the Administration of xNewsletter"/>
+ </a></h1>
+ <!-- -----Help Content ---------- -->
+ <h4 class="odd">Tutorial</h4>
+ <h5 class="odd">(Un) subscriptions to newsletters</h5>
+ <p class="even">
+ You can define for each newsletter and for each group, whether for (un) subscription or change a confirmation email with activation key is necessary or not (use double-option).<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Accounts</h5>
+ <p class="even">
+ You can use one or more email-account; sending with php mail, php sendmail, smtp is possible.<br />
+ There is a feature for testing pop3 and imap accounts.<br />
+ <br />
+ Pay attention: functions like testing account, sending emails, start Bounced email handler,... work not with local server (you get white page without any error).<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Newsletter categories</h5>
+ <p class="even">
+ You can handle one or more newsletter categories.<br />
+ It is possible to set permissions "read", "create", "admin" and "list subscribers" for each newsletter cat.<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Create a newsletter</h5>
+ <p class="even">
+ The newsletter can be created with each text editor which is installed in current xoops core (e.g. TinyMCE). <br />
+ For each newsletter you can use different templates (see also 'Newsletter templates').<br />
+ You can define one or more newsletter categories for your newsletter.<br />
+ You can add files (as attachment or as link) to each newsletter (max number, size and type of attachments can be set in module preferences).<br /><br />
+ Optionally you can also copy an older newsletter and edit or send it as a new one.
+ <br /><br /></p>
+
+ <h5 class="odd">Newsletter templates</h5>
+ <p class="even">
+ The newsletters are template based.<br />
+ The templates are stored as files in language/{yourlanguage}/templates or stored in database.<br />
+ To create a new template you can:
+ <ol>
+ <li>make a new template html-file in in language/{yourlanguage}/templates folder and to put in the smarty-vars;</li>
+ <li>from admin side create a new template item and to put in the smarty-vars.</li>
+ </ol>
+ <br />
+ This module uses the Xoops <a href="http://www.smarty.net/">Smarty template engine</a> to render the email letter.<br /><br />
+ Available smarty-vars are:
+ <ul>
+ <li><{$salutation}> or <{$sex}>: the subscriber "Salutation" (subscr_sex) field</li>
+ <li><{$firstname}>: the subscriber "First name" (subscr_firstname) field</li>
+ <li><{$lastname}>: the subscriber "Last name" (subscr_lastname) field</li>
+ <li><{$email}> or <{$subscr_email}>: the subscriber "Email" (subscr_email) field</li>
+ </ul>
+ <ul>
+ <li><{$letter_id}>: the newsletter "id" (letter_id) field</li>
+ <li><{$title}>: the newsletter "Title" (letter_title) field</li>
+ <li><{$content}>: the newsletter "Content" (letter_content) field</li>
+ <li><{$attachments}>: attachments array
+ <br />
+ <span style="font-size:0.9em">
+ e.g.:
+ <br>
+ <ul>
+ <br>
+ <{foreach item="attachment" from=$attachments}>
+ <br>
+ <li><a href="<{$attachment.attachment_url}>"><{$attachment.attachment_name}></a></li>
+ <br>
+ <{/foreach}>
+ <br>
+ </ul>
+ <br>
+ will output the linked attachments list
+ </span>
+ </li>
+ </ul>
+ <ul>
+ <li><{$date}>: the sending date as timestamp integer
+ <br />
+ <span style="font-size:0.9em">
+ e.g.:
+ <br>
+ <{$date|date_format:"%Y/%m/%d"}> will output the date formatted as php fuction date('Y/m/d', $date)
+ </span>
+ </li>
+ <li><{$unsubscribe_url}>: the unsubscribe url</li>
+ </ul>
+ <ul>
+ <li><{$xoops_url}>: the site main url (e.g. http://localhost/)</li>
+ <li><{$xoops_langcode}>: the site langcode (e.g. en)</li>
+ <li><{$xoops_charset}>: the site cherset (e.g. UTF-8)</li>
+ </ul>
+ <br /><br /></p>
+
+ <h5 class="odd">Sending newsletter</h5>
+ <p class="even">
+ You can show a preview of a newsletter before sending.<br />
+ You can send the newsletter for testing to a defined email-address.<br />
+ The newsletters will be sent subscriber by subscriber.<br />
+ For each sending action a protocol will be created.<br />
+ If one or more send failed, you can see it in the protocol.<br />
+ You can restart sending procedure. You can send it again to all subscribers or send it only to the subscribers, where sending procedure failed).<br />
+ <br />
+ You can send all emails immediately or limit emails send in one package.<br />
+ The number of emails and the minutes until next sending can be defined in module preferences (e.g. 200 emails all 60 minutes).<br />
+ The first package will be sent immediately. To start the next sending procedure you need an external cronjob, which is calling "../modules/xnewsletter/cron.php". Xoops cannot do this.
+ Is also possible to call "../modules/xnewsletter/cron.php" from administrative Tasks page.<br />
+ <br />
+ Pay attention: functions like testing account, sending emails, start Bounced email handler,... work not with local server (you get white page).<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Task list</h5>
+ <p class="even">
+ If you limit emails send in one package, you can see all newsletters waiting for next cronjob and the time, when cronjob can send the newsletter.<br />
+ If you do not use this option, this list must always be empty.<br />
+ Normally the tab "Task list" is hidden, if this option is disabled.<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Handle mailing lists</h5>
+ <p class="even">
+ If you have an existing mailing list, you can synchronize the (un) subscriptions of one newsletter category with one mailing list.<br />
+ I use majordomo beside this newsletter module because then I can also send an email from my email-client to the newsletter recipients.<br />
+ One of the disadvantages of mailing lists is, that, if one person is registered in two or more mailing lists and you send a one newsletter to all mailing lists, this person gets the same newsletter more than one time. With xNewsletter he gets only one newsletter.<br />
+ <br />
+ <br />Normally the tab "Mailing list" is hidden, if this option is disabled.<br />
+ <br />
+ <b>xNewsletter cannot create mailing lists</b>.
+ <br /><br /></p>
+
+ <h5 class="odd">Bounced email handler (BMH)</h5>
+ <p class="even">
+ If you send newsletters, there will always be some emails not delivered to recipient (Bounced email), because email is no more valid, mailbox is full, and so on.<br />
+ To handle this event and to react on this, you can use BMH.<br />
+ You can activate BMH for each account.<br />
+ Mails, which are detected as Bounced emails by BMH, can be deleted or moved in a special folder, you have to define.<br />
+ Possible actions for Bounced emails:<br />
+ -- no action (only store)<br />
+ -- quit temporary the subscriptions of this email-address<br />
+ -- delete the subscriptions of this email-address<br />
+ <br />
+ <br />
+ <h6 class="odd">Types of Bounced emails</h6>
+ <span style="text-decoration: underline;">bounce type hard:</span>
+ This means that there is a permanent error when sending a mail, e.g. unknown recipient, unknown domain, and so on.<br />
+ This mails will be deleted after detection, so it is recommended using the move hard option (the email will be only moved in this folder, you can check this mail later, if you want).<br />
+ <br />
+ <span style="text-decoration: underline;">bounce type soft:</span><br />
+ This means that there is a temporary problem with sending a mail, e.g. mailbox full, server not available, and so on.<br />
+ This mails will not be deleted after detection, but it is recommended using the move soft option in order to keep your basic in box clean.<br />
+ <br />
+ Pay attention: functions like testing account, sending emails, start Bounced email handler,... work not with local server (you get white page).<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Maintenance</h5>
+ <p class="even">
+ This module has a maintain function, which can repair several faults in the data.<br />
+ <br /><br /></p>
+
+ <h5 class="odd">Import</h5>
+ <p class="even">
+ You can import data with various plug-ins:
+ <ul>
+ <li>csv</li>
+ <li>module rmbulletin</li>
+ <li>module smartpartner</li>
+ <li>module weblinks</li>
+ <li>module evennews</li>
+ <li>module subscribers</li>
+ <li>users from xoops users</li>
+ </ul>
+ The import tool works in this way:<br />
+ - Adding email to the list of subscribers<br />
+ - Subscribe this email to one newsletter cat<br />
+ Before you run import tool therefore, please create first minimum one newsletter cat, otherwise the email cannot be subscribed to a cat and the import fails.<br />
+ You have the possibility<br />
+ - to import the E-Mail-Addresses without any check (recommended for big import data sets) or<br />
+ - after reading data you can decide for each email<br />
+ -- whether you want to make a subscription or not<br />
+ -- to which newsletter you want to make the subscription<br />
+ If an email is already registered, import of this email should be skipped (default action, do not touch existing registrations).
+ <br />
+ Sample files (sample1col.csv, sample4col.csv) for csv-import you can find in ../xnewsletter/plugins/
+ <br /><br />
+ <b>Attention:</b>In case of registrations/subscription with this import tool there will not be sent an email notification to the email owner.<br />
+ <br /><br />
+ <b>Importation of big email lists:</b><br />
+ To avoid cache overflow during importation, there are two limits:<br />
+ - first limit: only 100000 lines (e.g. of a csv-file) can be stored in temporary import table<br />
+ - second limit: you can finally import data from temporary import table in packages of max. 25000<br />
+ <br />
+ For import of more than 100k emails following procedure can be done:<br />
+ - run first import email 1 to 100000
+ - import finally emails in packages of 25k
+ - run second import emails 100001 to 200000 (select option "skip existing subscriptions")
+ - import finally in packages of 25k
+ and so on.<br />
+ If file size is not too big to upload, you can repeat as often you want.<br />
+ <br /><br />
+ If you get somewhere a white page, it is no problem because if option "skip existing subscriptions" is selected the import procedure restart at the first not imported email-address.<br />
+ Reduce number of importing emails or package size and try again.<br />
+ <br /><br /></p>
+
+</div>
Modified: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/modinfo.php
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/modinfo.php 2014-12-13 15:49:41 UTC (rev 12903)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/language/english/modinfo.php 2014-12-13 17:45:11 UTC (rev 12904)
@@ -42,7 +42,7 @@
define('_MI_XNEWSLETTER_ADMENU10', "Bounced emails ");
define('_MI_XNEWSLETTER_ADMENU11', "Maintenance");
define('_MI_XNEWSLETTER_ADMENU12', "Import");
-define('_MI_XNEWSLETTER_ADMENU13', "Task list");
+define('_MI_XNEWSLETTER_ADMENU13', "Tasks");
define('_MI_XNEWSLETTER_ADMENU99', "About");
define('_MI_XNEWSLETTER_SUBSCRIBE', "(Un)Subscribe");
define('_MI_XNEWSLETTER_LIST', "Newsletter list");
Modified: XoopsModules/xnewsletter/branches/luciorota/xnewsletter/xoops_version.php
===================================================================
--- XoopsModules/xnewsletter/branches/luciorota/xnewsletter/xoops_version.php 2014-12-13 15:49:41 UTC (rev 12903)
+++ XoopsModules/xnewsletter/branches/luciorota/xnewsletter/xoops_version.php 2014-12-13 17:45:11 UTC (rev 12904)
@@ -90,9 +90,11 @@
++$i;
$modversion['helpsection'][$i]['name'] = 'Install';
$modversion['helpsection'][$i]['link'] = 'page=help2';
+++$i;
+$modversion['helpsection'][$i]['name'] = 'Tutorial';
+$modversion['helpsection'][$i]['link'] = 'page=help3';
-
// Admin things
$modversion['hasAdmin'] = true;
$modversion['adminindex'] = 'admin/index.php';
|
