MailAccount (bus-all 5.6.6 API)

java.lang.Object
- org.aoju.bus.extra.mail.MailAccount

All Implemented Interfaces:

Serializable
```
public class MailAccount
extends Object
implements Serializable
```
邮件账户对象

Since:

JDK 1.8+

Version:

5.6.6

Author:

Kimi Liu

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String MAIL_SETTING_PATH

Fields
Modifier and Type	Field and Description
`static String`	`MAIL_SETTING_PATH`

Constructor Summary

Constructors
Constructor and Description

MailAccount()
构造,所有参数需自行定义或保持默认值

MailAccount(Setting setting)
构造

MailAccount(String settingPath)
构造

Constructors
Constructor and Description
`MailAccount()` 构造,所有参数需自行定义或保持默认值
`MailAccount(Setting setting)` 构造
`MailAccount(String settingPath)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MailAccount`	`defaultIfEmpty()` 如果某些值为null,使用默认值
`Charset`	`getCharset()` 获取字符集编码
`String`	`getFrom()` 获取发送方,遵循RFC-822标准
`String`	`getHost()` 获得SMTP服务器域名
`String`	`getPass()` 获取密码
`Integer`	`getPort()` 获得SMTP服务端口
`Properties`	`getSmtpProps()` 获得SMTP相关信息
`String`	`getSocketFactoryClass()` 获取指定实现javax.net.SocketFactory接口的类的名称,这个类将被用于创建SMTP的套接字
`int`	`getSocketFactoryPort()` 获取指定的端口连接到在使用指定的套接字工厂如果没有设置,将使用默认端口
`String`	`getUser()` 获取用户名
`Boolean`	`isAuth()` 是否需要用户名密码验证
`boolean`	`isDebug()` 是否打开调试模式,调试模式会显示与邮件服务器通信过程,默认不开启
`boolean`	`isSocketFactoryFallback()` 如果设置为true,未能创建一个套接字使用指定的套接字工厂类将导致使用java.net.Socket创建的套接字类, 默认值为true
`boolean`	`isSplitlongparameters()` 对于超长参数是否切分为多份,默认为false（国内邮箱附件不支持切分的附件名）
`Boolean`	`isSslEnable()` 是否使用 SSL安全连接
`boolean`	`isStartttlsEnable()` 是否使用 STARTTLS安全连接,STARTTLS是对纯文本通信协议的扩展它将纯文本连接升级为加密连接（TLS或SSL）, 而不是使用一个单独的加密通信端口
`MailAccount`	`setAuth(boolean isAuth)` 设置是否需要用户名密码验证
`MailAccount`	`setCharset(Charset charset)` 设置字符集编码
`MailAccount`	`setConnectionTimeout(long connectionTimeout)` 设置Socket连接超时值,单位毫秒,缺省值不超时
`MailAccount`	`setDebug(boolean debug)` 设置是否打开调试模式,调试模式会显示与邮件服务器通信过程,默认不开启
`MailAccount`	`setFrom(String from)` 设置发送方,遵循RFC-822标准
`MailAccount`	`setHost(String host)` 设置SMTP服务器域名
`MailAccount`	`setPass(String pass)` 设置密码
`MailAccount`	`setPort(Integer port)` 设置SMTP服务端口
`MailAccount`	`setSocketFactoryClass(String socketFactoryClass)` 设置指定实现javax.net.SocketFactory接口的类的名称,这个类将被用于创建SMTP的套接字
`MailAccount`	`setSocketFactoryFallback(boolean socketFactoryFallback)` 如果设置为true,未能创建一个套接字使用指定的套接字工厂类将导致使用java.net.Socket创建的套接字类, 默认值为true
`MailAccount`	`setSocketFactoryPort(int socketFactoryPort)` 指定的端口连接到在使用指定的套接字工厂如果没有设置,将使用默认端口
`void`	`setSplitlongparameters(boolean splitlongparameters)` 设置对于超长参数是否切分为多份,默认为false（国内邮箱附件不支持切分的附件名）
`MailAccount`	`setSslEnable(Boolean sslEnable)` 设置是否使用SSL安全连接
`MailAccount`	`setStartttlsEnable(boolean startttlsEnable)` 设置是否使用STARTTLS安全连接,STARTTLS是对纯文本通信协议的扩展它将纯文本连接升级为加密连接（TLS或SSL）, 而不是使用一个单独的加密通信端口
`MailAccount`	`setTimeout(long timeout)` 设置SMTP超时时长,单位毫秒,缺省值不超时
`MailAccount`	`setUser(String user)` 设置用户名

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAIL_SETTING_PATH
```
public static final String MAIL_SETTING_PATH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MailAccount
```
public MailAccount()
```
    构造,所有参数需自行定义或保持默认值
  - MailAccount
```
public MailAccount(String settingPath)
```
    构造
    
    Parameters:
    
    settingPath - 配置文件路径
  - MailAccount
```
public MailAccount(Setting setting)
```
    构造
    
    Parameters:
    
    setting - 配置文件
- Method Detail
  - getHost
```
public String getHost()
```
    获得SMTP服务器域名
    
    Returns:
    
    SMTP服务器域名
  - setHost
```
public MailAccount setHost(String host)
```
    设置SMTP服务器域名
    
    Parameters:
    
    host - SMTP服务器域名
    
    Returns:
    
    this
  - getPort
```
public Integer getPort()
```
    获得SMTP服务端口
    
    Returns:
    
    SMTP服务端口
  - setPort
```
public MailAccount setPort(Integer port)
```
    设置SMTP服务端口
    
    Parameters:
    
    port - SMTP服务端口
    
    Returns:
    
    this
  - isAuth
```
public Boolean isAuth()
```
    是否需要用户名密码验证
    
    Returns:
    
    是否需要用户名密码验证
  - setAuth
```
public MailAccount setAuth(boolean isAuth)
```
    设置是否需要用户名密码验证
    
    Parameters:
    
    isAuth - 是否需要用户名密码验证
    
    Returns:
    
    this
  - getUser
```
public String getUser()
```
    获取用户名
    
    Returns:
    
    用户名
  - setUser
```
public MailAccount setUser(String user)
```
    设置用户名
    
    Parameters:
    
    user - 用户名
    
    Returns:
    
    this
  - getPass
```
public String getPass()
```
    获取密码
    
    Returns:
    
    密码
  - setPass
```
public MailAccount setPass(String pass)
```
    设置密码
    
    Parameters:
    
    pass - 密码
    
    Returns:
    
    this
  - getFrom
```
public String getFrom()
```
    获取发送方,遵循RFC-822标准
    
    Returns:
    
    发送方, 遵循RFC-822标准
  - setFrom
```
public MailAccount setFrom(String from)
```
    设置发送方,遵循RFC-822标准
    
    Parameters:
    
    from - 发送方,遵循RFC-822标准
    
    Returns:
    
    this
  - isDebug
```
public boolean isDebug()
```
    是否打开调试模式,调试模式会显示与邮件服务器通信过程,默认不开启
    
    Returns:
    
    是否打开调试模式, 调试模式会显示与邮件服务器通信过程, 默认不开启
  - setDebug
```
public MailAccount setDebug(boolean debug)
```
    设置是否打开调试模式,调试模式会显示与邮件服务器通信过程,默认不开启
    
    Parameters:
    
    debug - 是否打开调试模式,调试模式会显示与邮件服务器通信过程,默认不开启
    
    Returns:
    
    MailAccount
  - getCharset
```
public Charset getCharset()
```
    获取字符集编码
    
    Returns:
    
    编码
  - setCharset
```
public MailAccount setCharset(Charset charset)
```
    设置字符集编码
    
    Parameters:
    
    charset - 字符集编码
    
    Returns:
    
    this
  - isSplitlongparameters
```
public boolean isSplitlongparameters()
```
    对于超长参数是否切分为多份,默认为false（国内邮箱附件不支持切分的附件名）
    
    Returns:
    
    对于超长参数是否切分为多份
  - setSplitlongparameters
```
public void setSplitlongparameters(boolean splitlongparameters)
```
    设置对于超长参数是否切分为多份,默认为false（国内邮箱附件不支持切分的附件名）
    
    Parameters:
    
    splitlongparameters - 对于超长参数是否切分为多份
  - isStartttlsEnable
```
public boolean isStartttlsEnable()
```
    是否使用 STARTTLS安全连接,STARTTLS是对纯文本通信协议的扩展它将纯文本连接升级为加密连接（TLS或SSL）, 而不是使用一个单独的加密通信端口
    
    Returns:
    
    是否使用 STARTTLS安全连接
  - setStartttlsEnable
```
public MailAccount setStartttlsEnable(boolean startttlsEnable)
```
    设置是否使用STARTTLS安全连接,STARTTLS是对纯文本通信协议的扩展它将纯文本连接升级为加密连接（TLS或SSL）, 而不是使用一个单独的加密通信端口
    
    Parameters:
    
    startttlsEnable - 是否使用STARTTLS安全连接
    
    Returns:
    
    this
  - isSslEnable
```
public Boolean isSslEnable()
```
    是否使用 SSL安全连接
    
    Returns:
    
    是否使用 SSL安全连接
  - setSslEnable
```
public MailAccount setSslEnable(Boolean sslEnable)
```
    设置是否使用SSL安全连接
    
    Parameters:
    
    sslEnable - 是否使用SSL安全连接
    
    Returns:
    
    this
  - getSocketFactoryClass
```
public String getSocketFactoryClass()
```
    获取指定实现javax.net.SocketFactory接口的类的名称,这个类将被用于创建SMTP的套接字
    
    Returns:
    
    指定实现javax.net.SocketFactory接口的类的名称, 这个类将被用于创建SMTP的套接字
  - setSocketFactoryClass
```
public MailAccount setSocketFactoryClass(String socketFactoryClass)
```
    设置指定实现javax.net.SocketFactory接口的类的名称,这个类将被用于创建SMTP的套接字
    
    Parameters:
    
    socketFactoryClass - 指定实现javax.net.SocketFactory接口的类的名称,这个类将被用于创建SMTP的套接字
    
    Returns:
    
    this
  - isSocketFactoryFallback
```
public boolean isSocketFactoryFallback()
```
    如果设置为true,未能创建一个套接字使用指定的套接字工厂类将导致使用java.net.Socket创建的套接字类, 默认值为true
    
    Returns:
    
    如果设置为true, 未能创建一个套接字使用指定的套接字工厂类将导致使用java.net.Socket创建的套接字类, 默认值为true
  - setSocketFactoryFallback
```
public MailAccount setSocketFactoryFallback(boolean socketFactoryFallback)
```
    如果设置为true,未能创建一个套接字使用指定的套接字工厂类将导致使用java.net.Socket创建的套接字类, 默认值为true
    
    Parameters:
    
    socketFactoryFallback - 如果设置为true,未能创建一个套接字使用指定的套接字工厂类将导致使用java.net.Socket创建的套接字类, 默认值为true
    
    Returns:
    
    this
  - getSocketFactoryPort
```
public int getSocketFactoryPort()
```
    获取指定的端口连接到在使用指定的套接字工厂如果没有设置,将使用默认端口
    
    Returns:
    
    指定的端口连接到在使用指定的套接字工厂如果没有设置,将使用默认端口
  - setSocketFactoryPort
```
public MailAccount setSocketFactoryPort(int socketFactoryPort)
```
    指定的端口连接到在使用指定的套接字工厂如果没有设置,将使用默认端口
    
    Parameters:
    
    socketFactoryPort - 指定的端口连接到在使用指定的套接字工厂如果没有设置,将使用默认端口
    
    Returns:
    
    this
  - setTimeout
```
public MailAccount setTimeout(long timeout)
```
    设置SMTP超时时长,单位毫秒,缺省值不超时
    
    Parameters:
    
    timeout - SMTP超时时长,单位毫秒,缺省值不超时
    
    Returns:
    
    this
  - setConnectionTimeout
```
public MailAccount setConnectionTimeout(long connectionTimeout)
```
    设置Socket连接超时值,单位毫秒,缺省值不超时
    
    Parameters:
    
    connectionTimeout - Socket连接超时值,单位毫秒,缺省值不超时
    
    Returns:
    
    this
  - getSmtpProps
```
public Properties getSmtpProps()
```
    获得SMTP相关信息
    
    Returns:
    
    Properties
  - defaultIfEmpty
```
public MailAccount defaultIfEmpty()
```
    如果某些值为null,使用默认值
    
    Returns:
    
    this

Class MailAccount

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAIL_SETTING_PATH

Constructor Detail

MailAccount

MailAccount

MailAccount

Method Detail

getHost

setHost

getPort

setPort

isAuth

setAuth

getUser

setUser

getPass

setPass

getFrom

setFrom

isDebug

setDebug

getCharset

setCharset

isSplitlongparameters

setSplitlongparameters

isStartttlsEnable

setStartttlsEnable

isSslEnable

setSslEnable

getSocketFactoryClass

setSocketFactoryClass

isSocketFactoryFallback

setSocketFactoryFallback

getSocketFactoryPort

setSocketFactoryPort

setTimeout

setConnectionTimeout

getSmtpProps

defaultIfEmpty