xemail-net : Xemail.Mail.Imap Namespace
Imap

To be added.

public class Imap


Remarks
To be added.
Members

See Also: Inherited members from object.

Constructors
Imap ()
To be added.
Properties
AuthMethod
string . Authentication method use with the server. At this time only LOGIN and CRAM-MD5 are supported
ConnectedHostName [read-only]
string . Server Hostname
LastError [read-only]
string . Contain the last error message.
Port
int . the Ip Port of the remote server
Ssl
bool . Specifie is the connection use Ssl
Methods
AppendMail (string, XMail) : bool
Append a mail to mailbox.
AppendMime (string, string) : bool
To be added.
Capability () : string
Check the server capabilities. This is need to call other command that depends on server capabilites like quota or namespace.
Connect (string) : bool
Connect to the specified hostname.
Copy (string, string) : bool
To be added.
CreateMailbox (string) : bool
Create a new mailbox.
DeleteMailbox (string) : bool
Delete a mailbox.
Disconnect ()
Diconnect from the server.
Examine (string) : XMailbox
To be added.
Expunge () : bool
The EXPUNGE command permanently removes all messages that have the flag set from the currently selected mailbox.
FetchMessages (string, string, bool, bool, bool) : XMails
To be added.
IsConnected () : bool
To check connected status.
IsLoggedIn () : bool
To check login status.
ListMailboxes (string, string) : XMailboxes
The LIST command returns a subset of names from the complete set of all names available to the client.
ListSuscribesMailboxes (string, string) : XMailboxes
The LSUB command returns a subset of names from the set of names that the user has declared as being "active" or "subscribed".
Login (string, string) : bool
Login to the server.
Logout () : bool
Logout to the server.
Namespace () : Xemail.Mail.Imap.Namespaces
To be added.
NumMails (string) : int
Get the number of mails on the server in the specified mailbox.
RefetchMailFlags (XMail) : bool
To be added.
RenameMailbox (string, string) : bool
The RENAME command changes the name of a mailbox.
Search (string, bool) : MessageSet
The SEARCH command searches the mailbox for messages that match the given searching criteria.
SelectMailbox (string) : XMailbox
The SELECT command selects a mailbox so that messages in the mailbox can be accessed.
Store (string, bool, string) : bool
The STORE command alters data associated with a message in the mailbox.
SuscribeMailbox (string) : bool
The SUBSCRIBE command adds the specified mailbox name to the server's set of "active" or "subscribed" mailboxes as returned by the LSUB command.
UnSuscribeMailbox (string) : bool
The UNSUBSCRIBE command removes the specified mailbox name from the server's set of "active" or "subscribed" mailboxes as returned by the LSUB command.
Member Details
Imap Constructor
public Imap ()

To be added.

Remarks
To be added.
AppendMail
public bool AppendMail (string mailbox, Xemail.Mail.XMail email)

Append a mail to mailbox.

Parameters
mailbox
destination mailbox.
email
Xmail to append.
Returns
To be added.
Remarks
To be added.
AppendMime
public bool AppendMime (string mailbox, string mimeText)

To be added.

Parameters
mailbox
To be added.
mimeText
To be added.
Returns
To be added.
Remarks
To be added.
Capability
public string Capability ()

Check the server capabilities. This is need to call other command that depends on server capabilites like quota or namespace.

Returns
a string representation of server capabilities.
Remarks
To be added.
Connect
public bool Connect (string hostname)

Connect to the specified hostname.

Parameters
hostname
To be added.
Returns
To be added.
Remarks
To be added.
Copy
public bool Copy (string messageset, string destination)

To be added.

Parameters
messageset
a string representation of a message set : "1" , "1,3" , "1-5,8"
destination
mailbox destination name
Returns
To be added.
Remarks
To be added.
CreateMailbox
public bool CreateMailbox (string mailbox)

Create a new mailbox.

Parameters
mailbox
Mailbox name.
Returns
To be added.
Remarks
To be added.
DeleteMailbox
public bool DeleteMailbox (string mailbox)

Delete a mailbox.

Parameters
mailbox
Mailbox name.
Returns
To be added.
Remarks
To be added.
Disconnect
public void Disconnect ()

Diconnect from the server.

Remarks
To be added.
Examine
public Xemail.Mail.XMailbox Examine (string mailbox)

To be added.

