A B C D E F G H I J L M N O P R S T U V W X _
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- allowDomainLiterals(boolean) - Method in class jodd.mail.RFC2822AddressParser
-
Changes the behavior of the domain parsing.
- allowDotInAtext(boolean) - Method in class jodd.mail.RFC2822AddressParser
-
Allows "." to appear in atext (note: only atext which appears in the 2822 "name-addr" part of the address, not the other instances).
- allowParentheseInLocalpart(boolean) - Method in class jodd.mail.RFC2822AddressParser
-
Allows ")" or "(" to appear in quoted versions of the localpart (they are never allowed in unquoted versions).
- allowQuotedIdentifiers(boolean) - Method in class jodd.mail.RFC2822AddressParser
-
Defines if quoted identifiers are allowed.
- allowSquareBracketsInAtext(boolean) - Method in class jodd.mail.RFC2822AddressParser
-
Allows "[" or "]" to appear in atext.
- and() - Method in class jodd.mail.EmailFilter
-
Changes concatenation mode to AND.
- and(SearchTerm) - Method in class jodd.mail.EmailFilter
-
Sets
AndTerm
as searchTerm. - and(EmailFilter...) - Method in class jodd.mail.EmailFilter
-
Defines AND group of filters.
- attachedMessage(ReceivedEmail) - Method in class jodd.mail.ReceivedEmail
-
Adds attached
ReceivedEmail
. - attachedMessages() - Method in class jodd.mail.ReceivedEmail
-
Returns the
List
of attached messages. - attachedMessages(List<ReceivedEmail>) - Method in class jodd.mail.ReceivedEmail
-
Adds attached
ReceivedEmail
s. - attachment(EmailAttachment<? extends DataSource>) - Method in class jodd.mail.CommonEmail
-
Adds
EmailAttachment
. - attachment(EmailAttachmentBuilder) - Method in class jodd.mail.CommonEmail
- attachments() - Method in class jodd.mail.CommonEmail
-
Returns the list of all
EmailAttachment
s. - attachments(List<EmailAttachment<? extends DataSource>>) - Method in class jodd.mail.CommonEmail
-
Adds
EmailAttachment
s. - attachmentStorage - Variable in class jodd.mail.MailServer
- ATTR_CHARSET - Static variable in class jodd.mail.EmailUtil
- auth(String, String) - Method in class jodd.mail.MailServer.Builder
-
Sets authenticator as
SimpleAuthenticator
using username and password. - auth(Authenticator) - Method in class jodd.mail.MailServer.Builder
-
Sets the authenticator.
- authenticator - Variable in class jodd.mail.MailServer
-
The
Authenticator
.
B
- bcc() - Method in class jodd.mail.Email
-
Returns BCC addresses.
- bcc(String) - Method in class jodd.mail.Email
-
Appends BCC address.
- bcc(String) - Method in class jodd.mail.EmailFilter
-
Defines filter for BCC field.
- bcc(String...) - Method in class jodd.mail.Email
-
Appends BCC address.
- bcc(String, String) - Method in class jodd.mail.Email
-
Appends BCC address.
- bcc(Address) - Method in class jodd.mail.Email
-
Appends BCC address.
- bcc(Address...) - Method in class jodd.mail.Email
-
Appends BCC address.
- bcc(EmailAddress) - Method in class jodd.mail.Email
-
Appends BCC address.
- bcc(EmailAddress...) - Method in class jodd.mail.Email
-
Appends one or more BCC addresses.
- buildByteArrayDataSource() - Method in class jodd.mail.EmailAttachmentBuilder
-
Creates
EmailAttachment
. - Builder() - Constructor for class jodd.mail.MailServer.Builder
- buildFileDataSource(String, File) - Method in class jodd.mail.EmailAttachmentBuilder
-
Creates
EmailAttachment
. - buildImapMailServer() - Method in class jodd.mail.MailServer.Builder
-
Create a
ImapServer
from current data. - buildPop3MailServer() - Method in class jodd.mail.MailServer.Builder
-
Create a
Pop3Server
from current data. - buildSmtpMailServer() - Method in class jodd.mail.MailServer.Builder
-
Create a
SmtpServer
from current data.
C
- cc() - Method in class jodd.mail.CommonEmail
-
Returns CC addresses.
- cc(String) - Method in class jodd.mail.CommonEmail
-
Appends CC address.
- cc(String) - Method in class jodd.mail.EmailFilter
-
Defines filter for CC field.
- cc(String...) - Method in class jodd.mail.CommonEmail
-
Sets one or more CC address.
- cc(String, String) - Method in class jodd.mail.CommonEmail
-
Appends CC address.
- cc(Address) - Method in class jodd.mail.CommonEmail
-
Appends CC address.
- cc(Address...) - Method in class jodd.mail.CommonEmail
-
Sets one or more CC address.
- cc(EmailAddress) - Method in class jodd.mail.CommonEmail
-
Appends CC address.
- cc(EmailAddress...) - Method in class jodd.mail.CommonEmail
-
Appends CC addresses.
- clone() - Method in class jodd.mail.CommonEmail
-
Clones the email with all its necessary data.
- clone() - Method in class jodd.mail.Email
- clone() - Method in class jodd.mail.ReceivedEmail
- close() - Method in class jodd.mail.ReceiveMailSession
- closeFolderIfOpened(Folder) - Method in class jodd.mail.ReceiveMailSession
-
Closes folder if opened and expunge deleted messages.
- CommonEmail<T extends CommonEmail<T>> - Class in jodd.mail
-
Common stuff for both
Email
andReceivedEmail
. - CommonEmail() - Constructor for class jodd.mail.CommonEmail
- compose(Email) - Method in class jodd.mail.EMLComposer
-
Creates EML string from given
Email
. - compose(ReceivedEmail) - Method in class jodd.mail.EMLComposer
-
Creates EML string from given
ReceivedEmail
. - concat(SearchTerm) - Method in class jodd.mail.EmailFilter
-
Concatenates last search term with new one.
- content(byte[]) - Method in class jodd.mail.EmailAttachmentBuilder
-
Uses
null
contentType. - content(byte[], String) - Method in class jodd.mail.EmailAttachmentBuilder
-
Creates new
ByteArrayDataSource
and then callsEmailAttachmentBuilder.content(DataSource)
. - content(File) - Method in class jodd.mail.EmailAttachmentBuilder
-
Creates new
FileDataSource
and then callsEmailAttachmentBuilder.content(DataSource)
- content(InputStream, String) - Method in class jodd.mail.EmailAttachmentBuilder
-
Creates new
ByteArrayDataSource
and then callsEmailAttachmentBuilder.content(DataSource)
. - content(String) - Method in class jodd.mail.EmailAttachmentBuilder
- content(T) - Method in class jodd.mail.EmailAttachmentBuilder
-
Sets the
DataSource
. - contentId(String) - Method in class jodd.mail.EmailAttachmentBuilder
-
Sets content ID.
- convert(EmailAddress[]) - Static method in class jodd.mail.EmailAddress
-
Convert from array of
EmailAddress
to array ofInternetAddress
. - create() - Static method in class jodd.mail.Email
-
Static constructor for fluent interface.
- create() - Static method in class jodd.mail.EMLComposer
- create() - Static method in class jodd.mail.EMLParser
- create() - Static method in class jodd.mail.MailServer
-
Returns new mail server builder.
- create() - Static method in class jodd.mail.ReceivedEmail
-
Static constructor for fluent interface.
- createAttachmentBodyPart(EmailAttachment<? extends DataSource>) - Method in class jodd.mail.SendMailSession
-
Creates attachment body part.
- createMessage(Email) - Method in class jodd.mail.SendMailSession
-
Creates new
MimeMessage
from anEmail
. - createSession() - Method in class jodd.mail.ImapServer
-
Creates new mail session.
- createSession() - Method in class jodd.mail.MailServer
-
Creates new mail session.
- createSession() - Method in class jodd.mail.Pop3Server
-
Creates new mail session.
- createSession() - Method in class jodd.mail.SmtpServer
-
Creates new mail session.
- createSession(String, Properties, Authenticator, File) - Static method in class jodd.mail.EmailUtil
- createSessionProperties() - Method in class jodd.mail.ImapServer
- createSessionProperties() - Method in class jodd.mail.ImapSslServer
- createSessionProperties() - Method in class jodd.mail.MailServer
-
Creates
MailSession
Properties
. - createSessionProperties() - Method in class jodd.mail.Pop3Server
- createSessionProperties() - Method in class jodd.mail.Pop3SslServer
- createSessionProperties() - Method in class jodd.mail.SmtpServer
- createSessionProperties() - Method in class jodd.mail.SmtpSslServer
- currentSentDate() - Method in class jodd.mail.Email
-
Sets current date as the sent date.
- customProperties - Variable in class jodd.mail.MailServer
D
- debugMode - Variable in class jodd.mail.MailServer
- debugMode(boolean) - Method in class jodd.mail.MailServer.Builder
-
Enable or disable debug mode.
- DEFAULT_FOLDER - Static variable in class jodd.mail.ReceiveMailSession
-
Default folder.
- DEFAULT_IMAP_PORT - Static variable in class jodd.mail.ImapServer
-
Default IMAP port.
- DEFAULT_POP3_PORT - Static variable in class jodd.mail.Pop3Server
-
Default POP3 port.
- DEFAULT_SMTP_PORT - Static variable in class jodd.mail.SmtpServer
-
Default SMTP port
- DEFAULT_SSL_PORT - Static variable in class jodd.mail.ImapSslServer
-
Default IMAP SSL port.
- DEFAULT_SSL_PORT - Static variable in class jodd.mail.Pop3SslServer
- DEFAULT_SSL_PORT - Static variable in class jodd.mail.SmtpSslServer
-
Default SMTP SSL port.
E
- Email - Class in jodd.mail
-
E-mail holds all parts of an email and handle attachments.
- Email() - Constructor for class jodd.mail.Email
- EmailAddress - Class in jodd.mail
-
Storage for personal name and email address.
- EmailAddress(String, String) - Constructor for class jodd.mail.EmailAddress
-
Creates new address by specifying email and personal name.
- EmailAttachment<T extends javax.activation.DataSource> - Class in jodd.mail
-
Email attachment.
- EmailAttachment(String, String, boolean, T) - Constructor for class jodd.mail.EmailAttachment
-
Creates new attachment with given name and content id for inline attachments.
- EmailAttachmentBuilder - Class in jodd.mail
-
Helper class for convenient
EmailAttachment
creation. - EmailAttachmentBuilder() - Constructor for class jodd.mail.EmailAttachmentBuilder
-
Only allow instantiation from
EmailAttachment
class - EmailFilter - Class in jodd.mail
-
EmailFilter
helps in building boolean queries of search terms. - EmailFilter() - Constructor for class jodd.mail.EmailFilter
- EmailFilter.Operator - Enum in jodd.mail
-
Comparison operator.
- EmailMessage - Class in jodd.mail
-
Represents email message including the mime type and encoding.
- EmailMessage(String, String) - Constructor for class jodd.mail.EmailMessage
-
Uses UTF-8 email content by default.
- EmailMessage(String, String, String) - Constructor for class jodd.mail.EmailMessage
-
Defines email content.
- EmailUtil - Class in jodd.mail
-
Email utilities.
- EmailUtil() - Constructor for class jodd.mail.EmailUtil
- embeddedAttachment(EmailAttachment<? extends DataSource>) - Method in class jodd.mail.CommonEmail
-
Embed
EmailAttachment
to last message. - embeddedAttachment(EmailAttachmentBuilder) - Method in class jodd.mail.CommonEmail
-
Attaches the embedded attachment: Content ID will be set if missing from attachment's file name.
- embeddedMessage(EmailMessage) - Method in class jodd.mail.EmailAttachmentBuilder
-
Sets target
EmailMessage
. - EMLComposer - Class in jodd.mail
- EMLComposer() - Constructor for class jodd.mail.EMLComposer
- EMLParser - Class in jodd.mail
-
Developer-friendly class for parsing EML files.
- EMLParser() - Constructor for class jodd.mail.EMLParser
- EMPTY_ARRAY - Static variable in class jodd.mail.EmailAddress
- EMPTY_ARRAY - Static variable in class jodd.mail.ReceivedEmail
- envelopeOnly() - Method in class jodd.mail.ReceiverBuilder
-
Receives only envelopes.
- EQ - jodd.mail.EmailFilter.Operator
- extractCfwsPersonalName(boolean) - Method in class jodd.mail.RFC2822AddressParser
-
Controls the behavior of getInternetAddress.
- extractEncoding(String) - Static method in class jodd.mail.EmailUtil
-
Extracts encoding from a given content type.
- extractEncoding(String, String) - Static method in class jodd.mail.EmailUtil
-
Extracts encoding from a given content type.
- extractMimeType(String) - Static method in class jodd.mail.EmailUtil
-
Extracts MIME type from content type.
F
- filter() - Static method in class jodd.mail.EmailFilter
-
Creates new Email filter.
- filter(EmailFilter) - Method in class jodd.mail.ReceiverBuilder
-
Define applied filters.
- filterEmbeddedAttachments(List<EmailAttachment<? extends DataSource>>, EmailMessage) - Method in class jodd.mail.SendMailSession
- flag(Flags.Flag, boolean) - Method in class jodd.mail.EmailFilter
-
Defines filter for single flag.
- flags() - Method in class jodd.mail.ReceivedEmail
- flags(Flags) - Method in class jodd.mail.ReceivedEmail
-
Sets the flags.
- flags(Flags, boolean) - Method in class jodd.mail.EmailFilter
-
Defines filter for many flags at once.
- from() - Method in class jodd.mail.CommonEmail
-
Returns FROM
EmailAddress
. - from(String) - Method in class jodd.mail.CommonEmail
-
Sets the FROM address.
- from(String) - Method in class jodd.mail.EmailFilter
-
Defines filter for FROM field.
- from(String, String) - Method in class jodd.mail.CommonEmail
-
Sets the FROM address by providing personal name and address.
- from(Address) - Method in class jodd.mail.CommonEmail
-
Sets the FROM address from
Address
. - from(EmailAddress) - Method in class jodd.mail.CommonEmail
-
Sets the FROM address.
- fromFolder(String) - Method in class jodd.mail.ReceiverBuilder
-
Sets the working folder.
G
- GE - jodd.mail.EmailFilter.Operator
- get() - Method in class jodd.mail.ReceiverBuilder
-
Receives the emails as specified by the builder.
- getAllFolders() - Method in class jodd.mail.ReceiveMailSession
-
Returns array of all
Folder
s asString
s. - getContent() - Method in class jodd.mail.EmailMessage
-
Returns message content.
- getContentId() - Method in class jodd.mail.EmailAttachment
-
Returns content id for inline attachments.
- getContentType() - Method in class jodd.mail.EmailAttachment
-
Returns content type of
DataSource
. - getDataSource() - Method in class jodd.mail.EmailAttachment
-
Returns
DataSource
implementation, depending on attachment source. - getDeletedMessageCount() - Method in class jodd.mail.ReceiveMailSession
-
Returns the number of deleted messages.
- getDomain() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Returns domain part of the email address.
- getEmail() - Method in class jodd.mail.EmailAddress
-
Returns email address.
- getEncodedName() - Method in class jodd.mail.EmailAttachment
-
Returns encoded attachment name.
- getEncoding() - Method in class jodd.mail.EmailMessage
-
Returns message encoding.
- getFolder(String) - Method in class jodd.mail.ReceiveMailSession
-
Just returns a folder, w/o opening.
- getInternetAddress() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Given a 2822-valid single address string, returns an InternetAddress object holding that address, otherwise returns null.
- getLocalPart() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Returns local part of the email address.
- getMessageCount() - Method in class jodd.mail.ReceiveMailSession
-
Returns number of messages.
- getMimeType() - Method in class jodd.mail.EmailMessage
-
Returns message mime type.
- getName() - Method in class jodd.mail.EmailAttachment
-
Returns attachment name.
- getNewMessageCount() - Method in class jodd.mail.ReceiveMailSession
-
Returns the number of new messages.
- getPasswordAuthentication() - Method in class jodd.mail.SimpleAuthenticator
-
Return new
PasswordAuthentication
for given username and password. - getPersonalName() - Method in class jodd.mail.EmailAddress
-
Returns personal name.
- getPersonalName() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Returns personal name.
- getReturnPathAddress() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Pulls out the cleaned-up return path address.
- getSearchTerm() - Method in class jodd.mail.EmailFilter
-
Returns search term.
- getService() - Method in class jodd.mail.ReceiveMailSession
- getService() - Method in class jodd.mail.SendMailSession
- getSize() - Method in class jodd.mail.EmailAttachment
-
Returns size of attachment.
- getStore(Session) - Method in class jodd.mail.ImapServer
-
Returns email store.
- getStore(Session) - Method in class jodd.mail.ImapSslServer
-
Returns email store.
- getStore(Session) - Method in class jodd.mail.Pop3Server
-
Returns email store.
- getStore(Session) - Method in class jodd.mail.Pop3SslServer
-
Returns email store.
- getTransport(Session) - Method in class jodd.mail.SmtpServer
-
Get the
Transport
forSession
. - getUnreadMessageCount() - Method in class jodd.mail.ReceiveMailSession
-
Returns the number of unread messages.
- GT - jodd.mail.EmailFilter.Operator
H
- header(String) - Method in class jodd.mail.CommonEmail
-
Returns the value of a header.
- header(String, String) - Method in class jodd.mail.CommonEmail
-
Sets header value.
- header(String, String) - Method in class jodd.mail.EmailFilter
-
Defines filter for
Header
. - headers() - Method in class jodd.mail.CommonEmail
-
Returns all headers as a
HashMap
. - headers(Enumeration<Header>) - Method in class jodd.mail.CommonEmail
-
Sets headers.
- headers(Map<String, String>) - Method in class jodd.mail.CommonEmail
-
Sets headers.
- host - Variable in class jodd.mail.MailServer
-
The host.
- host(String) - Method in class jodd.mail.MailServer.Builder
-
Sets the host.
- htmlMessage(String) - Method in class jodd.mail.CommonEmail
-
Adds HTML message.
- htmlMessage(String, String) - Method in class jodd.mail.CommonEmail
-
Adds HTML message.
I
- ImapServer - Class in jodd.mail
-
IMAP Server.
- ImapServer(MailServer.Builder) - Constructor for class jodd.mail.ImapServer
- ImapServer(MailServer.Builder, int) - Constructor for class jodd.mail.ImapServer
- ImapSslServer - Class in jodd.mail
-
IMAP SSL Server.
- ImapSslServer(MailServer.Builder) - Constructor for class jodd.mail.ImapSslServer
- inline(boolean) - Method in class jodd.mail.EmailAttachmentBuilder
-
Sets whether
EmailAttachment
is inline. - isAnswered() - Method in class jodd.mail.ReceivedEmail
-
Returns
true
if message is answered. - isDeleted() - Method in class jodd.mail.ReceivedEmail
-
Returns
true
if message is deleted. - isDraft() - Method in class jodd.mail.ReceivedEmail
-
Returns
true
if message is draft. - isEmbedded() - Method in class jodd.mail.EmailAttachment
-
Returns
true
if the attachment is embedded. - isEmbeddedInto(EmailMessage) - Method in class jodd.mail.EmailAttachment
-
Returns
true
if attachment is embedded into provided message. - isEmptyFlags(Flags) - Static method in class jodd.mail.EmailUtil
-
Check whether flags is a empty flags
- isFlagged() - Method in class jodd.mail.ReceivedEmail
-
Returns
true
is message is flagged. - isInline() - Method in class jodd.mail.EmailAttachment
-
Returns
true
if it is an inline attachment. - isRecent() - Method in class jodd.mail.ReceivedEmail
-
Returns
true
if message is recent. - isSeen() - Method in class jodd.mail.ReceivedEmail
-
Returns
true
if message is seen. - isValid() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Returns
true
if email is valid. - isValidReturnPath() - Method in class jodd.mail.RFC2822AddressParser.ParsedAddress
-
Returns
true
if the email represents a valid return path.
J
- jodd.mail - package jodd.mail
-
Simple e-mail sending.
L
- LE - jodd.mail.EmailFilter.Operator
- LOOSE - Static variable in class jodd.mail.RFC2822AddressParser
-
Loose parser.
- LT - jodd.mail.EmailFilter.Operator
M
- MAIL_DEBUG - Static variable in class jodd.mail.MailServer
- MAIL_HOST - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_CONNECTIONTIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_HOST - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_PARTIALFETCH - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_PEEK - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_PORT - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_SOCKET_FACTORY_CLASS - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_SOCKET_FACTORY_FALLBACK - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_SOCKET_FACTORY_PORT - Static variable in class jodd.mail.MailServer
- MAIL_IMAP_TIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_MIME_ADDRESS_STRICT - Static variable in class jodd.mail.MailServer
- MAIL_POP3_AUTH - Static variable in class jodd.mail.MailServer
- MAIL_POP3_CONNECTIONTIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_POP3_HOST - Static variable in class jodd.mail.MailServer
- MAIL_POP3_PORT - Static variable in class jodd.mail.MailServer
- MAIL_POP3_SOCKET_FACTORY_CLASS - Static variable in class jodd.mail.MailServer
- MAIL_POP3_SOCKET_FACTORY_FALLBACK - Static variable in class jodd.mail.MailServer
- MAIL_POP3_SOCKET_FACTORY_PORT - Static variable in class jodd.mail.MailServer
- MAIL_POP3_TIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_AUTH - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_CONNECTIONTIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_HOST - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_PORT - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_SOCKET_FACTORY_CLASS - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_SOCKET_FACTORY_FALLBACK - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_SOCKET_FACTORY_PORT - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_STARTTLS_ENABLE - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_STARTTLS_REQUIRED - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_TIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_SMTP_WRITETIMEOUT - Static variable in class jodd.mail.MailServer
- MAIL_TRANSPORT_PROTOCOL - Static variable in class jodd.mail.MailServer
- MailException - Exception in jodd.mail
-
Jodd Mail exception.
- MailException(String) - Constructor for exception jodd.mail.MailException
-
Creates a
MailException
. - MailException(String, Throwable) - Constructor for exception jodd.mail.MailException
-
Creates a
MailException
. - MailException(Throwable) - Constructor for exception jodd.mail.MailException
-
Creates a
MailException
. - MailServer<MailSessionImpl extends jodd.mail.MailSession> - Class in jodd.mail
- MailServer(MailServer.Builder, int) - Constructor for class jodd.mail.MailServer
-
MailServer
defined with its host, port andAuthenticator
. - MailServer.Builder - Class in jodd.mail
-
Used to create implementing instances of
MailServer
. - mark(Flags.Flag) - Method in class jodd.mail.ReceiverBuilder
-
Marks message with given flag.
- markDeleted() - Method in class jodd.mail.ReceiverBuilder
-
Deletes messages upon receiving.
- markSeen() - Method in class jodd.mail.ReceiverBuilder
-
Marks messages as seen after receiving them.
- message(String, String) - Method in class jodd.mail.CommonEmail
-
Adds a
EmailMessage
. - message(String, String, String) - Method in class jodd.mail.CommonEmail
-
Adds a
EmailMessage
. - message(List<EmailMessage>) - Method in class jodd.mail.CommonEmail
-
Adds multiple messages.
- message(EmailMessage) - Method in class jodd.mail.CommonEmail
-
Adds an
EmailMessage
. - messageId() - Method in class jodd.mail.ReceivedEmail
-
Returns message ID if set by server.
- messageId(String) - Method in class jodd.mail.EmailFilter
-
Defines filter for message id.
- messageId(String) - Method in class jodd.mail.ReceivedEmail
-
Sets message ID.
- messageNumber() - Method in class jodd.mail.ReceivedEmail
-
Returns message number.
- messageNumber(int) - Method in class jodd.mail.EmailFilter
-
Defines filteer for message number.
- messageNumber(int) - Method in class jodd.mail.ReceivedEmail
-
Sets message number.
- messages() - Method in class jodd.mail.CommonEmail
-
Returns all messages.
- moveToFolder(String) - Method in class jodd.mail.ReceiverBuilder
-
Defines target folder where message will be moved.
N
- name(String) - Method in class jodd.mail.EmailAttachmentBuilder
-
Sets file name.
- NE - jodd.mail.EmailFilter.Operator
- not() - Method in class jodd.mail.EmailFilter
-
Marks next condition to be NOT.
- not(EmailFilter) - Method in class jodd.mail.EmailFilter
-
Appends single filter as NOT.
O
- of(String) - Static method in class jodd.mail.EmailAddress
-
Creates new address by specifying one of the following:
"[email protected]" - only email address.
"Jenny Doe <[email protected]>" - first part of the string is personal name, and the other part is email, surrounded with < and >.
- of(String...) - Static method in class jodd.mail.EmailAddress
-
Converts array of
String
toEmailAddress
. - of(String, String) - Static method in class jodd.mail.EmailAddress
- of(Address) - Static method in class jodd.mail.EmailAddress
-
Creates new email address from
InternetAddress
. - of(Address...) - Static method in class jodd.mail.EmailAddress
-
Converts array of
Address
toEmailAddress
. - of(InternetAddress) - Static method in class jodd.mail.EmailAddress
-
Creates new email address from
InternetAddress
. - or() - Method in class jodd.mail.EmailFilter
-
Changes concatenation mode to OR.
- or(SearchTerm) - Method in class jodd.mail.EmailFilter
-
Sets
OrTerm
searchTerm. - or(EmailFilter...) - Method in class jodd.mail.EmailFilter
-
Defines OR group of filters.
- originalMessage() - Method in class jodd.mail.ReceivedEmail
- originalMessage(Message) - Method in class jodd.mail.ReceivedEmail
-
Sets the original message.
P
- parse(byte[]) - Method in class jodd.mail.EMLParser
-
Parses EML with provided EML content.
- parse(File) - Method in class jodd.mail.EMLParser
-
Starts EML parsing with provided EML
File
. - parse(InputStream) - Method in class jodd.mail.EMLParser
-
Parses the EML content.
- parse(String) - Method in class jodd.mail.EMLParser
-
Parses EML with provided EML content.
- parse(String) - Method in class jodd.mail.RFC2822AddressParser
-
Parses email address.
- parse(String, String) - Method in class jodd.mail.EMLParser
-
Parses EML with provided EML content.
- parseContentId(Part) - Static method in class jodd.mail.ReceivedEmail
-
Returns the Content-ID of this
Part
. - parseInline(Part) - Static method in class jodd.mail.ReceivedEmail
-
Returns
true
if thePart
is inline. - parseMessage(Message, boolean) - Method in class jodd.mail.ReceivedEmail
-
Parses
Message
and extracts all data for the received message. - parseToEmailAddress(String) - Method in class jodd.mail.RFC2822AddressParser
- parseToInternetAddress(String) - Method in class jodd.mail.RFC2822AddressParser
- plaintextOverTLS - Variable in class jodd.mail.SmtpSslServer
-
Defaults to
false
. - plaintextOverTLS(boolean) - Method in class jodd.mail.SmtpSslServer
-
When enabled,
MAIL_SMTP_SOCKET_FACTORY_CLASS
will be not set, and Plaintext Authentication over TLS will be enabled. - Pop3Server - Class in jodd.mail
-
Represents simple plain POP server for sending emails.
- Pop3Server(MailServer.Builder) - Constructor for class jodd.mail.Pop3Server
- Pop3Server(MailServer.Builder, int) - Constructor for class jodd.mail.Pop3Server
- Pop3SslServer - Class in jodd.mail
-
POP3 SSL server.
- Pop3SslServer(MailServer.Builder) - Constructor for class jodd.mail.Pop3SslServer
- port - Variable in class jodd.mail.MailServer
-
The port.
- port(int) - Method in class jodd.mail.MailServer.Builder
-
Sets the port.
- priority() - Method in class jodd.mail.CommonEmail
-
Returns emails priority (1 - 5) or
-1
if priority not available. - priority(int) - Method in class jodd.mail.CommonEmail
-
Sets email priority.
- PRIORITY_HIGH - Static variable in class jodd.mail.CommonEmail
- PRIORITY_HIGHEST - Static variable in class jodd.mail.CommonEmail
- PRIORITY_LOW - Static variable in class jodd.mail.CommonEmail
- PRIORITY_LOWEST - Static variable in class jodd.mail.CommonEmail
- PRIORITY_NORMAL - Static variable in class jodd.mail.CommonEmail
- processPart(Part) - Method in class jodd.mail.ReceivedEmail
-
Process part of the received message.
- property(String, String) - Method in class jodd.mail.MailServer.Builder
- PROTOCOL_IMAP - Static variable in class jodd.mail.ImapServer
- PROTOCOL_POP3 - Static variable in class jodd.mail.Pop3Server
- PROTOCOL_SMTP - Static variable in class jodd.mail.SmtpServer
R
- receive() - Method in class jodd.mail.ReceiveMailSession
-
Defines the process of received email in an fluent way.
- receivedDate() - Method in class jodd.mail.ReceivedEmail
-
Returns email's received
Date
. - receivedDate(Date) - Method in class jodd.mail.ReceivedEmail
-
Sets email's received
Date
. - receivedDate(EmailFilter.Operator, long) - Method in class jodd.mail.EmailFilter
-
Defines filter for received date.
- ReceivedEmail - Class in jodd.mail
-
Received email.
- ReceivedEmail(Message, boolean, File) - Constructor for class jodd.mail.ReceivedEmail
-
Creates a
ReceivedEmail
from a givenMessage
. - receiveEmail() - Method in class jodd.mail.ReceiveMailSession
-
Receives all emails.
- receiveEmail(EmailFilter) - Method in class jodd.mail.ReceiveMailSession
-
Receives all emails that matches given
EmailFilter
. - receiveEmailAndDelete() - Method in class jodd.mail.ReceiveMailSession
-
Receives all emails and mark all messages as 'seen' and 'deleted'.
- receiveEmailAndDelete(EmailFilter) - Method in class jodd.mail.ReceiveMailSession
-
Receives all emails that matches given
EmailFilter
and mark all messages as 'seen' and 'deleted'. - receiveEmailAndMarkSeen() - Method in class jodd.mail.ReceiveMailSession
-
Receives all emails and mark all messages as 'seen' (ie 'read').
- receiveEmailAndMarkSeen(EmailFilter) - Method in class jodd.mail.ReceiveMailSession
-
Receives all emails that matches given
EmailFilter
and mark them as 'seen' (ie 'read'). - receiveEnvelopes() - Method in class jodd.mail.ReceiveMailSession
- receiveEnvelopes(EmailFilter) - Method in class jodd.mail.ReceiveMailSession
- ReceiveMailSession - Class in jodd.mail
-
Encapsulates
Email
receiving session. - ReceiveMailSession(Session, Store, File) - Constructor for class jodd.mail.ReceiveMailSession
-
Creates new mail session.
- ReceiverBuilder - Class in jodd.mail
-
Fluent builder
- ReceiverBuilder(ReceiveMailSession) - Constructor for class jodd.mail.ReceiverBuilder
- replyTo() - Method in class jodd.mail.CommonEmail
-
Returns REPLY-TO addresses.
- replyTo(String) - Method in class jodd.mail.CommonEmail
-
Appends REPLY-TO address.
- replyTo(String...) - Method in class jodd.mail.CommonEmail
-
Appends one or more REPLY-TO address.
- replyTo(String, String) - Method in class jodd.mail.CommonEmail
-
Appends REPLY-TO address.
- replyTo(Address) - Method in class jodd.mail.CommonEmail
-
Appends REPLY-TO address.
- replyTo(Address...) - Method in class jodd.mail.CommonEmail
-
Appeds one or more REPLY-TO address.
- replyTo(EmailAddress) - Method in class jodd.mail.CommonEmail
-
Appends REPLY-TO address.
- replyTo(EmailAddress...) - Method in class jodd.mail.CommonEmail
-
Appends REPLY-TO addresses.
- resetBcc() - Method in class jodd.mail.Email
-
Resets BCC addresses.
- resetCc() - Method in class jodd.mail.CommonEmail
-
Resets all CC addresses.
- resetReplyTo() - Method in class jodd.mail.CommonEmail
-
Resets all REPLY-To addresses.
- resetTo() - Method in class jodd.mail.CommonEmail
-
Resets TO addresses.
- resolveContentType(String) - Method in class jodd.mail.EmailAttachmentBuilder
-
Resolves content type from all data.
- resolveFileName(Part) - Static method in class jodd.mail.EmailUtil
-
Correctly resolves file name from the message part.
- RFC2822AddressParser - Class in jodd.mail
-
Utility class to parse, clean up, and extract email addresses per RFC2822 syntax.
- RFC2822AddressParser() - Constructor for class jodd.mail.RFC2822AddressParser
- RFC2822AddressParser.ParsedAddress - Class in jodd.mail
-
Parsed message address and various information.
S
- searchTerm - Variable in class jodd.mail.EmailFilter
-
The
SearchTerm
to be used. - sendMail(Email) - Method in class jodd.mail.SendMailSession
-
Prepares message and sends it.
- SendMailSession - Class in jodd.mail
-
Encapsulates
Email
sending session. - SendMailSession(Session, Transport) - Constructor for class jodd.mail.SendMailSession
-
Creates new mail session.
- sentDate() - Method in class jodd.mail.CommonEmail
-
Returns email's sent date.
- sentDate(Date) - Method in class jodd.mail.CommonEmail
-
Sets email's sent date.
- sentDate(EmailFilter.Operator, long) - Method in class jodd.mail.EmailFilter
-
Defines filter for sent date.
- setContentId(String) - Method in class jodd.mail.EmailAttachment
-
Sets content ID.
- setContentIdFromNameIfMissing() - Method in class jodd.mail.EmailAttachmentBuilder
-
Set content ID if it is missing.
- setEmbeddedMessage(EmailMessage) - Method in class jodd.mail.EmailAttachment
-
Sets target message for embedded attachments.
- setInline(boolean) - Method in class jodd.mail.EmailAttachment
-
Sets whether attachment is inline.
- setSize(int) - Method in class jodd.mail.EmailAttachment
-
Sets size of attachment.
- SimpleAuthenticator - Class in jodd.mail
-
Performs simple authentication when the server requires it.
- SimpleAuthenticator(String, String) - Constructor for class jodd.mail.SimpleAuthenticator
-
Creates new SimpleAuthenticator for given username and password.
- size(EmailFilter.Operator, int) - Method in class jodd.mail.EmailFilter
-
Defines filter for message size.
- SmtpServer - Class in jodd.mail
-
Represents simple plain SMTP server for sending emails.
- SmtpServer(MailServer.Builder) - Constructor for class jodd.mail.SmtpServer
- SmtpServer(MailServer.Builder, int) - Constructor for class jodd.mail.SmtpServer
- SmtpSslServer - Class in jodd.mail
-
Secure SMTP server (STARTTLS) for sending emails.
- SmtpSslServer(MailServer.Builder) - Constructor for class jodd.mail.SmtpSslServer
- ssl(boolean) - Method in class jodd.mail.MailServer.Builder
-
Sets the SSL implementation of the Mail server.
- startTlsRequired - Variable in class jodd.mail.SmtpSslServer
-
Defaults to
false
. - startTlsRequired(boolean) - Method in class jodd.mail.SmtpSslServer
-
Sets
mail.smtp.starttls.required
. - storeAttachment(EmailAttachment<? extends DataSource>) - Method in class jodd.mail.CommonEmail
-
Adds
EmailAttachment
. - storeAttachments(List<EmailAttachment<? extends DataSource>>) - Method in class jodd.mail.CommonEmail
-
Adds
EmailAttachment
s. - storeAttachmentsIn(File) - Method in class jodd.mail.MailServer.Builder
-
Defines attachment storage, a folder where attachments will be saved.
- STRICT - Static variable in class jodd.mail.RFC2822AddressParser
-
Strict parser.
- strictAddress - Variable in class jodd.mail.MailServer
-
Whether strict address checking is turned on.
- strictAddress(boolean) - Method in class jodd.mail.MailServer.Builder
-
Disables the strict address.
- subject() - Method in class jodd.mail.CommonEmail
-
Returns message subject.
- subject(String) - Method in class jodd.mail.CommonEmail
-
Sets message subject.
- subject(String) - Method in class jodd.mail.EmailFilter
-
Defines filter for SUBJECT field.
- subject(String, String) - Method in class jodd.mail.CommonEmail
-
Sets message subject with specified encoding to override default platform encoding.
- subjectEncoding() - Method in class jodd.mail.CommonEmail
-
Returns the message subject encoding.
T
- text(String) - Method in class jodd.mail.EmailFilter
-
Defines filter on a message body.
- textMessage(String) - Method in class jodd.mail.CommonEmail
-
Adds plain message text.
- textMessage(String, String) - Method in class jodd.mail.CommonEmail
-
Adds plain message text.
- timeout - Variable in class jodd.mail.MailServer
-
Connection timeout.
- timeout(int) - Method in class jodd.mail.MailServer.Builder
-
Defines timeout value in milliseconds for all mail-related operations.
- to() - Method in class jodd.mail.CommonEmail
-
Returns TO addresses.
- to(String) - Method in class jodd.mail.CommonEmail
-
Appends TO address.
- to(String) - Method in class jodd.mail.EmailFilter
-
Defines filter for TO field.
- to(String...) - Method in class jodd.mail.CommonEmail
-
Appends one or more TO address.
- to(String, String) - Method in class jodd.mail.CommonEmail
-
Appends TO address by personal name and email address.
- to(Address) - Method in class jodd.mail.CommonEmail
-
Appends TO address from
Address
. - to(Address...) - Method in class jodd.mail.CommonEmail
-
Appends one or more TO addresses.
- to(EmailAddress) - Method in class jodd.mail.CommonEmail
-
Appends TO address.
- to(EmailAddress...) - Method in class jodd.mail.CommonEmail
-
Appends TO addresses.
- toByteArray() - Method in class jodd.mail.EmailAttachment
-
Returns byte content of the attachment.
- toInternetAddress() - Method in class jodd.mail.EmailAddress
-
Creates new
InternetAddress
from current data. - toString() - Method in class jodd.mail.CommonEmail
- toString() - Method in class jodd.mail.EmailAddress
-
Returns string representation of this.
U
- unmark(Flags.Flag) - Method in class jodd.mail.ReceiverBuilder
-
Unmarks a message with given flag.
- updateEmailFlags(ReceivedEmail) - Method in class jodd.mail.ReceiveMailSession
-
Updates the email flags on the server.
- useDefaultFolder() - Method in class jodd.mail.ReceiveMailSession
-
Opens default folder: DEFAULT_FOLDER.
- useFolder(String) - Method in class jodd.mail.ReceiveMailSession
-
Opens new folder and closes previously opened folder.
- useFolder(String, int) - Method in class jodd.mail.ReceiveMailSession
-
Opens new folder and closes previously opened folder with a specific mode.
V
- valueOf(String) - Static method in enum jodd.mail.EmailFilter.Operator
-
Returns the enum constant of this type with the specified name.
- valueOrEmptyArray(EmailAddress[]) - Method in class jodd.mail.CommonEmail
- values() - Static method in enum jodd.mail.EmailFilter.Operator
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- with() - Static method in class jodd.mail.EmailAttachment
-
Returns new/empty
EmailAttachmentBuilder
. - writeToFile(File) - Method in class jodd.mail.EmailAttachment
-
Saves attachment to a file.
- writeToStream(OutputStream) - Method in class jodd.mail.EmailAttachment
-
Saves attachment to the output stream.
X
- X_PRIORITY - Static variable in class jodd.mail.CommonEmail
_
- _this() - Method in class jodd.mail.CommonEmail
All Classes All Packages