Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface SMTPLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

SMTPclient

public interface SMTPLibrary
extends CMLibrary

This library is an SMTP client, and probably won't remain a library forever, as it really belongs in common. Anyway, it handles the sending of emails to far and exciting places.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SMTPLibrary.SMTPClient	Interface for the underlying smtp client class, as opposed to tbe big bad library with its fancy abstract methods.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PORT	Default port number
static int	DEFAULT_TIMEOUT	default timeout
static java.lang.String	EOL	network end of line

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
boolean	emailIfPossible(java.lang.String fromName, java.lang.String toName, java.lang.String subj, java.lang.String msg)	Attempts to send an email to the given recipient, using the INI file smtp server if available, or directly if not.
boolean	emailIfPossible(java.lang.String SMTPServerInfo, java.lang.String from, java.lang.String replyTo, java.lang.String to, java.lang.String subject, java.lang.String message)	Attempts to connect to the given email server and send the given email to the given target address.
void	emailOrJournal(java.lang.String from, java.lang.String replyTo, java.lang.String to, java.lang.String subject, java.lang.String message)	Sends an email or a journal message from a variety of argument formats.
SMTPLibrary.SMTPClient	getClient(java.lang.String emailAddress)	Builds an smtp client based on the given email address for a target.
SMTPLibrary.SMTPClient	getClient(java.lang.String SMTPServerInfo, int port)	Builds an smtp client based on the given host/port info.
boolean	isValidEmailAddress(java.lang.String addy)	Checks the given string to see if it appears to be a valid email address.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

DEFAULT_PORT

static final int DEFAULT_PORT

Default port number

See Also:

Constant Field Values

EOL

static final java.lang.String EOL

network end of line

See Also:

Constant Field Values

DEFAULT_TIMEOUT

static final int DEFAULT_TIMEOUT

default timeout

See Also:

Constant Field Values

Method Detail

isValidEmailAddress

boolean isValidEmailAddress(java.lang.String addy)

Checks the given string to see if it appears to be a valid email address.

Parameters:

addy - the string to check

Returns:

true if it looks emaily, false otherwise

emailIfPossible

boolean emailIfPossible(java.lang.String SMTPServerInfo,
                        java.lang.String from,
                        java.lang.String replyTo,
                        java.lang.String to,
                        java.lang.String subject,
                        java.lang.String message)
                 throws java.io.IOException

Attempts to connect to the given email server and send the given email to the given target address.

Parameters:

SMTPServerInfo - the server hostname to connect through, or null to attempt a direct transmission.

from - the from email address

replyTo - the reply-to email address

to - the target email address, which may be used as a direct-connect host also

subject - the subject of the message

message - the message itself

Returns:

true if the email was sent, false otherwise

Throws:

java.io.IOException - any I/O errors that occur

See Also:

emailIfPossible(String, String, String, String), emailOrJournal(String, String, String, String, String)

emailIfPossible

boolean emailIfPossible(java.lang.String fromName,
                        java.lang.String toName,
                        java.lang.String subj,
                        java.lang.String msg)

Attempts to send an email to the given recipient, using the INI file smtp server if available, or directly if not.

Parameters:

fromName - the from email address

toName - the target email address, which may be used as a direct-connect host also

subj - the subject of the message

msg - the message itself

Returns:

if the email was sent, false otherwise

See Also:

emailIfPossible(String, String, String, String, String, String), emailOrJournal(String, String, String, String, String)

emailOrJournal

void emailOrJournal(java.lang.String from,
                    java.lang.String replyTo,
                    java.lang.String to,
                    java.lang.String subject,
                    java.lang.String message)

Sends an email or a journal message from a variety of argument formats. Also appends the disclaimer, and the unsubscribe link if necessary.

Parameters:

from - from character name, or from email address

replyTo - reply to character name, or email address

to - target to character name, or email address

subject - the subject of the message

message - the main message

See Also:

emailIfPossible(String, String, String, String, String, String), emailIfPossible(String, String, String, String)

getClient

SMTPLibrary.SMTPClient getClient(java.lang.String SMTPServerInfo,
                                 int port)
                          throws java.net.UnknownHostException,
                                 java.io.IOException

Builds an smtp client based on the given host/port info.

Parameters:

SMTPServerInfo - the smtp server host with optional override port

port - the port for the smtp server

Returns:

the client object to send emails through

Throws:

java.net.UnknownHostException - the smtp host couldn't be found

java.io.IOException - any I/O errors that occur

See Also:

getClient(String)

getClient

SMTPLibrary.SMTPClient getClient(java.lang.String emailAddress)
                          throws java.io.IOException,
                                 BadEmailAddressException

Builds an smtp client based on the given email address for a target.

Parameters:

emailAddress - the email address to extract the smtp server host from

Returns:

the client object to send emails through

Throws:

BadEmailAddressException - the email address was just bad

java.io.IOException - any I/O errors that occur

See Also:

getClient(String, int)