001package votorola.g.mail; // Copyright 2007, 2011, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.
002
003import javax.mail.*;
004import votorola.g.lang.*;
005
006
007/** Store utilities.
008  */
009public final @ThreadSafe class StoreX
010{
011
012    private StoreX() {}
013
014
015
016    /** Returns the store's default folder.
017      *
018      *     @throws MessagingException for a non-existent (typically Maildir) store if the
019      *       folder does not exist; precluding a later, uninformative
020      *       "javax.mail.FolderNotFoundException: folder 'INBOX' not found"
021      *
022      *     @deprecated in favour of Store.getDefaultFolder()
023      *     @see Store#getDefaultFolder()
024      */
025    public static @Deprecated Folder ensureDefaultFolder( Store store ) throws MessagingException
026    {
027        final Folder folder = store.getFolder( "INBOX" ); // why? "INBOX" is not documented anywhere
028        if( !folder.exists() ) throw new MessagingException( "mail store unavailable: " +  store.toString() );
029
030        return folder;
031    }
032
033
034
035}