Package com.openkm.sdk4j.definition

Interface BaseMail

All Known Implementing Classes:

MailImpl

public interface BaseMail

BaseMail

Author:

jllort

Method Summary

Modifier and Type	Method	Description
void	addAccount(MailAccount mailAccount)	Add mail account.
Mail	copy(String uuid, String dstId, String newName)	Copy mail mail.
Document	createAttachment(String uuid, String docName, InputStream is)	Create attachment document.
void	createFilter(long mailAccountId, MailFilter mailFilter)	Create mail filter.
void	createRule(long filterId, MailFilterRule rule)	Create mail rule.
WizardNode	createWizard(String uuid, String title, InputStream is, String type)	Create wizard mail wizard node.
void	delete(String uuid)	Delete mail.
void	deleteAccount(long mailAccountId)	Delete mail account.
void	deleteAttachment(String uuid, String docId)	Delete attachment.
void	deleteFilter(long mailFilterId)	Delete mail filter.
void	deleteRule(long ruleId)	Delete mail rule.
Mail	extendedCopy(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security, String newName)	Extended mail copy mail.
void	forwardEmail(String uuid, List<String> users, List<String> roles, List<String> mails, String message)	Forward email.
List<MailAccount>	getAccounts()	Gets mail accounts.
List<Document>	getAttachments(String uuid)	Gets attachments.
List<Mail>	getChildren(String uuid)	Gets mail children.
InputStream	getContent(String uuid)	Gets mail content.
String	getExtractedText(String uuid)	Obtain the mail extracted text.
List<MailFilterRule>	getFilterRules(long filterId)	Gets mail filter rules.
MailServerMessages	getMailMessages(long accountId, long start)	Gets mail messages.
NodeList	getMailsPaginated(String context, int offset, int limit, MailFilterQuery filter, String orderColumn, boolean orderAsc)	Gets mails paginated.
String	getPath(String uuid)	Gets mail path.
InputStream	getPdf(String uuid)	Gets pdf.
Mail	getProperties(String uuid)	Gets mail properties.
InputStream	getThumbnail(String uuid, ThumbnailType type)	Gets mail thumbnail.
Mail	importEml(String uuid, String title, InputStream is)	Import eml mail.
void	importMessages(long mailAccountId, List<Long> messageIds)	Import mail messages.
Mail	importMsg(String uuid, String title, InputStream is)	Import msg mail.
boolean	isValid(String uuid)	Is valid mail boolean.
void	move(String uuid, String dstId)	Move mail.
void	purge(String uuid)	Purge mail.
void	rename(String uuid, String newName)	Rename mail.
Document	saveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security)	Save mail as pdf document.
void	sendMail(String from, List<String> to, String subject, String body)	Send mail.
void	sendMail(List<String> to, String subject, String body)	Send mail.
Mail	sendMailWithAttachments(String from, List<String> to, List<String> cc, List<String> bcc, List<String> replyTo, String subject, String body, List<String> docsId, String uuid)	Send mail with attachments mail.
void	setDescription(String uuid, String description)	Sets mail description.
void	setDispositionStage(String uuid, long stage)	Sets mail disposition stage.
void	setNodeClass(String uuid, long ncId)	Sets mail node class.
void	setTitle(String uuid, String title)	Sets mail title.
void	testAccount(MailAccount mailAccount)	Test mail account.
void	updateAccount(MailAccount mailAccount)	Update mail account.
void	updateFilter(MailFilter mailFilter)	Update mail filter.
void	updateRule(MailFilterRule rule)	Update mail rule.

Method Detail

getProperties

Mail getProperties(String uuid)
            throws AccessDeniedException,
                   RepositoryException,
                   PathNotFoundException,
                   DatabaseException,
                   UnknownException,
                   WebserviceException

Gets mail properties.

Parameters:

uuid - the uuid

Returns:

the mail properties

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

delete

