Settings:
Sender address
Enter the address for the email's "From" field.
Subject line
Enter the text for the email's subject line. If you have metadata
associated with your images, you can use metadata tags here.
You can insert a previously defined metadata tag by either using:
- The insert key
- A right mouse button click inside the control
- In Windows, the Context menu key, which is between the Windows key and Ctrl key
The inserted metadata tag will appear in green. To change a previously inserted metadata tag,
navigate the cursor to just before the tag and either:
- Use the up and down arrows to cycle through possible values.
- Right-click on the tag to display and select the available values.
For instance, if you have plate metadata,
you might use the line, "CellProfiler: processing plate " and insert the metadata tag
for the plate at the end. Please see the
Metadata module for more details on metadata collection and usage.
Server name
Enter the address of your SMTP server. You can ask your
network administrator for your outgoing mail server which is often
made up of part of your email address, e.g.,
"Something@university.org". You might be able to find this information
by checking your settings or preferences in whatever email program
you use.
Port
Enter your server's SMTP port. The default (25) is the
port used by most SMTP servers. Your network administrator may
have set up SMTP to use a different port; also, the connection
security settings may require a different port.
Select connection security
Select the connection security. Your network administrator
can tell you which setting is appropriate, or you can check the
settings on your favorite email program.
Username and password required to login?
Select Yes if you need to enter a username and password
to authenticate.
Username
Enter your server's SMTP username.
Password
Enter your server's SMTP password.
Recipient address
Enter the address to which the messages will be sent.
When should the email be sent?
Select the kind of event that causes
SendEmail to send an email. You have the following choices:
- After first cycle: Send an email during
processing of the first image cycle.
- After last cycle: Send an email after all processing
is complete.
- After group start: Send an email during the first
cycle of each group of images.
- After group end: Send an email after all processing
for a group is complete.
- Every # of cycles Send an email each time a certain
number of image cycles have been processed. You will be prompted
for the number of image cycles if you select this choice.
- After cycle #: Send an email after the given number
of image cycles have been processed. You will be prompted for
the image cycle number if you select this choice. You can add
more events if you want emails after more than one image cycle.
Image cycle number
(Used only if sending email after a particular cycle number)
Send an email during processing of the given image cycle.
For instance, if you enter 4, then SendEmail
will send an email during processing of the fourth image cycle.
Image cycle count
(Used only if sending email after every N cycles)
Send an email each time this number of image cycles have
been processed. For instance, if you enter 4,
then SendEmail will send an email during processing of
the fourth, eighth, twelfth, etc. image cycles.
Message text
The body of the message sent from CellProfiler.
Your message can include metadata values. For instance,
if you group by plate and want to send an email after processing each
plate, you could use the message
"Finished processing plate \g<Plate>".