se.entra.phantom.server.extra

Class SendMail

java.lang.Object

se.entra.phantom.server.extra.SendMail

public class SendMail
extends Object

The NetPhantoms API for sending mail.

Uses SMTP protocol (port 25, or other port set using the setPort method).

Constructor Summary

Constructors

Constructor and Description
SendMail() Creates a new instance of the SendMail class.

Method Summary

Modifier and Type	Method and Description
void	send() Send a message.
void	sendError(String toEmail, String error) Send an Error message to an email address.
void	setAuthPassword(String password) Set the authentication password.
void	setAuthUser(String user) Set the authentication user.
void	setBccEmail(String recipient) Set the blind carbon copy recipient(s) for this email.
void	setCcEmail(String recipient) Set the carbon copy recipient(s) for this email.
void	setContentType(String type) Sets the content type of the message.
void	setDebug(boolean doDebug) Sets debugging mode.
void	setFromEmail(String sender) Set the senders email address.
void	setHost(String host) The SMTP host.
void	setMessageBody(String message) Set the body of the message.
void	setPort(String port) Set the port on the host to use.
void	setReplyToEmail(String reply) Set the Reply To email address(es).
void	setServer(String server) The server.
void	setSSL() Set the flag indicating that SSL should be used.
void	setSubject(String subject) Set the message subject.
void	setToEmail(String recipient) Set the recipient(s) for this email.
void	setXMailer(String mailer) Sets the X-mailer string.

Methods inherited from class java.lang.Object

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

Constructor Detail

SendMail

public SendMail()

Creates a new instance of the SendMail class.

Method Detail

setDebug

public void setDebug(boolean doDebug)

Sets debugging mode.

setXMailer

public void setXMailer(String mailer)

Sets the X-mailer string.

setToEmail

public void setToEmail(String recipient)

Set the recipient(s) for this email.

Parameters:

recipient - A string containing one or more email addresses. If there are more than one, they must be separated by a comma or semi-colon.

setCcEmail

public void setCcEmail(String recipient)

Set the carbon copy recipient(s) for this email.

Parameters:

recipient - A string containing one or more email addresses. If there are more than one, they must be separated by a comma or semi-colon.

setBccEmail

public void setBccEmail(String recipient)

Set the blind carbon copy recipient(s) for this email.

Parameters:

recipient - A string containing one or more email addresses. If there are more than one, they must be separated by a comma or semi-colon.

setFromEmail

public void setFromEmail(String sender)

Set the senders email address.

This can either be the complete email address, or just the senders id. In the later case it will be combined with the host name to create the complete senders email address.

Parameters:

sender - The senders email address.

setReplyToEmail

public void setReplyToEmail(String reply)

Set the Reply To email address(es).

This can either be the complete email address, or just the senders id. In the later case it will be combined with the host name to create the complete senders email address.

Parameters:

reply - The reply-to email address.

setServer

public void setServer(String server)

The server.

If the senders email address is missing the host, then this host name will be added to the senders email address.

setHost

public void setHost(String host)

The SMTP host.

This will be used for setting the system property "mail.smtp.host". The default value is "mail".

Parameters:

host -

setSubject

public void setSubject(String subject)

Set the message subject.

setMessageBody

public void setMessageBody(String message)

Set the body of the message.

Parameters:

message - The mails body.

setContentType

public void setContentType(String type)

Sets the content type of the message.

The default type is "text/plain".

Parameters:

type - The new content type.

setPort

public void setPort(String port)

Set the port on the host to use.

Parameters:

port - The host port.

setAuthUser

public void setAuthUser(String user)

Set the authentication user.

Parameters:

user - The authentication user.

setAuthPassword

public void setAuthPassword(String password)

Set the authentication password.

Parameters:

password - The authentication password.

setSSL

public void setSSL()

Set the flag indicating that SSL should be used.

sendError

public void sendError(String toEmail,
                      String error)
               throws Exception

Send an Error message to an email address. Good template for remote error notification.

Throws:

Exception

send

public void send()
          throws Exception

Send a message.

Throws:

Exception