void delete(String uuid)
     throws AutomationException,
            LockException,
            PathNotFoundException,
            AccessDeniedException,
            RepositoryException,
            DatabaseException,
            PromotedAsRecordLockException,
            UnknownException,
            WebserviceException

Delete mail.

Parameters:

uuid - the uuid

Throws:

AutomationException - the automation exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

rename

void rename(String uuid,
            String newName)
     throws PathNotFoundException,
            ItemExistsException,
            AccessDeniedException,
            RepositoryException,
            UnknownException,
            WebserviceException

Rename mail.

Parameters:

uuid - the uuid

newName - the new name

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

move

void move(String uuid,
          String dstId)
   throws PathNotFoundException,
          ItemExistsException,
          AccessDeniedException,
          RepositoryException,
          DatabaseException,
          PromotedAsRecordLockException,
          FilePlanCatalogManagerException,
          AutomationException,
          VersionException,
          LockException,
          UnknownException,
          WebserviceException

Move mail.

Parameters:

uuid - the uuid

dstId - the dst id

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

FilePlanCatalogManagerException - the file plan catalog manager exception

AutomationException - the automation exception

VersionException - the version exception

LockException - the lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getChildren

List<Mail> getChildren(String uuid)
                throws AccessDeniedException,
                       PathNotFoundException,
                       RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException

Gets mail children.

Parameters:

uuid - the uuid

Returns:

the mail children

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isValid

boolean isValid(String uuid)
         throws PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException,
                UnknownException,
                WebserviceException

Is valid mail boolean.

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPath

String getPath(String uuid)
        throws AccessDeniedException,
               RepositoryException,
               DatabaseException,
               UnknownException,
               WebserviceException

Gets mail path.

Parameters:

uuid - the uuid

Returns:

the mail path

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createAttachment

Document createAttachment(String uuid,
                          String docName,
                          InputStream is)
                   throws UnsupportedMimeTypeException,
                          FileSizeExceededException,
                          UserQuotaExceededException,
                          VirusDetectedException,
                          ItemExistsException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          ExtensionException,
                          AutomationException,
                          PromotedAsRecordLockException,
                          UnknownException,
                          WebserviceException

Create attachment document.

Parameters:

uuid - the uuid

docName - the doc name

is - the is

Returns:

the document

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteAttachment

void deleteAttachment(String uuid,
                      String docId)
               throws LockException,
                      PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      PromotedAsRecordLockException,
                      UnknownException,
                      WebserviceException

Delete attachment.

Parameters:

uuid - the uuid

docId - the doc id

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAttachments

List<Document> getAttachments(String uuid)
                       throws AccessDeniedException,
                              RepositoryException,
                              PathNotFoundException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Gets attachments.

Parameters:

uuid - the uuid

Returns:

the attachments

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

purge

void purge(String uuid)
    throws LockException,
           PathNotFoundException,
           AccessDeniedException,
           RepositoryException,
           DatabaseException,
           PromotedAsRecordLockException,
           UnknownException,
           WebserviceException

Purge mail.

Parameters:

uuid - the uuid

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copy

Mail copy(String uuid,
          String dstId,
          String newName)
   throws PathNotFoundException,
          ItemExistsException,
          AccessDeniedException,
          RepositoryException,
          AutomationException,
          DatabaseException,
          UserQuotaExceededException,
          PromotedAsRecordLockException,
          UnknownException,
          WebserviceException

Copy mail mail.

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

Returns:

the mail

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

AutomationException - the automation exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

extendedCopy

Mail extendedCopy(String uuid,
                  String dstId,
                  boolean categories,
                  boolean keywords,
                  boolean propertyGroups,
                  boolean notes,
                  boolean security,
                  String newName)
           throws ItemExistsException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  UserQuotaExceededException,
                  AutomationException,
                  PromotedAsRecordLockException,
                  UnknownException,
                  WebserviceException

Extended mail copy mail.

Parameters:

