#include <Mailbox.h>
Public Member Functions | |
Mailbox () | |
Constructor. | |
~Mailbox () | |
Destructor. | |
bool | getHttpLogging () const |
Determines if the HTTP communication will be logged. | |
String | getHttpLoggingFile () const |
If logging is set, this is the file it will log to. | |
String | getHttpProxyHost () const |
Returns the Proxy host. | |
uint16_t | getHttpProxyPort () const |
Returns the Proxy port. | |
bool | isLoggedIn () const |
Determines if the Mailbox is currently logged in. | |
String | getLoginUrl () const |
Gets the login url. | |
String | getLoginContent () const |
Gets the WebDAV Xml content that is sent to the login url in order to obtain the information regarding the mailbox. | |
String | getUser () const |
Gets the user name of the mailbox account. | |
String | getPassword () const |
Gets the password of the mailbox account. | |
String | getDomain () const |
Gets the domain of the mailbox account. | |
http::Session * | getSession () |
Gets the Http Session used for communicating with the server. | |
const http::Session * | getSession () const |
overload | |
Folder * | getRootFolder () |
Gets the root level folder of the mailbox. | |
const Folder * | getRootFolder () const |
overload | |
void | setHttpLogging (bool logging) |
Sets if the HTTP communication should be logged. | |
void | setHttpLoggingFile (String file) |
If logging is set, this is the file it will log to. | |
void | setHttpProxy (String host, uint16_t port) |
Sets Proxy information if an HTTP proxy is to be used for communication. | |
void | setLoginUrl (String url) |
Sets the login url. | |
void | setLoginContent (String content) |
Sets the WebDAV Xml content that is sent to the login url in order to obtain the information regarding the mailbox. | |
void | setUser (String user) |
Sets the user name of the mailbox account. | |
void | setPassword (String password) |
Sets the password of the mailbox account. | |
void | login () |
Logs into the account. | |
void | logout () |
Logs out of the account. | |
void | sendMessage (String msg, String mailFromRcpt=String::null) |
Sends an email. | |
String | processWebDavRequest (const http::Url &url, String webDavMethod, String webDavContent, String &errMsg) |
Processes a WebDAV request. | |
String | processWebDavRequest (const http::Url &url, String webDavMethod, String webDavContent, http::Headers &custHeaders, String &errMsg) |
Overloaded to allow for custom headers to be added to a request. |
|
Constructor.
|
|
Destructor.
|
|
Determines if the HTTP communication will be logged.
|
|
If logging is set, this is the file it will log to.
|
|
Returns the Proxy host.
|
|
Returns the Proxy port.
|
|
Determines if the Mailbox is currently logged in.
|
|
Gets the login url. This is the url used to connect to the HttpMail server. |
|
Gets the WebDAV Xml content that is sent to the login url in order to obtain the information regarding the mailbox.
|
|
Gets the user name of the mailbox account.
|
|
Gets the password of the mailbox account.
|
|
Gets the domain of the mailbox account.
|
|
Gets the Http Session used for communicating with the server. This function will return 0 when the mailbox is not logged in. |
|
overload
|
|
Gets the root level folder of the mailbox. When logging in, this folder has its Folder::refresh() function called, so it's not required to be called initially. This function will return 0 when the mailbox is not logged in. |
|
overload
|
|
Sets if the HTTP communication should be logged. This must only be called before the mailbox logs in. |
|
If logging is set, this is the file it will log to.
|
|
Sets Proxy information if an HTTP proxy is to be used for communication.
|
|
Sets the login url. This is the url used to connect to the HttpMail server. If this function is called while the mailbox is logged in, a MailboxInvalidModeException is thrown. |
|
Sets the WebDAV Xml content that is sent to the login url in order to obtain the information regarding the mailbox. There is a default value set for this by the mailbox and it should not be changed unless you know what you are doing. If this function is called while the mailbox is logged in, a MailboxInvalidModeException is thrown. |
|
Sets the user name of the mailbox account. If this function is called while the mailbox is logged in, a MailboxInvalidModeException is thrown. |
|
Sets the password of the mailbox account. If this function is called while the mailbox is logged in, a MailboxInvalidModeException is thrown. |
|
Logs into the account. The user name and password must have previously been set. If this function is called while the mailbox is logged in, a MailboxInvalidModeException is thrown. |
|
Logs out of the account. Any Folder instances and Message instance are deleted and should be discarded. They will not become valid again if the mailbox logs in again. |
|
Sends an email.
The |
|
Processes a WebDAV request.
|
|
Overloaded to allow for custom headers to be added to a request.
|