READ ME Examples

Contents

A - E-mail mass mailing

The e-mail mass mailing is part of the QR bill processor and is typically used after the creation of the QR bill PDF. But it may also be used standalone. This section explains, how to do this.

First, choose the selection HTML mail without PDF.

A.1 - Simple e-mail mass mailing

To produce a simple e-mail mass mailing (regardless if a QR bill PDF is attached or not) you need only two files for the e-mail itself (MailBody.html and MailBody.json) and a very simple Recipients.csv.

MailBody.html contains the text of the e-mail, MailBody.json contains the fromAddress, the fromName and the subject of the e-mail.

An entry in Recipients.csv does only need values for the language (field Language) and the e-mail address (field MailAddress); all other fields are not used.

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

3. Execution

Pressing Dry run will show this result:

*** Dry run *** (no PDFs stored, no e-mails sent)
Checking language of 4 recipients
Warning: Recipient '2' has language 'it' and the following input data does not contain values for this language:
MailDatajson: subject
MailBody_it.html

Warning: Recipient '3' has language 'en' and the following input data does not contain values for this language:
MailDatajson: subject
MailBody_en.html

Warning: Recipient '4' has language 'fr' and the following input data does not contain values for this language:
MailDatajson: subject
MailBody_fr.html

[ {profile} ] Number of recipients to process: 4
#1.a) Creating PDF suppressed by global flag 'createPdf'.
#1.b) Sending mail suppressed because of option 'dry run'.
#2.a) Creating PDF suppressed by global flag 'createPdf'.
#2.b) Sending mail suppressed because of option 'dry run'.
#3.a) Creating PDF suppressed by global flag 'createPdf'.
#3.b) Sending mail suppressed because of option 'dry run'.
#4.a) Creating PDF suppressed by global flag 'createPdf'.
#4.b) Sending mail suppressed because of option 'dry run'.
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!

The warnings can be ignored, as this execution is without multi-language support.

Remark:

Pressing Test run (to your address, indicated below by your.mail@yourmailhoster.com) will show this result:

Test run to email address: 'your.mail@yourmailhoster.com'
[ {profile} ] Number of recipients to process: 1
#1.a) Creating PDF suppressed by global flag 'createPdf'.
#1.b) Mail has been sent successfully to: your.mail@yourmailhoster.com
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!
Download protocol file _qr-bills-protocol.csv_.

The underlines around the text qr-bills-protocol.csv indicate that this text is underlined, it's the download link to the protocol.
Clicking on the link qr-bills-protocol.csv will download the protocol to your browser.

And the e-mail you have received, will look like this: A.1 - Test run QR bills Mail

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent. The result will look like this:

[ {profile} ] Number of recipients to process: 4
#1.a) Creating PDF suppressed by global flag 'createPdf'.
#1.b) Mail has been sent successfully to: hmuster@example.com
#2.a) Creating PDF suppressed by global flag 'createPdf'.
#2.b) Mail has been sent successfully to: han.muster@example.com
#3.a) Creating PDF suppressed by global flag 'createPdf'.
#3.b) Mail has been sent successfully to: musterag@example.com
#4.a) Creating PDF suppressed by global flag 'createPdf'.
#4.b) Mail has been sent successfully to: mustergmbh@example.com
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!
Download protocol file _qr-bills-protocol.csv_.

The underlines around the text qr-bills-protocol.csv indicate that this text is underlined, it's the download link to the protocol.
Clicking on the link qr-bills-protocol.csv will download the protocol to your browser.

Protocol

After the processing, the protocol file qr-bills-protocol.csv has the following content:

1,,,hmuster@example.com,false,true
2,,,han.muster@example.com,false,true
3,,,musterag@example.com,false,true
4,,,mustergmbh@example.com,false,true

After the number of the recipient, the columns last name and first name are empty (as not provided in the Recipients.csv), the next column contains the e-mail address, the following column contains false (as no PDF has been created) and the last column contains true, which means the e-mail has been sent.

A.2 - E-mail mass mailing with multi-language support

To produce a e-mail mass mailing with multi-language suport (regardless if a QR bill PDF is attached or not) you need some files for the e-mail itself (MailBody.html, MailBody_[language].html and MailBody.json) and a very simple Recipients.csv.

MailBody.html contains the default text of the e-mail (taken if there is no MailBody_[language].html that fits the language in the recipient), and the optional MailBody_de.html, MailBody_fr.html, MailBody_it.html and MailBody_en.html files for multi-language support. Both of these files contain an example of the usage of the placeholders {{greeting}} and {{amount}}.

