Scribe Document Object Modal

About
This document describes the Scribe Document Object Model which is to address fields inside objects. Fields can be used in filters, templates, item preview and scripts. Each object in Scribe will export a number of fields that can either be values or references to other objects. If you try and reference an Object that doesn't exist then the value returned will be NULL.

Go back to other versions.
AccountIdentity {   // ScribeSendReceive.cpp:835
    String Name;    // :838
    String Email;   // :839
    String Reply;   // :840
    String Sig;     // :841
    String HtmlSig; // :842
}

Attachment {          // ScribeAttachment.cpp:168
    Int64  Length;    // :173
    String Name;      // :178
    String MimeType;  // :183
    String ContentId; // :188
    Binary Data;      // :193
    Int32  Type;      // :205
}

Contact {                     // ScribeContact.cpp:708
    ScribeWnd      Scribe;    // :716
    ThingContainer Folder;    // :721
    String[]       Email;     // :729
    Int32          Type;      // :743
    String[]       Groups;    // :748
    Image          Image;     // :791
    String         ImageHtml; // :796
}

ContactGroup {     // ScribeGroup.cpp:168
    String   Name; // :173
    String[] List; // :178
    Int32    Type; // :195
}

Filter {                      // ScribeFilter.cpp:2572
    Mail      Mail;           // :2724
    ScribeWnd Scribe;         // :2732
    String    Name;           // :2737
    Bool      TestConditions; // :2742
    Int32     Type;           // :2753
    String    ConditionsXml;  // :2758
    String    ActionsXml;     // :2763
    Int32     Index;          // :2768

    function AddCondition(String Feild, String Op, String Value); // :2577
    function AddAction(String ActionName, String Value); // :2653
    function StopFiltering(); // :2683
    function DoActions(Mail Object); // :2693
}

GCssStyle {         // GHtml.cpp:9228
    String Display; // :9233
}

GCustomType {             // GVariant.cpp.bak:2262
    String        Name;   // :2267
    String        Type;   // :2272
    Int32         Length; // :2277
    CustomField[] Field;  // :2282
    String        Name;   // :2330
    String        Type;   // :2335
    Int32         Length; // :2340
    CustomField[] Field;  // :2345

    function New(); // :2319
    function Delete(Object); // :2328
    function New(); // :2382
    function Delete(Object); // :2391
}

GCustomType::CustomField { // GVariant.cpp.bak:1983
    String Name;   // :1988
    Int32  Length; // :1991
    String Name;   // :2051
    Int32  Length; // :2054
}

GFile {            // GFileCommon.cpp:11
    String Type;   // :16
    String Name;   // :19
    Int64  Length; // :22
    Int64  Pos;    // :25

    function Length([NewLength]); // :58
    function Pos([NewPosition]); // :66
    function Type(); // :74
    function Open(Path[, Mode]); // :79
    function Close(); // :104
    function Read([ReadLength[, ReadType = 0 - string, 1 - integer]]); // :109
    function Write(Data[, WriteLength]); // :185
}

GHtml {                // GHtml.cpp:8691
    Bool supportLists; // :8693
    Bool vml;          // :8695
    Bool mso;          // :8698
}

GRichTextEdit {                   // GRichTextEdit.cpp:302
    Unknown HtmlImagesLinkCid;    // :307
    Unknown SpellCheckLanguage;   // :312
    Unknown SpellCheckDictionary; // :317
}

GSurface {               // GSurface.cpp:1821
    Int32 X;             // :1825
    Int32 Y;             // :1830
    Int32 Bits;          // :1835
    Int32 ColourSpace;   // :1840
    Int32 IncludeCursor; // :1845
}

GTag {                     // GHtml.cpp:1394
    GCssStyle Style;       // :1399
    String    textContent; // :1404
}

GXmlTag {                    // GXmlTree.cpp:503
    String 'attribute_name'; // :505
}

LDateTime {             // LDateTime.cpp:1818
    Int32  Year;        // :1823
    Int32  Month;       // :1826
    Int32  Day;         // :1829
    Int32  Hour;        // :1832
    Int32  Minute;      // :1835
    Int32  Second;      // :1838
    String Date;        // :1841
    String Time;        // :1848
    String DateAndTime; // :1855
    Int64  DateInt64;   // :1862

    function SetNow(); // :1923
    function SetStr(); // :1928
    function GetStr(); // :1940
}

ListAddr {            // ScribeListAddr.cpp:1178
    String   Text;    // :1183
    String   Name;    // :1199
    String   Email;   // :1204
    Int32    Type;    // :1209
    Contact  Contact; // :1214
    String[] Groups;  // :1226
}

