Module exchangelib.folders.known_folders

Expand source code
from ..items import (
    ASSOCIATED,
    ITEM_CLASSES,
    CalendarItem,
    Contact,
    DistributionList,
    MeetingCancellation,
    MeetingRequest,
    MeetingResponse,
    Message,
    Task,
)
from ..properties import EWSMeta
from ..version import EXCHANGE_2010_SP1, EXCHANGE_2013, EXCHANGE_2013_SP1
from .base import Folder
from .collections import FolderCollection


class Calendar(Folder):
    """An interface for the Exchange calendar."""

    DISTINGUISHED_FOLDER_ID = "calendar"
    CONTAINER_CLASS = "IPF.Appointment"
    supported_item_models = (CalendarItem,)

    LOCALIZED_NAMES = {
        "da_DK": ("Kalender",),
        "de_DE": ("Kalender",),
        "en_US": ("Calendar",),
        "es_ES": ("Calendario",),
        "fr_CA": ("Calendrier",),
        "nl_NL": ("Agenda",),
        "ru_RU": ("Календарь",),
        "sv_SE": ("Kalender",),
        "zh_CN": ("日历",),
    }

    def view(self, *args, **kwargs):
        return FolderCollection(account=self.account, folders=[self]).view(*args, **kwargs)


class DeletedItems(Folder):
    DISTINGUISHED_FOLDER_ID = "deleteditems"
    CONTAINER_CLASS = "IPF.Note"
    supported_item_models = ITEM_CLASSES

    LOCALIZED_NAMES = {
        "da_DK": ("Slettet post",),
        "de_DE": ("Gelöschte Elemente",),
        "en_US": ("Deleted Items",),
        "es_ES": ("Elementos eliminados",),
        "fr_CA": ("Éléments supprimés",),
        "nl_NL": ("Verwijderde items",),
        "ru_RU": ("Удаленные",),
        "sv_SE": ("Borttaget",),
        "zh_CN": ("已删除邮件",),
    }


class Messages(Folder):
    CONTAINER_CLASS = "IPF.Note"
    supported_item_models = (Message, MeetingRequest, MeetingResponse, MeetingCancellation)