MailBody.json contains the fromAddress, the fromName and the subject of the e-mail, where subject contains optional sections that fit the languages of the recipient (only for the languages de and en to show the behavior when a language is not supported and the default is taken.

An entry in Recipients.csv needs non-empty values for the language (field Language), the e-mail address (field MailAddress) and the amount (field Amount) used for the placeholder {{amount}}; the greeting (field Greeting) must be present (defined in the header) for the placeholder {{greeting}}, but may be empty (in this case the placeholder {{greeting}} is just replaced with an empty string); all other fields are not used.

1. Configuration

Configure the QR bill processor as follows:

Press the button Save configuration a second time!

2. Upload input files

Delete old input files by pressing Delete files.

Upload the following input files:

3. Execution

Pressing Dry run will show this result:

*** Dry run *** (no PDFs stored, no e-mails sent)
Checking language of 4 recipients
Warning: Recipient '2' has language 'it' and the following input data does not contain values for this language:
MailDatajson: subject
MailBody_it.html

Warning: Recipient '4' has language 'fr' and the following input data does not contain values for this language:
MailDatajson: subject
MailBody_fr.html

[ {profile} ] Number of recipients to process: 4
#1.a) Creating PDF suppressed by global flag 'createPdf'.
#1.b) Sending mail suppressed because of option 'dry run'.
#2.a) Creating PDF suppressed by global flag 'createPdf'.
#2.b) Sending mail suppressed because of option 'dry run'.
#3.a) Creating PDF suppressed by global flag 'createPdf'.
#3.b) Sending mail suppressed because of option 'dry run'.
#4.a) Creating PDF suppressed by global flag 'createPdf'.
#4.b) Sending mail suppressed because of option 'dry run'.
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!

The warnings show that the recipients with index 2 (language is "it") and index 4 (language is "fr") have languages that have no multi-language support for the field subject in MailData.json and the file MailBody.html.
For these recipient the default language (German) will be used.

Pressing Test run (to your address) has the same result as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv; the e-mail subject and body are in the recipient's language (except for fr and it, where they are in German, the language of the default entry). Again, the configuration Sleep after send defines how fast the e-mails are sent. The status section shows the same as in A.1 - Simple e-mail mass mailing.

Again, clicking on the link qr-bills-protocol.csv will download the protocol to your browser.

Protocol

The protocol contains the same as in A.1 - Simple e-mail mass mailing.

B - QR bill with QR-IBAN and payment reference (former orange payment slip)

In this section, all the examples support multi-language (for the languages "de" and "en"). If multi-language support is not required, then just set the option Multi-language support to no.

First, choose the selection QR bill PDF with payment slip.

B.1 - QR bill without debtor and amount

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

3. Execution

Pressing Dry run QR bills will show this result:

*** Dry run *** (no PDFs stored, no e-mails sent)
Checking language of 4 recipients
Warning: Recipient '2' has language 'it' and the following input data does not contain values for this language:
AdditionalInformationjson: additionalInformation
PdfTemplate_it.pdf
PdfData.json: date
MailDatajson: subject
MailData.json: attachmentName
MailBody_it.html

Warning: Recipient '4' has language 'fr' and the following input data does not contain values for this language:
AdditionalInformationjson: additionalInformation
PdfTemplate_fr.pdf
PdfData.json: date
MailDatajson: subject
MailData.json: attachmentName
MailBody_fr.html

[ {profile} ] Number of recipients to process: 4
#1.a) Writing PDF suppressed because of option 'dry run'.
#1.b) Sending mail suppressed because of option 'dry run'.
#2.a) Writing PDF suppressed because of option 'dry run'.
#2.b) Sending mail suppressed because of option 'dry run'.
#3.a) Writing PDF suppressed because of option 'dry run'.
#3.b) Sending mail suppressed because of option 'dry run'.
#4.a) Writing PDF suppressed because of option 'dry run'.
#4.b) Sending mail suppressed because of option 'dry run'.
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!

The warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address, indicated below by your.mail@yourmailhoster.com) will show this result:

Test run to email address: 'your.mail@yourmailhoster.com'
[ {profile} ] Number of recipients to process: 1
#1.a) PDF for 'Muster Hans+Hanna' created
#1.b) Mail has been sent successfully to: your.mail@yourmailhoster.com
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!
Download protocol file _qr-bills-protocol.csv:.
Download _ZIP archive_.