Mail {                              // ScribeMail.cpp:5068
    ListAddr       From;            // :5073
    String         FromHtml;        // :5078
    Contact        Contact;         // :5086
    ListAddr[]     To;              // :5104
    String         ToHtml;          // :5145
    String         Subject;         // :5163
    String         Body;            // :5168
    String         BodyAsText;      // :5236
    String         BodyAsHtml;      // :5271
    String         HtmlHeadFields;  // :5284
    String         MessageID;       // :5348
    String         InternetHeaders; // :5353
    String[]       InternetHeader;  // :5358
    Int32          Priority;        // :5370
    String         Html;            // :5375
    Int32          Flags;           // :5380
    ThingContainer Folder;          // :5385
    ScribeWnd      Scribe;          // :5393
    Mail           Mail;            // :5398
    DateTime       DateSent;        // :5403
    DateTime       DateReceived;    // :5408
    String         Sig;             // :5413
    Int64          Size;            // :5421
    String         Label;           // :5426
    Int32          Attachments;     // :5431
    Attachment[]   Attachment;      // :5438
    String         MimeTree;        // :5452
    GView          Ui;              // :5463
    Int32          Type;            // :5468
    Bool           Selected;        // :5473
    Bool           Read;            // :5478
    Bool           ShowImages;      // :5483
    Int32          Colour;          // :5488

    function Send([Bool SendNow = true]); // :5599
}

ReceiveAccountlet {          // ScribeSendReceive.cpp:1411
    String  Protocol;        // :1414
    String  Server;          // :1415
    Integer Port;            // :1416
    String  Name;            // :1417
    Bool    AutoReceive;     // :1418
    String  CheckEvery;      // :1419
    Bool    LeaveOnServer;   // :1421
    Bool    DeleteAfter;     // :1422
    Bool    DelIfLarger;     // :1424
    Integer DelIfLargerSize; // :1425
    String  Folder;          // :1427
    Integer MaxSize;         // :1428
    String  8BitCharSet;     // :1429
    String  AsciiCharset;    // :1430
    Integer AuthType;        // :1431
}

ScribeAccount {                                   // ScribeAccount.cpp:57
    Accountlet.AccountIdentity   Identity;        // :65
    Accountlet.SendAccountlet    Send;            // :68
    Accountlet.ReceiveAccountlet Receive;         // :71
    Bool                         IsValid;         // :74
    Bool                         IsOnline;        // :77
    ScribeWnd                    Scribe;          // :80
    String                       Name;            // :83
    String                       Id;              // :85
    Bool                         Disable;         // :87
    Bool                         AccountExpanded; // :89

    function Stop(); // :126
    function Disconnect(); // :129
    function Kill(); // :132
    function EndSession(); // :135
}

ScribeDom {             // ScribeUtils.cpp:1309
    ScribeWnd Scribe;   // :1314
    Mail      Mail;     // :1319
    Contact   Contact;  // :1324
    Calendar  Calendar; // :1329
    Filter    Filter;   // :1334
    String    Now;      // :1339
}

ScribeWnd {                         // ScribeApp.cpp:2491
    String           Quote;         // :2496
    String           Name;          // :2500
    String           Home;          // :2505
    String           Now;           // :2514
    ThingContainer[] Folder;        // :2523
    String           AppName;       // :2545
    String           CalendarToday; // :2550
    String           Execute;       // :2554
    String           BuildType;     // :2578
    String           Tag;           // :2587
    String           Version;       // :2592
    String           Build;         // :2599
    String           Language;      // :2606
    String           String;        // :2617
    ThingContainer   CurrentFolder; // :2629
    GView            View;          // :2634
    Contact          NoContact;     // :2639
    Unknown          Accounts;      // :2644

    function GrowlOnMail(Mail Obj); // :2691
    function LookupContactGroup(String GroupName); // :2709
    function GetUserString(GView ParentView, String PromptMessage[, Bool ObsurePassword[, String DefaultValue]]); // :2721
    function CreateAccount(); // :2739
    function DeleteAccount(ScribeAccount AccountToDelete); // :2752
}

SendAccountlet {          // ScribeSendReceive.cpp:869
    String  Server;       // :872
    Integer Port;         // :873
    String  Domain;       // :874
    String  Name;         // :875
    Bool    Auth;         // :876
    Integer AuthType;     // :877
    String  PrefCharset1; // :878
    String  PrefCharset2; // :879
    Bool    OnlySendThis; // :880
}

SslSocket {     // OpenSSLSocket.cpp:635
    Bool isSsl; // :640
}

Store3Addr {          // Store3Common.cpp:88
    String   Name;    // :93
    String   Email;   // :98
    String   Text;    // :103
    Contact  Contact; // :123
    String[] Groups;  // :136
}

TableCell {           // GTableLayout.cpp:452
    GView[] Children; // :457
    GRect   Span;     // :475
    String  Align;    // :480
    String  VAlign;   // :489
    String  Class;    // :498
    String  Style;    // :503
    Unknown Debug;    // :508
}

ThingContainer {             // ScribeFolder.cpp:3218
    Int32          Type;     // :3223
    String         Name;     // :3228
    String         Path;     // :3234
    Int32          Unread;   // :3244
    Int32          Length;   // :3249
    Thing[]        Item;     // :3254
    Int32          ItemType; // :3277
    ScribeWnd      Scribe;   // :3282
    ThingContainer Child;    // :3287
    ThingContainer Next;     // :3292
    Thing[]        Selected; // :3297
}