com.libmailcore

Class IMAPSession

java.lang.Object

com.libmailcore.NativeObject

com.libmailcore.IMAPSession

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IMAPSession
extends NativeObject

IMAP session.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IMAPSession() Constructor for the IMAPSession.

Method Summary

Modifier and Type	Method and Description
boolean	allowsFolderConcurrentAccessEnabled() Returns whether the IMAP session can access folders using several IMAP connections.
IMAPAppendMessageOperation	appendMessageOperation(java.lang.String folder, byte[] messageData, int messageFlags) Returns an operation to append a message to a folder.
IMAPAppendMessageOperation	appendMessageOperation(java.lang.String folder, byte[] messageData, int messageFlags, java.util.List<java.lang.String> customFlags) Returns an operation to append a message to a folder.
int	authType() Returns authentication type.
void	cancelAllOperations() Cancels all queued operations.
IMAPCapabilityOperation	capabilityOperation() Returns an operation to fetch the capabilities.
IMAPOperation	checkAccountOperation() Returns an operation to check whether the credentials of the account are correct.
IMAPIdentity	clientIdentity() Returns client identity.
ConnectionLogger	connectionLogger() Returns the connection logger.
int	connectionType() Returns connection type (clear-text, SSL or STARTTLS).
IMAPOperation	connectOperation() Returns an operation to connect to the server.
IMAPCopyMessagesOperation	copyMessagesOperation(java.lang.String folder, IndexSet uids, java.lang.String destFolder) Returns an operation to copy messages to a folder.
IMAPOperation	createFolderOperation(java.lang.String folder) Returns an operation to create a folder.
IMAPNamespace	defaultNamespace() Returns the default namespace.
IMAPOperation	deleteFolderOperation(java.lang.String folder) Returns an operation to delete a folder.
IMAPOperation	disconnectOperation() Returns an operation to disconnect from the server.
IMAPOperation	expungeOperation(java.lang.String folder) Returns an operation to expunge messages after they've been marked as deleted.
IMAPFetchFoldersOperation	fetchAllFoldersOperation() Returns an operation to request the list of all folders.
IMAPFetchContentOperation	fetchMessageAttachmentByNumberOperation(java.lang.String folder, long number, java.lang.String partID, int encoding) Returns an operation to fetch an attachment content using the sequence number of a message.
IMAPFetchContentOperation	fetchMessageAttachmentByNumberOperation(java.lang.String folder, long number, java.lang.String partID, int encoding, boolean urgent) Returns an operation to fetch an attachment content using the sequence number of a message.
IMAPFetchContentOperation	fetchMessageAttachmentByUIDOperation(java.lang.String folder, long uid, java.lang.String partID, int encoding) Returns an operation to fetch an attachment content using the UID of a message.
IMAPFetchContentOperation	fetchMessageAttachmentByUIDOperation(java.lang.String folder, long uid, java.lang.String partID, int encoding, boolean urgent) Returns an operation to fetch an attachment content using the UID of a message.
IMAPFetchContentOperation	fetchMessageByNumberOperation(java.lang.String folder, long number) Returns an operation to fetch a message content by sequence number.
IMAPFetchContentOperation	fetchMessageByNumberOperation(java.lang.String folder, long number, boolean urgent) Returns an operation to fetch a message content by sequence number.
IMAPFetchContentOperation	fetchMessageByUIDOperation(java.lang.String folder, long uid) Returns an operation to fetch a message content by UID.
IMAPFetchContentOperation	fetchMessageByUIDOperation(java.lang.String folder, long uid, boolean urgent) Returns an operation to fetch a message content by UID.
IMAPFetchMessagesOperation	fetchMessagesByNumberOperation(java.lang.String folder, int requestKind, IndexSet indexes) Returns an operation to fetch a list of messages by sequence number.
IMAPFetchMessagesOperation	fetchMessagesByUIDOperation(java.lang.String folder, int requestKind, IndexSet indexes) Returns an operation to fetch a list of messages by UID.
IMAPFetchNamespaceOperation	fetchNamespaceOperation() Returns an operation to fetch the namespace.
IMAPFetchParsedContentOperation	fetchParsedMessageByNumberOperation(java.lang.String folder, long number) Returns an operation to fetch a message content by sequence number and parse it.
IMAPFetchParsedContentOperation	fetchParsedMessageByNumberOperation(java.lang.String folder, long number, boolean urgent) Returns an operation to fetch a message content by sequence number and parse it.
IMAPFetchParsedContentOperation	fetchParsedMessageByUIDOperation(java.lang.String folder, long uid) Returns an operation to fetch a message content by UID and parse it.
IMAPFetchParsedContentOperation	fetchParsedMessageByUIDOperation(java.lang.String folder, long uid, boolean urgent) Returns an operation to fetch a message content by UID and parse it.
IMAPFetchFoldersOperation	fetchSubscribedFoldersOperation() Returns an operation to request the list of subscribed folders.
protected void	finalize()
IMAPFolderInfoOperation	folderInfoOperation(java.lang.String folder) Returns an operation to request the folder info.
IMAPFolderStatusOperation	folderStatusOperation(java.lang.String folder) Returns an operation to request the folder status.
java.lang.String	gmailUserDisplayName() Returns the Gmail user display name.
java.lang.String	hostname() Returns the IMAP server hostname.
IMAPMessageRenderingOperation	htmlBodyRenderingOperation(IMAPMessage message, java.lang.String folder) Returns an operation to render the body of a message as HTML.
IMAPMessageRenderingOperation	htmlRenderingOperation(IMAPMessage message, java.lang.String folder) Returns an operation to render a message as HTML.
IMAPIdentityOperation	identityOperation(IMAPIdentity identity) Returns an operation to send to the server the identity of the client and to get the identity of the server.
IMAPIdleOperation	idleOperation(java.lang.String folder, long lastKnownUID) Returns an IDLE operation (wait for a new message).
boolean	isCheckCertificateEnabled() Returns whether the certificate of the server should be checked.
boolean	isOperationQueueRunning() Returns whether the operation queue is running.
int	maximumConnections() Returns the maximum number of IMAP connections to use.
IMAPOperation	noopOperation() Returns an IMAP NOOP operation.
java.lang.String	OAuth2Token() Returns the OAuth2 token.
OperationQueueListener	operationQueueListener() Returns the IMAP operations queue listener.
java.lang.String	password() Returns the password.
IMAPMessageRenderingOperation	plainTextBodyRenderingOperation(IMAPMessage message, java.lang.String folder, boolean stripWhitespace) Returns an operation to render the body of a message as text.
IMAPMessageRenderingOperation	plainTextRenderingOperation(IMAPMessage message, java.lang.String folder) Returns an operation to render a message as text.
int	port() Returns the port.
IMAPQuotaOperation	quotaOperation() Returns an operation to fetch the quota information.
IMAPOperation	renameFolderOperation(java.lang.String folder, java.lang.String otherName) Returns an operation to rename a folder.
IMAPSearchOperation	searchOperation(java.lang.String folder, IMAPSearchExpression expression) Returns a search operation using an expression.
IMAPSearchOperation	searchOperation(java.lang.String folder, int kind, java.lang.String searchString) Returns a simple search operation.
IMAPIdentity	serverIdentity() Returns server identity.
void	setAllowsFolderConcurrentAccessEnabled(boolean enabled) Set whether the IMAP session can access folders using several IMAP connections.
void	setAuthType(int authType) Sets the authentication type.
void	setCheckCertificateEnabled(boolean enabled) Sets whether the certificate of the server should be checked.
void	setConnectionLogger(ConnectionLogger logger) Sets the connection logger.
void	setConnectionType(int connectionType) Set connection type (clear-text, SSL or STARTTLS).
void	setDefaultNamespace(IMAPNamespace ns) Sets the default namespace.
void	setHostname(java.lang.String hostname) Sets the IMAP server hostname.
void	setMaximumConnections(int maxConnections) Sets the maximum number of IMAP connections to use.
void	setOAuth2Token(java.lang.String token) Sets the OAuth2 token.
void	setOperationQueueListener(OperationQueueListener listener) Sets the IMAP operations queue listener.
void	setPassword(java.lang.String password) Sets the password.
void	setPort(int port) Sets the port.
void	setTimeout(long seconds) Sets network timeout in seconds.
void	setUsername(java.lang.String username) Sets the username.
IMAPOperation	storeFlagsByNumberOperation(java.lang.String folder, IndexSet numbers, int kind, int flags) Returns an operation to store flags to a set of messages designated by sequence numbers.
IMAPOperation	storeFlagsByNumberOperation(java.lang.String folder, IndexSet numbers, int kind, int flags, java.util.List<java.lang.String> customFlags) Returns an operation to store flags to a set of messages designated by sequence numbers.
IMAPOperation	storeFlagsByUIDOperation(java.lang.String folder, IndexSet uids, int kind, int flags) Returns an operation to store flags to a set of messages designated by UIDs.
IMAPOperation	storeFlagsByUIDOperation(java.lang.String folder, IndexSet uids, int kind, int flags, java.util.List<java.lang.String> customFlags) Returns an operation to store flags to a set of messages designated by UIDs.
IMAPOperation	storeLabelsByNumberOperation(java.lang.String folder, IndexSet numbers, int kind, java.util.List<java.lang.String> labels) Returns an operation to store labels to a set of messages designated by sequence numbers.
IMAPOperation	storeLabelsByUIDOperation(java.lang.String folder, IndexSet uids, int kind, java.util.List<java.lang.String> labels) Returns an operation to store labels to a set of messages designated by UIDs.
IMAPOperation	subscribeFolderOperation(java.lang.String folder) Returns an operation to subscribe a folder.
IMAPFetchMessagesOperation	syncMessagesByUIDOperation(java.lang.String folder, int requestKind, IndexSet indexes, long modSeq) Returns an operation to sync a list of messages.
long	timeout() Returns network timeout in seconds.
IMAPOperation	unsubscribeFolderOperation(java.lang.String folder) Returns an operation to unsubscribe a folder.
java.lang.String	username() Returns the username.

