Index (Simple Java Mail 3.0.1 API)

A B C D E F G I M O P R S T V

A

addAttachment(String, byte[], String) - Method in class org.codemonkey.simplejavamail.email.Email: Adds an attachment to the email message and generates the necessary DataSource with the given byte data.
addAttachment(String, DataSource) - Method in class org.codemonkey.simplejavamail.email.Email: Overloaded method which sets an attachment on account of name and DataSource.
addAttachment(String, byte[], String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds an attachment to the email message and generates the necessary DataSource with the given byte data.
addAttachment(String, DataSource) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Overloaded method which sets an attachment on account of name and DataSource.
addEmbeddedImage(String, byte[], String) - Method in class org.codemonkey.simplejavamail.email.Email: Adds an embedded image (attachment type) to the email message and generates the necessary DataSource with the given byte data.
addEmbeddedImage(String, DataSource) - Method in class org.codemonkey.simplejavamail.email.Email: Overloaded method which sets an embedded image on account of name and DataSource.
addHeader(String, Object) - Method in class org.codemonkey.simplejavamail.email.Email: Adds a header to the Email.headers list.
addHeader(String, Object) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a header to the Email.Builder.headers list.
addRecipient(String, String, Message.RecipientType) - Method in class org.codemonkey.simplejavamail.email.Email: Adds a new Recipient to the list on account of name, address and recipient type (eg.
applyProperties(Properties) - Method in class org.codemonkey.simplejavamail.Mailer: Copies all property entries into the Session using Session.getProperties().
AttachmentResource - Class in org.codemonkey.simplejavamail.email: A named immutable email attachment information object.
AttachmentResource(String, DataSource) - Constructor for class org.codemonkey.simplejavamail.email.AttachmentResource: Constructor; initializes the attachment resource with a name and data.

B

bcc(String, String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.BCC.
bcc(Recipient) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.BCC.
build() - Method in class org.codemonkey.simplejavamail.email.Email.Builder
Builder() - Constructor for class org.codemonkey.simplejavamail.email.Email.Builder

C

cc(String, String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.CC.
cc(Recipient) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.CC.
cleanupPersonalString(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Given a string, if the string is a quoted string (without CFWS around it, although it will be trimmed) then remove the bounding quotations and then unescape it.
createDataSource(MimePart) - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser: Parses the MimePart to create a DataSource.
createMailSession(String, Integer, String, String) - Method in class org.codemonkey.simplejavamail.Mailer: Actually instantiates and configures the Session instance.

D

DEFAULT - Static variable in enum org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria: The default setting is not strictly 2822 compliant.

E

Email - Class in org.codemonkey.simplejavamail.email: Email message with all necessary data for an effective mailing action, including attachments etc.
Email() - Constructor for class org.codemonkey.simplejavamail.email.Email: Constructor, creates all internal lists.
Email(MimeMessage) - Constructor for class org.codemonkey.simplejavamail.email.Email: Constructor for MimeMessage.
Email.Builder - Class in org.codemonkey.simplejavamail.email: Fluent interface Builder for Emails
EmailAddressCriteria - Enum in org.hazlewood.connor.bottema.emailaddress: Defines a set of restriction flags for email address validation.
EmailAddressParser - Class in org.hazlewood.connor.bottema.emailaddress: A utility class to parse, clean up, and extract email addresses from messages per RFC2822 syntax.
EmailAddressValidator - Class in org.hazlewood.connor.bottema.emailaddress: A utility class to parse, clean up, and extract email addresses from messages per RFC2822 syntax.
embedImage(String, byte[], String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds an embedded image (attachment type) to the email message and generates the necessary DataSource with the given byte data.
embedImage(String, DataSource) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Overloaded method which sets an embedded image on account of name and DataSource.
extractHeaderAddresses(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Given the value of a header, like the From:, extract valid 2822 addresses from it and place them in an array.

F

from(String, String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Sets the sender address.

G

generateProperties() - Method in enum org.codemonkey.simplejavamail.TransportStrategy: Base implementation that simply returns an empty list of properties.
GENERIC_ERROR - Static variable in exception org.codemonkey.simplejavamail.MailException
getAddress() - Method in class org.codemonkey.simplejavamail.email.Recipient: Bean getter for Recipient.address;
getAddressParts(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: See getInternetAddress; does the same thing but returns the constituent parts of the address in a three-element array (or null if the address is invalid).
getAttachmentList() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getAttachments() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.attachments as unmodifiable list.
getBcc() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getCc() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getCidMap() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getDataSource() - Method in class org.codemonkey.simplejavamail.email.AttachmentResource
getDataSourceName(Part, DataSource) - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser: Determines the name of the data source if it is not already set.
getDomain(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: See getInternetAddress; does the same thing but returns the domain part in string form (essentially, the part to the right of the @).
getEmbeddedImages() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.embeddedImages as unmodifiable list.
getFirstComment(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Given a string, extract the first matched comment token as defined in 2822, trimmed; return null on all errors or non-findings
getFrom() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getFromRecipient() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.fromRecipient.
getHeaders() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.headers as unmodifiable map.
getHeaders() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getHtmlContent() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getInternetAddress(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Given a 2822-valid single address string, give us an InternetAddress object holding that address, otherwise returns null.
getLocalPart(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: See getInternetAddress; does the same thing but returns the local part that would have been returned from getInternetAddress() in String form (essentially, the part to the left of the @).
getMatcherParts(Matcher, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: See EmailAddressParser.pullFromGroups(Matcher, EnumSet, boolean).
getName() - Method in class org.codemonkey.simplejavamail.email.AttachmentResource
getName() - Method in class org.codemonkey.simplejavamail.email.Recipient: Bean getter for Recipient.name;
getPersonalName(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: See getInternetAddress; does the same thing but returns the personal name that would have been returned from getInternetAddress() in String form.
getPlainContent() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getRecipients() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.recipients as unmodifiable list.
getReplyTo() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getReplyToRecipient() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.replyToRecipient.
getReturnPathAddress(String, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Pull out the cleaned-up return path address.
getReturnPathBracketContents(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: WARNING: You may want to use getReturnPathAddress() instead if you're looking for a clean version of the return path without CFWS, etc.
getSession() - Method in class org.codemonkey.simplejavamail.Mailer: In case Simple Java Mail falls short somehow, you can get a hold of the internal Session instance to debug or tweak.
getSubject() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.subject.
getSubject() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getText() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.text.
getTextHTML() - Method in class org.codemonkey.simplejavamail.email.Email: Bean getter for Email.textHTML.
getTo() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser
getType() - Method in class org.codemonkey.simplejavamail.email.Recipient: Bean getter for Recipient.type;

I

INVALID_ENCODING - Static variable in exception org.codemonkey.simplejavamail.MailException
INVALID_RECIPIENT - Static variable in exception org.codemonkey.simplejavamail.MailException
INVALID_REPLYTO - Static variable in exception org.codemonkey.simplejavamail.MailException
INVALID_SENDER - Static variable in exception org.codemonkey.simplejavamail.MailException
isValid(String) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressValidator: Validates an e-mail with default validation flags that remains true to RFC 2822.
isValid(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressValidator: Using the given validation criteria, checks to see if the specified string is a valid email address according to the RFC 2822 specification, which is remarkably squirrely.
isValidAddressList(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Tells us if a header line is valid, i.e.
isValidMailboxList(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Tells us if a header line is valid, i.e.
isValidReturnPath(String, EnumSet<EmailAddressCriteria>) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Tells us if the email represents a valid return path header string.

M

Mailer - Class in org.codemonkey.simplejavamail: Mailing tool aimed for simplicity, for sending e-mails of any complexity.
Mailer(Session) - Constructor for class org.codemonkey.simplejavamail.Mailer: Default constructor, stores the given mail session for later use.
Mailer(String, Integer, String, String, TransportStrategy) - Constructor for class org.codemonkey.simplejavamail.Mailer: Overloaded constructor which produces a new Session on the fly.
Mailer(String, Integer, String, String) - Constructor for class org.codemonkey.simplejavamail.Mailer: Overloaded constructor which produces a new Session on the fly, using default vanilla SMTP transport protocol.
MailException - Exception in org.codemonkey.simplejavamail: This exception is used to communicate errors during the sending of email.
MailException(String) - Constructor for exception org.codemonkey.simplejavamail.MailException
MailException(String, Exception) - Constructor for exception org.codemonkey.simplejavamail.MailException
MailTest - Class in <Unnamed>: Demonstration program for the Simple Java Mail framework.
MailTest() - Constructor for class MailTest
main(String[]) - Static method in class MailTest
MimeMessageParser - Class in org.codemonkey.simplejavamail.util: heavily modified version based on org.apache.commons.mail.util.MimeMessageParser.html Parses a MimeMessage and stores the individual parts such a plain text, HTML text and attachments.
MimeMessageParser(MimeMessage) - Constructor for class org.codemonkey.simplejavamail.util.MimeMessageParser: Constructs an instance with the MimeMessage to be extracted.
MISSING_CONTENT - Static variable in exception org.codemonkey.simplejavamail.MailException
MISSING_HOST - Static variable in exception org.codemonkey.simplejavamail.MailException
MISSING_RECIPIENT - Static variable in exception org.codemonkey.simplejavamail.MailException
MISSING_SENDER - Static variable in exception org.codemonkey.simplejavamail.MailException
MISSING_SUBJECT - Static variable in exception org.codemonkey.simplejavamail.MailException
MISSING_USERNAME - Static variable in exception org.codemonkey.simplejavamail.MailException

O

org.codemonkey.simplejavamail - package org.codemonkey.simplejavamail
org.codemonkey.simplejavamail.email - package org.codemonkey.simplejavamail.email
org.codemonkey.simplejavamail.util - package org.codemonkey.simplejavamail.util
org.hazlewood.connor.bottema.emailaddress - package org.hazlewood.connor.bottema.emailaddress: COPIED FROM https://github.com/bbottema/email-rfc2822-validator

P

parse() - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser: Does the actual extraction.
parse(MimePart) - Method in class org.codemonkey.simplejavamail.util.MimeMessageParser: Extracts the content of a MimeMessage recursively.
produceMimeMessage(Email, Session) - Static method in class org.codemonkey.simplejavamail.Mailer: Creates a new MimeMessage instance and prepares it in the email structure, so that it can be filled and send.
pullFromGroups(Matcher, EnumSet<EmailAddressCriteria>, boolean) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: Using knowledge of the group-ID numbers (see comments at top) pull the data relevant to us from an already-successfully-matched matcher.

R

Recipient - Class in org.codemonkey.simplejavamail.email: An immutable recipient object, with a name, emailaddress and recipient type (eg Message.RecipientType.BCC).
Recipient(String, String, Message.RecipientType) - Constructor for class org.codemonkey.simplejavamail.email.Recipient: Constructor; initializes this recipient object.
removeAnyBounding(char, char, String) - Static method in class org.hazlewood.connor.bottema.emailaddress.EmailAddressParser: If the string starts and ends with s and e, remove them, otherwise return the string as it was passed in.
replyTo(String, String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Sets the reply-to address (optional).
RFC_COMPLIANT - Static variable in enum org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria: Criteria which is most RFC 2822 compliant and allows all compliant address forms, including the more exotic ones.

S

sendMail(Email) - Method in class org.codemonkey.simplejavamail.Mailer: Processes an Email instance into a completely configured Message.
setDebug(boolean) - Method in class org.codemonkey.simplejavamail.Mailer: Actually sets Session.setDebug(boolean) so that it generates debug information.
setEmailAddressCriteria(EnumSet<EmailAddressCriteria>) - Method in class org.codemonkey.simplejavamail.Mailer: Overrides the default email address validation restrictions Mailer.emailAddressCriteria when validating and sending emails using the current Mailer instance.
setFromAddress(String, String) - Method in class org.codemonkey.simplejavamail.email.Email: Sets the sender address.
setReplyToAddress(String, String) - Method in class org.codemonkey.simplejavamail.email.Email: Sets the reply-to address (optional).
setSubject(String) - Method in class org.codemonkey.simplejavamail.email.Email: Bean setters for Email.subject.
setText(String) - Method in class org.codemonkey.simplejavamail.email.Email: Bean setters for Email.text.
setTextHTML(String) - Method in class org.codemonkey.simplejavamail.email.Email: Bean setters for Email.textHTML.
subject(String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Sets the Email.Builder.subject.

T

text(String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Sets the Email.Builder.text.
textHTML(String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Sets the Email.Builder.textHTML.
to(String, String) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.TO.
to(Recipient) - Method in class org.codemonkey.simplejavamail.email.Email.Builder: Adds a new Recipient to the list on account of name, address with recipient type Message.RecipientType.TO.
toString() - Method in class org.codemonkey.simplejavamail.email.Recipient
TransportStrategy - Enum in org.codemonkey.simplejavamail: Defines the various types of transport protocols and implements respective properties so that a Session may be configured using a TransportStrategy implementation.

V

validate(Email) - Method in class org.codemonkey.simplejavamail.Mailer: Validates an Email instance.
valueOf(String) - Static method in enum org.codemonkey.simplejavamail.TransportStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.codemonkey.simplejavamail.TransportStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I M O P R S T V