net.bluemind.imap.impl

Class ClientSupport

java.lang.Object

net.bluemind.imap.impl.ClientSupport

public final class ClientSupport
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ClientSupport(ITagProducer tp, ICallbackFactory icf, int commandTimeoutSecs)

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()
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)
CreateMailboxResult	deleteMailbox(java.lang.String mailbox)
boolean	enable(java.lang.String capability, java.lang.String... otherCapabilities)
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()
java.util.Map<java.lang.String,Acl>	listAcl(java.lang.String mailbox)
ListResult	listAll()
ListResult	listMailbox(java.lang.String mailbox)
ListResult	listSubscribed()
boolean	login(java.lang.String login, java.lang.String password, org.apache.mina.transport.socket.SocketConnector connector, java.net.SocketAddress address, java.lang.Boolean activateTLS)
void	logout()
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)
boolean	setAcl(java.lang.String mailbox, java.lang.String consumer, Acl acl) Sets an IMAP Acl on a mailbox
boolean	setAnnotation(java.lang.String mbox, java.lang.String annotation, java.util.Map<java.lang.String,java.lang.String> kv)
boolean	setQuota(java.lang.String mailbox, int quota)
boolean	subscribe(java.lang.String mailbox)
MailboxChanges	sync(java.lang.String mailbox, SyncData sd)
TaggedResult	tagged(java.lang.String imapCommand)
void	throwError(IMAPException cause)
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> uid)
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSupport

public ClientSupport(ITagProducer tp,
                     ICallbackFactory icf,
                     int commandTimeoutSecs)

Method Detail

login

public boolean login(java.lang.String login,
                     java.lang.String password,
                     org.apache.mina.transport.socket.SocketConnector connector,
                     java.net.SocketAddress address,
                     java.lang.Boolean activateTLS)

logout

public void logout()

select

public boolean select(java.lang.String mailbox)

listSubscribed

public ListResult listSubscribed()

listAll

public ListResult listAll()

listMailbox

public ListResult listMailbox(java.lang.String mailbox)

capabilities

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

noop

public boolean noop()

create

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

createMailbox

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

deleteMailbox

public CreateMailboxResult deleteMailbox(java.lang.String mailbox)

rename

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

subscribe

public boolean subscribe(java.lang.String mailbox)

unsubscribe

public boolean unsubscribe(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)

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)

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> uid)

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()

setAcl

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

Sets an IMAP Acl on a mailbox

Parameters:

mailbox - user/toto@willow.vmw

consumer - admin0

acl - all

Returns:

true if SETACL succeeds

deleteAcl

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

listAcl

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

getUnseen

public int getUnseen(java.lang.String mailbox)

getUidnext

public int getUidnext(java.lang.String mailbox)

xfer

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

uidFetchSummary

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

setAnnotation

public boolean setAnnotation(java.lang.String mbox,
                             java.lang.String annotation,
                             java.util.Map<java.lang.String,java.lang.String> kv)

getAnnotation

public AnnotationList getAnnotation(java.lang.String mailbox)

getAnnotation

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

tagged

public TaggedResult tagged(java.lang.String imapCommand)

enable

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

getUidValidity

public SyncStatus getUidValidity(java.lang.String mailbox)

sync

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

getFirstUid

public long getFirstUid()

throwError

public void throwError(IMAPException cause)

Parameters:

cause -

isClosed

public boolean isClosed()