Dolibarr module to send recurring invoice by email.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Chl 0043e39f30 readme: more helpful download links + typos & format 2 months ago
.tx Commit initial 3 years ago
class Show attached files in agenda event 3 months ago
core/modules v. 0.3.1 3 months ago
img v. 0.3.0 : customization form for each recurring invoice 7 months ago
langs Link to default sender address configuration 3 months ago
sql v. 0.3.0 : customization form for each recurring invoice 7 months ago
test/phpunit Renaming from sendfacrecmail to sendrecurringinvoicebymail 2 years ago
.editorconfig Commit initial 3 years ago
.gitattributes Commit initial 3 years ago
.gitignore Commit initial 3 years ago
COPYING Commit initial 3 years ago
ChangeLog.md v. 0.3.1 3 months ago
README.md readme: more helpful download links + typos & format 2 months ago
fiche-rec-tab1.php Link to default sender address configuration 3 months ago
modulebuilder.txt Commit initial 3 years ago
phpdoc.dist.xml Renaming from sendfacrecmail to sendrecurringinvoicebymail 2 years ago

README.md

SendRecurringInvoiceByMail for DOLIBARR ERP CRM

Features

(en) This module sends by email the invoice generated with recurring invoices via scheduled jobs.

(fr) Ce module envoie par mail les factures générées automatiquement par les travaux planifiés et les factures modèles.

You can customize the mail globally or by recurring invoice.

Screenshot n° 1

To edit the default global mail template, go to Home > Setup > Emails > Email templates, and modify the SendRecurringInvoiceByMail : original template. If you don't want to attach the PDF of the invoice to the mails, set the Attach file input to 0 (default: 1, PDF attached).

To edit the default sender address, go to Home > Setup > Emails, and edit the Sender email for automatic emails field.

This module is triggered by the cron (Scheduled jobs module) and will not send emails when manually generating an invoice.

Requirements

It requires Dolibarr version 10.0 at least (first version with the cron/afterCreationOfRecurringInvoice() hook).

Don't forget to also activate the Scheduled jobs module.

Other modules are available on Dolistore.com.

Install

From the ZIP file and GUI interface

Go to Home > Setup > Modules/Applications and finally the Deploy/install external app/module tab and upload the module_sendrecurringinvoicebymail-x.y.z.zip file (you can get it from the original forge or Github).

Next, on the Modules/Applications page, activate the newly available sendrecurringinvoicebymail module, and probably the Scheduled jobs (alias cron or modCron) integrated module too.

Troubleshooting

Note: If the module screen tells you there is no custom directory, check that your setup is correct:

  • In your Dolibarr installation directory, edit the htdocs/conf/conf.php file and check that following lines are not commented:

    //$dolibarr_main_url_root_alt ...
    //$dolibarr_main_document_root_alt ...
    
  • Uncomment them if necessary (delete the leading //) and assign a sensible value according to your Dolibarr installation

    For example :

    • UNIX:

      $dolibarr_main_url_root_alt = '/custom';
      $dolibarr_main_document_root_alt = '/var/www/Dolibarr/htdocs/custom';
      
    • Windows:

      $dolibarr_main_url_root_alt = '/custom';
      $dolibarr_main_document_root_alt = 'C:/My Web Sites/Dolibarr/htdocs/custom';
      

From a GIT repository

  • Clone the repository in $dolibarr_main_document_root_alt/sendrecurringinvoicebymail
cd ....../custom
git clone git@github.com:bugness-chl/sendrecurringinvoicebymail.git sendrecurringinvoicebymail

Then, from your browser:

  • Log into Dolibarr as a super-administrator
  • Go to "Setup" -> "Modules"
  • You should now be able to find and enable the module

Updating instructions

  • Disable the module,
  • Update the files (see Install),
  • Re-enable the module.

Licenses

Main code

GPLv3 logo

GPLv3 or (at your option) any later version.

See file COPYING for more information.

Documentation

All texts and readmes.

GFDL logo