Webtest WebTest GitHub Home

Email Step emailStoreMessageId

Description

Stores the message id (optionally matching specific criteria) of a particular message.

Parameters

property
Required? yes
The target property name.
cc
Required? no
The email Cc header field.
description
Required? no
The description of this test step.
from
Required? no
The email From header field.
messageIndex
Required? no, default is 0, the first message
The messageIndex if more than one message match.
propertyType
Required? no, default is the "defaultPropertyType" as specified in the "config" element is used.
The target property type. Either "ant" or "dynamic".
replyTo
Required? no
The email ReplyTo header field.
subject
Required? no
The email Subject header field.
to
Required? no
The email To header field.

Details

Here is an example of using the emailStoreMessageId step.

emailStoreMessageId
<property name="testaddressvalue="your_address@your.emailaddress.com"/>
...
<steps>
    <emailSetConfig .../>
    <emailStoreMessageId subject="mailtest - multifiles - plain"
            from="${testaddress}to="/${testaddress}/"
            replyto="/${testaddress}/cc="/${testaddress}/"
            property="mid1"/>
    <-- further email test steps using messageId #{mid1} -->
</steps>

Note that subject and the email address attributes (to, from, cc and replyTo) are used for matching purposes to select a subset of the available messages. Each can be either plain text (like subject and from in the above example) or a regular expression (like to, cc and replyTo in the above example). Simply start and end them with the "/" character to make them a regular expression. If all of these are left blank, all messages will be selected (and you can use messageIndex to select a particular message if you know its position). In addition, to, cc and replyTo may contain a comma (",") separated list of email addresses. Each address must appear in an email message for it to match - order is not important.