org.nuclos.api.provider

Class MailProvider

java.lang.Object

org.nuclos.api.provider.MailProvider

public class MailProvider
extends java.lang.Object

This class is used in rule programming and provides methods for sending and receiving E-mails.

Please check Nuclos system parameter for setting connection parameter like POP3/SMTP

Author:

Matthias Reichart

Constructor Summary

Constructors

Constructor and Description
MailProvider()

Method Summary

Modifier and Type	Method and Description
static java.util.List<NuclosMail>	receive(boolean bDeleteMails) This method retrieves all NuclosMails that can be found in the Inbox of the account mentioned in the system parameters.
static java.util.List<NuclosMail>	receive(java.lang.String folderFrom, boolean bDeleteMails) This method retrieves all NuclosMails that can be found in the specified folder of the account mentioned in the system parameters.
static void	send(NuclosMail mail) This method sends a NuclosMail All connection settings like POP3/SMTP must be set in Nuclos as system parameters
void	setMailService(MailService repService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailProvider

public MailProvider()

Method Detail

setMailService

public void setMailService(MailService repService)

send

public static void send(NuclosMail mail)
                 throws BusinessException

This method sends a NuclosMail All connection settings like POP3/SMTP must be set in Nuclos as system parameters

Parameters:

mail - NuclosMail - email to send

Throws:

BusinessException

receive

public static java.util.List<NuclosMail> receive(boolean bDeleteMails)
                                          throws BusinessException

This method retrieves all NuclosMails that can be found in the Inbox of the account mentioned in the system parameters.

If argument 'bDeleteMails' is true, all mails will be deleted after retrieving them from the server.

All connection settings like POP3/SMTP must be set in Nuclos as system parameters

Parameters:

bDeleteMails - - bDeleteMails

Returns:

List of NuclosFile

Throws:

BusinessException

receive

public static java.util.List<NuclosMail> receive(java.lang.String folderFrom,
                                                 boolean bDeleteMails)
                                          throws BusinessException

This method retrieves all NuclosMails that can be found in the specified folder of the account mentioned in the system parameters.

Fetching mails from specific folders only works via IMAP. For POP3 the folder is always "INBOX".

If argument 'bDeleteMails' is true, all mails will be deleted after retrieving them from the server.

All connection settings like POP3/SMTP must be set in Nuclos as system parameters

Parameters:

folderFrom -

bDeleteMails - - bDeleteMails

Returns:

List of NuclosFile

Throws:

BusinessException