com.openkm.module

Interface MailModule

All Known Implementing Classes:

DbMailModule, JcrMailModule, OKMMail

public interface MailModule

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(String token, String mailPath, String dstPath) 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 mailPath) Delete a mail the repository.
List<Mail>	getChildren(String token, String fldPath) Retrieve a list of children mails from an existing folder.
List<Mail>	getChilds(String token, String fldPath) Deprecated.
String	getPath(String token, String uuid) Get the mail path from a UUID
Mail	getProperties(String token, String mailPath) Obtains properties from a previously created mail.
boolean	isValid(String token, String mailPath) Test if a mail path is valid.
void	move(String token, String mailPath, String dstPath) Move a mail to another location in the repository.
void	purge(String token, String mailPath) Deletes definitively a mail from the repository.
Mail	rename(String token, String mailPath, String newName) Rename a mail in the repository.

Method Detail

create

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

Create a new mail in the repository.

Parameters:

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

getProperties

Mail getProperties(String token,
                 String mailPath)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException

Obtains properties from a previously created mail.

Parameters:

mailPath - The path that identifies an unique mail.

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.

DatabaseException

delete

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

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

Parameters:

mailPath - 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

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

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

Parameters:

mailPath - 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

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

Rename a mail in the repository.

Parameters:

mailPath - 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

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

Move a mail to another location in the repository.

Parameters:

mailPath - The path that identifies an unique mail.

dstPath - 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

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

Copy a mail to another location in the repository.

Parameters:

mailPath - The path that identifies an unique mail.

dstPath - 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

getChilds

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

Deprecated.

Retrieve a list of child mails from an existing folder.

Parameters:

fldPath - The path that identifies an unique folder.

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.

DatabaseException

getChildren

List<Mail> getChildren(String token,
                     String fldPath)
                       throws PathNotFoundException,
                              RepositoryException,
                              DatabaseException

Retrieve a list of children mails from an existing folder.

Parameters:

fldPath - The path that identifies an unique folder.

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.

DatabaseException

isValid

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

Test if a mail path is valid.

Parameters:

mailPath - The path that identifies an unique mail.

Throws:

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.

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

DatabaseException

getPath

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

Get the mail path from a UUID

Parameters:

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