Parameters
mailbox
To be added.
Returns
To be added.
Remarks
To be added.
Expunge
public bool Expunge ()

The EXPUNGE command permanently removes all messages that have the flag set from the currently selected mailbox.

Returns
To be added.
Remarks
To be added.
FetchMessages
public Xemail.Mail.XMails FetchMessages (string start, string end, bool uid, bool headersonly, bool setseen)

To be added.

Parameters
start
To be added.
end
To be added.
uid
To be added.
headersonly
To be added.
setseen
To be added.
Returns
To be added.
Remarks
To be added.
IsConnected
public bool IsConnected ()

To check connected status.

Returns
To be added.
Remarks
To be added.
IsLoggedIn
public bool IsLoggedIn ()

To check login status.

Returns
To be added.
Remarks
To be added.
ListMailboxes
public Xemail.Mail.XMailboxes ListMailboxes (string reference, string pattern)

The LIST command returns a subset of names from the complete set of all names available to the client.

Parameters
reference
To be added.
pattern
To be added.
Returns
To be added.
Remarks
To be added.
ListSuscribesMailboxes
public Xemail.Mail.XMailboxes ListSuscribesMailboxes (string reference, string pattern)

The LSUB command returns a subset of names from the set of names that the user has declared as being "active" or "subscribed".

Parameters
reference
To be added.
pattern
To be added.
Returns
To be added.
Remarks
To be added.
Login
public bool Login (string login, string password)

Login to the server.

Parameters
login
string representing login.
password
String representing password.
Returns
To be added.
Remarks
To be added.
Logout
public bool Logout ()

Logout to the server.

Returns
To be added.
Remarks
To be added.
Namespace
public Namespaces Namespace ()

To be added.

Returns
To be added.
Remarks
To be added.
NumMails
public int NumMails (string mailbox)

Get the number of mails on the server in the specified mailbox.

Parameters
mailbox
Returns
To be added.
Remarks
To be added.
RefetchMailFlags
public bool RefetchMailFlags (Xemail.Mail.XMail email)

To be added.

Parameters
email
To be added.
Returns
To be added.
Remarks
To be added.
RenameMailbox
public bool RenameMailbox (string frommailbox, string tomailbox)

The RENAME command changes the name of a mailbox.

Parameters
frommailbox
the mailbox to rename.
tomailbox
New mailbox name.
Returns
To be added.
Remarks
To be added.
Search
public Xemail.Mail.MessageSet Search (string criteria, bool uid)

The SEARCH command searches the mailbox for messages that match the given searching criteria.

Parameters
criteria
To be added.
uid
To be added.
Returns
To be added.
Remarks
To be added.
SelectMailbox
public Xemail.Mail.XMailbox SelectMailbox (string mailbox)

The SELECT command selects a mailbox so that messages in the mailbox can be accessed.

Parameters
mailbox
To be added.
Returns
To be added.
Remarks
To be added.
Store
public bool Store (string messageset, bool replace, string flags)

The STORE command alters data associated with a message in the mailbox.

Parameters
messageset
To be added.
replace
To be added.
flags
To be added.
Returns
To be added.
Remarks
To be added.
SuscribeMailbox
public bool SuscribeMailbox (string mailbox)

The SUBSCRIBE command adds the specified mailbox name to the server's set of "active" or "subscribed" mailboxes as returned by the LSUB command.

Parameters
mailbox
To be added.
Returns
To be added.
Remarks
To be added.
UnSuscribeMailbox
public bool UnSuscribeMailbox (string mailbox)

The UNSUBSCRIBE command removes the specified mailbox name from the server's set of "active" or "subscribed" mailboxes as returned by the LSUB command.

Parameters
mailbox
To be added.
Returns
To be added.
Remarks
To be added.
AuthMethod
public string AuthMethod { set; get; }

Authentication method use with the server. At this time only LOGIN and CRAM-MD5 are supported

Value
value is a string representing authentication method : LOGIN,CRAM-MD5
Remarks
LastError
public string LastError { get; }

Contain the last error message.

Value
a string containing the last error message
Remarks
To be added.
ConnectedHostName
public string ConnectedHostName { get; }

Server Hostname

Value
Server Hostname
Remarks
Port
public int Port { set; get; }

the Ip Port of the remote server

Value
To be added.
Remarks
To be added.
Ssl
public bool Ssl { set; get; }

Specifie is the connection use Ssl

Value
To be added.
Remarks
To be added.