EmailSettings (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.settings.childSections.EmailSettings

All Implemented Interfaces:: SettingsSection

public class EmailSettings
extends Object
implements SettingsSection

Constructor Summary

Constructors
Constructor and Description

EmailSettings()

Constructors
Constructor and Description
`EmailSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getAdminEmails()` A list of email addresses for admins, these addresses will get exception emails and other other system emails.
`List<String>`	`getAllowedOutboundEmails()` A list of whitelisted outbound email addresses
`List<Pattern>`	`getAllowedTestingOutboundEmailCompiledPatterns()` Compiled regular expressions for getAllowedTestingOutboundEmailPatterns()
`List<String>`	`getAllowedTestingOutboundEmailPatterns()` A list of regualar expressions, email addresses matching the patterns will be permitted outbound email addresses even if restrictOutboundEmails is true.
`String`	`getCanSpamText()` The name and postal address of the sender, for compliance with the CAN-SPAM law
`String`	`getDefaultFromAddress()` The default email address for the "From" field.
`String`	`getHost()` The SMTP host
`String`	`getOutboundEmailTestAddress()` The email address that all outbound emails are routed to in local and QA mode.
`String`	`getPassword()` The password with which to connect to the SMTP server
`Long`	`getPort()` The SMTP port to try to connect to, defaults to 587
`Boolean`	`getRestrictOutboundEmails()` If true, will restrict outbound email address sending to a whitelist of addresses, all other emails will be converted into a white-listed form using the "+" section.
`Boolean`	`getTls()` Whether to use TLS to connect, defaults to true
`String`	`getUsername()` The username with which to connect to the SMTP server
`EmailSettings`	`setAdminEmails(List<String> adminEmails)`
`EmailSettings`	`setAllowedOutboundEmails(List<String> allowedOutboundEmails)`
`EmailSettings`	`setAllowedTestingOutboundEmailCompiledPatterns(List<Pattern> allowedTestingOutboundEmailCompiledPatterns)`
`EmailSettings`	`setAllowedTestingOutboundEmailPatterns(List<String> allowedTestingOutboundEmailPatterns)`
`void`	`setCanSpamText(String canSpamText)`
`void`	`setDefaultFromAddress(String defaultFromAddress)`
`void`	`setHost(String host)`
`EmailSettings`	`setOutboundEmailTestAddress(String outboundEmailTestAddress)`
`void`	`setPassword(String password)`
`void`	`setPort(Long port)`
`EmailSettings`	`setRestrictOutboundEmails(Boolean restrictOutboundEmails)`
`void`	`setTls(Boolean tls)`
`void`	`setUsername(String username)`

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

Methods inherited from interface io.stallion.settings.childSections.SettingsSection
postLoad

- Constructor Detail
  - EmailSettings
```
public EmailSettings()
```
- Method Detail
  - getHost
```
public String getHost()
```
    The SMTP host
    
    Returns:
  - setHost
```
public void setHost(String host)
```
  - getUsername
```
public String getUsername()
```
    The username with which to connect to the SMTP server
    
    Returns:
  - setUsername
```
public void setUsername(String username)
```
  - getPassword
```
public String getPassword()
```
    The password with which to connect to the SMTP server
    
    Returns:
  - setPassword
```
public void setPassword(String password)
```
  - getTls
```
public Boolean getTls()
```
    Whether to use TLS to connect, defaults to true
    
    Returns:
  - setTls
```
public void setTls(Boolean tls)
```
  - getPort
```
public Long getPort()
```
    The SMTP port to try to connect to, defaults to 587
    
    Returns:
  - setPort
```
public void setPort(Long port)
```
  - getDefaultFromAddress
```
public String getDefaultFromAddress()
```
    The default email address for the "From" field.
    
    Returns:
  - setDefaultFromAddress
```
public void setDefaultFromAddress(String defaultFromAddress)
```
  - getCanSpamText
```
public String getCanSpamText()
```
    The name and postal address of the sender, for compliance with the CAN-SPAM law
    
    Returns:
  - setCanSpamText
```
public void setCanSpamText(String canSpamText)
```
  - getAdminEmails
```
public List<String> getAdminEmails()
```
    A list of email addresses for admins, these addresses will get exception emails and other other system emails.
    
    Returns:
  - setAdminEmails
```
public EmailSettings setAdminEmails(List<String> adminEmails)
```
  - getRestrictOutboundEmails
```
public Boolean getRestrictOutboundEmails()
```
    If true, will restrict outbound email address sending to a whitelist of addresses, all other emails will be converted into a white-listed form using the "+" section. So if this is true, and the outboundEmailTestAddress email is admin@stallion.io, and you are trying to email barack@whitehouse.gov, then the to address will be converted to admin+barack-whitehouse-gov@stallion.io This is setting is true in local and QA mode. The purpose of this setting is to prevent accidentally sending real emails to people from the development mode.
    
    Returns:
  - setRestrictOutboundEmails
```
public EmailSettings setRestrictOutboundEmails(Boolean restrictOutboundEmails)
```
  - getAllowedTestingOutboundEmailPatterns
```
public List<String> getAllowedTestingOutboundEmailPatterns()
```
    A list of regualar expressions, email addresses matching the patterns will be permitted outbound email addresses even if restrictOutboundEmails is true.
    
    Returns:
  - setAllowedTestingOutboundEmailPatterns
```
public EmailSettings setAllowedTestingOutboundEmailPatterns(List<String> allowedTestingOutboundEmailPatterns)
```
  - getAllowedOutboundEmails
```
public List<String> getAllowedOutboundEmails()
```
    A list of whitelisted outbound email addresses
  - setAllowedOutboundEmails
```
public EmailSettings setAllowedOutboundEmails(List<String> allowedOutboundEmails)
```
  - getAllowedTestingOutboundEmailCompiledPatterns
```
public List<Pattern> getAllowedTestingOutboundEmailCompiledPatterns()
```
    Compiled regular expressions for getAllowedTestingOutboundEmailPatterns()
    
    Returns:
  - setAllowedTestingOutboundEmailCompiledPatterns
```
public EmailSettings setAllowedTestingOutboundEmailCompiledPatterns(List<Pattern> allowedTestingOutboundEmailCompiledPatterns)
```
  - getOutboundEmailTestAddress
```
public String getOutboundEmailTestAddress()
```
    The email address that all outbound emails are routed to in local and QA mode.
    
    Returns:
  - setOutboundEmailTestAddress
```
public EmailSettings setOutboundEmailTestAddress(String outboundEmailTestAddress)
```

Class EmailSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.stallion.settings.childSections.SettingsSection

Constructor Detail

EmailSettings

Method Detail

getHost

setHost

getUsername

setUsername

getPassword

setPassword

getTls

setTls

getPort

setPort

getDefaultFromAddress

setDefaultFromAddress

getCanSpamText

setCanSpamText

getAdminEmails

setAdminEmails

getRestrictOutboundEmails

setRestrictOutboundEmails

getAllowedTestingOutboundEmailPatterns

setAllowedTestingOutboundEmailPatterns

getAllowedOutboundEmails

setAllowedOutboundEmails

getAllowedTestingOutboundEmailCompiledPatterns

setAllowedTestingOutboundEmailCompiledPatterns

getOutboundEmailTestAddress

setOutboundEmailTestAddress