Package org.apache.jmeter.reporters

# Class MailerModel

java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.reporters.MailerModel

All Implemented Interfaces:
  `Serializable`, `Cloneable`, `Searchable`, `org.apache.jmeter.testelement.TestElement`

public class MailerModel extends AbstractTestElement implements Serializable
The model for a MailerVisualizer.

See Also:
  - Serialized Form

## Nested Class Summary

Nested Classes
Modifier and Type
Class
Description
`static enum`
`MailerModel.MailAuthType`

## Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement

`org.apache.jmeter.testelement.TestElement.Companion`

## Field Summary

### Fields inherited from interface org.apache.jmeter.testelement.TestElement

`COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS`

## Constructor Summary

Constructors
Constructor
Description
`MailerModel()`
Constructs a MailerModel.

## Method Summary

Modifier and Type
Method
Description
`void`
`add(SampleResult sample)`
Adds a SampleResult for display in the Visualizer.
`void`
`add(SampleResult sample, boolean sendMails)`
Adds a SampleResult.
`void`
`addChangeListener(ChangeListener list)`
`void`
`clear()`
Resets the state of this object to its default.
`Object`
`clone()`
`List<String>`
`getAddressList()`
Gets a List of String-objects.
`long`
`getFailureCount()`
`long`
`getFailureLimit()`
`String`
`getFailureSubject()`
`String`
`getFromAddress()`
`String`
`getLogin()`
`MailerModel.MailAuthType`
`getMailAuthType()`
`String`
`getPassword()`
`String`
`getSmtpHost()`
`String`
`getSmtpPort()`
`long`
`getSuccessCount()`
`long`
`getSuccessLimit()`
`String`
`getSuccessSubject()`
`String`
`getToAddress()`
`void`
`notifyChangeListeners()`
`void`
`sendMail(String from, List<String> vEmails, String subject, String attText, String smtpHost)`
Sends a mail with the given parameters using SMTP.
`void`
`sendMail(String from, List<String> vEmails, String subject, String attText, String smtpHost, String smtpPort, String user, String password, MailerModel.MailAuthType mailAuthType, boolean debug)`
Sends a mail with the given parameters using SMTP.
`void`
`sendTestMail()`
Send a Test Mail to check configuration
`void`
`setFailureLimit(String limit)`
`void`
`setFailureSubject(String str)`
`void`
`setFromAddress(String str)`
`void`
`setLogin(String login)`
`void`
`setMailAuthType(String value)`
`void`
`setPassword(String password)`
`void`
`setSmtpHost(String str)`
`void`
`setSmtpPort(String value)`
`void`
`setSuccessLimit(String limit)`
`void`
`setSuccessSubject(String str)`
`void`
`setToAddress(String str)`
`String`
`toString()`
Returns a String-representation of this object.

### Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

`addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clearTemporary, clearTestElementChildren, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty`

### Methods inherited from class java.lang.Object

`finalize, getClass, notify, notifyAll, wait, wait, wait`

### Methods inherited from interface org.apache.jmeter.testelement.TestElement

`get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getPropertyOrNull, getProps, getSchema, getString, removed, removeProperty, set, set, set, set, set, set, set, set, set`

## Constructor Details

### MailerModel

public MailerModel()
Constructs a MailerModel.

## Method Details

### addChangeListener

public void addChangeListener(ChangeListener list)

### clone

public Object clone()

Specified by:
  `clone` in interface `org.apache.jmeter.testelement.TestElement`
Overrides:
  `clone` in class `AbstractTestElement`

### notifyChangeListeners

public void notifyChangeListeners()

### getAddressList

public List<String> getAddressList()
Gets a List of String-objects. Each String is one mail-address of the addresses-String set by `setToAddress(str)`. The addresses must be separated by commas. Only String-objects containing a "@" are added to the returned List.

Returns:
  a List of String-objects wherein each String represents a mail-address.

### add

public void add(SampleResult sample)
Adds a SampleResult for display in the Visualizer.

Parameters:
  `sample` - the SampleResult encapsulating information about the last sample.

