org.opencms.mail

类 CmsMailSettings

java.lang.Object

org.opencms.mail.CmsMailSettings

public class CmsMailSettings
extends java.lang.Object

Contains the settings for the OpenCms mail service.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	MAIL_DEFAULT_PROTOCOL The default protocol for sending mail ("smtp").
static java.lang.String	MAIL_DEFAULT_SENDER The default mail from address.

构造器概要

构造器

构造器和说明
CmsMailSettings() Empty constructor, required for configuration.

方法概要

方法

限定符和类型	方法和说明
void	addMailHost(java.lang.String hostname, java.lang.String order, java.lang.String protocol, java.lang.String username, java.lang.String password) Adds a new mail host to the internal list of mail hosts with default port 25.
void	addMailHost(java.lang.String hostname, java.lang.String port, java.lang.String order, java.lang.String protocol, java.lang.String username, java.lang.String password) Adds a new mail host to the internal list of mail hosts.
CmsMailHost	getDefaultMailHost() Returns the default mail host.
java.lang.String	getMailFromDefault() Returns the mail from default sender.
java.util.List<CmsMailHost>	getMailHosts() Returns an unmodifiable sorted list of all configured mail hosts.
void	setMailFromDefault(java.lang.String sender) Sets the mail from default sender.
java.lang.String	toString()

从类继承的方法 java.lang.Object

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

字段详细资料

MAIL_DEFAULT_PROTOCOL

public static final java.lang.String MAIL_DEFAULT_PROTOCOL

The default protocol for sending mail ("smtp").

另请参阅:

常量字段值

MAIL_DEFAULT_SENDER

public static final java.lang.String MAIL_DEFAULT_SENDER

The default mail from address.

另请参阅:

常量字段值

构造器详细资料

CmsMailSettings

public CmsMailSettings()

Empty constructor, required for configuration.

方法详细资料

addMailHost

public void addMailHost(java.lang.String hostname,
               java.lang.String order,
               java.lang.String protocol,
               java.lang.String username,
               java.lang.String password)

Adds a new mail host to the internal list of mail hosts with default port 25.

参数:

hostname - the name of the mail host

order - the order in which the host is tried

protocol - the protocol to use (default "smtp")

username - the user name to use for authentication

password - the password to use for authentication

addMailHost

public void addMailHost(java.lang.String hostname,
               java.lang.String port,
               java.lang.String order,
               java.lang.String protocol,
               java.lang.String username,
               java.lang.String password)

Adds a new mail host to the internal list of mail hosts.

参数:

hostname - the name of the mail host

port - the port of the mail host

order - the order in which the host is tried

protocol - the protocol to use (default "smtp")

username - the user name to use for authentication

password - the password to use for authentication

getDefaultMailHost

public CmsMailHost getDefaultMailHost()

Returns the default mail host.

返回:

the default mail host

getMailFromDefault

public java.lang.String getMailFromDefault()

Returns the mail from default sender.

返回:

the mail from default sender

getMailHosts

public java.util.List<CmsMailHost> getMailHosts()

Returns an unmodifiable sorted list of all configured mail hosts.

返回:

an unmodifiable sorted list of all configured mail hosts

setMailFromDefault

public void setMailFromDefault(java.lang.String sender)

Sets the mail from default sender.

参数:

sender - the mail from default sender to set

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()