uuid - the uuid

dstId - the dst id

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

security - the security

newName - the new name

Returns:

the mail

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setNodeClass

void setNodeClass(String uuid,
                  long ncId)
           throws VersionException,
                  LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  PromotedAsRecordLockException,
                  UnknownException,
                  WebserviceException

Sets mail node class.

Parameters:

uuid - the uuid

ncId - the nc id

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setDispositionStage

void setDispositionStage(String uuid,
                         long stage)
                  throws PathNotFoundException,
                         AccessDeniedException,
                         DatabaseException,
                         WebserviceException,
                         UnknownException

Sets mail disposition stage.

Parameters:

uuid - the uuid

stage - the stage

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

setTitle

void setTitle(String uuid,
              String title)
       throws VersionException,
              LockException,
              PathNotFoundException,
              AccessDeniedException,
              RepositoryException,
              DatabaseException,
              UnknownException,
              WebserviceException

Sets mail title.

Parameters:

uuid - the uuid

title - the title

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

sendMailWithAttachments

Mail sendMailWithAttachments(String from,
                             List<String> to,
                             List<String> cc,
                             List<String> bcc,
                             List<String> replyTo,
                             String subject,
                             String body,
                             List<String> docsId,
                             String uuid)
                      throws AccessDeniedException,
                             PathNotFoundException,
                             ItemExistsException,
                             AutomationException,
                             VirusDetectedException,
                             UserQuotaExceededException,
                             UnsupportedMimeTypeException,
                             FileSizeExceededException,
                             RepositoryException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException,
                             IOException

Send mail with attachments mail.

Parameters:

from - the from

to - the to

cc - the cc

bcc - the bcc

replyTo - the reply to

subject - the subject

body - the body

docsId - the docs id

uuid - the uuid

Returns:

the mail

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

VirusDetectedException - the virus detected exception

UserQuotaExceededException - the user quota exceeded exception

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

importEml

Mail importEml(String uuid,
               String title,
               InputStream is)
        throws MessagingException,
               PathNotFoundException,
               ItemExistsException,
               VirusDetectedException,
               AccessDeniedException,
               RepositoryException,
               DatabaseException,
               UserQuotaExceededException,
               UnsupportedMimeTypeException,
               FileSizeExceededException,
               ExtensionException,
               AutomationException,
               UnknownException,
               WebserviceException,
               IOException

Import eml mail.

Parameters:

uuid - the uuid

title - the title

is - the is

Returns:

the mail

Throws:

MessagingException - the messaging exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

importMsg

Mail importMsg(String uuid,
               String title,
               InputStream is)
        throws MessagingException,
               PathNotFoundException,
               ItemExistsException,
               VirusDetectedException,
               AccessDeniedException,
               RepositoryException,
               DatabaseException,
               UserQuotaExceededException,
               UnsupportedMimeTypeException,
               FileSizeExceededException,
               ExtensionException,
               AutomationException,
               UnknownException,
               WebserviceException,
               IOException

Import msg mail.

Parameters:

uuid - the uuid

title - the title

is - the is

Returns:

the mail

Throws:

MessagingException - the messaging exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

sendMail

void sendMail(String from,
              List<String> to,
              String subject,
              String body)
       throws AccessDeniedException,
              UnknownException,
              WebserviceException,
              IOException

Send mail.

Parameters:

from - the from

to - the recipients

subject - the subject

body - the body

Throws:

AccessDeniedException - the access denied exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

sendMail

void sendMail(List<String> to,
              String subject,
              String body)
       throws AccessDeniedException,
              UnknownException,
              WebserviceException,
              IOException

Send mail.

Parameters:

to - the recipients

subject - the subject

body - the body

Throws:

AccessDeniedException - the access denied exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

IOException - the io exception

setDescription

void setDescription(String uuid,
                    String description)
             throws VersionException,
                    LockException,
                    PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    WebserviceException,
                    UnknownException

