TransportEvent (JavaMail API documentation)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.event
class TransportEvent

javax.mail.event.MailEvent
  javax.mail.event.TransportEvent

public class TransportEvent
extends MailEvent

This class models Transport events.

See Also (auto-generated):

Session

Transport

Message

Field Summary
`protected transient 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 transient Message`	`msg`
`protected int`	`type` The event type.
`protected transient Address[]`	`validSent`
`protected transient Address[]`	`validUnsent`

Constructor Summary
`TransportEvent(Transport transport, int type, Address[] validSent, Address[] validUnsent, Address[] invalid, Message msg)` Constructor.

Method Summary
`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.

Methods inherited from class javax.mail.event.MailEvent
`dispatch`

Field Detail

invalid

protected transient Address[] invalid

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,

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.

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.

msg

protected transient Message msg

type

protected int type

The event type.

validSent

protected transient Address[] validSent

validUnsent

protected transient Address[] validUnsent

Constructor Detail

TransportEvent

public TransportEvent(Transport transport,
                      int type,
                      Address[] validSent,
                      Address[] validUnsent,
                      Address[] invalid,
                      Message msg)

Constructor.

Parameters:: transport - The Transport object; type; validSent; validUnsent; invalid; msg

Method Detail

dispatch

public void dispatch(Object listener)

Invokes the appropriate TransportListener method.

Overrides:: dispatch in class MailEvent
Parameters:: listener

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

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