MailUtils (OpenKM Web Application 6.3.2 API)

java.lang.Object
- com.openkm.util.MailUtils

```
public class MailUtils
extends Object
```
Java Mail configuration properties http://docs.oracle.com/javaee/7/api/javax/mail/internet/package-summary.html

Field Summary

Fields
Modifier and Type Field and Description

static String MAIL_REGEX

static String NO_BODY

static String NO_SUBJECT

Fields
Modifier and Type	Field and Description
`static String`	`MAIL_REGEX`
`static String`	`NO_BODY`
`static String`	`NO_SUBJECT`

Constructor Summary

Constructors
Constructor and Description

MailUtils()

Constructors
Constructor and Description
`MailUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addAttachments(String token, Mail mail, com.auxilii.msgparser.Message msg, String userId)` Add attachments to an imported mail.
`static void`	`addAttachments(String token, Mail mail, javax.mail.Part p, String userId)` Add attachments to an imported mail.
`static String`	`addressToString(javax.mail.Address a)` Conversion from Address to String.
`static boolean`	`checkRules(Mail mail, Set<MailFilterRule> filterRules)` Check mail import rules
`static javax.mail.internet.MimeMessage`	`create(String token, Mail mail)` Create a mail from a Mail object
`static void`	`forwardMail(String token, String fromAddress, Collection<String> toAddress, String message, String mailId)` Forward a mail in the repository.
`static void`	`forwardMail(String token, String fromAddress, String toAddress, String message, String mailPath)` Forward a mail in the repository.
`static Properties`	`getProperties()` Common properties for all mail sessions.
`static String`	`getTinyUrl(String fullUrl)` User tinyurl service as url shorter Depends on commons-httpclient:commons-httpclient:jar:3.0 because of org.apache.jackrabbit:jackrabbit-webdav:jar:1.6.4
`static String`	`getUserMailPath(String user)`
`static void`	`importMail(String token, String mailPath, boolean grouping, javax.mail.Folder folder, javax.mail.Message msg, MailAccount ma, Mail mail)` Import mail into OpenKM repository
`static String`	`importMessages(String token, MailAccount ma)` Import messages http://www.jguru.com/faq/view.jsp?
`static String`	`mail2html(Mail mail)` Generate HTML with mail object data and contents
`static Mail`	`messageToMail(javax.mail.Message msg)` Convert Mime Message to Mail
`static Mail`	`messageToMail(com.auxilii.msgparser.Message msg)` Convert Outlook Message to Mail
`static List<String>`	`parseMailList(String mails)` Convert string with mails to list.
`static void`	`sendDocument(String fromAddress, List<String> toAddress, String subject, String text, String docPath)` Send document to non-registered OpenKM users
`static void`	`sendDocuments(String fromAddress, List<String> toAddress, String subject, String text, List<String> docsPath)` Send document to non-registered OpenKM users
`static void`	`sendMessage(Collection<String> toAddress, String subject, String content)` Send mail without FROM addresses.
`static void`	`sendMessage(String fromAddress, List<String> toAddress, String subject, String content)` Send mail without FROM addresses.
`static void`	`sendMessage(String toAddress, String subject, String content)` Send mail without FROM addresses.
`static void`	`sendMessage(String fromAddress, String toAddress, String subject, String content)` Send mail without FROM addresses.
`static void`	`testConnection(MailAccount ma)` Test IMAP connection

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

Field Detail
- NO_SUBJECT
```
public static final String NO_SUBJECT
```
  See Also:
  
  Constant Field Values
- NO_BODY
```
public static final String NO_BODY
```
  See Also:
  
  Constant Field Values
- MAIL_REGEX
```
public static final String MAIL_REGEX
```
  See Also:
  
  Constant Field Values

Constructor Detail
- MailUtils
```
public MailUtils()
```

Method Detail

getProperties
```
public static Properties getProperties()
```
Common properties for all mail sessions.

sendMessage

public static void sendMessage(Collection<String> toAddress,
                               String subject,
                               String content)
                        throws javax.mail.MessagingException

Send mail without FROM addresses.

Parameters:: toAddress - Destination addresses.; subject - The mail subject.; content - The mail body.
Throws:: javax.mail.MessagingException - If there is any error.

sendMessage

public static void sendMessage(String toAddress,
                               String subject,
                               String content)
                        throws javax.mail.MessagingException

