public interface AQMailQueue
A mail queue needs to be in enabled
and not-paused
state in order to get emails delivered right away.
Emails will not be accepted by a mail queue if it is disabled
; emails will be saved onto secondary storage
but not delivered if mail queue is enabled
and paused
.
In Aqua Data Studio, one can change the state of embedded mail queue using the Options dialog as:
File -> Options -> E-mail -> E-mail Queue
* Enable queue check box
* Pause queue check box
* Archive queue check box
An instance of the object that implements the AQMailQueue
interface can be instantiated via aqua.mail.newMailQueue() alias.
Modifier and Type | Method and Description |
---|---|
boolean |
isArchived()
Returns true if the
archive option is turned on in this mail queue. |
boolean |
isEnabled()
Returns true if this mail queue is in
enabled state. |
boolean |
isPaused()
Returns true if this mail queue is in
paused state. |
void |
sendMail(AQMailMessage email)
Delivers an email via this mail queue.
|
boolean isEnabled()
enabled
state.
A mail queue will not accept emails if it is disabled.boolean isPaused()
paused
state.
A mail queue will not deliver emails to recipients if it is paused, emails will be saved to secondary storage, though.boolean isArchived()
archive
option is turned on in this mail queue.
A copy of each delivered email is saved if the archive
option is on.void sendMail(AQMailMessage email) throws Exception
email
- the email to deliver.Exception
- if the specified email is not valid or this mail queue is not enabled.
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.