org.xmlBlaster.util.admin
Interface I_AdminSmtpClient

All Superinterfaces:

I_AdminUsage

All Known Subinterfaces:

SmtpClientMBean

All Known Implementing Classes:

SmtpClient

public interface I_AdminSmtpClient
extends I_AdminUsage

Declares available methods to control the POP3 email poller.

Since:

1.0.8

Author:

xmlBlaster@marcelruff.info

See Also:

SmtpClient

Method Summary

int	getAsyncSendQueueSizeMax()
int	getSmtpConnectionTimeout() mail.smtp.connectiontimeout Socket connection timeout value in milliseconds.
int	getSmtpIoTimeout() mail.smtp.timeout Socket I/O timeout value in milliseconds.
java.lang.String	getSmtpUrl() Access the SMTP access uri, for example "smtp://aUser:mypassword@mySmtpHost.org:25"
boolean	isAddExpiresHeader() If the message to send has an expiry date and this addExpiresHeader=true we send an 'Expires:' header in the email (Expiry Date Indication).
boolean	isAsyncSendQueueBlockOnOverflow()
boolean	isBreakLongMessageIdLine() Defaults to false.
boolean	isContentForceBase64() Force the MsgUnit attachment to always be base64 encoded.
boolean	isMessageIdForceBase64()
void	setAddExpiresHeader(boolean addExpiresHeader) Add 'Expires:' email header.
void	setAsyncSendQueueBlockOnOverflow(boolean asyncSendQueueBlockOnOverflow)
void	setBreakLongMessageIdLine(boolean breakLongMessageIdLine) Defaults to false.
void	setContentForceBase64(boolean contentForceBase64) Setting this to true we can force the MsgUnit attachment to always be base64 encoded.
void	setMessageIdForceBase64(boolean messageIdForceBase64) Setting this to true we can force the messageId attachment to always be base64 encoded.
void	setSmtpUrl(java.lang.String uri)

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage

getUsageUrl, setUsageUrl, usage

Method Detail

isContentForceBase64

boolean isContentForceBase64()

Force the MsgUnit attachment to always be base64 encoded.

Returns:

Force base64

setContentForceBase64

void setContentForceBase64(boolean contentForceBase64)

Setting this to true we can force the MsgUnit attachment to always be base64 encoded.
Javamail does base64 encoding automatically if need so the default of this variable is false.

Parameters:

contentForceBase64 -

isMessageIdForceBase64

boolean isMessageIdForceBase64()

Returns:

Returns the messageIdForceBase64.

setMessageIdForceBase64

void setMessageIdForceBase64(boolean messageIdForceBase64)

Setting this to true we can force the messageId attachment to always be base64 encoded.
Javamail does base64 encoding automatically if need so the default of this variable is false.

isAddExpiresHeader

boolean isAddExpiresHeader()

If the message to send has an expiry date and this addExpiresHeader=true we send an 'Expires:' header in the email (Expiry Date Indication).
Supported as new RFC 822 header (Expires:). In general, no automatic action can be expected by MTAs.
Defaults to true.

See Also:

http://www.faqs.org/rfcs/rfc2156.html

setAddExpiresHeader

void setAddExpiresHeader(boolean addExpiresHeader)

Add 'Expires:' email header. If the message to send has an expiry date and this addExpiresHeader=true we send an 'Expires:' header in the email (Expiry Date Indication).
Supported as new RFC 822 header (Expires:). In general, no automatic action can be expected by MTAs.
Defaults to true.

See Also:

http://www.faqs.org/rfcs/rfc2156.html

isBreakLongMessageIdLine

boolean isBreakLongMessageIdLine()

Defaults to false.

Returns:

Returns the breakLongMessageIdLine.

setBreakLongMessageIdLine

void setBreakLongMessageIdLine(boolean breakLongMessageIdLine)

Defaults to false. If set to true tries to keep the <messageId> markup in lines shorter than 72 characters.

Parameters:

breakLongMessageIdLine - The breakLongMessageIdLine to set.

getSmtpUrl

java.lang.String getSmtpUrl()

Access the SMTP access uri, for example "smtp://aUser:mypassword@mySmtpHost.org:25"

Returns:

The SMTP server uri

setSmtpUrl

void setSmtpUrl(java.lang.String uri)

Parameters:

uri - For example "smtp://aUser:mypassword@mySmtpHost.org:25"

getSmtpIoTimeout

int getSmtpIoTimeout()

mail.smtp.timeout Socket I/O timeout value in milliseconds. Default is infinite timeout.

getSmtpConnectionTimeout

int getSmtpConnectionTimeout()

mail.smtp.connectiontimeout Socket connection timeout value in milliseconds. Default is infinite timeout.

getAsyncSendQueueSizeMax

int getAsyncSendQueueSizeMax()

isAsyncSendQueueBlockOnOverflow

boolean isAsyncSendQueueBlockOnOverflow()

Returns:

the asyncSendQueueBlockOnOverflow

setAsyncSendQueueBlockOnOverflow

void setAsyncSendQueueBlockOnOverflow(boolean asyncSendQueueBlockOnOverflow)

Parameters:

asyncSendQueueBlockOnOverflow - the asyncSendQueueBlockOnOverflow to set