public interface MailModule
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.
|
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 fldId)
Retrieve a list of children mails from an existing folder.
|
List<Mail> |
getChilds(String token,
String fldId)
Deprecated.
|
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.
|
boolean |
isValid(String token,
String mailId)
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.
|
Mail create(String token, Mail mail) throws PathNotFoundException, ItemExistsException, VirusDetectedException, AccessDeniedException, RepositoryException, DatabaseException, UserQuotaExceededException, AutomationException
mail
- A mail object with the new mail properties.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
Mail getProperties(String token, String mailId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
mailId
- 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.AccessDeniedException
DatabaseException
void delete(String token, String mailPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
mailPath
- The path that identifies an unique mail.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
void purge(String token, String mailPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
mailPath
- The path that identifies an unique mail.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
Mail rename(String token, String mailPath, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, DatabaseException
mailPath
- The path that identifies an unique mail.newName
- The new mail name.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
void move(String token, String mailPath, String dstPath) throws PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, DatabaseException
mailPath
- The path that identifies an unique mail.dstPath
- The path of the destination mail.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
void copy(String token, String mailPath, String dstPath) throws PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException
mailPath
- The path that identifies an unique mail.dstPath
- The path of the destination mail.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
void extendedCopy(String token, String mailPath, String dstPath, ExtendedAttributes extAttr) throws PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException
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
AutomationException
DatabaseException
UserQuotaExceededException
@Deprecated List<Mail> getChilds(String token, String fldId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
fldId
- 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.AccessDeniedException
DatabaseException
List<Mail> getChildren(String token, String fldId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
fldId
- 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.AccessDeniedException
DatabaseException
boolean isValid(String token, String mailId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
mailId
- The path that identifies an unique mail or its UUID.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
String getPath(String token, String uuid) throws AccessDeniedException, RepositoryException, DatabaseException
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.