MailSenderConfiguration (XWiki Platform - Mail - Send

```
@Role
public interface MailSenderConfiguration
```
Represents all XWiki configuration options for the Mail Sending feature.

Since:

6.1M2

Version:

$Id: 22ffa99d52888dd8dee58bda098dc85469172796 $

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Properties`	`getAdditionalProperties()`
`Properties`	`getAllProperties()`
`List<String>`	`getBCCAddresses()`
`String`	`getFromAddress()`
`String`	`getHost()`
`String`	`getPassword()`
`int`	`getPort()`
`default int`	`getPrepareQueueCapacity()`
`String`	`getScriptServicePermissionCheckerHint()`
`default int`	`getSendQueueCapacity()`
`long`	`getSendWaitTime()`
`String`	`getUsername()`
`boolean`	`usesAuthentication()`

- Method Detail
  - getHost
```
String getHost()
```
    Returns:
    
    the SMTP server
  - getPort
```
int getPort()
```
    Returns:
    
    the SMTP server port
  - getUsername
```
String getUsername()
```
    Returns:
    
    the SMTP user name to authenticate to the SMTP server, if any
  - getPassword
```
String getPassword()
```
    Returns:
    
    the SMTP password to authenticate to the SMTP server, if any
  - getFromAddress
```
String getFromAddress()
```
    Returns:
    
    the default email address to use when sending the email. This is optional and if the user of the API sets it, then it overrides this default value
  - getBCCAddresses
```
List<String> getBCCAddresses()
```
    Returns:
    
    the list of default email addresses to add to the BCC mail header when sending email.This is optional and if the user of the API sets it, then it overrides this default value
    
    Since:
    
    6.4M2
  - getAdditionalProperties
```
Properties getAdditionalProperties()
```
    Returns:
    
    the list of additional Java Mail properties (in addition to the host, port, username and from properties) to use when sending the mail (eg mail.smtp.starttls.enable=true if TLS should be used). See Java Mail Properties for the full list of available properties.
  - getAllProperties
```
Properties getAllProperties()
```
    Returns:
    
    the full list of Java Mail properties to use when sending the email (this includes the Java Mail properties for host (mail.smtp.host), port (mail.smtp.port), username (mail.smtp.user), from mail.smtp.from) + the all the additional properties from getAdditionalProperties()
  - usesAuthentication
```
boolean usesAuthentication()
```
    Returns:
    
    if true then the SMTP server requires authentication
  - getScriptServicePermissionCheckerHint
```
String getScriptServicePermissionCheckerHint()
```
    Returns:
    
    the hint of the ScriptServicePermissionChecker component to use to check if a mail is allowed to be sent or not when using the Mail Sender Script Service API. For example: "alwaysallow", "programmingrights".
    
    Since:
    
    6.4M2
  - getSendWaitTime
```
long getSendWaitTime()
```
    Returns:
    
    the delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not considered a spammer by mail servers.
    
    Since:
    
    6.4RC1
  - getPrepareQueueCapacity
```
default int getPrepareQueueCapacity()
```
    Returns:
    
    the max size of the prepare queue. When this size is reached calls to put new elements on the queue will block
    
    Since:
    
    11.6RC1
  - getSendQueueCapacity
```
default int getSendQueueCapacity()
```
    Returns:
    
    the max size of the send queue. When this size is reached calls to put new elements on the queue will block
    
    Since:
    
    11.6RC1

Interface MailSenderConfiguration

Method Summary

Method Detail

getHost

getPort

getUsername

getPassword

getFromAddress

getBCCAddresses

getAdditionalProperties

getAllProperties

usesAuthentication

getScriptServicePermissionCheckerHint

getSendWaitTime

getPrepareQueueCapacity

getSendQueueCapacity