public class JcrMailModule extends Object implements MailModule
Constructor and Description |
---|
JcrMailModule() |
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.
|
Mail |
create(String token,
Mail mail,
String userId)
Used when importing mail from scheduler
|
void |
delete(String token,
String mailPath)
Delete a mail the repository.
|
void |
extendedCopy(String token,
String mailPath,
String dstPath,
ExtendedAttributes extAttr)
Copy a mail to another location in 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.
|
public Mail create(String token, Mail mail) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, VirusDetectedException, DatabaseException, UserQuotaExceededException
MailModule
create
in interface MailModule
mail
- A mail object with the new mail properties.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.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.VirusDetectedException
DatabaseException
UserQuotaExceededException
public Mail create(String token, Mail mail, String userId) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, VirusDetectedException, DatabaseException, UserQuotaExceededException
public Mail getProperties(String token, String mailPath) throws PathNotFoundException, RepositoryException, DatabaseException
MailModule
getProperties
in interface MailModule
mailPath
- The path that identifies an unique mail, or its UUID.PathNotFoundException
- If the indicated mail doesn't exist.RepositoryException
- If there is any general repository problem.DatabaseException
public void delete(String token, String mailPath) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException
MailModule
delete
in interface MailModule
mailPath
- The path that identifies an unique mail.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.PathNotFoundException
- If there is no mail in the repository in this path.LockException
- Can't delete a mail with locked documents.DatabaseException
public void purge(String token, String mailPath) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException
MailModule
purge
in interface MailModule
mailPath
- The path that identifies an unique mail.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.PathNotFoundException
- If there is no mail in the repository in this path.DatabaseException
public Mail rename(String token, String mailPath, String newName) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, DatabaseException
MailModule
rename
in interface MailModule
mailPath
- The path that identifies an unique mail.newName
- The new mail name.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.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.DatabaseException
public void move(String token, String mailPath, String dstPath) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, DatabaseException
MailModule
move
in interface MailModule
mailPath
- The path that identifies an unique mail.dstPath
- The path of the destination mail.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.PathNotFoundException
- If the dstPath does not exists.ItemExistsException
- If there is already a mail in the
destination mail with the same name.DatabaseException
public void copy(String token, String mailPath, String dstPath) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, IOException, DatabaseException, UserQuotaExceededException
MailModule
copy
in interface MailModule
mailPath
- The path that identifies an unique mail.dstPath
- The path of the destination mail.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.PathNotFoundException
- If the dstPath does not exists.ItemExistsException
- If there is already a mail in the
destination mail with the same name.IOException
DatabaseException
UserQuotaExceededException
public void extendedCopy(String token, String mailPath, String dstPath, ExtendedAttributes extAttr) throws PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, IOException, DatabaseException, UserQuotaExceededException
MailModule
extendedCopy
in interface MailModule
mailPath
- The path that identifies an unique mail.dstPath
- The path of the destination mail.extAttr
- Attributes to define what need to be duplicated.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
DatabaseException
UserQuotaExceededException
@Deprecated public List<Mail> getChilds(String token, String fldPath) throws PathNotFoundException, RepositoryException, DatabaseException
MailModule
getChilds
in interface MailModule
fldPath
- The path that identifies an unique folder or its UUID.PathNotFoundException
- If there is no folder in the repository in this pathRepositoryException
- If there is any general repository problem.DatabaseException
public List<Mail> getChildren(String token, String fldPath) throws PathNotFoundException, RepositoryException, DatabaseException
MailModule
getChildren
in interface MailModule
fldPath
- The path that identifies an unique folder or its UUID.PathNotFoundException
- If there is no folder in the repository in this pathRepositoryException
- If there is any general repository problem.DatabaseException
public boolean isValid(String token, String mailPath) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
MailModule
isValid
in interface MailModule
mailPath
- The path that identifies an unique mail or its UUID.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
public String getPath(String token, String uuid) throws AccessDeniedException, RepositoryException, DatabaseException
MailModule
getPath
in interface MailModule
uuid
- The unique mail id.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
Copyright © 2016. All rights reserved.