Send mail without FROM addresses.

Parameters:: toAddress - Destination addresses.; subject - The mail subject.; content - The mail body.
Throws:: javax.mail.MessagingException - If there is any error.

sendMessage

public static void sendMessage(String fromAddress,
                               List<String> toAddress,
                               String subject,
                               String content)
                        throws javax.mail.MessagingException

Send mail without FROM addresses.

Parameters:: toAddress - Destination addresses.; subject - The mail subject.; content - The mail body.
Throws:: javax.mail.MessagingException - If there is any error.

sendMessage

public static void sendMessage(String fromAddress,
                               String toAddress,
                               String subject,
                               String content)
                        throws javax.mail.MessagingException

Send mail without FROM addresses.

Parameters:: toAddress - Destination addresses.; subject - The mail subject.; content - The mail body.
Throws:: javax.mail.MessagingException - If there is any error.

sendDocument

public static void sendDocument(String fromAddress,
                                List<String> toAddress,
                                String subject,
                                String text,
                                String docPath)
                         throws javax.mail.MessagingException,
                                PathNotFoundException,
                                AccessDeniedException,
                                RepositoryException,
                                IOException,
                                DatabaseException

Send document to non-registered OpenKM users

Parameters:: toAddress - Destination addresses.; subject - The mail subject.; text - The mail body.
Throws:: javax.mail.MessagingException - If there is any error.; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException

sendDocuments

public static void sendDocuments(String fromAddress,
                                 List<String> toAddress,
                                 String subject,
                                 String text,
                                 List<String> docsPath)
                          throws javax.mail.MessagingException,
                                 PathNotFoundException,
                                 AccessDeniedException,
                                 RepositoryException,
                                 IOException,
                                 DatabaseException

Send document to non-registered OpenKM users

Parameters:: toAddress - Destination addresses.; subject - The mail subject.; text - The mail body.
Throws:: javax.mail.MessagingException - If there is any error.; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException

forwardMail

public static void forwardMail(String token,
                               String fromAddress,
                               String toAddress,
                               String message,
                               String mailPath)
                        throws javax.mail.MessagingException,
                               PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               IOException,
                               DatabaseException

Forward a mail in the repository.

Parameters:: token - Authentication token.; fromAddress - Origin address.; toAddress - Destination addresses.; mailPath - Path of the mail to be forwarded.
Throws:: javax.mail.MessagingException - If there is any error.; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException

forwardMail

public static void forwardMail(String token,
                               String fromAddress,
                               Collection<String> toAddress,
                               String message,
                               String mailId)
                        throws javax.mail.MessagingException,
                               PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               IOException,
                               DatabaseException

Forward a mail in the repository.

Parameters:: token - Authentication token.; fromAddress - Origin address.; toAddress - Destination addresses.; mailId - Path of the mail to be forwarded or its UUID.
Throws:: javax.mail.MessagingException - If there is any error.; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException

create

public static javax.mail.internet.MimeMessage create(String token,
                                                     Mail mail)
                                              throws javax.mail.MessagingException,
                                                     PathNotFoundException,
                                                     AccessDeniedException,
                                                     RepositoryException,
                                                     IOException,
                                                     DatabaseException

Create a mail from a Mail object

Throws:: javax.mail.MessagingException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException

importMessages
```
public static String importMessages(String token,
                                    MailAccount ma)
                             throws PathNotFoundException,
                                    ItemExistsException,
                                    VirusDetectedException,
                                    AccessDeniedException,
                                    RepositoryException,
                                    DatabaseException,
                                    UserQuotaExceededException,
                                    ExtensionException,
                                    AutomationException
```
Import messages http://www.jguru.com/faq/view.jsp?EID=26898 == Using Unique Identifier (UIDL) == Mail server assigns an unique identifier for every email in the same account. You can get as UIDL for every email by MailInfo.UIDL property. To avoid receiving the same email twice, the best way is storing the UIDL of email retrieved to a text file or database. Next time before you retrieve email, compare your local uidl list with remote uidl. If this uidl exists in your local uidl list, don't receive it; otherwise receive it. == Different property of UIDL in POP3 and IMAP4 == UIDL is always unique in IMAP4 and it is always an incremental integer. UIDL in POP3 can be any valid asc-ii characters, and an UIDL may be reused by POP3 server if email with this UIDL has been deleted from the server. Hence you are advised to remove the uidl from your local uidl list if that uidl is no longer exist on the POP3 server. == Remarks == You should create different local uidl list for different email account, because the uidl is only unique for the same account.