Methods inherited from class com.libmailcore.NativeObject

clone, initWithNative, readObject, toString, writeObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IMAPSession

public IMAPSession()

Constructor for the IMAPSession.

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class NativeObject

Throws:

java.lang.Throwable

setHostname

public void setHostname(java.lang.String hostname)

Sets the IMAP server hostname.

hostname

public java.lang.String hostname()

Returns the IMAP server hostname.

setPort

public void setPort(int port)

Sets the port.

port

public int port()

Returns the port.

setUsername

public void setUsername(java.lang.String username)

Sets the username.

username

public java.lang.String username()

Returns the username.

setPassword

public void setPassword(java.lang.String password)

Sets the password.

password

public java.lang.String password()

Returns the password.

setOAuth2Token

public void setOAuth2Token(java.lang.String token)

Sets the OAuth2 token.

OAuth2Token

public java.lang.String OAuth2Token()

Returns the OAuth2 token.

setAuthType

public void setAuthType(int authType)

Sets the authentication type.

See Also:

AuthType

authType

public int authType()

Returns authentication type.

See Also:

AuthType

setConnectionType

public void setConnectionType(int connectionType)

Set connection type (clear-text, SSL or STARTTLS).

See Also:

ConnectionType

connectionType

public int connectionType()

Returns connection type (clear-text, SSL or STARTTLS).