### add

public void add(SampleResult sample, boolean sendMails)
Adds a SampleResult. If SampleResult represents a change concerning the failure/success of the sampling a message might be sent to the addressies according to the settings of `successCount` and `failureCount`.

Parameters:
  `sample` - the SampleResult encapsulating information about the last sample.
  `sendMails` - whether or not to send e-mails

### clear

public void clear()
Resets the state of this object to its default. But: This method does not reset any mail-specific attributes (like sender, mail-subject...) since they are independent of the sampling.

Specified by:
  `clear` in interface `org.apache.jmeter.testelement.TestElement`
Overrides:
  `clear` in class `AbstractTestElement`

### toString

public String toString()
Returns a String-representation of this object. Returns always "E-Mail-Notification". Might be enhanced in future versions to return some kind of String-representation of the mail-parameters (like sender, addressies, smtpHost...).

Overrides:
  `toString` in class `Object`
Returns:
  A String-representation of this object.

### sendMail

public void sendMail(String from, List<String> vEmails, String subject, String attText, String smtpHost) throws javax.mail.MessagingException
Sends a mail with the given parameters using SMTP.

Parameters:
  `from` - the sender of the mail as shown in the mail-client.
  `vEmails` - all receivers of the mail. The receivers are seperated by commas.
  `subject` - the subject of the mail.
  `attText` - the message-body.
  `smtpHost` - the smtp-server used to send the mail.
Throws:
  `javax.mail.MessagingException` - if the building of the message fails
  `javax.mail.internet.AddressException` - if any of the addresses is wrong

### sendMail

public void sendMail(String from, List<String> vEmails, String subject, String attText, String smtpHost, String smtpPort, String user, String password, MailerModel.MailAuthType mailAuthType, boolean debug) throws javax.mail.MessagingException
Sends a mail with the given parameters using SMTP.

Parameters:
  `from` - the sender of the mail as shown in the mail-client.
  `vEmails` - all receivers of the mail. The receivers are seperated by commas.
  `subject` - the subject of the mail.
  `attText` - the message-body.
  `smtpHost` - the smtp-server used to send the mail.
  `smtpPort` - the smtp-server port used to send the mail.
  `user` - the login used to authenticate
  `password` - the password used to authenticate
  `mailAuthType` - `MailerModel.MailAuthType` Security policy
  `debug` - Flag whether debug messages for the mail session should be generated
Throws:
  `javax.mail.internet.AddressException` - If mail address is wrong
  `javax.mail.MessagingException` - If building MimeMessage fails

### sendTestMail

public void sendTestMail() throws javax.mail.MessagingException
Send a Test Mail to check configuration

Throws:
  `javax.mail.internet.AddressException` - If mail address is wrong
  `javax.mail.MessagingException` - If building MimeMessage fails

### setToAddress

public void setToAddress(String str)

### setFromAddress

public void setFromAddress(String str)

### setSmtpHost

public void setSmtpHost(String str)

### setSmtpPort

public void setSmtpPort(String value)

### setLogin

public void setLogin(String login)

### setPassword

public void setPassword(String password)

### setMailAuthType

public void setMailAuthType(String value)

### setFailureSubject

public void setFailureSubject(String str)

### setSuccessSubject

public void setSuccessSubject(String str)

### setSuccessLimit

public void setSuccessLimit(String limit)

### setFailureLimit

public void setFailureLimit(String limit)

### getToAddress

public String getToAddress()

### getFromAddress

public String getFromAddress()

### getSmtpHost

public String getSmtpHost()

### getSmtpPort

public String getSmtpPort()

### getFailureSubject

public String getFailureSubject()

### getSuccessSubject

public String getSuccessSubject()

### getSuccessLimit

public long getSuccessLimit()

### getSuccessCount

public long getSuccessCount()

### getFailureLimit

public long getFailureLimit()

### getFailureCount

public long getFailureCount()

### getLogin

public String getLogin()

### getPassword

public String getPassword()

### getMailAuthType

public MailerModel.MailAuthType getMailAuthType()