org.apache.jmeter.protocol.mail.sampler
Class MailReaderSampler
java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.samplers.AbstractSampler
org.apache.jmeter.protocol.mail.sampler.MailReaderSampler
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Sampler, TestElement
public class MailReaderSampler
- extends AbstractSampler
Sampler that can read from POP3 and IMAP mail servers
- See Also:
- Serialized Form
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement |
addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, 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, toString, wait, wait, wait |
Methods inherited from interface org.apache.jmeter.testelement.TestElement |
addTestElement, canRemove, clear, clone, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse |
TYPE_POP3
public static final java.lang.String TYPE_POP3
- See Also:
- Constant Field Values
TYPE_POP3S
public static final java.lang.String TYPE_POP3S
- See Also:
- Constant Field Values
TYPE_IMAP
public static final java.lang.String TYPE_IMAP
- See Also:
- Constant Field Values
TYPE_IMAPS
public static final java.lang.String TYPE_IMAPS
- See Also:
- Constant Field Values
ALL_MESSAGES
public static final int ALL_MESSAGES
- See Also:
- Constant Field Values
MailReaderSampler
public MailReaderSampler()
sample
public SampleResult sample(Entry e)
- Description copied from interface:
Sampler
- Obtains statistics about the given Entry, and packages the information
into a SampleResult.
setServerType
public void setServerType(java.lang.String serverType)
- Sets the type of protocol to use when talking with the remote mail
server. Either MailReaderSampler.TYPE_IMAP[S] or
MailReaderSampler.TYPE_POP3[S]. Default is MailReaderSampler.TYPE_POP3.
- Parameters:
serverType
-
getServerType
public java.lang.String getServerType()
- Returns the type of the protocol set to use when talking with the remote
server. Either MailReaderSampler.TYPE_IMAP[S] or
MailReaderSampler.TYPE_POP3[S].
- Returns:
- Server Type
setServer
public void setServer(java.lang.String server)
- Parameters:
server
- -
The name or address of the remote server.
getServer
public java.lang.String getServer()
- Returns:
- The name or address of the remote server.
setUserName
public void setUserName(java.lang.String username)
- Parameters:
username
- -
The username of the mail account.
getUserName
public java.lang.String getUserName()
- Returns:
- The username of the mail account.
setPassword
public void setPassword(java.lang.String password)
- Parameters:
password
-
getPassword
public java.lang.String getPassword()
- Returns:
- password
setFolder
public void setFolder(java.lang.String folder)
- Parameters:
folder
- -
Name of the folder to read emails from. "INBOX" is the only
acceptable value if the server type is POP3.
getFolder
public java.lang.String getFolder()
- Returns:
- folder
setNumMessages
public void setNumMessages(int num_messages)
- Parameters:
num_messages
- -
The number of messages to retrieve from the mail server. Set
this value to -1 to retrieve all messages.
setNumMessages
public void setNumMessages(java.lang.String num_messages)
- Parameters:
num_messages
- -
The number of messages to retrieve from the mail server. Set
this value to -1 to retrieve all messages.
getNumMessages
public int getNumMessages()
- Returns:
- The number of messages to retrieve from the mail server.
-1 denotes get all messages.
getNumMessagesString
public java.lang.String getNumMessagesString()
- Returns:
- The number of messages to retrieve from the mail server.
-1 denotes get all messages.
setDeleteMessages
public void setDeleteMessages(boolean delete)
- Parameters:
delete
- -
Whether or not to delete the read messages from the folder.
getDeleteMessages
public boolean getDeleteMessages()
- Returns:
- Whether or not to delete the read messages from the folder.
isStoreMimeMessage
public boolean isStoreMimeMessage()
- Returns:
- Whether or not to store the retrieved message as MIME message in
the sample result
setStoreMimeMessage
public void setStoreMimeMessage(boolean storeMimeMessage)
- Parameters:
storeMimeMessage
- Whether or not to store the retrieved message as MIME message in the
sample result
Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.