class CrawlerData(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.CrawlerData"


class DlpPolicyEvaluation(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.DlpPolicyEvaluation"


class FreeBusyCache(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.FreeBusyCache"


class RecoveryPoints(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.RecoveryPoints"


class SwssItems(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.SwssItems"


class SkypeTeamsMessages(Folder):
    CONTAINER_CLASS = "IPF.SkypeTeams.Message"
    LOCALIZED_NAMES = {
        None: ("Team-chat",),
    }


class Birthdays(Folder):
    CONTAINER_CLASS = "IPF.Appointment.Birthday"
    LOCALIZED_NAMES = {
        None: ("Birthdays",),
        "da_DK": ("Fødselsdage",),
    }


class Drafts(Messages):
    DISTINGUISHED_FOLDER_ID = "drafts"

    LOCALIZED_NAMES = {
        "da_DK": ("Kladder",),
        "de_DE": ("Entwürfe",),
        "en_US": ("Drafts",),
        "es_ES": ("Borradores",),
        "fr_CA": ("Brouillons",),
        "nl_NL": ("Concepten",),
        "ru_RU": ("Черновики",),
        "sv_SE": ("Utkast",),
        "zh_CN": ("草稿",),
    }


class Inbox(Messages):
    DISTINGUISHED_FOLDER_ID = "inbox"

    LOCALIZED_NAMES = {
        "da_DK": ("Indbakke",),
        "de_DE": ("Posteingang",),
        "en_US": ("Inbox",),
        "es_ES": ("Bandeja de entrada",),
        "fr_CA": ("Boîte de réception",),
        "nl_NL": ("Postvak IN",),
        "ru_RU": ("Входящие",),
        "sv_SE": ("Inkorgen",),
        "zh_CN": ("收件箱",),
    }


class Outbox(Messages):
    DISTINGUISHED_FOLDER_ID = "outbox"

    LOCALIZED_NAMES = {
        "da_DK": ("Udbakke",),
        "de_DE": ("Postausgang",),
        "en_US": ("Outbox",),
        "es_ES": ("Bandeja de salida",),
        "fr_CA": ("Boîte d'envoi",),
        "nl_NL": ("Postvak UIT",),
        "ru_RU": ("Исходящие",),
        "sv_SE": ("Utkorgen",),
        "zh_CN": ("发件箱",),
    }


class SentItems(Messages):
    DISTINGUISHED_FOLDER_ID = "sentitems"

    LOCALIZED_NAMES = {
        "da_DK": ("Sendt post",),
        "de_DE": ("Gesendete Elemente",),
        "en_US": ("Sent Items",),
        "es_ES": ("Elementos enviados",),
        "fr_CA": ("Éléments envoyés",),
        "nl_NL": ("Verzonden items",),
        "ru_RU": ("Отправленные",),
        "sv_SE": ("Skickat",),
        "zh_CN": ("已发送邮件",),
    }


class JunkEmail(Messages):
    DISTINGUISHED_FOLDER_ID = "junkemail"

    LOCALIZED_NAMES = {
        "da_DK": ("Uønsket e-mail",),
        "de_DE": ("Junk-E-Mail",),
        "en_US": ("Junk E-mail",),
        "es_ES": ("Correo no deseado",),
        "fr_CA": ("Courrier indésirables",),
        "nl_NL": ("Ongewenste e-mail",),
        "ru_RU": ("Нежелательная почта",),
        "sv_SE": ("Skräppost",),
        "zh_CN": ("垃圾邮件",),
    }


class Tasks(Folder):
    DISTINGUISHED_FOLDER_ID = "tasks"
    CONTAINER_CLASS = "IPF.Task"
    supported_item_models = (Task,)

    LOCALIZED_NAMES = {
        "da_DK": ("Opgaver",),
        "de_DE": ("Aufgaben",),
        "en_US": ("Tasks",),
        "es_ES": ("Tareas",),
        "fr_CA": ("Tâches",),
        "nl_NL": ("Taken",),
        "ru_RU": ("Задачи",),
        "sv_SE": ("Uppgifter",),
        "zh_CN": ("任务",),
    }


class Contacts(Folder):
    DISTINGUISHED_FOLDER_ID = "contacts"
    CONTAINER_CLASS = "IPF.Contact"
    supported_item_models = (Contact, DistributionList)

    LOCALIZED_NAMES = {
        "da_DK": ("Kontaktpersoner",),
        "de_DE": ("Kontakte",),
        "en_US": ("Contacts",),
        "es_ES": ("Contactos",),
        "fr_CA": ("Contacts",),
        "nl_NL": ("Contactpersonen",),
        "ru_RU": ("Контакты",),
        "sv_SE": ("Kontakter",),
        "zh_CN": ("联系人",),
    }


class WellknownFolder(Folder, metaclass=EWSMeta):
    """Base class to use until we have a more specific folder implementation for this folder."""

    supported_item_models = ITEM_CLASSES


class AdminAuditLogs(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "adminauditlogs"
    supported_from = EXCHANGE_2013
    get_folder_allowed = False


class ArchiveDeletedItems(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archivedeleteditems"
    supported_from = EXCHANGE_2010_SP1


class ArchiveInbox(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiveinbox"
    supported_from = EXCHANGE_2013_SP1


class ArchiveMsgFolderRoot(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archivemsgfolderroot"
    supported_from = EXCHANGE_2010_SP1


class ArchiveRecoverableItemsDeletions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemsdeletions"
    supported_from = EXCHANGE_2010_SP1


class ArchiveRecoverableItemsPurges(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemspurges"
    supported_from = EXCHANGE_2010_SP1


class ArchiveRecoverableItemsRoot(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemsroot"
    supported_from = EXCHANGE_2010_SP1


class ArchiveRecoverableItemsVersions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemsversions"
    supported_from = EXCHANGE_2010_SP1


class Conflicts(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "conflicts"
    supported_from = EXCHANGE_2013


class ConversationHistory(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "conversationhistory"
    supported_from = EXCHANGE_2013


class Directory(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "directory"
    supported_from = EXCHANGE_2013_SP1


class Favorites(WellknownFolder):
    CONTAINER_CLASS = "IPF.Note"
    DISTINGUISHED_FOLDER_ID = "favorites"
    supported_from = EXCHANGE_2013


class IMContactList(WellknownFolder):
    CONTAINER_CLASS = "IPF.Contact.MOC.ImContactList"
    DISTINGUISHED_FOLDER_ID = "imcontactlist"
    supported_from = EXCHANGE_2013


class Journal(WellknownFolder):
    CONTAINER_CLASS = "IPF.Journal"
    DISTINGUISHED_FOLDER_ID = "journal"


class LocalFailures(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "localfailures"
    supported_from = EXCHANGE_2013


class MsgFolderRoot(WellknownFolder):
    """Also known as the 'Top of Information Store' folder."""

    DISTINGUISHED_FOLDER_ID = "msgfolderroot"
    LOCALIZED_NAMES = {
        None: ("Top of Information Store",),
        "da_DK": ("Informationslagerets øverste niveau",),
        "zh_CN": ("信息存储顶部",),
    }


class MyContacts(WellknownFolder):
    CONTAINER_CLASS = "IPF.Note"
    DISTINGUISHED_FOLDER_ID = "mycontacts"
    supported_from = EXCHANGE_2013


class Notes(WellknownFolder):
    CONTAINER_CLASS = "IPF.StickyNote"
    DISTINGUISHED_FOLDER_ID = "notes"
    LOCALIZED_NAMES = {
        "da_DK": ("Noter",),
    }


class PeopleConnect(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "peopleconnect"
    supported_from = EXCHANGE_2013


class QuickContacts(WellknownFolder):
    CONTAINER_CLASS = "IPF.Contact.MOC.QuickContacts"
    DISTINGUISHED_FOLDER_ID = "quickcontacts"
    supported_from = EXCHANGE_2013


class RecipientCache(Contacts):
    DISTINGUISHED_FOLDER_ID = "recipientcache"
    CONTAINER_CLASS = "IPF.Contact.RecipientCache"
    supported_from = EXCHANGE_2013

    LOCALIZED_NAMES = {}


class RecoverableItemsDeletions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemsdeletions"
    supported_from = EXCHANGE_2010_SP1


class RecoverableItemsPurges(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemspurges"
    supported_from = EXCHANGE_2010_SP1


class RecoverableItemsRoot(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemsroot"
    supported_from = EXCHANGE_2010_SP1


class RecoverableItemsVersions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemsversions"
    supported_from = EXCHANGE_2010_SP1


class SearchFolders(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "searchfolders"


class ServerFailures(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "serverfailures"
    supported_from = EXCHANGE_2013


class SyncIssues(WellknownFolder):
    CONTAINER_CLASS = "IPF.Note"
    DISTINGUISHED_FOLDER_ID = "syncissues"
    supported_from = EXCHANGE_2013


class ToDoSearch(WellknownFolder):
    CONTAINER_CLASS = "IPF.Task"
    DISTINGUISHED_FOLDER_ID = "todosearch"
    supported_from = EXCHANGE_2013

    LOCALIZED_NAMES = {
        None: ("To-Do Search",),
    }


class VoiceMail(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "voicemail"
    CONTAINER_CLASS = "IPF.Note.Microsoft.Voicemail"
    LOCALIZED_NAMES = {
        None: ("Voice Mail",),
    }


class NonDeletableFolderMixin:
    """A mixin for non-wellknown folders than that are not deletable."""

    @property
    def is_deletable(self):
        return False


class AllContacts(NonDeletableFolderMixin, Contacts):
    CONTAINER_CLASS = "IPF.Note"

    LOCALIZED_NAMES = {
        None: ("AllContacts",),
    }


class AllItems(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF"

    LOCALIZED_NAMES = {
        None: ("AllItems",),
    }


class ApplicationData(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPM.ApplicationData"


class Audits(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Audits",),
    }
    get_folder_allowed = False


class CalendarLogging(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Calendar Logging",),
    }


class CommonViews(NonDeletableFolderMixin, Folder):
    DEFAULT_ITEM_TRAVERSAL_DEPTH = ASSOCIATED
    LOCALIZED_NAMES = {
        None: ("Common Views",),
    }


class Companies(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINTER_CLASS = "IPF.Contact.Company"
    LOCALIZED_NAMES = {
        None: ("Companies",),
        "da_DK": ("Firmaer",),
    }


class ConversationSettings(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Configuration"
    LOCALIZED_NAMES = {
        "da_DK": ("Indstillinger for samtalehandlinger",),
    }


class DefaultFoldersChangeHistory(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPM.DefaultFolderHistoryItem"
    LOCALIZED_NAMES = {
        None: ("DefaultFoldersChangeHistory",),
    }


class DeferredAction(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Deferred Action",),
    }


class ExchangeSyncData(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("ExchangeSyncData",),
    }


class Files(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Files"

    LOCALIZED_NAMES = {
        "da_DK": ("Filer",),
    }


class FreebusyData(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Freebusy Data",),
    }


class Friends(NonDeletableFolderMixin, Contacts):
    CONTAINER_CLASS = "IPF.Note"

    LOCALIZED_NAMES = {
        "de_DE": ("Bekannte",),
    }


class GALContacts(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINER_CLASS = "IPF.Contact.GalContacts"

    LOCALIZED_NAMES = {
        None: ("GAL Contacts",),
    }


class GraphAnalytics(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.GraphAnalytics"
    LOCALIZED_NAMES = {
        None: ("GraphAnalytics",),
    }


class Location(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Location",),
    }


class MailboxAssociations(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("MailboxAssociations",),
    }


class MyContactsExtended(NonDeletableFolderMixin, Contacts):
    CONTAINER_CLASS = "IPF.Note"
    LOCALIZED_NAMES = {
        None: ("MyContactsExtended",),
    }


class OrganizationalContacts(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINTER_CLASS = "IPF.Contact.OrganizationalContacts"
    LOCALIZED_NAMES = {
        None: ("Organizational Contacts",),
    }


class ParkedMessages(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = None
    LOCALIZED_NAMES = {
        None: ("ParkedMessages",),
    }


class PassThroughSearchResults(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.PassThroughSearchResults"
    LOCALIZED_NAMES = {
        None: ("Pass-Through Search Results",),
    }


class PeopleCentricConversationBuddies(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINTER_CLASS = "IPF.Contact.PeopleCentricConversationBuddies"
    LOCALIZED_NAMES = {
        None: ("PeopleCentricConversation Buddies",),
    }


class PdpProfileV2Secured(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.PdpProfileSecured"
    LOCALIZED_NAMES = {
        None: ("PdpProfileV2Secured",),
    }


class Reminders(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "Outlook.Reminder"
    LOCALIZED_NAMES = {
        "da_DK": ("Påmindelser",),
    }


class RSSFeeds(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Note.OutlookHomepage"
    LOCALIZED_NAMES = {
        None: ("RSS Feeds",),
    }


class Schedule(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Schedule",),
    }


class Sharing(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Note"
    LOCALIZED_NAMES = {
        None: ("Sharing",),
    }


class Shortcuts(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Shortcuts",),
    }


class Signal(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.Signal"
    LOCALIZED_NAMES = {
        None: ("Signal",),
    }


class SmsAndChatsSync(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.SmsAndChatsSync"
    LOCALIZED_NAMES = {
        None: ("SmsAndChatsSync",),
    }


class SpoolerQueue(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Spooler Queue",),
    }


class System(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("System",),
    }
    get_folder_allowed = False


class System1(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("System1",),
    }
    get_folder_allowed = False


class TemporarySaves(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("TemporarySaves",),
    }


class Views(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Views",),
    }


class WorkingSet(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Working Set",),
    }


# Folders that return 'ErrorDeleteDistinguishedFolder' when we try to delete them. I can't find any official docs
# listing these folders.
NON_DELETABLE_FOLDERS = [
    AllContacts,
    AllItems,
    ApplicationData,
    Audits,
    CalendarLogging,
    CommonViews,
    Companies,
    ConversationSettings,
    DefaultFoldersChangeHistory,
    DeferredAction,
    ExchangeSyncData,
    FreebusyData,
    Files,
    Friends,
    GALContacts,
    GraphAnalytics,
    Location,
    MailboxAssociations,
    MyContactsExtended,
    OrganizationalContacts,
    ParkedMessages,
    PassThroughSearchResults,
    PeopleCentricConversationBuddies,
    PdpProfileV2Secured,
    Reminders,
    RSSFeeds,
    Schedule,
    Sharing,
    Shortcuts,
    Signal,
    SmsAndChatsSync,
    SpoolerQueue,
    System,
    System1,
    TemporarySaves,
    Views,
    WorkingSet,
]

WELLKNOWN_FOLDERS_IN_ROOT = [
    AdminAuditLogs,
    Calendar,
    Conflicts,
    Contacts,
    ConversationHistory,
    DeletedItems,
    Directory,
    Drafts,
    Favorites,
    IMContactList,
    Inbox,
    Journal,
    JunkEmail,
    LocalFailures,
    MsgFolderRoot,
    MyContacts,
    Notes,
    Outbox,
    PeopleConnect,
    QuickContacts,
    RecipientCache,
    RecoverableItemsDeletions,
    RecoverableItemsPurges,
    RecoverableItemsRoot,
    RecoverableItemsVersions,
    SearchFolders,
    SentItems,
    ServerFailures,
    SyncIssues,
    Tasks,
    ToDoSearch,
    VoiceMail,
]

WELLKNOWN_FOLDERS_IN_ARCHIVE_ROOT = [
    ArchiveDeletedItems,
    ArchiveInbox,
    ArchiveMsgFolderRoot,
    ArchiveRecoverableItemsDeletions,
    ArchiveRecoverableItemsPurges,
    ArchiveRecoverableItemsRoot,
    ArchiveRecoverableItemsVersions,
]

MISC_FOLDERS = [
    CrawlerData,
    DlpPolicyEvaluation,
    FreeBusyCache,
    RecoveryPoints,
    SwssItems,
    SkypeTeamsMessages,
    Birthdays,
]

Classes

class AdminAuditLogs (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class AdminAuditLogs(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "adminauditlogs"
    supported_from = EXCHANGE_2013
    get_folder_allowed = False

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var get_folder_allowed
var supported_from

Inherited members

class AllContacts (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class AllContacts(NonDeletableFolderMixin, Contacts):
    CONTAINER_CLASS = "IPF.Note"

    LOCALIZED_NAMES = {
        None: ("AllContacts",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class AllItems (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class AllItems(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF"

    LOCALIZED_NAMES = {
        None: ("AllItems",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class ApplicationData (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class ApplicationData(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPM.ApplicationData"

Ancestors

Class variables

var CONTAINER_CLASS

Inherited members

class ArchiveDeletedItems (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveDeletedItems(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archivedeleteditems"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ArchiveInbox (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveInbox(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiveinbox"
    supported_from = EXCHANGE_2013_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ArchiveMsgFolderRoot (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveMsgFolderRoot(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archivemsgfolderroot"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ArchiveRecoverableItemsDeletions (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveRecoverableItemsDeletions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemsdeletions"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ArchiveRecoverableItemsPurges (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveRecoverableItemsPurges(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemspurges"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ArchiveRecoverableItemsRoot (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveRecoverableItemsRoot(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemsroot"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ArchiveRecoverableItemsVersions (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ArchiveRecoverableItemsVersions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "archiverecoverableitemsversions"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class Audits (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Audits(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Audits",),
    }
    get_folder_allowed = False

Ancestors

Class variables

var LOCALIZED_NAMES
var get_folder_allowed

Inherited members

class Birthdays (**kwargs)
Expand source code
class Birthdays(Folder):
    CONTAINER_CLASS = "IPF.Appointment.Birthday"
    LOCALIZED_NAMES = {
        None: ("Birthdays",),
        "da_DK": ("Fødselsdage",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class Calendar (**kwargs)

An interface for the Exchange calendar.

Expand source code
class Calendar(Folder):
    """An interface for the Exchange calendar."""

    DISTINGUISHED_FOLDER_ID = "calendar"
    CONTAINER_CLASS = "IPF.Appointment"
    supported_item_models = (CalendarItem,)

    LOCALIZED_NAMES = {
        "da_DK": ("Kalender",),
        "de_DE": ("Kalender",),
        "en_US": ("Calendar",),
        "es_ES": ("Calendario",),
        "fr_CA": ("Calendrier",),
        "nl_NL": ("Agenda",),
        "ru_RU": ("Календарь",),
        "sv_SE": ("Kalender",),
        "zh_CN": ("日历",),
    }

    def view(self, *args, **kwargs):
        return FolderCollection(account=self.account, folders=[self]).view(*args, **kwargs)

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES
var supported_item_models

Methods

def view(self, *args, **kwargs)
Expand source code
def view(self, *args, **kwargs):
    return FolderCollection(account=self.account, folders=[self]).view(*args, **kwargs)

Inherited members

class CalendarLogging (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class CalendarLogging(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Calendar Logging",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class CommonViews (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class CommonViews(NonDeletableFolderMixin, Folder):
    DEFAULT_ITEM_TRAVERSAL_DEPTH = ASSOCIATED
    LOCALIZED_NAMES = {
        None: ("Common Views",),
    }

Ancestors

Class variables

var DEFAULT_ITEM_TRAVERSAL_DEPTH
var LOCALIZED_NAMES

Inherited members

class Companies (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Companies(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINTER_CLASS = "IPF.Contact.Company"
    LOCALIZED_NAMES = {
        None: ("Companies",),
        "da_DK": ("Firmaer",),
    }

Ancestors

Class variables

var CONTAINTER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class Conflicts (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class Conflicts(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "conflicts"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class Contacts (**kwargs)
Expand source code
class Contacts(Folder):
    DISTINGUISHED_FOLDER_ID = "contacts"
    CONTAINER_CLASS = "IPF.Contact"
    supported_item_models = (Contact, DistributionList)

    LOCALIZED_NAMES = {
        "da_DK": ("Kontaktpersoner",),
        "de_DE": ("Kontakte",),
        "en_US": ("Contacts",),
        "es_ES": ("Contactos",),
        "fr_CA": ("Contacts",),
        "nl_NL": ("Contactpersonen",),
        "ru_RU": ("Контакты",),
        "sv_SE": ("Kontakter",),
        "zh_CN": ("联系人",),
    }

Ancestors

Subclasses

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES
var supported_item_models

Inherited members

class ConversationHistory (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ConversationHistory(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "conversationhistory"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class ConversationSettings (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class ConversationSettings(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Configuration"
    LOCALIZED_NAMES = {
        "da_DK": ("Indstillinger for samtalehandlinger",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class CrawlerData (**kwargs)
Expand source code
class CrawlerData(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.CrawlerData"

Ancestors

Class variables

var CONTAINER_CLASS

Inherited members

class DefaultFoldersChangeHistory (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class DefaultFoldersChangeHistory(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPM.DefaultFolderHistoryItem"
    LOCALIZED_NAMES = {
        None: ("DefaultFoldersChangeHistory",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class DeferredAction (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class DeferredAction(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Deferred Action",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class DeletedItems (**kwargs)
Expand source code
class DeletedItems(Folder):
    DISTINGUISHED_FOLDER_ID = "deleteditems"
    CONTAINER_CLASS = "IPF.Note"
    supported_item_models = ITEM_CLASSES

    LOCALIZED_NAMES = {
        "da_DK": ("Slettet post",),
        "de_DE": ("Gelöschte Elemente",),
        "en_US": ("Deleted Items",),
        "es_ES": ("Elementos eliminados",),
        "fr_CA": ("Éléments supprimés",),
        "nl_NL": ("Verwijderde items",),
        "ru_RU": ("Удаленные",),
        "sv_SE": ("Borttaget",),
        "zh_CN": ("已删除邮件",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES
var supported_item_models

Inherited members

class Directory (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class Directory(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "directory"
    supported_from = EXCHANGE_2013_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class DlpPolicyEvaluation (**kwargs)
Expand source code
class DlpPolicyEvaluation(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.DlpPolicyEvaluation"

Ancestors

Class variables

var CONTAINER_CLASS

Inherited members

class Drafts (**kwargs)
Expand source code
class Drafts(Messages):
    DISTINGUISHED_FOLDER_ID = "drafts"

    LOCALIZED_NAMES = {
        "da_DK": ("Kladder",),
        "de_DE": ("Entwürfe",),
        "en_US": ("Drafts",),
        "es_ES": ("Borradores",),
        "fr_CA": ("Brouillons",),
        "nl_NL": ("Concepten",),
        "ru_RU": ("Черновики",),
        "sv_SE": ("Utkast",),
        "zh_CN": ("草稿",),
    }

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class ExchangeSyncData (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class ExchangeSyncData(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("ExchangeSyncData",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class Favorites (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class Favorites(WellknownFolder):
    CONTAINER_CLASS = "IPF.Note"
    DISTINGUISHED_FOLDER_ID = "favorites"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class Files (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Files(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Files"

    LOCALIZED_NAMES = {
        "da_DK": ("Filer",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class FreeBusyCache (**kwargs)
Expand source code
class FreeBusyCache(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.FreeBusyCache"

Ancestors

Class variables

var CONTAINER_CLASS

Inherited members

class FreebusyData (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class FreebusyData(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Freebusy Data",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class Friends (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Friends(NonDeletableFolderMixin, Contacts):
    CONTAINER_CLASS = "IPF.Note"

    LOCALIZED_NAMES = {
        "de_DE": ("Bekannte",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class GALContacts (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class GALContacts(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINER_CLASS = "IPF.Contact.GalContacts"

    LOCALIZED_NAMES = {
        None: ("GAL Contacts",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class GraphAnalytics (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class GraphAnalytics(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.GraphAnalytics"
    LOCALIZED_NAMES = {
        None: ("GraphAnalytics",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class IMContactList (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class IMContactList(WellknownFolder):
    CONTAINER_CLASS = "IPF.Contact.MOC.ImContactList"
    DISTINGUISHED_FOLDER_ID = "imcontactlist"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class Inbox (**kwargs)
Expand source code
class Inbox(Messages):
    DISTINGUISHED_FOLDER_ID = "inbox"

    LOCALIZED_NAMES = {
        "da_DK": ("Indbakke",),
        "de_DE": ("Posteingang",),
        "en_US": ("Inbox",),
        "es_ES": ("Bandeja de entrada",),
        "fr_CA": ("Boîte de réception",),
        "nl_NL": ("Postvak IN",),
        "ru_RU": ("Входящие",),
        "sv_SE": ("Inkorgen",),
        "zh_CN": ("收件箱",),
    }

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class Journal (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class Journal(WellknownFolder):
    CONTAINER_CLASS = "IPF.Journal"
    DISTINGUISHED_FOLDER_ID = "journal"

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID

Inherited members

class JunkEmail (**kwargs)
Expand source code
class JunkEmail(Messages):
    DISTINGUISHED_FOLDER_ID = "junkemail"

    LOCALIZED_NAMES = {
        "da_DK": ("Uønsket e-mail",),
        "de_DE": ("Junk-E-Mail",),
        "en_US": ("Junk E-mail",),
        "es_ES": ("Correo no deseado",),
        "fr_CA": ("Courrier indésirables",),
        "nl_NL": ("Ongewenste e-mail",),
        "ru_RU": ("Нежелательная почта",),
        "sv_SE": ("Skräppost",),
        "zh_CN": ("垃圾邮件",),
    }

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class LocalFailures (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class LocalFailures(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "localfailures"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class Location (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Location(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Location",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class MailboxAssociations (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class MailboxAssociations(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("MailboxAssociations",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class Messages (**kwargs)
Expand source code
class Messages(Folder):
    CONTAINER_CLASS = "IPF.Note"
    supported_item_models = (Message, MeetingRequest, MeetingResponse, MeetingCancellation)

Ancestors

Subclasses

Class variables

var CONTAINER_CLASS
var supported_item_models

Inherited members

class MsgFolderRoot (**kwargs)

Also known as the 'Top of Information Store' folder.

Expand source code
class MsgFolderRoot(WellknownFolder):
    """Also known as the 'Top of Information Store' folder."""

    DISTINGUISHED_FOLDER_ID = "msgfolderroot"
    LOCALIZED_NAMES = {
        None: ("Top of Information Store",),
        "da_DK": ("Informationslagerets øverste niveau",),
        "zh_CN": ("信息存储顶部",),
    }

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class MyContacts (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class MyContacts(WellknownFolder):
    CONTAINER_CLASS = "IPF.Note"
    DISTINGUISHED_FOLDER_ID = "mycontacts"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class MyContactsExtended (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class MyContactsExtended(NonDeletableFolderMixin, Contacts):
    CONTAINER_CLASS = "IPF.Note"
    LOCALIZED_NAMES = {
        None: ("MyContactsExtended",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class NonDeletableFolderMixin

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class NonDeletableFolderMixin:
    """A mixin for non-wellknown folders than that are not deletable."""

    @property
    def is_deletable(self):
        return False

Subclasses

Instance variables

var is_deletable
Expand source code
@property
def is_deletable(self):
    return False
class Notes (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class Notes(WellknownFolder):
    CONTAINER_CLASS = "IPF.StickyNote"
    DISTINGUISHED_FOLDER_ID = "notes"
    LOCALIZED_NAMES = {
        "da_DK": ("Noter",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class OrganizationalContacts (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class OrganizationalContacts(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINTER_CLASS = "IPF.Contact.OrganizationalContacts"
    LOCALIZED_NAMES = {
        None: ("Organizational Contacts",),
    }

Ancestors

Class variables

var CONTAINTER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class Outbox (**kwargs)
Expand source code
class Outbox(Messages):
    DISTINGUISHED_FOLDER_ID = "outbox"

    LOCALIZED_NAMES = {
        "da_DK": ("Udbakke",),
        "de_DE": ("Postausgang",),
        "en_US": ("Outbox",),
        "es_ES": ("Bandeja de salida",),
        "fr_CA": ("Boîte d'envoi",),
        "nl_NL": ("Postvak UIT",),
        "ru_RU": ("Исходящие",),
        "sv_SE": ("Utkorgen",),
        "zh_CN": ("发件箱",),
    }

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class ParkedMessages (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class ParkedMessages(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = None
    LOCALIZED_NAMES = {
        None: ("ParkedMessages",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class PassThroughSearchResults (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class PassThroughSearchResults(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.PassThroughSearchResults"
    LOCALIZED_NAMES = {
        None: ("Pass-Through Search Results",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class PdpProfileV2Secured (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class PdpProfileV2Secured(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.PdpProfileSecured"
    LOCALIZED_NAMES = {
        None: ("PdpProfileV2Secured",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class PeopleCentricConversationBuddies (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class PeopleCentricConversationBuddies(NonDeletableFolderMixin, Contacts):
    DISTINGUISHED_FOLDER_ID = None
    CONTAINTER_CLASS = "IPF.Contact.PeopleCentricConversationBuddies"
    LOCALIZED_NAMES = {
        None: ("PeopleCentricConversation Buddies",),
    }

Ancestors

Class variables

var CONTAINTER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class PeopleConnect (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class PeopleConnect(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "peopleconnect"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class QuickContacts (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class QuickContacts(WellknownFolder):
    CONTAINER_CLASS = "IPF.Contact.MOC.QuickContacts"
    DISTINGUISHED_FOLDER_ID = "quickcontacts"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class RSSFeeds (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class RSSFeeds(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Note.OutlookHomepage"
    LOCALIZED_NAMES = {
        None: ("RSS Feeds",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class RecipientCache (**kwargs)
Expand source code
class RecipientCache(Contacts):
    DISTINGUISHED_FOLDER_ID = "recipientcache"
    CONTAINER_CLASS = "IPF.Contact.RecipientCache"
    supported_from = EXCHANGE_2013

    LOCALIZED_NAMES = {}

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES
var supported_from

Inherited members

class RecoverableItemsDeletions (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class RecoverableItemsDeletions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemsdeletions"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class RecoverableItemsPurges (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class RecoverableItemsPurges(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemspurges"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class RecoverableItemsRoot (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class RecoverableItemsRoot(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemsroot"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class RecoverableItemsVersions (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class RecoverableItemsVersions(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "recoverableitemsversions"
    supported_from = EXCHANGE_2010_SP1

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class RecoveryPoints (**kwargs)
Expand source code
class RecoveryPoints(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.RecoveryPoints"

Ancestors

Class variables

var CONTAINER_CLASS

Inherited members

class Reminders (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Reminders(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "Outlook.Reminder"
    LOCALIZED_NAMES = {
        "da_DK": ("Påmindelser",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class Schedule (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Schedule(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Schedule",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class SearchFolders (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class SearchFolders(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "searchfolders"

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID

Inherited members

class SentItems (**kwargs)
Expand source code
class SentItems(Messages):
    DISTINGUISHED_FOLDER_ID = "sentitems"

    LOCALIZED_NAMES = {
        "da_DK": ("Sendt post",),
        "de_DE": ("Gesendete Elemente",),
        "en_US": ("Sent Items",),
        "es_ES": ("Elementos enviados",),
        "fr_CA": ("Éléments envoyés",),
        "nl_NL": ("Verzonden items",),
        "ru_RU": ("Отправленные",),
        "sv_SE": ("Skickat",),
        "zh_CN": ("已发送邮件",),
    }

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class ServerFailures (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ServerFailures(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "serverfailures"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class Sharing (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Sharing(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.Note"
    LOCALIZED_NAMES = {
        None: ("Sharing",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class Shortcuts (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Shortcuts(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Shortcuts",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class Signal (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Signal(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.StoreItem.Signal"
    LOCALIZED_NAMES = {
        None: ("Signal",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class SkypeTeamsMessages (**kwargs)
Expand source code
class SkypeTeamsMessages(Folder):
    CONTAINER_CLASS = "IPF.SkypeTeams.Message"
    LOCALIZED_NAMES = {
        None: ("Team-chat",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class SmsAndChatsSync (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class SmsAndChatsSync(NonDeletableFolderMixin, Folder):
    CONTAINER_CLASS = "IPF.SmsAndChatsSync"
    LOCALIZED_NAMES = {
        None: ("SmsAndChatsSync",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var LOCALIZED_NAMES

Inherited members

class SpoolerQueue (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class SpoolerQueue(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Spooler Queue",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class SwssItems (**kwargs)
Expand source code
class SwssItems(Folder):
    CONTAINER_CLASS = "IPF.StoreItem.SwssItems"

Ancestors

Class variables

var CONTAINER_CLASS

Inherited members

class SyncIssues (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class SyncIssues(WellknownFolder):
    CONTAINER_CLASS = "IPF.Note"
    DISTINGUISHED_FOLDER_ID = "syncissues"
    supported_from = EXCHANGE_2013

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var supported_from

Inherited members

class System (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class System(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("System",),
    }
    get_folder_allowed = False

Ancestors

Class variables

var LOCALIZED_NAMES
var get_folder_allowed

Inherited members

class System1 (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class System1(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("System1",),
    }
    get_folder_allowed = False

Ancestors

Class variables

var LOCALIZED_NAMES
var get_folder_allowed

Inherited members

class Tasks (**kwargs)
Expand source code
class Tasks(Folder):
    DISTINGUISHED_FOLDER_ID = "tasks"
    CONTAINER_CLASS = "IPF.Task"
    supported_item_models = (Task,)

    LOCALIZED_NAMES = {
        "da_DK": ("Opgaver",),
        "de_DE": ("Aufgaben",),
        "en_US": ("Tasks",),
        "es_ES": ("Tareas",),
        "fr_CA": ("Tâches",),
        "nl_NL": ("Taken",),
        "ru_RU": ("Задачи",),
        "sv_SE": ("Uppgifter",),
        "zh_CN": ("任务",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES
var supported_item_models

Inherited members

class TemporarySaves (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class TemporarySaves(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("TemporarySaves",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class ToDoSearch (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class ToDoSearch(WellknownFolder):
    CONTAINER_CLASS = "IPF.Task"
    DISTINGUISHED_FOLDER_ID = "todosearch"
    supported_from = EXCHANGE_2013

    LOCALIZED_NAMES = {
        None: ("To-Do Search",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES
var supported_from

Inherited members

class Views (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class Views(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Views",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members

class VoiceMail (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class VoiceMail(WellknownFolder):
    DISTINGUISHED_FOLDER_ID = "voicemail"
    CONTAINER_CLASS = "IPF.Note.Microsoft.Voicemail"
    LOCALIZED_NAMES = {
        None: ("Voice Mail",),
    }

Ancestors

Class variables

var CONTAINER_CLASS
var DISTINGUISHED_FOLDER_ID
var LOCALIZED_NAMES

Inherited members

class WellknownFolder (**kwargs)

Base class to use until we have a more specific folder implementation for this folder.

Expand source code
class WellknownFolder(Folder, metaclass=EWSMeta):
    """Base class to use until we have a more specific folder implementation for this folder."""

    supported_item_models = ITEM_CLASSES

Ancestors

Subclasses

Class variables

var supported_item_models

Inherited members

class WorkingSet (**kwargs)

A mixin for non-wellknown folders than that are not deletable.

Expand source code
class WorkingSet(NonDeletableFolderMixin, Folder):
    LOCALIZED_NAMES = {
        None: ("Working Set",),
    }

Ancestors

Class variables

var LOCALIZED_NAMES

Inherited members