com.openkm.api

Class OKMMail

java.lang.Object

com.openkm.api.OKMMail

All Implemented Interfaces:

MailModule

public class OKMMail
extends Object
implements MailModule

Author:

pavila

Method Summary

Modifier and Type	Method and Description
void	copy(String token, String mailPath, String dstId) Copy a mail to another location in the repository.
Mail	create(String token, Mail mail) Create a new mail in the repository.
void	delete(String token, String mailId) Delete a mail the repository.
void	extendedCopy(String token, String mailPath, String dstId, ExtendedAttributes extAttr) Copy a mail to another location in the repository.
List<Mail>	getChildren(String token, String fldId) Retrieve a list of children mails from an existing folder.
List<Mail>	getChilds(String token, String fldId) Deprecated.
static OKMMail	getInstance()
String	getPath(String token, String uuid) Get the mail path from a UUID
Mail	getProperties(String token, String mailId) Obtains properties from a previously created mail.
Mail	importEml(String path, InputStream is) Import EML file as MailNode.
Mail	importMsg(String path, InputStream is) Import MSG file as MailNode.
boolean	isValid(String token, String mailId) Test if a mail path is valid.
void	move(String token, String mailPath, String dstId) Move a mail to another location in the repository.
void	purge(String token, String mailId) Deletes definitively a mail from the repository.
Mail	rename(String token, String mailId, String newName) Rename a mail in the repository.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMMail getInstance()

create

public Mail create(String token,
                   Mail mail)
            throws PathNotFoundException,
                   ItemExistsException,
                   VirusDetectedException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException,
                   UserQuotaExceededException,
                   AutomationException

Description copied from interface: MailModule

Create a new mail in the repository.

Specified by:

create in interface MailModule

mail - A mail object with the new mail properties.

Returns:

A mail object with the new created mail properties.

Throws:

PathNotFoundException - If the parent mail doesn't exist.

ItemExistsException - If there is already a mail in the repository with the same name in the same path.

AccessDeniedException - If there is any security problem: you can't modify the parent mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

VirusDetectedException

DatabaseException

UserQuotaExceededException

AutomationException

getProperties

public Mail getProperties(String token,
                          String mailId)
                   throws AccessDeniedException,
                          PathNotFoundException,
                          RepositoryException,
                          DatabaseException

Description copied from interface: MailModule

Obtains properties from a previously created mail.

Specified by:

getProperties in interface MailModule

mailId - The path that identifies an unique mail, or its UUID.

Returns:

A mail object with the selected mail properties.

Throws:

PathNotFoundException - If the indicated mail doesn't exist.

RepositoryException - If there is any general repository problem.

AccessDeniedException

DatabaseException

delete

public void delete(String token,
                   String mailId)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Description copied from interface: MailModule

Delete a mail the repository. It is a logical delete, so really is moved to the user trash and can be restored.

Specified by:

delete in interface MailModule

mailId - The path that identifies an unique mail.

Throws:

LockException - Can't delete a mail with locked documents.

PathNotFoundException - If there is no mail in the repository in this path.

AccessDeniedException - If there is any security problem: you can't modify the mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

purge

public void purge(String token,
                  String mailId)
           throws LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException

Description copied from interface: MailModule

Deletes definitively a mail from the repository. It is a physical delete, so the mail can't be restored.

Specified by:

purge in interface MailModule

mailId - The path that identifies an unique mail.

Throws:

LockException - Can't delete a mail with locked documents.

PathNotFoundException - If there is no mail in the repository in this path.

AccessDeniedException - If there is any security problem: you can't modify the mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

rename

public Mail rename(String token,
                   String mailId,
                   String newName)
            throws PathNotFoundException,
                   ItemExistsException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Description copied from interface: MailModule

Rename a mail in the repository.

Specified by:

rename in interface MailModule

mailId - The path that identifies an unique mail.

newName - The new mail name.

Returns:

A mail object with the new mail properties.

Throws:

PathNotFoundException - If there is no mail in the repository in this path.

ItemExistsException - If there is already a mail in the repository with the same name in the same path.

AccessDeniedException - If there is any security problem: you can't modify the mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

move

public void move(String token,
                 String mailPath,
                 String dstId)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 DatabaseException

Description copied from interface: MailModule

Move a mail to another location in the repository.

Specified by:

move in interface MailModule

mailPath - The path that identifies an unique mail.

dstId - The path of the destination mail.

Throws:

PathNotFoundException - If the dstPath does not exists.

ItemExistsException - If there is already a mail in the destination mail with the same name.

AccessDeniedException - If there is any security problem: you can't modify the parent mail or the destination mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

copy