The underlines around the texts qr-bills-protocol.csv and ZIP archive indicate that these texts are underlined; these are the download links to the protocol and the ZIP archive containing the created PDFs.
Clicking on the link qr-bills-protocol.csv will download the protocol to your browser.
Clicking on the link ZIP archive will download the ZIP archive to your browser.

And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.
Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look like this:

[ {profile} ] Number of recipients to process: 4
#1.a) PDF for 'Muster Hanna' created
#1.b) Mail has been sent successfully to: hmuster@example.com
#2.a) PDF for 'Muster Han' created
#2.b) Mail has been sent successfully to: han.muster@example.com
#3.a) PDF for 'Muster Hans' created
#3.b) Mail has been sent successfully to: musterag@example.com
#4.a) PDF for 'Muster (-Müsterli) c/o Hans' created
#4.b) Mail has been sent successfully to: mustergmbh@example.com
[ {profile} ] CONGRATULATIONS: All recipients successfully processed!
Download protocol file qr-bills-protocol.csv.
Download ZIP archive.

(As the mail addresses do not exist, nobody receives an e-mail.)

The underlines around the texts qr-bills-protocol.csv and ZIP archive indicate that these texts are underlined; these are the download links to the protocol and the ZIP archive containing the created PDFs.
Clicking on the link qr-bills-protocol.csv will download the protocol to your browser.
Clicking on the link ZIP archive will download the ZIP archive to your browser.

Created PDFs

The PDFs created in the output folder look like this:

 example for recipient with index 1 (no company, but salutation)

The name of the PDF in the ZIP archive is qr-bill-1-Muster-Hanna-hmuster@example.com.pdf. B.1 - Create QR bills PDF 1

 example for recipient with index 3 (company, no salutation)

The name of the PDF in the ZIP archive is qr-bill-3-Muster-Hans-musterag@example.com.pdf. B.1 - Create QR bills PDF 3

Protocol

After the processing, the protocol file qr-bills-protocol.csv has the following content:

0,Muster,Hanna,hmuster@example.com,true,true
1,Muster,Han,han.muster@example.com,true,true
2,Muster,Hans,musterag@example.com,true,true
3,"Muster (-Müsterli)","c/o Hans",true,true

Index 1 contains the last name, index 2 contains the first name, index 3 contains the e-mail address, index 4 contains true, which means the PDF has been created, and index 5 contains true, which means the e-mail has been sent.

B.2 - QR bill with debtor and global amount

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

These files are actually exactly the same as in B.1 - QR bill without debtor and amount, the only difference between the examples B.1 and B.2 is the global configuration.

3. Execution

Pressing Dry run will show the same result as in B.1 - QR bill without debtor and amount. Again, the warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address) will show the same result as in B.1 - QR bill without debtor and amount. And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.

Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look the same as in B.1 - QR bill without debtor and amount. (Again, as the mail addresses to not exist, nobody receives an e-mail.)

Created PDFs

The difference to B.1:

The PDFs created in the output folder look like this:

example for recipient with index 1 (no company, but salutation)

B.2 - Create QR bills PDF 1

example for recipient with index 3 (company, no salutation)

B.2 - Create QR bills PDF 3

Protocol

The protocol file qr-bills-protocol.csv in the sub folder with the current date/time in the output folder looks like the one in B.1 - QR bill without debtor and amount.

B.3 - QR bill with debtor, individual amount and greeting

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

These files are actually the same as in B.1 - QR bill without debtor and amount except the file Recipients.csv, which contains now a different amount for every recipient. Another difference is the global configuration.

3. Execution

Pressing Dry run will show the same result as in B.1 - QR bill without debtor and amount. Again, the warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address) will show the same result as in B.1 - QR bill without debtor and amount. And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.

Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look the same as in B.1 - QR bill without debtor and amount. (Again, as the mail addresses to not exist, nobody receives an e-mail.)

Created PDFs

The difference to B.2:

The PDFs created in the output folder look like this:

example for recipient with index 1 (no company, but salutation)

B.3 - Create QR bills PDF 1

example for recipient with index 3 (company, no salutation)

B.3 - Create QR bills PDF 3

Protocol

The protocol file qr-bills-protocol.csv in the sub folder with the current date/time in the output folder looks like the one in B.1 - QR bill without debtor and amount.

B.4 - QR bill with BESR-ID

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

