Email (sendcloud4j 0.0.4 API)

java.lang.Object
- io.jstack.sendcloud4j.mail.Email<E>

Type Parameters:
E -

Direct Known Subclasses:

GeneralEmail, TemplateEmail
```
public abstract class Email<E extends Email<E>>
extends Object
```
邮件信息，抽象普通邮箱和模块邮件公共信息。

Author:

denger

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,byte[]> attachments

protected org.slf4j.Logger logger

protected Map<String,String> parameters

Fields
Modifier and Type	Field and Description
`protected Map<String,byte[]>`	`attachments`
`protected org.slf4j.Logger`	`logger`
`protected Map<String,String>`	`parameters`

Constructor Summary

Constructors
Constructor and Description

Email()

Constructors
Constructor and Description
`Email()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addBinaryAttachment(File file)`
`protected void`	`addBinaryAttachment(File file, String name)`
`protected E`	`addParameter(String name, Object value)`
`protected E`	`addParameters(String name, String[] values, String sep)`
`E`	`attachment(byte[] attachment, String name)` 添加附件
`E`	`attachment(File attachment)` 添加附件。附件名默认使用文件名
`E`	`attachment(File attachment, String name)` 添加附件
`Map<String,byte[]>`	`attachments()` 获取附件列表。
`E`	`attachments(File[] attachments)` 添加附件。附件名默认使用文件名
`protected String`	`attachmentsKey()`
`E`	`from(String from)` 发件人地址.
`E`	`fromName(String fromName)` 发件人名称.
`static GeneralEmail`	`general()` 普通发送邮件
`protected String`	`getParameter(String name)`
`Map<String,String>`	`getParameters()`
`protected String[]`	`getParameters(String name, String sep)`
`protected abstract E`	`getThis()`
`protected boolean`	`hasAttachment()`
`E`	`headers(String headers)` 邮件头部信息.
`E`	`labelId(int labelid)` 本次发送所使用的标签ID.
`E`	`notRespEmailId()` 不返回 emailId.
`E`	`replyTo(String replyTo)` 设置用户默认的回复邮件地址.
`protected void`	`rewriteParameters()`
`E`	`subject(String subject)` 标题.
`static TemplateEmail`	`template(String template)` 根据模板名创建模块邮件。
`protected String[]`	`to()`
`E`	`to(String to)` 收件人地址.
`E`	`to(String[] toAddrs)` 收件人地址，批量设置。
`E`	`useNotification()` 使用发送回执

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

- Field Detail
  - logger
```
protected org.slf4j.Logger logger
```
  - parameters
```
protected Map<String,String> parameters
```
  - attachments
```
protected Map<String,byte[]> attachments
```
- Constructor Detail
  - Email
```
public Email()
```
- Method Detail
  - general
```
public static GeneralEmail general()
```
    普通发送邮件
    
    Returns:
    GeneralEmail
  - template
```
public static TemplateEmail template(String template)
```
    根据模板名创建模块邮件。
    
    Parameters:
    template - name
    
    Returns:
    TemplateEmail
  - from
```
public E from(String from)
```
    发件人地址. 举例: support@test.com, Support。
    必须设置.
    
    Parameters:
    from - 发件人地址
    
    Returns:
    E
  - fromName
```
public E fromName(String fromName)
```
    发件人名称. 显示如: Support
    
    Parameters:
    fromName - 发件人名称
    
    Returns:
    E
  - subject
```
public E subject(String subject)
```
    标题. 不能为空
    
    Parameters:
    subject - 标题
    
    Returns:
    E
  - replyTo
```
public E replyTo(String replyTo)
```
    设置用户默认的回复邮件地址. 如果 replyTo 没有或者为空, 则默认的回复邮件地址为 from.
    
    Parameters:
    replyTo - 回复邮件地址
    
    Returns:
    E
  - to
```
public E to(String to)
```
    收件人地址. 发送多个地址支持调用该方法多次或使用';'分隔, 如 denger@gmail.com;andy@gmail.com
    
    Parameters:
    to - 收件人地址
    
    Returns:
    E
  - to
```
public E to(String[] toAddrs)
```
    收件人地址，批量设置。
    
    Parameters:
    toAddrs - 地址列表
    
    Returns:
    E
  - to
```
protected String[] to()
```
  - labelId
```
public E labelId(int labelid)
```
    本次发送所使用的标签ID. 此标签需要事先创建
    
    Parameters:
    labelid - 标签ID
    
    Returns:
    E
  - headers
```
public E headers(String headers)
```
    邮件头部信息. JSON 格式, 比如:{"header1": "value1", "header2": "value2"}
    
    Parameters:
    headers - 邮件头部信息
    
    Returns:
    E
  - notRespEmailId
```
public E notRespEmailId()
```
    不返回 emailId. 有多个收件人时, 会返回 emailId 的列表
    
    Returns:
    E
  - useNotification
```
public E useNotification()
```
    使用发送回执
    
    Returns:
    E
  - attachments
```
public E attachments(File[] attachments)
```
    添加附件。附件名默认使用文件名
    
    Parameters:
    attachments - 附件列表
    
    Returns:
  - attachment
```
public E attachment(File attachment)
```
    添加附件。附件名默认使用文件名
    
    Parameters:
    attachment -
    
    Returns:
  - attachment
```
public E attachment(File attachment,
           String name)
```
    添加附件
    
    Parameters:
    attachment - 附件文件
    name - 附件名
    
    Returns:
    E
  - attachment
```
public E attachment(byte[] attachment,
           String name)
```
    添加附件
    
    Parameters:
    attachment - 附件内容
    name - 附件名
    
    Returns:
    E
  - attachments
```
public Map<String,byte[]> attachments()
```
    获取附件列表。
    
    Returns:
    key: name, value: bytes
  - attachmentsKey
```
protected String attachmentsKey()
```
  - hasAttachment
```
protected boolean hasAttachment()
```
  - addBinaryAttachment
```
protected void addBinaryAttachment(File file)
```
  - addBinaryAttachment
```
protected void addBinaryAttachment(File file,
                       String name)
```
  - addParameters
```
protected E addParameters(String name,
              String[] values,
              String sep)
```
  - addParameter
```
protected E addParameter(String name,
             Object value)
```
  - getParameter
```
protected String getParameter(String name)
```
  - getParameters
```
protected String[] getParameters(String name,
                     String sep)
```
  - getParameters
```
public final Map<String,String> getParameters()
```
  - rewriteParameters
```
protected void rewriteParameters()
```
  - getThis
```
protected abstract E getThis()
```

Class Email<E extends Email<E>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

parameters

attachments

Constructor Detail

Email

Method Detail

general

template

from

fromName

subject

replyTo

to

to

to

labelId

headers

notRespEmailId

useNotification

attachments

attachment

attachment

attachment

attachments

attachmentsKey

hasAttachment

addBinaryAttachment

addBinaryAttachment

addParameters

addParameter

getParameter

getParameters

getParameters

rewriteParameters

getThis