| Package | Description |
|---|---|
| eu.easyrpa.openframework.email |
Functionality for working with email messages within RPA process.
|
| eu.easyrpa.openframework.email.service |
Services to work with mailbox and email messages.
|
| eu.easyrpa.openframework.email.service.javax |
Implementation of email services based on
javax.mail functionality (SMTP, IMAP and POP3 protocols). |
| eu.easyrpa.openframework.email.utils |
Miscellaneous utility classes.
|
| Modifier and Type | Field and Description |
|---|---|
protected EmailMessage |
EmailMessage.forwardedMessage
Link to the email message that this email message forwards.
|
protected EmailMessage |
EmailMessage.replyOnMessage
Link to the email message that this email message replies on.
|
| Modifier and Type | Method and Description |
|---|---|
EmailMessage |
EmailMessage.addHtml(String html)
Adds given HTML string as HTML body part of this email message.
|
EmailMessage |
EmailMessage.addText(String text)
Adds given text string as text body part of this email message.
|
EmailMessage |
EmailMessage.attach(File file)
Attaches given file to this email message.
|
EmailMessage |
EmailMessage.attach(Path filePath)
Attaches given file to this email message.
|
EmailMessage |
EmailMessage.attach(String fileName,
InputStream fileContent,
String mimeType)
Attaches given file content as attachment to this email message.
|
EmailMessage |
EmailMessage.bccRecipients(String... recipientsSequence)
Sets explicitly email addresses who are BCC recipients of this email message.
|
EmailMessage |
EmailMessage.ccRecipients(String... recipientsSequence)
Sets explicitly email addresses who are CC recipients of this email message.
|
EmailMessage |
EmailMessage.charset(String charset)
Sets explicitly the charset of this email message body.
|
EmailMessage |
EmailClient.copyMessage(EmailMessage message,
String targetFolder)
Makes a copy of given email message in the specified folder.
|
EmailMessage |
EmailMessage.excludeFromCcRecipients(String... recipientsSequence)
Excludes given email addresses from the list of CC recipients of this email message.
|
EmailMessage |
EmailMessage.excludeFromRecipients(String... recipientsSequence)
Excludes given email addresses from the list of recipients of this email message.
|
EmailMessage |
EmailClient.fetchMessage(String messageId)
Searches email message in the mailbox with given message ID.
|
EmailMessage |
EmailMessage.forwardMessage(boolean withAttachments)
Generates a new email message that is a forwarding of this email message.
|
EmailMessage |
EmailMessage.from(String fromAddress)
Sets explicitly the email address displayed in the field
From: of this email message. |
static EmailMessage |
EmailMessage.fromJson(String json)
Deserializes the email message from JSON.
|
EmailMessage |
EmailMessage.getForwardedMessage()
Gets the email message that this email message forwards.
|
EmailMessage |
EmailMessage.getReplyOnMessage()
Gets the email message that this email message replies on.
|
EmailMessage |
EmailMessage.header(String key,
String value)
Sets header parameter for this email message.
|
EmailMessage |
EmailMessage.html(String html)
Sets given HTML string as body of this email message.
|
EmailMessage |
EmailMessage.markRead()
Marks this email message as read.
|
EmailMessage |
EmailMessage.markUnread()
Marks this email message as unread.
|
EmailMessage |
EmailClient.moveMessage(EmailMessage message,
String targetFolder)
Moves given email message to the specified folder.
|
EmailMessage |
EmailMessage.property(String key,
Object value)
Puts a new property into the properties map used for substitution of variables within the body of this
email message.
|
EmailMessage |
EmailMessage.recipients(String... recipientsSequence)
Sets explicitly email addresses who are recipients of this email message.
|
EmailMessage |
EmailMessage.replyAllMessage(boolean withAttachments)
Generates a new email message that is a replying to all recipients of this email message.
|
EmailMessage |
EmailMessage.replyMessage(boolean withAttachments)
Generates a new email message that is a replying on this email message.
|
EmailMessage |
EmailMessage.replyTo(String... recipientsSequence)
Sets explicitly email addresses who are supposed recipients of the replying on this email message.
|
EmailMessage |
EmailMessage.senderName(String senderName)
Sets explicitly the display name of the actual sender of this email message.
|
EmailMessage |
EmailMessage.subject(String subject)
Sets explicitly the subject of this email message.
|
EmailMessage |
EmailMessage.text(String text)
Sets given text string as body of this email message.
|
| Modifier and Type | Method and Description |
|---|---|
List<EmailMessage> |
EmailClient.fetchAllMessages()
Gets all email messages contained in all mailbox folders.
|
List<EmailMessage> |
EmailClient.fetchAllMessages(Predicate<EmailMessage> isSatisfy)
Gets all email messages contained in all mailbox folders and satisfy to specific condition.
|
List<EmailMessage> |
EmailClient.fetchMessages()
Gets all email messages contained in the default mailbox folder.
|
List<EmailMessage> |
EmailClient.fetchMessages(Predicate<EmailMessage> isSatisfy)
Gets email messages contained in the default mailbox folder and satisfy to specific condition.
|
List<EmailMessage> |
EmailClient.fetchMessages(String folderName)
Gets all email messages contained in the mailbox folder with given name.
|
List<EmailMessage> |
EmailClient.fetchMessages(String folderName,
Predicate<EmailMessage> isSatisfy)
Gets email messages contained in the mailbox folder with given name and satisfy to specific condition.
|
List<EmailMessage> |
EmailClient.fetchUnreadMessages(boolean markRead)
Gets unread messages contained in the mailbox.
|
List<EmailMessage> |
EmailClient.fetchUnreadMessages(String folderName,
boolean markRead)
Gets unread messages contained in the mailbox folder with given name.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(Predicate<EmailMessage> isSatisfy)
Waits appearing of email messages in the default mailbox folder that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(Predicate<EmailMessage> isSatisfy,
Duration timeout)
Waits appearing of email messages in the default mailbox folder that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval)
Waits appearing of email messages in the default mailbox folder that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
| Modifier and Type | Method and Description |
|---|---|
EmailMessage |
EmailClient.copyMessage(EmailMessage message,
String targetFolder)
Makes a copy of given email message in the specified folder.
|
void |
EmailClient.deleteMessage(EmailMessage message)
Deletes given email message from the mailbox.
|
EmailMessage |
EmailClient.moveMessage(EmailMessage message,
String targetFolder)
Moves given email message to the specified folder.
|
void |
EmailSender.send(EmailMessage message)
Sends given email message.
|
void |
EmailClient.updateMessage(EmailMessage message)
Updates parameters of given email message in the mailbox.
|
| Modifier and Type | Method and Description |
|---|---|
void |
EmailClient.deleteMessages(List<EmailMessage> messages)
Deletes given email messages from the mailbox.
|
List<EmailMessage> |
EmailClient.fetchAllMessages(Predicate<EmailMessage> isSatisfy)
Gets all email messages contained in all mailbox folders and satisfy to specific condition.
|
List<EmailMessage> |
EmailClient.fetchMessages(Predicate<EmailMessage> isSatisfy)
Gets email messages contained in the default mailbox folder and satisfy to specific condition.
|
List<EmailMessage> |
EmailClient.fetchMessages(String folderName,
Predicate<EmailMessage> isSatisfy)
Gets email messages contained in the mailbox folder with given name and satisfy to specific condition.
|
void |
EmailClient.updateMessages(List<EmailMessage> messages)
Updates parameters of given email messages in the mailbox.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(Predicate<EmailMessage> isSatisfy)
Waits appearing of email messages in the default mailbox folder that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(Predicate<EmailMessage> isSatisfy,
Duration timeout)
Waits appearing of email messages in the default mailbox folder that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval)
Waits appearing of email messages in the default mailbox folder that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
CompletableFuture<List<EmailMessage>> |
EmailClient.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
| Modifier and Type | Method and Description |
|---|---|
abstract EmailMessage |
MessageConverter.convertToEmailMessage(M nativeMessage)
Converts the native message to
EmailMessage message. |
EmailMessage |
InboundEmailService.copyMessage(EmailMessage message,
String targetFolder)
Makes a copy of given email message in the specified folder.
|
EmailMessage |
InboundEmailService.fetchMessage(String messageId)
Searches email message in the mailbox with given message ID.
|
EmailMessage |
InboundEmailService.moveMessage(EmailMessage message,
String targetFolder)
Moves given email message to the specified folder.
|
| Modifier and Type | Method and Description |
|---|---|
List<EmailMessage> |
MessageConverter.convertAllToEmailMessages(List<M> nativeMessages)
Converts the list of native messages to corresponding
EmailMessage messages. |
List<EmailMessage> |
MessageConverter.convertAllToEmailMessages(M[] nativeMessages)
Converts the array of native messages to corresponding
EmailMessage messages. |
List<EmailMessage> |
InboundEmailService.fetchAllMessages(Predicate<EmailMessage> isSatisfy)
Gets all email messages contained in all mailbox folders and satisfy to specific condition.
|
List<EmailMessage> |
InboundEmailService.fetchMessages(String folderName,
Predicate<EmailMessage> isSatisfy)
Gets email messages contained in the mailbox folder with given name and satisfy to specific condition.
|
List<EmailMessage> |
InboundEmailService.fetchUnreadMessages(String folderName,
boolean markRead)
Gets unread messages contained in the mailbox folder with given name.
|
CompletableFuture<List<EmailMessage>> |
InboundEmailService.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
| Modifier and Type | Method and Description |
|---|---|
List<M> |
MessageConverter.convertAllToNativeMessages(EmailMessage[] emailMessages)
Converts array of
EmailMessage messages to corresponding native messages. |
abstract M |
MessageConverter.convertToNativeMessage(EmailMessage emailMessage)
Converts
EmailMessage message to the native message. |
EmailMessage |
InboundEmailService.copyMessage(EmailMessage message,
String targetFolder)
Makes a copy of given email message in the specified folder.
|
void |
InboundEmailService.deleteMessage(EmailMessage message)
Deletes given email message from the mailbox.
|
EmailMessage |
InboundEmailService.moveMessage(EmailMessage message,
String targetFolder)
Moves given email message to the specified folder.
|
void |
OutboundEmailService.send(EmailMessage message)
Sends given email message.
|
void |
InboundEmailService.updateMessage(EmailMessage message)
Updates parameters of given email message in the mailbox.
|
| Modifier and Type | Method and Description |
|---|---|
List<M> |
MessageConverter.convertAllToNativeMessages(List<EmailMessage> emailMessages)
Converts the list of
EmailMessage messages to corresponding native messages. |
void |
InboundEmailService.deleteMessages(List<EmailMessage> messages)
Deletes given email messages from the mailbox.
|
List<EmailMessage> |
InboundEmailService.fetchAllMessages(Predicate<EmailMessage> isSatisfy)
Gets all email messages contained in all mailbox folders and satisfy to specific condition.
|
List<EmailMessage> |
InboundEmailService.fetchMessages(String folderName,
Predicate<EmailMessage> isSatisfy)
Gets email messages contained in the mailbox folder with given name and satisfy to specific condition.
|
void |
InboundEmailService.updateMessages(List<EmailMessage> messages)
Updates parameters of given email messages in the mailbox.
|
CompletableFuture<List<EmailMessage>> |
InboundEmailService.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval)
Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MimeMessageWrapper
Special implementation of
EmailMessage that wraps related MimeMessage and provides read-only
access to its data and parameters. |
| Modifier and Type | Method and Description |
|---|---|
EmailMessage |
MimeMessageWrapper.attach(File file) |
EmailMessage |
MimeMessageWrapper.attach(Path filePath) |
EmailMessage |
MimeMessageWrapper.attach(String fileName,
InputStream fileContent,
String mimeType) |
EmailMessage |
MimeMessageWrapper.bccRecipients(String... recipientsSequence) |
EmailMessage |
MimeMessageWrapper.ccRecipients(String... recipientsSequence) |
EmailMessage |
MimeMessageConverter.convertToEmailMessage(javax.mail.Message nativeMessage)
Converts the
MimeMessage message to EmailMessage message. |
EmailMessage |
ImapPop3EmailService.copyMessage(EmailMessage message,
String targetFolder) |
EmailMessage |
ImapPop3EmailService.fetchMessage(String messageId) |
EmailMessage |
MimeMessageWrapper.header(String key,
String value) |
EmailMessage |
MimeMessageWrapper.html(String html) |
EmailMessage |
ImapPop3EmailService.moveMessage(EmailMessage message,
String targetFolder) |
EmailMessage |
MimeMessageWrapper.recipients(String... recipientsSequence) |
EmailMessage |
MimeMessageWrapper.replyTo(String... recipientsSequence) |
EmailMessage |
MimeMessageWrapper.text(String text) |
| Modifier and Type | Method and Description |
|---|---|
List<EmailMessage> |
ImapPop3EmailService.fetchAllMessages(Predicate<EmailMessage> isSatisfy) |
List<EmailMessage> |
ImapPop3EmailService.fetchMessages(String folderName,
Predicate<EmailMessage> isSatisfy) |
List<EmailMessage> |
ImapPop3EmailService.fetchUnreadMessages(String folderName,
boolean markRead) |
CompletableFuture<List<EmailMessage>> |
ImapPop3EmailService.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval) |
| Modifier and Type | Method and Description |
|---|---|
javax.mail.Message |
MimeMessageConverter.convertToNativeMessage(EmailMessage emailMessage)
Converts
EmailMessage message to the MimeMessage message. |
EmailMessage |
ImapPop3EmailService.copyMessage(EmailMessage message,
String targetFolder) |
void |
ImapPop3EmailService.deleteMessage(EmailMessage message) |
EmailMessage |
ImapPop3EmailService.moveMessage(EmailMessage message,
String targetFolder) |
void |
SmtpEmailService.send(EmailMessage message) |
void |
ImapPop3EmailService.updateMessage(EmailMessage message) |
| Modifier and Type | Method and Description |
|---|---|
void |
ImapPop3EmailService.deleteMessages(List<EmailMessage> messages) |
List<EmailMessage> |
ImapPop3EmailService.fetchAllMessages(Predicate<EmailMessage> isSatisfy) |
List<EmailMessage> |
ImapPop3EmailService.fetchMessages(String folderName,
Predicate<EmailMessage> isSatisfy) |
void |
ImapPop3EmailService.updateMessages(List<EmailMessage> messages) |
CompletableFuture<List<EmailMessage>> |
ImapPop3EmailService.waitMessages(String folderName,
Predicate<EmailMessage> isSatisfy,
Duration timeout,
Duration checkInterval) |
| Modifier and Type | Method and Description |
|---|---|
static EmailMessage |
EmailParsingUtils.parseEmlFile(InputStream source)
Reads and parse provided data as EML file.
|
static EmailMessage |
EmailParsingUtils.parseEmlFile(String path)
Reads given file and parse it as EML file.
|
Copyright © 2023. All rights reserved.