Sets mail description.

Parameters:

uuid - the uuid

description - the description

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getContent

InputStream getContent(String uuid)
                throws RepositoryException,
                       PathNotFoundException,
                       AccessDeniedException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException

Gets mail content.

Parameters:

uuid - the uuid

Returns:

the mail content

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getThumbnail

InputStream getThumbnail(String uuid,
                         ThumbnailType type)
                  throws PathNotFoundException,
                         AccessDeniedException,
                         ConversionException,
                         AutomationException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Gets mail thumbnail.

Parameters:

uuid - the uuid

type - the type

Returns:

the mail thumbnail

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

ConversionException - the conversion exception

AutomationException - the automation exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getMailsPaginated

NodeList getMailsPaginated(String context,
                           int offset,
                           int limit,
                           MailFilterQuery filter,
                           String orderColumn,
                           boolean orderAsc)
                    throws AccessDeniedException,
                           RepositoryException,
                           PathNotFoundException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException

Gets mails paginated.

Parameters:

context - the context

offset - the offset

limit - the limit

filter - the filter

orderColumn - the order column

orderAsc - the order asc

Returns:

the mails paginated

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createWizard

WizardNode createWizard(String uuid,
                        String title,
                        InputStream is,
                        String type)
                 throws PathNotFoundException,
                        ItemExistsException,
                        VirusDetectedException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        UserQuotaExceededException,
                        AutomationException,
                        UnknownException,
                        WebserviceException,
                        MessagingException,
                        UnsupportedMimeTypeException,
                        FileSizeExceededException,
                        ExtensionException,
                        IOException

Create wizard mail wizard node.

Parameters:

uuid - the uuid

title - the title

is - the is

type - the type

Returns:

the wizard node

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

MessagingException - the messaging exception

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

ExtensionException - the extension exception

IOException - the io exception

getAccounts

List<MailAccount> getAccounts()
                       throws AccessDeniedException,
                              RepositoryException,
                              PathNotFoundException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Gets mail accounts.

Returns:

the mail accounts

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getMailMessages

MailServerMessages getMailMessages(long accountId,
                                   long start)
                            throws AccessDeniedException,
                                   RepositoryException,
                                   PathNotFoundException,
                                   DatabaseException,
                                   UnknownException,
                                   WebserviceException

Gets mail messages.

Parameters:

accountId - the account id

start - the start

Returns:

the mail messages

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addAccount

void addAccount(MailAccount mailAccount)
         throws AccessDeniedException,
                RepositoryException,
                DatabaseException,
                PathNotFoundException,
                UnknownException,
                WebserviceException

Add mail account.

Parameters:

mailAccount - the mail account

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

updateAccount

void updateAccount(MailAccount mailAccount)
            throws AccessDeniedException,
                   RepositoryException,
                   DatabaseException,
                   PathNotFoundException,
                   UnknownException,
                   WebserviceException

Update mail account.

Parameters:

mailAccount - the mail account

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

testAccount

void testAccount(MailAccount mailAccount)
          throws AccessDeniedException,
                 RepositoryException,
                 DatabaseException,
                 PathNotFoundException,
                 UnknownException,
                 WebserviceException

Test mail account.

Parameters:

mailAccount - the mail account

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteAccount

void deleteAccount(long mailAccountId)
            throws AccessDeniedException,
                   RepositoryException,
                   DatabaseException,
                   PathNotFoundException,
                   UnknownException,
                   WebserviceException

Delete mail account.

Parameters:

mailAccountId - the mail account id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

importMessages

void importMessages(long mailAccountId,
                    List<Long> messageIds)
             throws AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    PathNotFoundException,
                    UnknownException,
                    WebserviceException

Import mail messages.

Parameters:

mailAccountId - the mail account id

messageIds - the message ids

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFilter

void createFilter(long mailAccountId,
                  MailFilter mailFilter)
           throws AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  PathNotFoundException,
                  UnknownException,
                  WebserviceException