Throws:

PathNotFoundException

ItemExistsException

VirusDetectedException

AccessDeniedException

RepositoryException

DatabaseException

UserQuotaExceededException

ExtensionException

AutomationException

messageToMail

public static Mail messageToMail(javax.mail.Message msg)
                          throws javax.mail.MessagingException,
                                 IOException

Convert Mime Message to Mail

Throws:: javax.mail.MessagingException; IOException

messageToMail

public static Mail messageToMail(com.auxilii.msgparser.Message msg)
                          throws javax.mail.MessagingException,
                                 IOException

Convert Outlook Message to Mail

Throws:: javax.mail.MessagingException; IOException

importMail

public static void importMail(String token,
                              String mailPath,
                              boolean grouping,
                              javax.mail.Folder folder,
                              javax.mail.Message msg,
                              MailAccount ma,
                              Mail mail)
                       throws DatabaseException,
                              RepositoryException,
                              AccessDeniedException,
                              ItemExistsException,
                              PathNotFoundException,
                              javax.mail.MessagingException,
                              VirusDetectedException,
                              UserQuotaExceededException,
                              IOException,
                              ExtensionException,
                              AutomationException

Import mail into OpenKM repository

Throws:: DatabaseException; RepositoryException; AccessDeniedException; ItemExistsException; PathNotFoundException; javax.mail.MessagingException; VirusDetectedException; UserQuotaExceededException; IOException; ExtensionException; AutomationException

checkRules

public static boolean checkRules(Mail mail,
                                 Set<MailFilterRule> filterRules)

Check mail import rules

addAttachments

public static void addAttachments(String token,
                                  Mail mail,
                                  javax.mail.Part p,
                                  String userId)
                           throws javax.mail.MessagingException,
                                  IOException,
                                  UnsupportedMimeTypeException,
                                  FileSizeExceededException,
                                  UserQuotaExceededException,
                                  VirusDetectedException,
                                  ItemExistsException,
                                  PathNotFoundException,
                                  AccessDeniedException,
                                  RepositoryException,
                                  DatabaseException,
                                  ExtensionException,
                                  AutomationException

Add attachments to an imported mail.

Throws:: javax.mail.MessagingException; IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException

addressToString

public static String addressToString(javax.mail.Address a)

Conversion from Address to String.

getUserMailPath

public static String getUserMailPath(String user)

getTinyUrl
```
public static String getTinyUrl(String fullUrl)
                         throws org.apache.commons.httpclient.HttpException,
                                IOException
```
User tinyurl service as url shorter Depends on commons-httpclient:commons-httpclient:jar:3.0 because of org.apache.jackrabbit:jackrabbit-webdav:jar:1.6.4

Throws:

org.apache.commons.httpclient.HttpException

IOException

testConnection

public static void testConnection(MailAccount ma)
                           throws IOException

Test IMAP connection

Throws:: IOException

addAttachments

public static void addAttachments(String token,
                                  Mail mail,
                                  com.auxilii.msgparser.Message msg,
                                  String userId)
                           throws DatabaseException,
                                  RepositoryException,
                                  PathNotFoundException,
                                  ItemExistsException,
                                  VirusDetectedException,
                                  UserQuotaExceededException,
                                  UnsupportedMimeTypeException,
                                  ExtensionException,
                                  AccessDeniedException,
                                  IOException,
                                  AutomationException,
                                  FileSizeExceededException

Add attachments to an imported mail.

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

mail2html

public static String mail2html(Mail mail)
                        throws ConversionException

Generate HTML with mail object data and contents

Throws:: ConversionException

parseMailList

public static List<String> parseMailList(String mails)

Convert string with mails to list.

Class MailUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_SUBJECT

NO_BODY

MAIL_REGEX

Constructor Detail

MailUtils

Method Detail

getProperties

sendMessage

sendMessage

sendMessage

sendMessage

sendDocument

sendDocuments

forwardMail

forwardMail

create

importMessages

messageToMail

messageToMail

importMail

checkRules

addAttachments

addressToString

getUserMailPath

getTinyUrl

testConnection

addAttachments

mail2html

parseMailList