See Also:

ConnectionType

setTimeout

public void setTimeout(long seconds)

Sets network timeout in seconds.

timeout

public long timeout()

Returns network timeout in seconds.

setCheckCertificateEnabled

public void setCheckCertificateEnabled(boolean enabled)

Sets whether the certificate of the server should be checked.

isCheckCertificateEnabled

public boolean isCheckCertificateEnabled()

Returns whether the certificate of the server should be checked.

setDefaultNamespace

public void setDefaultNamespace(IMAPNamespace ns)

Sets the default namespace.

defaultNamespace

public IMAPNamespace defaultNamespace()

Returns the default namespace.

setAllowsFolderConcurrentAccessEnabled

public void setAllowsFolderConcurrentAccessEnabled(boolean enabled)

Set whether the IMAP session can access folders using several IMAP connections.

allowsFolderConcurrentAccessEnabled

public boolean allowsFolderConcurrentAccessEnabled()

Returns whether the IMAP session can access folders using several IMAP connections.

setMaximumConnections

public void setMaximumConnections(int maxConnections)

Sets the maximum number of IMAP connections to use.

maximumConnections

public int maximumConnections()

Returns the maximum number of IMAP connections to use.

setConnectionLogger

public void setConnectionLogger(ConnectionLogger logger)

Sets the connection logger.