These files are actually the same as in B.1 - QR bill without debtor and amount except the file CreditorInformation.json, which contains now a BESR-ID, and the file AdditionalInformation.json, which is missing.

3. Execution

Pressing Dry run will show the same result as in B.1 - QR bill without debtor and amount. Again, the warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address) will show the same result as in B.1 - QR bill without debtor and amount. And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.

Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look the same as in B.1 - QR bill without debtor and amount. (Again, as the mail addresses to not exist, nobody receives an e-mail.)

Created PDFs

The difference to B.1:

The PDFs created in the output folder look like this:

example for recipient with index 1 (no company, but salutation)

B.4 - Create QR bills PDF 1

example for recipient with index 3 (company, no salutation)

B.4 - Create QR bills PDF 3

Protocol

The protocol file qr-bills-protocol.csv in the sub folder with the current date/time in the output folder looks like the one in B.1 - QR bill without debtor and amount.

C - QR bill with Bank-IBAN (former red payment slip)

C.1 - QR bill without debtor and amount

First, choose the selection QR bill PDF with payment slip.

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

(This is actually the same configuration as in B.1 - QR bill without debtor and amount).

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

These files are actually the same as in B.1 - QR bill without debtor and amount, except the file CreditorInformation.json, which contains now a bank iban, and has set checkQrIban to false.

3. Execution

Pressing Dry run will show the same result as in B.1 - QR bill without debtor and amount. Again, the warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address) will show the same result as in B.1 - QR bill without debtor and amount. And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.

Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look the same as in B.1 - QR bill without debtor and amount. (Again, as the mail addresses to not exist, nobody receives an e-mail.)

Created PDFs

The difference to B.1:

The PDFs created in the output folder look like this:

example for recipient with index 1 (no company, but salutation)

C.1 - Create QR bills PDF 1

example for recipient with index 3 (company, no salutation)

C.1 - Create QR bills PDF 3

Protocol

The protocol file qr-bills-protocol.csv in the sub folder with the current date/time in the output folder looks like the one in B.1 - QR bill without debtor and amount.

C.2 - QR bill with amount and reference in 'AdditionalInformation'

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

These files are nearly the same as in C.1 - QR bill without debtor and amount, the only differences are the configuration and the PDF template (that contains an amount).

3. Execution

Pressing Dry run will show the same result as in B.1 - QR bill without debtor and amount. Again, the warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address) will show the same result as in B.1 - QR bill without debtor and amount. And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.

Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look the same as in B.1 - QR bill without debtor and amount. (Again, as the mail addresses to not exist, nobody receives an e-mail.)

Created PDFs

The difference to C.1:

The PDFs created in the output folder look like this:

example for recipient with index 1 (no company, but salutation)

C.2 - Create QR bills PDF 1

example for recipient with index 3 (company, no salutation)

C.2 - Create QR bills PDF 3

Protocol

The protocol file qr-bills-protocol.csv in the sub folder with the current date/time in the output folder looks like the one in B.1 - QR bill without debtor and amount.

D - E-mail mass mailing with attached personalized PDF

First, choose the selection PDF without payment slip.

D.1 - Personalized attached PDF

1. Configuration

Configure the QR bill processor as follows:

Don't forget to press the button Save configuration!

2. Upload input files

Delete old input files by pressing Delete input files.

Upload the following input files:

3. Execution

Pressing Dry run will show the same result as in B.1 - QR bill without debtor and amount. Again, the warnings can be ignored, there is no multi-language support for it and fr; these recipients will receive the e-mail and the PDF in the default language German.

Pressing Test run (to your address) will show the same result as in B.1 - QR bill without debtor and amount. And the e-mail you have received, is the same as in A.1 - Simple e-mail mass mailing.

Pressing Execute will send the mail to all the e-mail addresses in Recipients.csv. The configuration Sleep after send defines how fast the e-mails are sent.

Remark: For the first trials, configure Send e-mail to no and look into the ZIP archive whether the created PDF files are like you expect them.

The result will look the same as in B.1 - QR bill without debtor and amount. (Again, as the mail addresses to not exist, nobody receives an e-mail.)

Created PDFs

The PDFs created in the output folder look like this:

example for recipient with index 1 (no company, but salutation)

D.1 - Create QR bills PDF 1

example for recipient with index 3 (company, no salutation)

D.1 - Create QR bills PDF 3

Protocol

The protocol file qr-bills-protocol.csv in the sub folder with the current date/time in the output folder looks like the one in B.1 - QR bill without debtor and amount.