Create mail filter.

Parameters:

mailAccountId - the mail account id

mailFilter - the mail filter

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

updateFilter

void updateFilter(MailFilter mailFilter)
           throws AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  PathNotFoundException,
                  UnknownException,
                  WebserviceException

Update mail filter.

Parameters:

mailFilter - the mail filter

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteFilter

void deleteFilter(long mailFilterId)
           throws AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  PathNotFoundException,
                  UnknownException,
                  WebserviceException

Delete mail filter.

Parameters:

mailFilterId - the mail filter id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createRule

void createRule(long filterId,
                MailFilterRule rule)
         throws AccessDeniedException,
                RepositoryException,
                DatabaseException,
                PathNotFoundException,
                UnknownException,
                WebserviceException

Create mail rule.

Parameters:

filterId - the filter id

rule - the rule

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

updateRule

void updateRule(MailFilterRule rule)
         throws AccessDeniedException,
                RepositoryException,
                DatabaseException,
                PathNotFoundException,
                UnknownException,
                WebserviceException

Update mail rule.

Parameters:

rule - the rule

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteRule

void deleteRule(long ruleId)
         throws AccessDeniedException,
                RepositoryException,
                DatabaseException,
                PathNotFoundException,
                UnknownException,
                WebserviceException

Delete mail rule.

Parameters:

ruleId - the rule id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getFilterRules

List<MailFilterRule> getFilterRules(long filterId)
                             throws AccessDeniedException,
                                    RepositoryException,
                                    DatabaseException,
                                    PathNotFoundException,
                                    UnknownException,
                                    WebserviceException

Gets mail filter rules.

Parameters:

filterId - the filter id

Returns:

the mail filter rules

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

forwardEmail

void forwardEmail(String uuid,
                  List<String> users,
                  List<String> roles,
                  List<String> mails,
                  String message)
           throws WebserviceException,
                  AccessDeniedException,
                  RepositoryException,
                  LockException,
                  PathNotFoundException,
                  DatabaseException,
                  UnknownException,
                  VersionException,
                  PromotedAsRecordLockException

Forward email.

Parameters:

uuid - the uuid

users - the users

roles - the roles

mails - the mails

message - the message

Throws:

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

LockException - the lock exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

VersionException - the version exception

PromotedAsRecordLockException - the promoted as record lock exception

getExtractedText

String getExtractedText(String uuid)
                 throws AccessDeniedException,
                        RepositoryException,
                        PathNotFoundException,
                        DatabaseException,
                        UnknownException,
                        WebserviceException

Obtain the mail extracted text.

Parameters:

uuid - Node uuid

Returns:

Returns the text of the document.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPdf

InputStream getPdf(String uuid)
            throws PathNotFoundException,
                   AccessDeniedException,
                   ConversionException,
                   AutomationException,
                   RepositoryException,
                   DatabaseException,
                   UnknownException,
                   WebserviceException

Gets pdf.

Parameters:

uuid - the uuid

Returns:

the pdf

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

ConversionException - the conversion exception

AutomationException - the automation exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

saveAsPdf

Document saveAsPdf(String uuid,
                   String newName,
                   boolean propertyGroups,
                   boolean security)
            throws RepositoryException,
                   AccessDeniedException,
                   PathNotFoundException,
                   DatabaseException,
                   ConversionException,
                   UnsupportedMimeTypeException,
                   VirusDetectedException,
                   ItemExistsException,
                   AutomationException,
                   PromotedAsRecordLockException,
                   PrincipalAdapterException,
                   UnknownException,
                   WebserviceException

Save mail as pdf document.

Parameters:

uuid - the uuid

newName - the new name

propertyGroups - the property groups

security - the security

Returns:

the document

Throws:

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

ConversionException - the conversion exception

UnsupportedMimeTypeException - the unsupported mime type exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception