java.lang.Object
- com.openkm.sdk4j.impl.ClientImpl
- - com.openkm.sdk4j.impl.MailImpl

All Implemented Interfaces:

BaseMail, Serializable
```
public class MailImpl
extends ClientImpl
implements BaseMail, Serializable
```
MailImpl

Author:

sochoa

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

MailImpl(String host)
MailImpl

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected void`	`setAuthorizationToken(String authorizationToken)`	setAuthenticationToken
`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.

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MailImpl
```
public MailImpl(String host)
```
  MailImpl

Method Detail

setAuthorizationToken

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

getProperties

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

Description copied from interface: BaseMail

Gets mail properties.

Specified by:: getProperties in interface BaseMail
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

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

Description copied from interface: BaseMail

Delete mail.

Specified by:: delete in interface BaseMail
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

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

Description copied from interface: BaseMail

Rename mail.

Specified by:: rename in interface BaseMail
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

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

Description copied from interface: BaseMail

Move mail.

Specified by:: move in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mail children.

Specified by:: getChildren in interface BaseMail
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
```
public boolean isValid(String uuid)
                throws PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException
```
Description copied from interface: BaseMail

Is valid mail boolean.

Specified by:

isValid in interface BaseMail

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
```
public String getPath(String uuid)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      UnknownException,
                      WebserviceException
```
Description copied from interface: BaseMail

Gets mail path.

Specified by:

getPath in interface BaseMail

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

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

Description copied from interface: BaseMail

Create attachment document.

Specified by:: createAttachment in interface BaseMail
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

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

Description copied from interface: BaseMail

Delete attachment.

Specified by:: deleteAttachment in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets attachments.

Specified by:: getAttachments in interface BaseMail
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
```
public void purge(String uuid)
           throws LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  PromotedAsRecordLockException,
                  UnknownException,
                  WebserviceException
```
Description copied from interface: BaseMail

Purge mail.

Specified by:

purge in interface BaseMail

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

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

Description copied from interface: BaseMail

Copy mail mail.

Specified by:: copy in interface BaseMail
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

public 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

Description copied from interface: BaseMail

Extended mail copy mail.

Specified by:: extendedCopy in interface BaseMail
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

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

Description copied from interface: BaseMail

Sets mail node class.

Specified by:: setNodeClass in interface BaseMail
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

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

Description copied from interface: BaseMail

Sets mail disposition stage.

Specified by:: setDispositionStage in interface BaseMail
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

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

Description copied from interface: BaseMail

Sets mail title.

Specified by:: setTitle in interface BaseMail
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

public 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

Description copied from interface: BaseMail

Send mail with attachments mail.

Specified by:: sendMailWithAttachments in interface BaseMail
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

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

Description copied from interface: BaseMail

Import eml mail.

Specified by:: importEml in interface BaseMail
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

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

Description copied from interface: BaseMail

Import msg mail.

Specified by:: importMsg in interface BaseMail
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

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

Description copied from interface: BaseMail

Send mail.

Specified by:: sendMail in interface BaseMail
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

sendMail

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

Description copied from interface: BaseMail

Send mail.

Specified by:: sendMail in interface BaseMail
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

setDescription

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

Description copied from interface: BaseMail

Sets mail description.

Specified by:: setDescription in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mail content.

Specified by:: getContent in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mail thumbnail.

Specified by:: getThumbnail in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mails paginated.

Specified by:: getMailsPaginated in interface BaseMail
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

public 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

Description copied from interface: BaseMail

Create wizard mail wizard node.

Specified by:: createWizard in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mail accounts.

Specified by:: getAccounts in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mail messages.

Specified by:: getMailMessages in interface BaseMail
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

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

Description copied from interface: BaseMail

Add mail account.

Specified by:: addAccount in interface BaseMail
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

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

Description copied from interface: BaseMail

Update mail account.

Specified by:: updateAccount in interface BaseMail
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

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

Description copied from interface: BaseMail

Test mail account.

Specified by:: testAccount in interface BaseMail
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

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

Description copied from interface: BaseMail

Delete mail account.

Specified by:: deleteAccount in interface BaseMail
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

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

Description copied from interface: BaseMail

Import mail messages.

Specified by:: importMessages in interface BaseMail
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

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

Description copied from interface: BaseMail

Create mail filter.

Specified by:: createFilter in interface BaseMail
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

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

Description copied from interface: BaseMail

Update mail filter.

Specified by:: updateFilter in interface BaseMail
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

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

Description copied from interface: BaseMail

Delete mail filter.

Specified by:: deleteFilter in interface BaseMail
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

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

Description copied from interface: BaseMail

Create mail rule.

Specified by:: createRule in interface BaseMail
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

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

Description copied from interface: BaseMail

Update mail rule.

Specified by:: updateRule in interface BaseMail
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

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

Description copied from interface: BaseMail

Delete mail rule.

Specified by:: deleteRule in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets mail filter rules.

Specified by:: getFilterRules in interface BaseMail
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

public 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

Description copied from interface: BaseMail

Forward email.

Specified by:: forwardEmail in interface BaseMail
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

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

Description copied from interface: BaseMail

Obtain the mail extracted text.

Specified by:: getExtractedText in interface BaseMail
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

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

Description copied from interface: BaseMail

Gets pdf.

Specified by:: getPdf in interface BaseMail
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

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

Description copied from interface: BaseMail

Save mail as pdf document.

Specified by:: saveAsPdf in interface BaseMail
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

Class MailImpl

Constructor Summary

Method Summary

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

Methods inherited from class java.lang.Object

Constructor Detail

MailImpl

Method Detail

setAuthorizationToken

getProperties

delete

rename

move

getChildren

isValid

getPath

createAttachment

deleteAttachment

getAttachments

purge

copy

extendedCopy

setNodeClass

setDispositionStage

setTitle

sendMailWithAttachments

importEml

importMsg

sendMail

sendMail

setDescription

getContent

getThumbnail

getMailsPaginated

createWizard

getAccounts

getMailMessages

addAccount

updateAccount

testAccount

deleteAccount

importMessages

createFilter

updateFilter

deleteFilter

createRule

updateRule

deleteRule

getFilterRules

forwardEmail

getExtractedText

getPdf

saveAsPdf