BaseMail (OpenKM SDK for Java 2.7 API)

All Known Subinterfaces:

OKMWebservices

All Known Implementing Classes:

MailImpl, OKMWebservice20
```
public interface BaseMail
```
BaseMail

Author:

jllort

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`copyMail(String mailId, String dstId, String newName)`
`Document`	`createAttachment(String mailId, String docName, InputStream is)`
`Mail`	`createMail(Mail mail)`
`void`	`deleteAttachment(String mailId, String docId)`
`void`	`deleteMail(String mailId)`
`void`	`extendedMailCopy(String mailId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, String newName)`
`List<Document>`	`getAttachments(String mailId)`
`List<Mail>`	`getMailChildren(String fldId)`
`String`	`getMailPath(String uuid)`
`Mail`	`getMailProperties(String mailId)`
`Mail`	`importEml(String dstId, String title, InputStream is)`
`Mail`	`importMsg(String dstId, String title, InputStream is)`
`boolean`	`isValidMail(String mailId)`
`void`	`moveMail(String mailId, String dstId)`
`void`	`purgeMail(String mailId)`
`void`	`renameMail(String mailId, String newName)`
`void`	`sendMail(List<String> recipients, String subject, String body)`
`void`	`sendMailWithAttachments(String from, List<String> to, List<String> cc, List<String> bcc, String subject, String body, List<String> docsId, String dstId)`
`void`	`setMailTitle(String mailId, String title)`

Method Detail

createMail

Mail createMail(Mail mail)
         throws PathNotFoundException,
                ItemExistsException,
                VirusDetectedException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException,
                UserQuotaExceededException,
                AutomationException,
                UnknowException,
                WebserviceException

Throws:: PathNotFoundException; ItemExistsException; VirusDetectedException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; AutomationException; UnknowException; WebserviceException

getMailProperties

Mail getMailProperties(String mailId)
                throws AccessDeniedException,
                       RepositoryException,
                       PathNotFoundException,
                       DatabaseException,
                       UnknowException,
                       WebserviceException

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

deleteMail

void deleteMail(String mailId)
         throws AutomationException,
                LockException,
                PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException,
                UnknowException,
                WebserviceException

Throws:: AutomationException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

purgeMail

void purgeMail(String mailId)
        throws LockException,
               PathNotFoundException,
               AccessDeniedException,
               RepositoryException,
               DatabaseException,
               UnknowException,
               WebserviceException

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

renameMail

void renameMail(String mailId,
                String newName)
         throws PathNotFoundException,
                ItemExistsException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException,
                UnknowException,
                WebserviceException

Throws:: PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

moveMail

void moveMail(String mailId,
              String dstId)
       throws PathNotFoundException,
              ItemExistsException,
              AccessDeniedException,
              RepositoryException,
              DatabaseException,
              UnknowException,
              WebserviceException

Throws:: PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

copyMail

void copyMail(String mailId,
              String dstId,
              String newName)
       throws PathNotFoundException,
              ItemExistsException,
              AccessDeniedException,
              RepositoryException,
              IOException,
              AutomationException,
              DatabaseException,
              UserQuotaExceededException,
              UnknowException,
              WebserviceException

Throws:: PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; IOException; AutomationException; DatabaseException; UserQuotaExceededException; UnknowException; WebserviceException

extendedMailCopy

void extendedMailCopy(String mailId,
                      String dstId,
                      boolean categories,
                      boolean keywords,
                      boolean propertyGroups,
                      boolean notes,
                      boolean wiki,
                      String newName)
               throws ItemExistsException,
                      PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      IOException,
                      DatabaseException,
                      UserQuotaExceededException,
                      AutomationException,
                      UnknowException,
                      WebserviceException

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; UserQuotaExceededException; AutomationException; UnknowException; WebserviceException

getMailChildren

List<Mail> getMailChildren(String fldId)
                    throws AccessDeniedException,
                           PathNotFoundException,
                           RepositoryException,
                           DatabaseException,
                           UnknowException,
                           WebserviceException

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknowException; WebserviceException

isValidMail

boolean isValidMail(String mailId)
             throws PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    UnknowException,
                    WebserviceException

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

getMailPath

String getMailPath(String uuid)
            throws AccessDeniedException,
                   RepositoryException,
                   DatabaseException,
                   UnknowException,
                   WebserviceException

Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

createAttachment

Document createAttachment(String mailId,
                          String docName,
                          InputStream is)
                   throws AccessDeniedException,
                          IOException,
                          UnsupportedMimeTypeException,
                          FileSizeExceededException,
                          UserQuotaExceededException,
                          VirusDetectedException,
                          ItemExistsException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          ExtensionException,
                          AutomationException,
                          UnknowException,
                          WebserviceException

Throws:: AccessDeniedException; IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; RepositoryException; DatabaseException; ExtensionException; AutomationException; UnknowException; WebserviceException

deleteAttachment

void deleteAttachment(String mailId,
                      String docId)
               throws AccessDeniedException,
                      LockException,
                      PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      UnknowException,
                      WebserviceException

Throws:: AccessDeniedException; LockException; PathNotFoundException; RepositoryException; DatabaseException; UnknowException; WebserviceException

getAttachments

List<Document> getAttachments(String mailId)
                       throws AccessDeniedException,
                              RepositoryException,
                              PathNotFoundException,
                              DatabaseException,
                              UnknowException,
                              WebserviceException

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

sendMailWithAttachments

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

Throws:: AccessDeniedException; PathNotFoundException; ItemExistsException; AutomationException; VirusDetectedException; UserQuotaExceededException; UnsupportedMimeTypeException; FileSizeExceededException; RepositoryException; DatabaseException; IOException; UnknowException; WebserviceException

importEml

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

Throws:: MessagingException; PathNotFoundException; ItemExistsException; VirusDetectedException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; UnsupportedMimeTypeException; FileSizeExceededException; ExtensionException; AutomationException; IOException; UnknowException; WebserviceException

importMsg

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

Throws:: MessagingException; PathNotFoundException; ItemExistsException; VirusDetectedException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; UnsupportedMimeTypeException; FileSizeExceededException; ExtensionException; AutomationException; IOException; UnknowException; WebserviceException

setMailTitle

void setMailTitle(String mailId,
                  String title)
           throws VersionException,
                  LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  UnknowException,
                  WebserviceException

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

sendMail

void sendMail(List<String> recipients,
              String subject,
              String body)
       throws AccessDeniedException,
              IOException,
              UnknowException,
              WebserviceException

Throws:: AccessDeniedException; IOException; UnknowException; WebserviceException

Interface BaseMail

Method Summary

Method Detail

createMail

getMailProperties

deleteMail

purgeMail

renameMail

moveMail

copyMail

extendedMailCopy

getMailChildren

isValidMail

getMailPath

createAttachment

deleteAttachment

getAttachments

sendMailWithAttachments

importEml

importMsg

setMailTitle

sendMail