net.bluemind.imap

Class StoreClient

java.lang.Object

net.bluemind.imap.StoreClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class StoreClient
extends java.lang.Object
implements java.lang.AutoCloseable

IMAP client entry point

Constructor Summary

Constructors

Constructor and Description
StoreClient(ITagProducer tp, java.lang.String hostname, int port, java.lang.String login, java.lang.String password)
StoreClient(ITagProducer tp, java.lang.String hostname, int port, java.lang.String login, java.lang.String password, int timeoutSecs)
StoreClient(java.lang.String hostname, int port, java.lang.String login, java.lang.String password)
StoreClient(java.lang.String hostname, int port, java.lang.String login, java.lang.String password, int timeoutSecs)

Method Summary

Modifier and Type	Method and Description
int	append(java.lang.String mailbox, java.io.InputStream in, FlagsList fl)
int	append(java.lang.String mailbox, java.io.InputStream in, FlagsList fl, java.util.Date delivery)
java.util.Set<java.lang.String>	capabilities() Issues the CAPABILITY command to the IMAP server
void	close()
boolean	create(java.lang.String mailbox)
boolean	create(java.lang.String mailbox, java.lang.String specialUse)
CreateMailboxResult	createMailbox(java.lang.String mailbox, java.lang.String partition)
boolean	deleteAcl(java.lang.String mailbox, java.lang.String consumer)
boolean	deleteAllConsumerAcls(java.lang.String consumer)
CreateMailboxResult	deleteMailbox(java.lang.String mailbox)
boolean	deleteMailboxAcl(java.lang.String mailbox, java.lang.String consumer)
CreateMailboxResult	deleteMailboxHierarchy(java.lang.String mbox)
boolean	enable(java.lang.String capability, java.lang.String... otherCapabilities) Tells the server our client supports given capabilities, eg.
void	expunge()
AnnotationList	getAnnotation(java.lang.String mailbox)
AnnotationList	getAnnotation(java.lang.String mailbox, java.lang.String annotation)
long	getFirstUid()
int	getUidnext(java.lang.String mailbox)
SyncStatus	getUidValidity(java.lang.String mailbox)
int	getUnseen(java.lang.String mailbox)
boolean	isClosed()
boolean	isExist(java.lang.String mbox)
boolean	isExistAndSelectable(java.lang.String mbox)
java.util.Map<java.lang.String,Acl>	listAcl(java.lang.String mailbox)
ListResult	listAll()
ListResult	listAllDomain(java.lang.String virtDomain)
ListResult	listSubFoldersMailbox(java.lang.String mailbox)
ListResult	listSubscribed()
boolean	login() Logs into the IMAP store.
boolean	login(java.lang.Boolean activateTLS) Logs into the IMAP store
void	logout() Logs out & disconnect from the IMAP server.
NameSpaceInfo	namespace()
boolean	noop()
QuotaInfo	quota(java.lang.String mailbox)
boolean	rename(java.lang.String mailbox, java.lang.String newMailbox)
boolean	select(java.lang.String mailbox) Opens the given IMAP folder.
boolean	setAcl(java.lang.String mailbox, java.lang.String consumer, Acl acl)
boolean	setMailboxAcl(java.lang.String mailbox, java.lang.String consumer, Acl acl)
boolean	setMailboxAnnotation(java.lang.String mailbox, java.lang.String annotationId, java.util.Map<java.lang.String,java.lang.String> keyValues)
boolean	setQuota(java.lang.String mailbox, int quota)
boolean	subscribe(java.lang.String mailbox)
MailboxChanges	sync(java.lang.String mailbox, SyncData sd) Uses QRESYNC to fetch changes to a folder.
TaggedResult	tagged(java.lang.String imapCommand)
java.util.Map<java.lang.Integer,java.lang.Integer>	uidCopy(java.util.Collection<java.lang.Integer> uids, java.lang.String destMailbox)
java.util.Map<java.lang.Integer,java.lang.Integer>	uidCopy(java.lang.String uidSet, java.lang.String destMailbox)
void	uidExpunge(java.util.Collection<java.lang.Integer> uids)
java.util.Collection<MimeTree>	uidFetchBodyStructure(java.util.Collection<java.lang.Integer> uids)
java.util.Collection<Envelope>	uidFetchEnvelope(java.util.Collection<java.lang.Integer> uids)
java.util.Collection<FlagsList>	uidFetchFlags(java.util.Collection<java.lang.Integer> uids)
java.util.Collection<FlagsList>	uidFetchFlags(java.lang.String uidSet)
java.util.Collection<IMAPHeaders>	uidFetchHeaders(java.util.Collection<java.lang.Integer> uids, java.lang.String[] headers)
InternalDate[]	uidFetchInternalDate(java.util.Collection<java.lang.Integer> uids)
InternalDate[]	uidFetchInternalDate(java.lang.String uidSet)
IMAPByteSource	uidFetchMessage(java.lang.Integer uid)
IMAPByteSource	uidFetchPart(java.lang.Integer uid, java.lang.String address)
java.util.Collection<Summary>	uidFetchSummary(java.lang.String uidSet)
java.util.Collection<java.lang.Integer>	uidSearch(SearchQuery sq)
java.util.Collection<java.lang.Integer>	uidSearchDeleted()
boolean	uidStore(java.util.Collection<java.lang.Integer> uids, FlagsList fl, boolean set)
boolean	uidStore(java.lang.String uidSet, FlagsList fl, boolean set)
java.util.List<MailThread>	uidThreads()
boolean	unsubscribe(java.lang.String mailbox)
boolean	xfer(java.lang.String boxName, java.lang.String serverName, java.lang.String partition) Transfer a mailbox to a new backend using XFER command

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StoreClient