connectionLogger

public ConnectionLogger connectionLogger()

Returns the connection logger.

setOperationQueueListener

public void setOperationQueueListener(OperationQueueListener listener)

Sets the IMAP operations queue listener.

operationQueueListener

public OperationQueueListener operationQueueListener()

Returns the IMAP operations queue listener.

isOperationQueueRunning

public boolean isOperationQueueRunning()

Returns whether the operation queue is running.

cancelAllOperations

public void cancelAllOperations()

Cancels all queued operations.

serverIdentity

public IMAPIdentity serverIdentity()

Returns server identity.

clientIdentity

public IMAPIdentity clientIdentity()

Returns client identity. It can be modified before establishing connection.

gmailUserDisplayName

public java.lang.String gmailUserDisplayName()

Returns the Gmail user display name.

folderInfoOperation

public IMAPFolderInfoOperation folderInfoOperation(java.lang.String folder)

Returns an operation to request the folder info.

folderStatusOperation

public IMAPFolderStatusOperation folderStatusOperation(java.lang.String folder)

Returns an operation to request the folder status.

fetchSubscribedFoldersOperation

public IMAPFetchFoldersOperation fetchSubscribedFoldersOperation()

Returns an operation to request the list of subscribed folders.

fetchAllFoldersOperation

public IMAPFetchFoldersOperation fetchAllFoldersOperation()

Returns an operation to request the list of all folders.

renameFolderOperation

public IMAPOperation renameFolderOperation(java.lang.String folder,
                                           java.lang.String otherName)

Returns an operation to rename a folder.

deleteFolderOperation

public IMAPOperation deleteFolderOperation(java.lang.String folder)

Returns an operation to delete a folder.

createFolderOperation

public IMAPOperation createFolderOperation(java.lang.String folder)

Returns an operation to create a folder.

subscribeFolderOperation

public IMAPOperation subscribeFolderOperation(java.lang.String folder)

Returns an operation to subscribe a folder.

unsubscribeFolderOperation

public IMAPOperation unsubscribeFolderOperation(java.lang.String folder)

Returns an operation to unsubscribe a folder.

appendMessageOperation

public IMAPAppendMessageOperation appendMessageOperation(java.lang.String folder,
                                                         byte[] messageData,
                                                         int messageFlags,
                                                         java.util.List<java.lang.String> customFlags)

Returns an operation to append a message to a folder.

appendMessageOperation

public IMAPAppendMessageOperation appendMessageOperation(java.lang.String folder,
                                                         byte[] messageData,
                                                         int messageFlags)

Returns an operation to append a message to a folder.

copyMessagesOperation

public IMAPCopyMessagesOperation copyMessagesOperation(java.lang.String folder,
                                                       IndexSet uids,
                                                       java.lang.String destFolder)

Returns an operation to copy messages to a folder.

expungeOperation

public IMAPOperation expungeOperation(java.lang.String folder)

Returns an operation to expunge messages after they've been marked as deleted.

