Classes | |
| class | property |
Public Member Functions | |
| virtual | ~serviceInfos () |
| virtual const string | getPropertyPrefix () const =0 |
| virtual const std::vector < property > | getAvailableProperties () const =0 |
| template<typename TYPE > | |
| const TYPE | getPropertyValue (shared_ptr< session > s, const property &p) const |
| bool | hasProperty (shared_ptr< session > s, const property &p) const |
Protected Member Functions | |
| serviceInfos () | |
| serviceInfos (const serviceInfos &) | |
Detailed Description
Stores information about a messaging service.
Constructor & Destructor Documentation
|
protected |
|
protected |
|
virtual |
Member Function Documentation
|
pure virtual |
Return a list of available properties for this service.
- Returns
- list of properties
Implemented in SMTPServiceInfos, POP3ServiceInfos, IMAPServiceInfos, maildirServiceInfos, and sendmailServiceInfos.
|
pure virtual |
Return the property prefix used by this service.
Use this to set/get properties in the session object.
- Returns
- property prefix
Implemented in SMTPServiceInfos, POP3ServiceInfos, IMAPServiceInfos, maildirServiceInfos, and sendmailServiceInfos.
Referenced by serviceInfos::hasProperty().
Helper function to retrieve the value of a property.
- Parameters
-
s session object p property to retrieve
- Exceptions
-
exceptions::no_such_property if the property does not exist and has the flag property::FLAG_REQUIRED
- Returns
- value of the property
References serviceInfos::property::getDefaultValue(), serviceInfos::property::getFlags(), and serviceInfos::property::getName().
Helper function to test if the specified property is set in the session object.
- Parameters
-
s session object p property to test
- Returns
- true if the property is set, false otherwise
References serviceInfos::property::getName(), and serviceInfos::getPropertyPrefix().
The documentation for this class was generated from the following files:
