ReceiveMailSession (Jodd API Documentation)

java.lang.Object
- jodd.mail.ReceiveMailSession

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class ReceiveMailSession
extends java.lang.Object
```
Encapsulates Email receiving session. Prepares and receives Emails. Some methods do not work on POP3 servers.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class jodd.mail.MailSession.Defaults

Nested Classes
Modifier and Type	Class and Description
`static class`	`jodd.mail.MailSession.Defaults`

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String DEFAULT_FOLDER
Default folder.

protected javax.mail.Service service

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`DEFAULT_FOLDER` Default folder.
`protected javax.mail.Service`	`service`

Constructor Summary

Constructors
Constructor and Description
`ReceiveMailSession(javax.mail.Session session, javax.mail.Store store, java.io.File attachmentStorage)` Creates new mail session.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes session.
`protected void`	`closeFolderIfOpened(javax.mail.Folder folder)` Closes folder if opened and expunge deleted messages.
`java.lang.String[]`	`getAllFolders()` Returns array of all `Folder`s as `String`s.
`int`	`getDeletedMessageCount()` Returns the number of deleted messages.
`javax.mail.Folder`	`getFolder(java.lang.String folder)` Just returns a folder, w/o opening.
`int`	`getMessageCount()` Returns number of messages.
`int`	`getNewMessageCount()` Returns the number of new messages.
`javax.mail.Store`	`getService()` Returns the `Service`.
`javax.mail.Session`	`getSession()` Returns the `Session`.
`int`	`getUnreadMessageCount()` Returns the number of unread messages.
`boolean`	`isConnected()` Returns `true` if mail session is still connected.
`void`	`open()` Opens session.
`ReceiverBuilder`	`receive()` Defines the process of received email in an fluent way.
`ReceivedEmail[]`	`receiveEmail()` Receives all emails.
`ReceivedEmail[]`	`receiveEmail(EmailFilter filter)` Receives all emails that matches given `EmailFilter`.
`ReceivedEmail[]`	`receiveEmailAndDelete()` Receives all emails and mark all messages as 'seen' and 'deleted'.
`ReceivedEmail[]`	`receiveEmailAndDelete(EmailFilter filter)` Receives all emails that matches given `EmailFilter` and mark all messages as 'seen' and 'deleted'.
`ReceivedEmail[]`	`receiveEmailAndMarkSeen()` Receives all emails and mark all messages as 'seen' (ie 'read').
`ReceivedEmail[]`	`receiveEmailAndMarkSeen(EmailFilter filter)` Receives all emails that matches given `EmailFilter` and mark them as 'seen' (ie 'read').
`ReceivedEmail[]`	`receiveEnvelopes()`
`ReceivedEmail[]`	`receiveEnvelopes(EmailFilter filter)`
`protected static void`	`setupSystemMailProperties()` Setups the system email properties.
`void`	`updateEmailFlags(ReceivedEmail receivedEmail)` Updates the email flags on the server.
`void`	`useDefaultFolder()` Opens default folder: DEFAULT_FOLDER.
`void`	`useFolder(java.lang.String folderName)` Opens new folder and closes previously opened folder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_FOLDER
```
protected static final java.lang.String DEFAULT_FOLDER
```
    Default folder.
    
    See Also:
    
    Constant Field Values
  - service
```
protected final javax.mail.Service service
```
- Constructor Detail
  - ReceiveMailSession
```
public ReceiveMailSession(javax.mail.Session session,
                          javax.mail.Store store,
                          java.io.File attachmentStorage)
