sirius.web.mails

Class SMTPConfiguration

java.lang.Object

sirius.web.mails.SMTPConfiguration

public class SMTPConfiguration
extends Object

Represents a configuration for using a SMTP server.

Constructor Summary

Constructors

Constructor and Description
SMTPConfiguration() Creates a new configuration based on either the system configuration or the current scope.

Method Summary

Modifier and Type	Method and Description
static String	getDefaultSender() Returns the default sender from the system configuration.
static String	getDefaultSenderName() Returns the default sender name from the system configuration.
String	getMailHost() Returns the hostname of the mail server to be used.
String	getMailPassword() Returns the password used to authenticate against the mail server
String	getMailPort() Returns the port used to connect to the mail server
String	getMailSender() Returns the sender address used when no other address is supplied.
String	getMailSenderName() Returns the sender name which is used when no other sender name is supplied.
String	getMailUser() Returns the username used to authenticate against the mail server
boolean	isUseSenderAndEnvelopeFrom() Determines if mails sent via this configuration use a "Sender" and "Envelope-From" header with the mail sender / senderName or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

SMTPConfiguration

public SMTPConfiguration()

Creates a new configuration based on either the system configuration or the current scope.

Therefore such an instance must not be cached or reused.

Method Detail

getDefaultSender

public static String getDefaultSender()

Returns the default sender from the system configuration.

Returns:

the email address used as sender

getDefaultSenderName

public static String getDefaultSenderName()

Returns the default sender name from the system configuration.

Returns:

the name used as sender

getMailHost

public String getMailHost()

Returns the hostname of the mail server to be used.

Returns:

the hostname or ip address of the mail server

getMailPort

public String getMailPort()

Returns the port used to connect to the mail server

Returns:

the port used to connect to the mail server (Default for SMTP is 25)

getMailUser

public String getMailUser()

Returns the username used to authenticate against the mail server

Returns:

the username used for authentication

getMailPassword

public String getMailPassword()

Returns the password used to authenticate against the mail server

Returns:

the password used for authentication

getMailSender

public String getMailSender()

Returns the sender address used when no other address is supplied.

Also if isUseSenderAndEnvelopeFrom() is true, this is used as "Sender" as well as the "Envelope-Sender"

Returns:

the sender address used if no other address is supplied

getMailSenderName

public String getMailSenderName()

Returns the sender name which is used when no other sender name is supplied.

Returns:

the name of the sender which is used when no other sender is given

isUseSenderAndEnvelopeFrom

public boolean isUseSenderAndEnvelopeFrom()

Determines if mails sent via this configuration use a "Sender" and "Envelope-From" header with the mail sender / senderName or not.

Returns:

true if a "sender" / "Envelope-From" header should be set, false otherwise