public StoreClient(java.lang.String hostname,
                   int port,
                   java.lang.String login,
                   java.lang.String password,
                   int timeoutSecs)

StoreClient

public StoreClient(java.lang.String hostname,
                   int port,
                   java.lang.String login,
                   java.lang.String password)

StoreClient

public StoreClient(ITagProducer tp,
                   java.lang.String hostname,
                   int port,
                   java.lang.String login,
                   java.lang.String password)

StoreClient

public StoreClient(ITagProducer tp,
                   java.lang.String hostname,
                   int port,
                   java.lang.String login,
                   java.lang.String password,
                   int timeoutSecs)

Method Detail

login

public boolean login()

Logs into the IMAP store. Defaults to no-TLS

Returns:

true if login is successful

Throws:

IMAPException

login

public boolean login(java.lang.Boolean activateTLS)

Logs into the IMAP store

Returns:

true if login is successful

Throws:

IMAPException

logout

public void logout()

Logs out & disconnect from the IMAP server. The underlying network connection is released.

select

public boolean select(java.lang.String mailbox)
               throws IMAPException

Opens the given IMAP folder. Only one folder quand be active at a time.

Parameters:

mailbox - utf8 mailbox name.

Throws:

IMAPException

create

public boolean create(java.lang.String mailbox)
               throws IMAPException

Throws:

IMAPException

create

public boolean create(java.lang.String mailbox,
                      java.lang.String specialUse)

createMailbox

public CreateMailboxResult createMailbox(java.lang.String mailbox,
                                         java.lang.String partition)
                                  throws IMAPException

Throws:

IMAPException

setAcl

public boolean setAcl(java.lang.String mailbox,
                      java.lang.String consumer,
                      Acl acl)
               throws IMAPException

Throws:

IMAPException

setMailboxAcl

public boolean setMailboxAcl(java.lang.String mailbox,
                             java.lang.String consumer,
                             Acl acl)
                      throws IMAPException

Throws:

IMAPException

deleteAcl

public boolean deleteAcl(java.lang.String mailbox,
                         java.lang.String consumer)
                  throws IMAPException

Throws:

IMAPException

deleteMailboxAcl

public boolean deleteMailboxAcl(java.lang.String mailbox,
                                java.lang.String consumer)
                         throws IMAPException

Throws:

IMAPException

deleteAllConsumerAcls

public boolean deleteAllConsumerAcls(java.lang.String consumer)
                              throws IMAPException

Throws:

IMAPException

listAcl

public java.util.Map<java.lang.String,Acl> listAcl(java.lang.String mailbox)
                                            throws IMAPException

Throws:

IMAPException

subscribe

public boolean subscribe(java.lang.String mailbox)
                  throws IMAPException

Throws:

IMAPException

unsubscribe

public boolean unsubscribe(java.lang.String mailbox)
                    throws IMAPException

Throws:

IMAPException

deleteMailbox

public CreateMailboxResult deleteMailbox(java.lang.String mailbox)
                                  throws IMAPException

Throws:

IMAPException

deleteMailboxHierarchy

public CreateMailboxResult deleteMailboxHierarchy(java.lang.String mbox)
                                           throws IMAPException

Throws:

IMAPException

rename

public boolean rename(java.lang.String mailbox,
                      java.lang.String newMailbox)
               throws IMAPException

Throws:

IMAPException

capabilities

public java.util.Set<java.lang.String> capabilities()
                                             throws IMAPException

Issues the CAPABILITY command to the IMAP server

Returns:

Throws:

IMAPException

noop

public boolean noop()

listSubscribed

public ListResult listSubscribed()

listAll

public ListResult listAll()

