- java.lang.Object
-
- java.util.EventObject
-
- javax.mail.event.MailEvent
-
- javax.mail.event.TransportEvent
-
- All Implemented Interfaces:
- Serializable
public class TransportEvent extends MailEvent
This class models Transport events.- Author:
- John Mani, Max Spivak
- See Also:
Transport
,TransportListener
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description protected Address[]
invalid
static int
MESSAGE_DELIVERED
Message has been successfully delivered to all recipients by the transport firing this event.static int
MESSAGE_NOT_DELIVERED
Message was not sent for some reason.static int
MESSAGE_PARTIALLY_DELIVERED
Message was successfully sent to some recipients but not to all.protected Message
msg
protected int
type
The event type.protected Address[]
validSent
protected Address[]
validUnsent
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description TransportEvent(Transport transport, int type, Address[] validSent, Address[] validUnsent, Address[] invalid, Message msg)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
dispatch(Object listener)
Invokes the appropriate TransportListener method.Address[]
getInvalidAddresses()
Return the addresses to which this message could not be sent.Message
getMessage()
Get the Message object associated with this Transport Event.int
getType()
Return the type of this event.Address[]
getValidSentAddresses()
Return the addresses to which this message was sent succesfully.Address[]
getValidUnsentAddresses()
Return the addresses that are valid but to which this message was not sent.
-
-
-
Field Detail
-
MESSAGE_DELIVERED
public static final int MESSAGE_DELIVERED
Message has been successfully delivered to all recipients by the transport firing this event. validSent[] contains all the addresses this transport sent to successfully. validUnsent[] and invalid[] should be null,- See Also:
- Constant Field Values
-
MESSAGE_NOT_DELIVERED
public static final int MESSAGE_NOT_DELIVERED
Message was not sent for some reason. validSent[] should be null. validUnsent[] may have addresses that are valid (but the message wasn't sent to them). invalid[] should likely contain invalid addresses.- See Also:
- Constant Field Values
-
MESSAGE_PARTIALLY_DELIVERED
public static final int MESSAGE_PARTIALLY_DELIVERED
Message was successfully sent to some recipients but not to all. validSent[] holds addresses of recipients to whom the message was sent. validUnsent[] holds valid addresses to which the message was not sent. invalid[] holds invalid addresses, if any.- See Also:
- Constant Field Values
-
type
protected int type
The event type.
-
validSent
protected transient Address[] validSent
-
validUnsent
protected transient Address[] validUnsent
-
invalid
protected transient Address[] invalid
-
msg
protected transient Message msg
-
-
Method Detail
-
getType
public int getType()
Return the type of this event.- Returns:
- type
-
getValidSentAddresses
public Address[] getValidSentAddresses()
Return the addresses to which this message was sent succesfully.- Returns:
- Addresses to which the message was sent successfully or null
-
getValidUnsentAddresses
public Address[] getValidUnsentAddresses()
Return the addresses that are valid but to which this message was not sent.- Returns:
- Addresses that are valid but to which the message was not sent successfully or null
-
getInvalidAddresses
public Address[] getInvalidAddresses()
Return the addresses to which this message could not be sent.- Returns:
- Addresses to which the message sending failed or null
-
getMessage
public Message getMessage()
Get the Message object associated with this Transport Event.- Returns:
- the Message object
- Since:
- JavaMail 1.2
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/mail/event/TransportEvent.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.