fetchMessagesByUIDOperation

public IMAPFetchMessagesOperation fetchMessagesByUIDOperation(java.lang.String folder,
                                                              int requestKind,
                                                              IndexSet indexes)

Returns an operation to fetch a list of messages by UID.

fetchMessagesByNumberOperation

public IMAPFetchMessagesOperation fetchMessagesByNumberOperation(java.lang.String folder,
                                                                 int requestKind,
                                                                 IndexSet indexes)

Returns an operation to fetch a list of messages by sequence number.

syncMessagesByUIDOperation

public IMAPFetchMessagesOperation syncMessagesByUIDOperation(java.lang.String folder,
                                                             int requestKind,
                                                             IndexSet indexes,
                                                             long modSeq)

Returns an operation to sync a list of messages.

fetchMessageByUIDOperation

public IMAPFetchContentOperation fetchMessageByUIDOperation(java.lang.String folder,
                                                            long uid,
                                                            boolean urgent)

Returns an operation to fetch a message content by UID.

fetchMessageByUIDOperation

public IMAPFetchContentOperation fetchMessageByUIDOperation(java.lang.String folder,
                                                            long uid)

Returns an operation to fetch a message content by UID.

fetchMessageAttachmentByUIDOperation

public IMAPFetchContentOperation fetchMessageAttachmentByUIDOperation(java.lang.String folder,
                                                                      long uid,
                                                                      java.lang.String partID,
                                                                      int encoding,
                                                                      boolean urgent)

Returns an operation to fetch an attachment content using the UID of a message.

fetchMessageAttachmentByUIDOperation

public IMAPFetchContentOperation fetchMessageAttachmentByUIDOperation(java.lang.String folder,
                                                                      long uid,
                                                                      java.lang.String partID,
                                                                      int encoding)

Returns an operation to fetch an attachment content using the UID of a message.

fetchMessageByNumberOperation

public IMAPFetchContentOperation fetchMessageByNumberOperation(java.lang.String folder,
                                                               long number,
                                                               boolean urgent)

Returns an operation to fetch a message content by sequence number.

fetchMessageByNumberOperation

public IMAPFetchContentOperation fetchMessageByNumberOperation(java.lang.String folder,
                                                               long number)

Returns an operation to fetch a message content by sequence number.

fetchMessageAttachmentByNumberOperation

public IMAPFetchContentOperation fetchMessageAttachmentByNumberOperation(java.lang.String folder,
                                                                         long number,
                                                                         java.lang.String partID,
                                                                         int encoding,
                                                                         boolean urgent)

Returns an operation to fetch an attachment content using the sequence number of a message.

fetchMessageAttachmentByNumberOperation

public IMAPFetchContentOperation fetchMessageAttachmentByNumberOperation(java.lang.String folder,
                                                                         long number,
                                                                         java.lang.String partID,
                                                                         int encoding)

Returns an operation to fetch an attachment content using the sequence number of a message.

fetchParsedMessageByUIDOperation

public IMAPFetchParsedContentOperation fetchParsedMessageByUIDOperation(java.lang.String folder,
                                                                        long uid,
                                                                        boolean urgent)

Returns an operation to fetch a message content by UID and parse it.

fetchParsedMessageByUIDOperation

public IMAPFetchParsedContentOperation fetchParsedMessageByUIDOperation(java.lang.String folder,
                                                                        long uid)

Returns an operation to fetch a message content by UID and parse it.

fetchParsedMessageByNumberOperation

public IMAPFetchParsedContentOperation fetchParsedMessageByNumberOperation(java.lang.String folder,
                                                                           long number,
                                                                           boolean urgent)

Returns an operation to fetch a message content by sequence number and parse it.

fetchParsedMessageByNumberOperation

public IMAPFetchParsedContentOperation fetchParsedMessageByNumberOperation(java.lang.String folder,
                                                                           long number)

Returns an operation to fetch a message content by sequence number and parse it.

storeFlagsByUIDOperation

