lazyj.mail

Class Sendmail

java.lang.Object

lazyj.mail.Sendmail

public class Sendmail
extends java.lang.Object

Class for sending mails.

Since:

2006-10-06

Author:

costing

See Also:

Mail

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CRLF What is an CRLF ?
int	iSentOk Result of the sending operation.
static int	LINE_MAX_LENGTH What is the current limit for a line.
java.util.List<java.lang.String>	lInvalidAddresses Recipient addresses that were rejected by the mail server
static int	SENT_ERROR The mail could not be sent.
static int	SENT_OK Everything was ok when sending.
static int	SENT_WARNING There are some warnings, but the mail was sent.
java.lang.String	sError Reason of the failure

Constructor Summary

Constructors

Constructor and Description
Sendmail(java.lang.String sFrom) The simplest constructor.
Sendmail(java.lang.String sFrom, java.lang.String sServerAddress) Constructor used to specify also the server to send this mail through.
Sendmail(java.lang.String sFrom, java.lang.String sServerAddress, int iServerPort) Full-options constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	quickSend(Mail m) Convenience mail for quick sending of emails.
boolean	registerFilter(MailFilter filter) Register another filter that is to be called before sending each mail
boolean	send(Mail mail) Send the given mail.
void	setDebug(boolean bDebug) Enable debugging (printing all lines of the email to the standard error).
java.lang.String	setHELO(java.lang.String s) Set an override to HELO SMTP command.
java.lang.String	setMAILFROM(java.lang.String s) Set an override to the MAIL FROM SMTP command.
boolean	unregisterFilter(MailFilter filter) Unregister a filter

Methods inherited from class java.lang.Object

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

Field Detail

LINE_MAX_LENGTH

public static final int LINE_MAX_LENGTH

What is the current limit for a line. If the line is longer it will be split with '=' at the end and will be continued on the next line.

See Also:

Constant Field Values

SENT_OK

public static final int SENT_OK

Everything was ok when sending.

See Also:

Constant Field Values

SENT_WARNING

public static final int SENT_WARNING

There are some warnings, but the mail was sent.

See Also:

Constant Field Values

SENT_ERROR

public static final int SENT_ERROR

The mail could not be sent.

See Also:

Constant Field Values

iSentOk

public int iSentOk

Result of the sending operation.

sError

public java.lang.String sError

Reason of the failure

lInvalidAddresses

public java.util.List<java.lang.String> lInvalidAddresses

Recipient addresses that were rejected by the mail server

CRLF

public static final java.lang.String CRLF

What is an CRLF ?

See Also:

Constant Field Values

Constructor Detail

Sendmail

public Sendmail(java.lang.String sFrom)

The simplest constructor. It only need the email address of the sender. The default server that will be used is 127.0.0.1:25.

Parameters:

sFrom - sender email address

Sendmail

public Sendmail(java.lang.String sFrom,
        java.lang.String sServerAddress)

Constructor used to specify also the server to send this mail through.

Parameters:

sFrom - sender mail address

sServerAddress - server to send the mails through

Sendmail

public Sendmail(java.lang.String sFrom,
        java.lang.String sServerAddress,
        int iServerPort)

Full-options constructor.

Parameters:

sFrom - sender mail address

sServerAddress - server to send the mails through

iServerPort - server port

Method Detail

registerFilter

public boolean registerFilter(MailFilter filter)

Register another filter that is to be called before sending each mail

Parameters:

filter -

Returns:

true if registration was successful, false if not (filter already registered)

Since:

1.0.6

unregisterFilter

public boolean unregisterFilter(MailFilter filter)

Unregister a filter

Parameters:

filter -

Returns:

true if this filter was previously registered

Since:

1.0.6

setHELO

public java.lang.String setHELO(java.lang.String s)

Set an override to HELO SMTP command. By default the string that is sent is extracted from the "From" header, taking only the string after "@". A null value will return to the default behavior.

Parameters:

s - string to send to the SMTP server

Returns:

old value of the override

setMAILFROM

public java.lang.String setMAILFROM(java.lang.String s)

Set an override to the MAIL FROM SMTP command. By default the string that is sent is either the "Return-Path" (MailHeader.sReturnPath, if this is not specified, the "From" (MailHeader.sFrom) field. A value of null will return the code to the default behavior.

Parameters:

s - email address to give to MAIL FROM

Returns:

old value of the override

setDebug

public void setDebug(boolean bDebug)

Enable debugging (printing all lines of the email to the standard error).

Parameters:

bDebug - debug flag

send

public boolean send(Mail mail)

Send the given mail. This method will return true if everything is ok, false on any error. You can later check sError to see what went wrong.

Parameters:

mail - mail to be sent

Returns:

true if everything is ok, false on any error.

quickSend

public static boolean quickSend(Mail m)

Convenience mail for quick sending of emails. It will take the "From" field from the given Mail object.

Parameters:

m - the mail to send. Remember to fill at least MailHeader.sFrom, MailHeader.sTo and some Mail.sBody.

Returns:

true if the sending was ok, false otherwise