listAllDomain

public ListResult listAllDomain(java.lang.String virtDomain)

listSubFoldersMailbox

public ListResult listSubFoldersMailbox(java.lang.String mailbox)

append

public int append(java.lang.String mailbox,
                  java.io.InputStream in,
                  FlagsList fl)

append

public int append(java.lang.String mailbox,
                  java.io.InputStream in,
                  FlagsList fl,
                  java.util.Date delivery)

tagged

public TaggedResult tagged(java.lang.String imapCommand)

expunge

public void expunge()

uidExpunge

public void uidExpunge(java.util.Collection<java.lang.Integer> uids)

quota

public QuotaInfo quota(java.lang.String mailbox)

setQuota

public boolean setQuota(java.lang.String mailbox,
                        int quota)

Parameters:

mailbox - user/admin@buffy.kvm

quota - unit is KB, 0 removes the quota

Returns:

uidFetchMessage

public IMAPByteSource uidFetchMessage(java.lang.Integer uid)

uidSearch

public java.util.Collection<java.lang.Integer> uidSearch(SearchQuery sq)

uidSearchDeleted

public java.util.Collection<java.lang.Integer> uidSearchDeleted()

uidFetchBodyStructure

public java.util.Collection<MimeTree> uidFetchBodyStructure(java.util.Collection<java.lang.Integer> uids)

uidFetchHeaders

public java.util.Collection<IMAPHeaders> uidFetchHeaders(java.util.Collection<java.lang.Integer> uids,
                                                         java.lang.String[] headers)

uidFetchEnvelope

public java.util.Collection<Envelope> uidFetchEnvelope(java.util.Collection<java.lang.Integer> uids)

uidFetchFlags

public java.util.Collection<FlagsList> uidFetchFlags(java.util.Collection<java.lang.Integer> uids)

uidFetchFlags

public java.util.Collection<FlagsList> uidFetchFlags(java.lang.String uidSet)

uidFetchInternalDate

public InternalDate[] uidFetchInternalDate(java.util.Collection<java.lang.Integer> uids)

uidFetchInternalDate

public InternalDate[] uidFetchInternalDate(java.lang.String uidSet)

uidCopy

public java.util.Map<java.lang.Integer,java.lang.Integer> uidCopy(java.util.Collection<java.lang.Integer> uids,
                                                                  java.lang.String destMailbox)

uidCopy

public java.util.Map<java.lang.Integer,java.lang.Integer> uidCopy(java.lang.String uidSet,
                                                                  java.lang.String destMailbox)

uidStore

public boolean uidStore(java.util.Collection<java.lang.Integer> uids,
                        FlagsList fl,
                        boolean set)

uidStore

public boolean uidStore(java.lang.String uidSet,
                        FlagsList fl,
                        boolean set)

uidFetchPart

public IMAPByteSource uidFetchPart(java.lang.Integer uid,
                                   java.lang.String address)

uidThreads

public java.util.List<MailThread> uidThreads()

namespace

public NameSpaceInfo namespace()

getUnseen

public int getUnseen(java.lang.String mailbox)

getUidnext

public int getUidnext(java.lang.String mailbox)

uidFetchSummary

public java.util.Collection<Summary> uidFetchSummary(java.lang.String uidSet)

xfer

public boolean xfer(java.lang.String boxName,
                    java.lang.String serverName,
                    java.lang.String partition)

Transfer a mailbox to a new backend using XFER command

Parameters:

boxName -

serverName -

Returns:

setMailboxAnnotation

public boolean setMailboxAnnotation(java.lang.String mailbox,
                                    java.lang.String annotationId,
                                    java.util.Map<java.lang.String,java.lang.String> keyValues)

getAnnotation

public AnnotationList getAnnotation(java.lang.String mailbox)

getAnnotation

public AnnotationList getAnnotation(java.lang.String mailbox,
                                    java.lang.String annotation)

enable

public boolean enable(java.lang.String capability,
                      java.lang.String... otherCapabilities)

Tells the server our client supports given capabilities, eg. QRESYNC

Parameters:

capability -

otherCapabilities -

Returns:

getUidValidity

public SyncStatus getUidValidity(java.lang.String mailbox)

getFirstUid

public long getFirstUid()

sync

public MailboxChanges sync(java.lang.String mailbox,
                           SyncData sd)

Uses QRESYNC to fetch changes to a folder. enable(String, String...) must be called first with QRESYNC capability. The folder is selected by this command.

Parameters:

mailbox -

sd -

Returns:

isExist

public boolean isExist(java.lang.String mbox)

isExistAndSelectable

public boolean isExistAndSelectable(java.lang.String mbox)

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

isClosed

public boolean isClosed()