org.botlibre.sense.email

Class Email

java.lang.Object

org.botlibre.sense.BasicSense

org.botlibre.sense.email.Email

All Implemented Interfaces:

Sense

public class Email
extends BasicSense

Receive and respond to incoming email. Can use any pop mail server, such as gmail.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_EMAIL
static java.lang.String	SIGNATURE
static int	SLEEP
static int	TIMEOUT

Fields inherited from class org.botlibre.sense.BasicSense

conversations, DAY, DEFAULT_SPEAKER, engaged, HOUR, MAX_FILE_SIZE, MINUTE, RETRY

Constructor Summary

Constructors

Constructor and Description
Email()

Method Summary

Modifier and Type	Method and Description
void	checkEmail() Check the inbox for new messages, and process each message.
void	connect() Connect and verify the email settings.
javax.mail.Session	connectSession()
javax.mail.Store	connectStore()
javax.mail.Store	connectStoreSSL()
void	email(Vertex source, Vertex replyTo, Vertex subject, Vertex message)
java.lang.String	getEmailAddress()
int	getEmails()
int	getEmailsProcessed()
java.lang.String	getFrom(javax.mail.Message message)
java.util.List<java.lang.String>	getInbox() Return a list in inbox message headers.
java.lang.String	getIncomingHost()
int	getIncomingPort()
int	getMaxEmails()
java.lang.String	getOutgoingHost()
int	getOutgoingPort()
java.lang.String	getPassword()
java.lang.String	getProtocol()
java.lang.String	getRecipient(javax.mail.Message message)
java.util.List<java.lang.String>	getSent() Return a list in inbox message headers.
java.lang.String	getSignature()
java.lang.String	getUsername()
void	initProperties() Load settings.
void	input(java.lang.Object input, Network network) Process the email message.
void	inputSentence(java.lang.String text, java.lang.String subject, java.lang.String userName, java.lang.String targetUserName, javax.mail.Message message, Network network) Process the text sentence.
boolean	isSSLRequired()
void	migrateProperties() Migrate to new properties system.
void	output(Vertex output) Output the email reply.
void	saveProperties()
void	sendEmail(java.lang.String text, java.lang.String subject, java.lang.String replyTo) Send the email reply.
void	setEmailAddress(java.lang.String emailAddress)
void	setEmails(int emails)
void	setEmailsProcessed(int emailsProcessed)
void	setIncomingHost(java.lang.String incomingHost)
void	setIncomingPort(int incomingPort)
void	setIsEnabled(boolean isEnabled) Allow the sense to disabled/enabled.
void	setMaxEmails(int maxEmails)
void	setOutgoingHost(java.lang.String outgoingHost)
void	setOutgoingPort(int outgoingPort)
void	setPassword(java.lang.String password)
void	setProtocol(java.lang.String protocol)
void	setSignature(java.lang.String signature)
void	setSSLRequired(boolean isSSLRequired)
void	setUsername(java.lang.String username)
void	startCheckingEmail()

Methods inherited from class org.botlibre.sense.BasicSense

addListener, awake, checkEngaged, checkSentence, discover, discoverSentence, getAction, getBot, getEmotionalState, getLanguageState, getListeners, getName, getPrimitive, getResponseListener, getShortTermMemory, initialize, input, isEnabled, log, log, log, notifyExceptionListeners, notifyResponseListener, pool, printInput, removeListener, setAction, setBot, setEmotionalState, setLanguageState, setName, setResponseListener, shutdown, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SLEEP

public static int SLEEP

SIGNATURE

public static java.lang.String SIGNATURE

DEFAULT_EMAIL

public static java.lang.String DEFAULT_EMAIL

TIMEOUT

public static int TIMEOUT

Constructor Detail

Email

public Email()

Method Detail

migrateProperties

public void migrateProperties()

Migrate to new properties system.

Specified by:

migrateProperties in interface Sense

Overrides:

migrateProperties in class BasicSense

initProperties

public void initProperties()

Load settings.

saveProperties

public void saveProperties()

Specified by:

saveProperties in interface Sense

Overrides:

saveProperties in class BasicSense

setIsEnabled

public void setIsEnabled(boolean isEnabled)

Description copied from class: BasicSense

Allow the sense to disabled/enabled.

Specified by:

setIsEnabled in interface Sense

Overrides:

setIsEnabled in class BasicSense

startCheckingEmail

public void startCheckingEmail()

connectStore

public javax.mail.Store connectStore()
                              throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

connectStoreSSL

public javax.mail.Store connectStoreSSL()
                                 throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

checkEmail

public void checkEmail()

Check the inbox for new messages, and process each message.

connect

public void connect()

Connect and verify the email settings.

getInbox

public java.util.List<java.lang.String> getInbox()

Return a list in inbox message headers.

getSent

public java.util.List<java.lang.String> getSent()

Return a list in inbox message headers.

connectSession

public javax.mail.Session connectSession()

email

public void email(Vertex source,
                  Vertex replyTo,
                  Vertex subject,
                  Vertex message)

sendEmail

public void sendEmail(java.lang.String text,
                      java.lang.String subject,
                      java.lang.String replyTo)

Send the email reply.

getRecipient

public java.lang.String getRecipient(javax.mail.Message message)
                              throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getFrom

public java.lang.String getFrom(javax.mail.Message message)
                         throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

input

public void input(java.lang.Object input,
                  Network network)
           throws java.lang.Exception

Process the email message.

Specified by:

input in interface Sense

Overrides:

input in class BasicSense

Throws:

java.lang.Exception

output

public void output(Vertex output)

Output the email reply.

Specified by:

output in interface Sense

Overrides:

output in class BasicSense

getSignature

public java.lang.String getSignature()

setSignature

public void setSignature(java.lang.String signature)

getEmailAddress

public java.lang.String getEmailAddress()

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

getIncomingHost

public java.lang.String getIncomingHost()

setIncomingHost

public void setIncomingHost(java.lang.String incomingHost)

getIncomingPort

public int getIncomingPort()

setIncomingPort

public void setIncomingPort(int incomingPort)

getOutgoingHost

public java.lang.String getOutgoingHost()

setOutgoingHost

public void setOutgoingHost(java.lang.String outgoingHost)

getOutgoingPort

public int getOutgoingPort()

setOutgoingPort

public void setOutgoingPort(int outgoingPort)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getProtocol

public java.lang.String getProtocol()

setProtocol

public void setProtocol(java.lang.String protocol)

isSSLRequired

public boolean isSSLRequired()

setSSLRequired

public void setSSLRequired(boolean isSSLRequired)

getMaxEmails

public int getMaxEmails()

setMaxEmails

public void setMaxEmails(int maxEmails)

getEmails

public int getEmails()

setEmails

public void setEmails(int emails)

getEmailsProcessed

public int getEmailsProcessed()

setEmailsProcessed

public void setEmailsProcessed(int emailsProcessed)

inputSentence

public void inputSentence(java.lang.String text,
                          java.lang.String subject,
                          java.lang.String userName,
                          java.lang.String targetUserName,
                          javax.mail.Message message,
                          Network network)
                   throws javax.mail.MessagingException

Process the text sentence.

Throws:

javax.mail.MessagingException