public void copy(String token,
                 String mailPath,
                 String dstId)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 IOException,
                 AutomationException,
                 DatabaseException,
                 UserQuotaExceededException

Description copied from interface: MailModule

Copy a mail to another location in the repository.

Specified by:

copy in interface MailModule

mailPath - The path that identifies an unique mail.

dstId - The path of the destination mail.

Throws:

PathNotFoundException - If the dstPath does not exists.

ItemExistsException - If there is already a mail in the destination mail with the same name.

AccessDeniedException - If there is any security problem: you can't modify the parent mail or the destination mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException

AutomationException

DatabaseException

UserQuotaExceededException

extendedCopy

public void extendedCopy(String token,
                         String mailPath,
                         String dstId,
                         ExtendedAttributes extAttr)
                  throws PathNotFoundException,
                         ItemExistsException,
                         AccessDeniedException,
                         RepositoryException,
                         IOException,
                         AutomationException,
                         DatabaseException,
                         UserQuotaExceededException

Description copied from interface: MailModule

Copy a mail to another location in the repository.

Specified by:

extendedCopy in interface MailModule

mailPath - The path that identifies an unique mail.

dstId - The path of the destination mail.

extAttr - Attributes to define what need to be duplicated.

Throws:

PathNotFoundException - If the dstPath does not exists.

ItemExistsException - If there is already a mail in the destination mail with the same name.

AccessDeniedException - If there is any security problem: you can't modify the parent mail or the destination mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException

AutomationException

DatabaseException

UserQuotaExceededException

getChilds

@Deprecated
public List<Mail> getChilds(String token,
                                        String fldId)
                                 throws AccessDeniedException,
                                        PathNotFoundException,
                                        RepositoryException,
                                        DatabaseException

Deprecated.

Description copied from interface: MailModule

Retrieve a list of child mails from an existing folder.

Specified by:

getChilds in interface MailModule

fldId - The path that identifies an unique folder or its UUID.

Returns:

A Collection with the child folders.

Throws:

PathNotFoundException - If there is no folder in the repository in this path

RepositoryException - If there is any general repository problem.

AccessDeniedException

DatabaseException

getChildren

public List<Mail> getChildren(String token,
                              String fldId)
                       throws AccessDeniedException,
                              PathNotFoundException,
                              RepositoryException,
                              DatabaseException

Description copied from interface: MailModule

Retrieve a list of children mails from an existing folder.

Specified by:

getChildren in interface MailModule

fldId - The path that identifies an unique folder or its UUID.

Returns:

A Collection with the child folders.

Throws:

PathNotFoundException - If there is no folder in the repository in this path

RepositoryException - If there is any general repository problem.

AccessDeniedException

DatabaseException

isValid

public boolean isValid(String token,
                       String mailId)
                throws PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: MailModule

Test if a mail path is valid.

Specified by:

isValid in interface MailModule

mailId - The path that identifies an unique mail or its UUID.

Throws:

PathNotFoundException - If there is no mail in the repository with this path.

AccessDeniedException - If there is any security problem: you can't access this mail because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

getPath

public String getPath(String token,
                      String uuid)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: MailModule

Get the mail path from a UUID

Specified by:

getPath in interface MailModule

uuid - The unique mail id.

Returns:

The mail path

Throws:

AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.

RepositoryException - If there is any problem.

DatabaseException

importEml

public Mail importEml(String path,
                      InputStream is)
               throws javax.mail.MessagingException,
                      PathNotFoundException,
                      ItemExistsException,
                      VirusDetectedException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      UserQuotaExceededException,
                      UnsupportedMimeTypeException,
                      FileSizeExceededException,
                      ExtensionException,
                      AutomationException,
                      IOException

Import EML file as MailNode.

Throws:

javax.mail.MessagingException

PathNotFoundException

ItemExistsException

VirusDetectedException

AccessDeniedException

RepositoryException

DatabaseException

UserQuotaExceededException

UnsupportedMimeTypeException

FileSizeExceededException

ExtensionException

AutomationException

IOException

importMsg

public Mail importMsg(String path,
                      InputStream is)
               throws javax.mail.MessagingException,
                      PathNotFoundException,
                      ItemExistsException,
                      VirusDetectedException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      UserQuotaExceededException,
                      UnsupportedMimeTypeException,
                      FileSizeExceededException,
                      ExtensionException,
                      AutomationException,
                      IOException

Import MSG file as MailNode.

Throws:

javax.mail.MessagingException

PathNotFoundException

ItemExistsException

VirusDetectedException

AccessDeniedException

RepositoryException

DatabaseException

UserQuotaExceededException

UnsupportedMimeTypeException

FileSizeExceededException

ExtensionException

AutomationException

IOException