ALL_MESSAGES
public static final int ALL_MESSAGES
TYPE_IMAP
public static final String TYPE_IMAP
TYPE_IMAPS
public static final String TYPE_IMAPS
TYPE_POP3
public static final String TYPE_POP3
TYPE_POP3S
public static final String TYPE_POP3S
getDeleteMessages
public boolean getDeleteMessages()
- Whether or not to delete the read messages from the folder.
getFolder
public String getFolder()
getNumMessages
public int getNumMessages()
- The number of messages to retrieve from the mail server.
-1 denotes get all messages.
getNumMessagesString
public String getNumMessagesString()
- The number of messages to retrieve from the mail server.
-1 denotes get all messages.
getPassword
public String getPassword()
getServer
public String getServer()
- The name or address of the remote server.
getServerType
public 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].
getUserName
public String getUserName()
- The username of the mail account.
isStoreMimeMessage
public boolean isStoreMimeMessage()
- Whether or not to store the retrieved message as MIME message in
the sample result
sample
public SampleResult sample(Entry e)
Obtains statistics about the given Entry, and packages the information
into a SampleResult.
- sample in interface Sampler
setDeleteMessages
public void setDeleteMessages(boolean delete)
delete
- -
Whether or not to delete the read messages from the folder.
setFolder
public void setFolder(String folder)
folder
- -
Name of the folder to read emails from. "INBOX" is the only
acceptable value if the server type is POP3.
setNumMessages
public void setNumMessages(String num_messages)
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(int num_messages)
num_messages
- -
The number of messages to retrieve from the mail server. Set
this value to -1 to retrieve all messages.
setPassword
public void setPassword(String password)
setServer
public void setServer(String server)
server
- -
The name or address of the remote server.
setServerType
public void setServerType(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.
setStoreMimeMessage
public void setStoreMimeMessage(boolean storeMimeMessage)
storeMimeMessage
- Whether or not to store the retrieved message as MIME message in the
sample result
setUserName
public void setUserName(String username)
username
- -
The username of the mail account.