Package TsahiAsher.LibYMail

Contains all the classes of LibY!Mail related to message handling. More...

Namespaces
package	Preferences
	Contains all the classes of LibY!Mail related to user preferences.

Classes
class	Account
	The main access point of this library. Describes the account, the folders and the messages in the account. More...
class	ErrorHandler
	Utility class to process returned errors
class	Folder
	Describes a folder of messages in the mail account. More...
class	FolderCollection
	A collection of Folders in the Account. More...
class	MessageErrorException
	Describes an error while executing an operation on a message. More...
class	MessageRequest
	A request to retrieve a message content from the server More...
class	Utils
	General purpuse utility methods
class	YAlternateView
	Describes one of the alternative views of a message More...
class	YAttachment
	Represents an attachment of a mail message. More...
class	YMailMessage
	Represents an e-mail message in the Yahoo! Mail account. More...
class	YMailMessageCollection
	A collection of YMailMessage objects in a Folder. More...

Enumerations
enum	BlockImageOption {   None = ImageBlockOption.none,   All = ImageBlockOption.all,   Remote = ImageBlockOption.remote }
	Specifies options for blocking images in retrieved messages More...
enum	Filter {   Replied = 1,   Flagged = 2,   Read = 4,   Draft = 8,   UUEncoded = 16,   Forwarded = 32,   Ham = 64,   Spam = 128,   HasAttachment = 256,   InAddressbook = 512,   All }
	The values used to filter messages by various methods. More...
enum	MessageFlags {   Flagged = 1,   Read = 2,   Draft = 4,   Forwarded = 8,   Ham = 16,   Spam = 32,   Replied = 64 }
	The flags that should be set on messages with the Folder.FlagMessages method. More...
enum	OffsetType {   StartWith = com.yahooapis.mail.OffsetType.startWith,   CenterOn = com.yahooapis.mail.OffsetType.centerOn }
	Determine the type of offset to use for listing received from the Yahoo! Mail server. More...
enum	SortKey {   Date = com.yahooapis.mail.SortKey.date,   Size = com.yahooapis.mail.SortKey.size,   Subject = com.yahooapis.mail.SortKey.subject,   Sender = com.yahooapis.mail.SortKey.sender,   To = com.yahooapis.mail.SortKey.to,   Recipient = com.yahooapis.mail.SortKey.recipient,   Folder = com.yahooapis.mail.SortKey.folder }
	The message property to use for sorting messages retrieved from the Yahoo! Mail server. More...
enum	SortOrder {   Ascending = com.yahooapis.mail.SortOrder.up,   Descending = com.yahooapis.mail.SortOrder.down }
	Sort order to use in combination with SortKey for messages retrieved from the Yahoo! Mail server. More...

Detailed Description

Contains all the classes of LibY!Mail related to message handling.

Enumeration Type Documentation

enum BlockImageOption

Specifies options for blocking images in retrieved messages

Encapsulates the ImageBlockOption enumeration of the Yahoo! Mail Web Services.

Enumerator:

None	Don't block images
All	Block all images
Remote	Block only remote images (that are not attached to the message?)

enum Filter

The values used to filter messages by various methods.

Encaplsulates the Flag data type of the Yahoo! Mail Web Services.

Enumerator:

Replied	The message has been replied to
Flagged	The message was flagged
Read	The message has been read
Draft	The message is a draft
UUEncoded	The message is UU encoded
Forwarded	The message has beed forwarded
Ham	The message has been marked as ham (not spam) by the user
Spam	The message is spam
HasAttachment	The message has an attachment
InAddressbook	The sender is in the user's address book.
All	All types of messages

enum MessageFlags

The flags that should be set on messages with the Folder.FlagMessages method.

Encapsulates the SetFlags data type of the Yahoo! Mail Web Services.

Enumerator:

Flagged	The message has been flagged
Read	The message has been read
Draft	The message is a draft
Forwarded	The message has been forwarded
Ham	The message has been marked as ham (not spam) by the user
Spam	The message is spam
Replied	The message has been replied to

enum OffsetType

Determine the type of offset to use for listing received from the Yahoo! Mail server.

Enumerator:

StartWith	Start with the message specified as the offset message
CenterOn	Center on the message specified as the offset message

enum SortKey

The message property to use for sorting messages retrieved from the Yahoo! Mail server.

Enumerator:

Date	Sort by date
Size	Sort by size
Subject	Sort by subject alphabeticaly
Sender	Sort by sender name alphabeticaly
To	Sort by the name in the "To:" field alphabeticaly
Recipient	Sort by the recipient name alphabeticaly
Folder	Sort by the folder that contains the message. Relevant mostly for search results.

enum SortOrder

Sort order to use in combination with SortKey for messages retrieved from the Yahoo! Mail server.

Enumerator:

Ascending	Sort ascending
Descending	Sort descending