Trees       Index       Help   

Chandler

Package osaf :: Package pim :: Module mail :: Class AccountBase
[frames | no frames]

Type AccountBase

object --+                
         |                
     CItem --+            
             |            
          Item --+        
                 |        
              Item --+    
                     |    
           ContentItem --+
                         |
                        AccountBase

Known Subclasses:
DownloadAccountBase, SMTPAccount
Method Summary
  getActiveAccounts(cls, view)
(Class method)
Inherited from ContentItem: __init__, __str__, __unicode__, addToCollection, ExportItemData, getBasedAttributes, getCurrentMeEmailAddress, getEmailAddress, getMembershipItem, getSharedState, InitOutgoingAttributes, isAttributeModifiable, ItemAboutString, ItemBodyString, ItemWhoFromString, ItemWhoString, removeFromCollection, SetItemBodyString, StampKind
Inherited from Item: getDefaultParent, getKind, iterItems
Inherited from Item: __getitem__, __iter__, _repr_, addValue, check, clone, collectionChanged, copy, delete, dir, find, findMatch, findPath, findUUID, getACL, getAttributeValue, getItemChild, getItemCloud, getItemDisplayName, getItemDisplayString, getValue, getVersion, hasAttributeAspect, hasChild, hasChildren, hashItem, hasKey, hasLocalAttributeValue, hasValue, isAttributeDirty, isItemOf, isRemote, iterAttributeValues, iterChildren, mixinKinds, move, placeChild, printItem, refCount, removeACL, removeAttributeValue, removeValue, rename, setACL, setAttributeValue, setPinned, setValue, unwatchCollection, unwatchKind, walk, watchCollection, watchKind
Inherited from CItem: __new__, __repr__, getAttributeAspect, getDirty, isDeleted, isDeleting, isDirty, isNew, isPinned, isSchema, isStale, setDirty
Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__

Property Summary
Inherited from ContentItem: bodyString, sharedState

Instance Variable Summary
  connectionSecurity: Connection Security -- One(connectionSecurityEnum)
  host: Host -- One(Text)
  isActive: Is active -- One(Boolean)
  mailMessages: Mail Messages -- Sequence(MailMessageMixin)
  numRetries: Number of Retries -- One(Integer)
  password: Password -- One(Text) This could either be a password or some other sort of authentication info.
  pollingFrequency: Polling frequency -- One(Integer)
  port: Port -- One(Integer)
  timeout: Timeout -- One(Integer)
  username: Username -- One(Text)
Inherited from ContentItem: body, contentsOwner, createdOn, creator, importance, lastModified, lastModifiedBy, mine, modifiedOn, previousStamps, private, read, sharedIn, shares, TPBDetailItemOwner, TPBSelectedItemOwner, viewContainer
Inherited from Item: collections, description, displayName, kindExtent, monitors, references, watcherDispatch, watchers, watches
Inherited from Item: aliasedBy, path, typeFor, version
Inherited from CItem: itsKind, itsName, itsParent, itsPath, itsRoot, itsUUID, itsVersion, itsView

Class Variable Summary
ItemRoot __default_path__ = ItemRoot'userdata'
dict __kind_info__ = {'displayName': u'Account base kind', 'd...
Inherited from ContentItem: __kind_clouds__, READONLY, READWRITE, UNSHARED
Inherited from CItem: ADIRTY, CDIRTY, CMERGED, CONTAINER, COPYEXPORT, CORESCHEMA, DELETED, DELETING, DIRTY, FDIRTY, IMPORTING, MERGED, MUTATING, NDIRTY, NEW, NMERGED, NODIRTY, PINNED, RAW, RDIRTY, RMERGED, SAVEMASK, SCHEMA, STALE, VDIRTY, VMERGED, VRDIRTY

Instance Variable Details

connectionSecurity

Connection Security -- One(connectionSecurityEnum)

The security mechanism to leverage for a network connection
Value:
<Role connectionSecurity of <class 'osaf.pim.mail.AccountBase'>>

host

Host -- One(Text)

The hostname of the account
Value:
<Role host of <class 'osaf.pim.mail.AccountBase'>>

isActive

Is active -- One(Boolean)

Whether or not an account should be used for sending or fetching email
Value:
<Role isActive of <class 'osaf.pim.mail.AccountBase'>>

mailMessages

Mail Messages -- Sequence(MailMessageMixin)

Mail Messages sent or retrieved with this account
Value:
<Role mailMessages of <class 'osaf.pim.mail.AccountBase'>>

numRetries

Number of Retries -- One(Integer)

How many times to retry before giving up
Value:
<Role numRetries of <class 'osaf.pim.mail.AccountBase'>>

password

Password -- One(Text)

This could either be a password or some other sort of authentication info. We can use it for whatever is needed for this account type.

Issues:
   This should not be a simple string. We need some solution for encrypting it.
Value:
<Role password of <class 'osaf.pim.mail.AccountBase'>>

pollingFrequency

Polling frequency -- One(Integer)

Frequency in seconds
Value:
<Role pollingFrequency of <class 'osaf.pim.mail.AccountBase'>>

port

Port -- One(Integer)

The port number to use
Value:
<Role port of <class 'osaf.pim.mail.AccountBase'>>

timeout

Timeout -- One(Integer)

The number of seconds before timing out a stalled connection
Value:
<Role timeout of <class 'osaf.pim.mail.AccountBase'>>

username

Username -- One(Text)

The account login name
Value:
<Role username of <class 'osaf.pim.mail.AccountBase'>>

Class Variable Details

__default_path__

Type:
ItemRoot
Value:
ItemRoot'userdata'

__kind_info__

Type:
dict
Value:
{'description': 'The base kind for various account kinds, such as IMAP\
, SMTP, WebDav',
 'displayName': u'Account base kind'}

   Trees       Index       Help   

Chandler

Generated by Epydoc 2.1 on Mon Dec 19 13:33:26 2005 http://epydoc.sf.net