- java.lang.Object
-
- javax.mail.FetchProfile
-
public class FetchProfile extends Object
Clients use a FetchProfile to list the Message attributes that it wishes to prefetch from the server for a range of messages.Messages obtained from a Folder are light-weight objects that typically start off as empty references to the actual messages. Such a Message object is filled in "on-demand" when the appropriate get*() methods are invoked on that particular Message. Certain server-based message access protocols (Ex: IMAP) allow batch fetching of message attributes for a range of messages in a single request. Clients that want to use message attributes for a range of Messages (Example: to display the top-level headers in a headerlist) might want to use the optimization provided by such servers. The
FetchProfile
allows the client to indicate this desire to the server.Note that implementations are not obligated to support FetchProfiles, since there might be cases where the backend service does not allow easy, efficient fetching of such profiles.
Sample code that illustrates the use of a FetchProfile is given below:
Message[] msgs = folder.getMessages(); FetchProfile fp = new FetchProfile(); fp.add(FetchProfile.Item.ENVELOPE); fp.add("X-mailer"); folder.fetch(msgs, fp);
- Author:
- John Mani, Bill Shannon
- See Also:
Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
FetchProfile.Item
This inner class is the base class of all items that can be requested in a FetchProfile.
-
Constructor Summary
Constructors Constructor and Description FetchProfile()
Create an empty FetchProfile.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
add(FetchProfile.Item item)
Add the given special item as one of the attributes to be prefetched.void
add(String headerName)
Add the specified header-field to the list of attributes to be prefetched.boolean
contains(FetchProfile.Item item)
Returns true if the fetch profile contains given special item.boolean
contains(String headerName)
Returns true if the fetch profile contains given header name.String[]
getHeaderNames()
Get the names of the header-fields set in this profile.FetchProfile.Item[]
getItems()
Get the items set in this profile.
-
-
-
Method Detail
-
add
public void add(FetchProfile.Item item)
Add the given special item as one of the attributes to be prefetched.- Parameters:
item
- the special item to be fetched- See Also:
FetchProfile.Item.ENVELOPE
,FetchProfile.Item.CONTENT_INFO
,FetchProfile.Item.FLAGS
-
add
public void add(String headerName)
Add the specified header-field to the list of attributes to be prefetched.- Parameters:
headerName
- header to be prefetched
-
contains
public boolean contains(FetchProfile.Item item)
Returns true if the fetch profile contains given special item.
-
contains
public boolean contains(String headerName)
Returns true if the fetch profile contains given header name.
-
getItems
public FetchProfile.Item[] getItems()
Get the items set in this profile.- Returns:
- items set in this profile
-
getHeaderNames
public String[] getHeaderNames()
Get the names of the header-fields set in this profile.- Returns:
- headers set in this profile
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/mail/FetchProfile.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.