public IMAPOperation storeFlagsByUIDOperation(java.lang.String folder,
                                              IndexSet uids,
                                              int kind,
                                              int flags,
                                              java.util.List<java.lang.String> customFlags)

Returns an operation to store flags to a set of messages designated by UIDs.

storeFlagsByUIDOperation

public IMAPOperation storeFlagsByUIDOperation(java.lang.String folder,
                                              IndexSet uids,
                                              int kind,
                                              int flags)

Returns an operation to store flags to a set of messages designated by UIDs.

storeFlagsByNumberOperation

public IMAPOperation storeFlagsByNumberOperation(java.lang.String folder,
                                                 IndexSet numbers,
                                                 int kind,
                                                 int flags,
                                                 java.util.List<java.lang.String> customFlags)

Returns an operation to store flags to a set of messages designated by sequence numbers.

storeFlagsByNumberOperation

public IMAPOperation storeFlagsByNumberOperation(java.lang.String folder,
                                                 IndexSet numbers,
                                                 int kind,
                                                 int flags)

Returns an operation to store flags to a set of messages designated by sequence numbers.

storeLabelsByUIDOperation

public IMAPOperation storeLabelsByUIDOperation(java.lang.String folder,
                                               IndexSet uids,
                                               int kind,
                                               java.util.List<java.lang.String> labels)

Returns an operation to store labels to a set of messages designated by UIDs.

storeLabelsByNumberOperation

public IMAPOperation storeLabelsByNumberOperation(java.lang.String folder,
                                                  IndexSet numbers,
                                                  int kind,
                                                  java.util.List<java.lang.String> labels)

Returns an operation to store labels to a set of messages designated by sequence numbers.

searchOperation

public IMAPSearchOperation searchOperation(java.lang.String folder,
                                           int kind,
                                           java.lang.String searchString)

Returns a simple search operation.

searchOperation

public IMAPSearchOperation searchOperation(java.lang.String folder,
                                           IMAPSearchExpression expression)

Returns a search operation using an expression.

idleOperation

public IMAPIdleOperation idleOperation(java.lang.String folder,
                                       long lastKnownUID)

Returns an IDLE operation (wait for a new message).

fetchNamespaceOperation

public IMAPFetchNamespaceOperation fetchNamespaceOperation()

Returns an operation to fetch the namespace.

identityOperation

public IMAPIdentityOperation identityOperation(IMAPIdentity identity)

Returns an operation to send to the server the identity of the client and to get the identity of the server.

connectOperation

public IMAPOperation connectOperation()

Returns an operation to connect to the server.

checkAccountOperation

public IMAPOperation checkAccountOperation()

Returns an operation to check whether the credentials of the account are correct.

disconnectOperation

public IMAPOperation disconnectOperation()

Returns an operation to disconnect from the server.

capabilityOperation

public IMAPCapabilityOperation capabilityOperation()

Returns an operation to fetch the capabilities.

quotaOperation

public IMAPQuotaOperation quotaOperation()

Returns an operation to fetch the quota information.

noopOperation

public IMAPOperation noopOperation()

Returns an IMAP NOOP operation.

htmlRenderingOperation

public IMAPMessageRenderingOperation htmlRenderingOperation(IMAPMessage message,
                                                            java.lang.String folder)

Returns an operation to render a message as HTML.

htmlBodyRenderingOperation

public IMAPMessageRenderingOperation htmlBodyRenderingOperation(IMAPMessage message,
                                                                java.lang.String folder)

Returns an operation to render the body of a message as HTML.

plainTextRenderingOperation

public IMAPMessageRenderingOperation plainTextRenderingOperation(IMAPMessage message,
                                                                 java.lang.String folder)

Returns an operation to render a message as text.

plainTextBodyRenderingOperation

public IMAPMessageRenderingOperation plainTextBodyRenderingOperation(IMAPMessage message,
                                                                     java.lang.String folder,
                                                                     boolean stripWhitespace)

Returns an operation to render the body of a message as text.