Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addError() - Method in class de.aikiit.mailversendala.MailingResult
-
Increment internal error counter by 1.
- addSuccess() - Method in class de.aikiit.mailversendala.MailingResult
-
Increment internal success counter by 1.
- App - Class in de.aikiit.mailversendala
-
Main application that sends out mailings found in the configurable CSV file.
- App() - Constructor for class de.aikiit.mailversendala.App
- applyTo(HtmlEmail, MailTemplate) - Method in class de.aikiit.mailversendala.template.MailResources
-
Embed local images using Content-IDs and add ordinary downloadable attachments.
B
- BASE_NAME_HTML - Static variable in interface de.aikiit.mailversendala.template.MailTemplate
-
Default template file name for HTML.
- BASE_NAME_PLAINTEXT - Static variable in interface de.aikiit.mailversendala.template.MailTemplate
-
Default template file name for plain text
C
- CsvParser - Class in de.aikiit.mailversendala.csv
-
Main class to parse given arguments for mailversendala configuration.
- CsvParser(Reader) - Constructor for class de.aikiit.mailversendala.csv.CsvParser
-
Parse given CSV values internally.
D
- de.aikiit.mailversendala - package de.aikiit.mailversendala
-
Provides the application itself and its main configuration and runtime classes.
- de.aikiit.mailversendala.csv - package de.aikiit.mailversendala.csv
-
Contains all CSV and CSV-parsing relevant parts of the application.
- de.aikiit.mailversendala.template - package de.aikiit.mailversendala.template
-
Contains all template-related parts of the application.
E
- email() - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Returns the value of the
emailrecord component. - EMAIL - Static variable in interface de.aikiit.mailversendala.csv.Headers
-
Required, non-blank email address used to send the mailing to.
- equals(Object) - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
-
Indicates whether some other object is "equal to" this one.
F
- FileMailTemplate - Record Class in de.aikiit.mailversendala.template
-
Immutable mail bodies read from files, streams or supplied directly as strings.
- FileMailTemplate(MailConfig) - Constructor for record class de.aikiit.mailversendala.template.FileMailTemplate
-
Apply given configuration and generate internal mailing contents.
- FileMailTemplate(InputStream, InputStream) - Constructor for record class de.aikiit.mailversendala.template.FileMailTemplate
-
Read given input streams and populate internal mailing contents.
- FileMailTemplate(String, String) - Constructor for record class de.aikiit.mailversendala.template.FileMailTemplate
-
Creates an instance of a
FileMailTemplaterecord class. - firstname() - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Returns the value of the
firstnamerecord component. - FIRSTNAME - Static variable in interface de.aikiit.mailversendala.csv.Headers
-
Firstname in the mailing.
G
- getErrorCounter() - Method in class de.aikiit.mailversendala.MailingResult
-
Returns error counter.
- getHtml() - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
- getHtml() - Method in interface de.aikiit.mailversendala.template.MailTemplate
-
Returns HTML contents.
- getMailCounter() - Method in class de.aikiit.mailversendala.MailingResult
-
Returns success counter.
- getPlaintext() - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
- getPlaintext() - Method in interface de.aikiit.mailversendala.template.MailTemplate
-
Returns plaintext contents.
- getTotal() - Method in class de.aikiit.mailversendala.MailingResult
-
Returns total counter.
H
- hashCode() - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Returns a hash code value for this object.
- hashCode() - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
-
Returns a hash code value for this object.
- Headers - Interface in de.aikiit.mailversendala.csv
-
Contains the required CSV headers.
- html() - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
-
Returns the value of the
htmlrecord component. - HtmlMarkupValidator - Class in de.aikiit.mailversendala.template
-
Checks rendered HTML without changing the outgoing markup or fetching resources.
M
- MailConfig - Class in de.aikiit.mailversendala
-
Encapsulates the configuration of this application.
- MailConfig() - Constructor for class de.aikiit.mailversendala.MailConfig
-
Read an optional UTF-8 properties file specified by
-Dconfig=path. - Mailing - Record Class in de.aikiit.mailversendala.csv
-
Comprises a mailing recipient.
- Mailing(String, String, String, String) - Constructor for record class de.aikiit.mailversendala.csv.Mailing
-
Creates an instance of a
Mailingrecord class. - MailingResult - Class in de.aikiit.mailversendala
-
Class encapsulates internal counters to gauge how many errors and how many mails were successfully sent out during an application run.
- MailingResult() - Constructor for class de.aikiit.mailversendala.MailingResult
- MailResources - Class in de.aikiit.mailversendala.template
-
Validates and snapshots local mail resources once per run.
- MailResources(MailConfig) - Constructor for class de.aikiit.mailversendala.template.MailResources
-
Load configured, comma-separated attachments relative to the real template directory.
- MailTemplate - Interface in de.aikiit.mailversendala.template
-
Contains the contents of a mail.
- Mailversendala - Class in de.aikiit.mailversendala
-
Encapsulates the actual CSV parsing and mailing generation.
- Mailversendala() - Constructor for class de.aikiit.mailversendala.Mailversendala
- main(String[]) - Static method in class de.aikiit.mailversendala.App
-
Main method to launch MailVersendala with the given arguments.
- main(String...) - Static method in class de.aikiit.mailversendala.SendOut
-
Test method to verify the actual mail creation and send out.
P
- parse() - Method in class de.aikiit.mailversendala.csv.CsvParser
-
Do the actual parsing of a given CSV configuration.
- plaintext() - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
-
Returns the value of the
plaintextrecord component.
R
- render(Mailing) - Method in class de.aikiit.mailversendala.template.VelocityMailTemplate
-
Render both alternatives for one recipient, without retaining recipient state.
S
- salutation() - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Returns the value of the
salutationrecord component. - SALUTATION - Static variable in interface de.aikiit.mailversendala.csv.Headers
-
Greeting prefix, for example "Liebe" or "Lieber".
- send() - Method in class de.aikiit.mailversendala.SendOut
-
Send out an email that contains only text contents.
- send(MailTemplate) - Method in class de.aikiit.mailversendala.SendOut
-
Send a rendered message with HTML and plain-text alternatives in UTF-8.
- sendComplex() - Method in class de.aikiit.mailversendala.SendOut
-
Send out an email with plain text and HTML contents.
- sendOut(MailConfig) - Static method in class de.aikiit.mailversendala.Mailversendala
-
Send out mails with the given configuration and return result object afterwards.
- SendOut - Class in de.aikiit.mailversendala
-
This class performs the actual mail sending and encapsulates all the technicalities to create and send out an email.
- SendOut(Mailing) - Constructor for class de.aikiit.mailversendala.SendOut
-
Create mail based on the given mailing recipient.
- SendOut(Mailing, MailConfig) - Constructor for class de.aikiit.mailversendala.SendOut
-
Create a sender using the same configuration as the mailing run.
- sendOutMails() - Method in class de.aikiit.mailversendala.MailConfig
-
If in demo mode NO mails should be sent out!
- surname() - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Returns the value of the
surnamerecord component. - SURNAME - Static variable in interface de.aikiit.mailversendala.csv.Headers
-
Surname in the mailing.
T
- toString() - Method in record class de.aikiit.mailversendala.csv.Mailing
-
Returns a string representation of this record class.
- toString() - Method in record class de.aikiit.mailversendala.template.FileMailTemplate
-
Returns a string representation of this record class.
V
- validate(MailTemplate) - Method in class de.aikiit.mailversendala.template.MailResources
-
Validate every inline image in a rendered message before the first delivery.
- validate(String, String) - Static method in class de.aikiit.mailversendala.template.HtmlMarkupValidator
-
Reject HTML parser errors and likely misspelled HTML tags before delivery.
- VelocityMailTemplate - Class in de.aikiit.mailversendala.template
-
Compiles external UTF-8 templates once per run and renders isolated recipient contexts.
- VelocityMailTemplate(MailConfig) - Constructor for class de.aikiit.mailversendala.template.VelocityMailTemplate
-
Load both templates from the configured external directory before sending begins.
All Classes and Interfaces|All Packages|Constant Field Values