```
    Creates new mail session.
    
    Parameters:
    
    session - Session.
    
    store - Store.
- Method Detail
  - getService
```
public javax.mail.Store getService()
```
    Returns the Service.
    
    Returns:
    
    the Service.
  - getAllFolders
```
public java.lang.String[] getAllFolders()
```
    Returns array of all Folders as Strings. You can use these names in useFolder(String) method.
    
    Returns:
    
    array of all Folders as Strings.
  - useFolder
```
public void useFolder(java.lang.String folderName)
```
    Opens new folder and closes previously opened folder.
    
    Parameters:
    
    folderName - Folder to open
  - getFolder
```
public javax.mail.Folder getFolder(java.lang.String folder)
```
    Just returns a folder, w/o opening.
  - useDefaultFolder
```
public void useDefaultFolder()
```
    Opens default folder: DEFAULT_FOLDER.
  - getMessageCount
```
public int getMessageCount()
```
    Returns number of messages.
    
    Returns:
    
    The number of messages.
  - getNewMessageCount
```
public int getNewMessageCount()
```
    Returns the number of new messages.
    
    Returns:
    
    The number of new message.
  - getUnreadMessageCount
```
public int getUnreadMessageCount()
```
    Returns the number of unread messages.
  - getDeletedMessageCount
```
public int getDeletedMessageCount()
```
    Returns the number of deleted messages.
    
    Returns:
    
    The number of deleted messages.
  - receive
```
public ReceiverBuilder receive()
```
    Defines the process of received email in an fluent way.
  - receiveEmail
```
public ReceivedEmail[] receiveEmail()
```
    Receives all emails. Messages are not modified. However, servers may set SEEN flag anyway, so we force messages to remain unseen.
    
    Returns:
    
    array of ReceivedEmails.
  - receiveEmail
```
public ReceivedEmail[] receiveEmail(EmailFilter filter)
```
    Receives all emails that matches given EmailFilter. Messages are not modified. However, servers may set SEEN flag anyway, so we force messages to remain unseen.
    
    Parameters:
    
    filter - EmailFilter
    
    Returns:
    
    array of ReceivedEmails.
  - receiveEmailAndMarkSeen
```
public ReceivedEmail[] receiveEmailAndMarkSeen()
```
    Receives all emails and mark all messages as 'seen' (ie 'read').
    
    Returns:
    
    array of ReceivedEmails.
    
    See Also:
    
    receiveEmailAndMarkSeen(EmailFilter)
  - receiveEmailAndMarkSeen
```
public ReceivedEmail[] receiveEmailAndMarkSeen(EmailFilter filter)
```
    Receives all emails that matches given EmailFilter and mark them as 'seen' (ie 'read').
    
    Parameters:
    
    filter - EmailFilter
    
    Returns:
    
    array of ReceivedEmails.
  - receiveEmailAndDelete
```
public ReceivedEmail[] receiveEmailAndDelete()
```
    Receives all emails and mark all messages as 'seen' and 'deleted'.
    
    Returns:
    
    array of ReceivedEmails.
  - receiveEmailAndDelete
```
public ReceivedEmail[] receiveEmailAndDelete(EmailFilter filter)
```
    Receives all emails that matches given EmailFilter and mark all messages as 'seen' and 'deleted'.
    
    Parameters:
    
    filter - EmailFilter
    
    Returns:
    
    array of ReceivedEmails.
  - receiveEnvelopes
```
public ReceivedEmail[] receiveEnvelopes()
```
  - receiveEnvelopes
```
public ReceivedEmail[] receiveEnvelopes(EmailFilter filter)
```
  - updateEmailFlags
```
public void updateEmailFlags(ReceivedEmail receivedEmail)
```
    Updates the email flags on the server.
  - closeFolderIfOpened
```
protected void closeFolderIfOpened(javax.mail.Folder folder)
```
    Closes folder if opened and expunge deleted messages.
  - close
```
public void close()
```
    Closes session.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - setupSystemMailProperties
```
protected static void setupSystemMailProperties()
```
    Setups the system email properties.
  - open
```
public void open()
```
    Opens session.
  - isConnected
```
public boolean isConnected()
```
    Returns true if mail session is still connected.
    
    Returns:
    
    true if mail session is still connected.
  - getSession
```
public javax.mail.Session getSession()
```
    Returns the Session.
    
    Returns:
    
    the Session.

Class ReceiveMailSession

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FOLDER

service

Constructor Detail

ReceiveMailSession

Method Detail

getService

getAllFolders

useFolder

getFolder

useDefaultFolder

getMessageCount

getNewMessageCount

getUnreadMessageCount

getDeletedMessageCount

receive

receiveEmail

receiveEmail

receiveEmailAndMarkSeen

receiveEmailAndMarkSeen

receiveEmailAndDelete

receiveEmailAndDelete

receiveEnvelopes

receiveEnvelopes

updateEmailFlags

closeFolderIfOpened

close

setupSystemMailProperties

open

isConnected

getSession