MailMessage.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  MailMessage.qm Copyright 2012 - 2024 Qore Technologies, s.r.o.
 
    Original Authors: Wolfgang Ritzinger, Marian Bonda, Pavol Potoncok
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum qore version
 
// need mime definitions
 
// assume local var scope, do not use "$" for vars, members, and method calls
// require type declarations everywhere
// disallows access to backwards-compatible "noop" variants
// enables all warnings
 
 
 
namespace MailMessage {
public hashdecl PartInfo {
    string name;
 
    string mime;
 
    data part_data;
 
    *hash<auto> headers;
 
    string transfer_encoding;
};
 
public hashdecl MailMessageInfo {
    *string from;
 
    *string sender;
 
    *string subject;
 
    *list<string> to;
 
    *list<string> cc;
 
    *list<string> bcc;
 
    *data body;
 
    *string body_encoding;
 
    *string body_content_type;
 
    *hash<auto> headers;
 
    *bool important;
 
    *bool delivery_receipt;
 
    *bool read_receipt;
 
    *list<hash<PartInfo>> attachments;
 
    *list<hash<PartInfo>> parts;
};
 
 
const EncDefault = "default";
 
const EncNone = "none";
 
const EncBase64 = ContentTransEncBase64;
 
const EncQuotedPrintable = ContentTransEncQuotedPrintable;
 
const Encodings = ...;
 
 
 
class Message {
 
public:
protected:
        // the sender
        string from;
        // subject is a header field
        string subject;
 
        // additional headers
        hash headers;      // hash of additional headers except the ones below
        // message statuses
        bool importance = False;
        bool deliveryReceipt = False;
        bool readReceipt = False;
 
        // names
        list<string> to(); // list of names for to (header only) will be prefilled (and overwritten) with the recipients
        list<string> cc(); // list of cc's
        list<string> bcc(); // list of bcc's
 
        // message data itself
        *data body;
 
        // message body content transfer encoding
        string bodyEncoding = EncDefault;
 
        // message body content type
        *string bodyContentType;
 
        // list of Attachments
        list<Attachment> attachments();
 
        // list of Parts that are not Attachments (and not the main Message body - could be alternative representations of the body, for example)
        list<Part> parts();
 
        string sender;
 
        // SMTP mode: do not serialize a single "." alone on a line
        bool smtp_mode = True;
 
public:
 
        string mpboundary = replace(make_base64_string(string(now_us())), "=", "");
 
 
    constructor(string sender, string subject, bool smtp_mode = True);
 
 
 
    constructor(string msg);
 
 
    hash<MailMessageInfo> getInfo();
 
 
 
    string serialize();
 
 
protected:
     processPart(hash<auto> p);
public:
 
 
      static *string getEmailAddress(string str);
 
      static bool checkEmailAddress(string str);
 
 
    list<string> addTO(string recipient);
 
 
 
    list<string> addCC(string recipient);
 
 
 
    list<string> addBCC(string recipient);
 
 
    *string getSender();
 
 
    *string getFrom();
 
 
    list<string> getTO();
 
 
    list<string> getCC();
 
 
    list<string> getBCC();
 
 
    string getSubject();
 
 
    list<string> getRecipients();
 
 
 
    bool sendPossible();
 
 
 
    checkSendPossible();
 
 
 
    setBody(data body, string enc = EncDefault, *string content_type);
 
 
 
    addBody(string str);
 
 
 
    addBody(binary bin);
 
 
    *data getBody();
 
 
    string getBodyTransferEncoding();
 
 
 
      static hash parseHeader(string hdr, bool decode = True);
 
 
    setHeader(string hdr);
 
 
 
    setHeader(list hdrs);
 
 
 
    setHeader(hash hdrs);
 
 
 
    addHeader(string hdr);
 
 
 
    addHeader(list<auto> hdrs);
 
 
 
    addHeader(hash<auto> hdrs);
 
 
    softlist getHeader();
 
 
    *hash<auto> getHeaders();
 
 
 
    bool important();
 
 
 
    important(softbool i);
 
 
 
    bool receiptRead();
 
 
 
    receiptRead(bool arg);
 
 
 
    bool receiptDelivery();
 
 
 
    receiptDelivery(bool arg);
 
 
 
    attach(string name, string mime, data att, string enc = EncBase64, *hash<auto> hdr);
 
 
 
    attach(Attachment att);
 
 
    list<Attachment> getAttachments();
 
 
 
    list<Part> getParts();
 
 
 
      static string doHeaderValue(string hdr, string val, string eol = '\r\n', bool encode = True);
 
 
    string getHeaderString(string eol = '\r\n', bool encode = True);
 
 
 
    string toString(bool include_body = False);
 
 
 
    string toLine();
 
 
 
      static string checkEncoding(data data, string enc, bool noneok = False);
 
 
      static string encodeTransferData(data data, string enc, reference<hash> hdr);
 
      static string encodeData(data data, string mime, string disp, string enc);
 
 
      static string getLine(reference<string> msg, reference<int> pos);
 
protected:
     list<string> getEnvelopeList();
public:
 
};
 
 
class Part {
 
public:
    // no public members
    
 
protected:
        string name;
        string mime;
        data part_data;
        string enc;
        // any extra headers for the message
        *hash<auto> headers;
 
public:
 
    // will only be called internally when parsing a Message
    constructor(string filename, string mimetype, data filedata, string encoding = EncDefault, *hash<auto> hdr);
 
 
    hash<auto> getInfo();
 
 
    string getName();
 
 
    string getMime();
 
 
    data getData();
 
 
    string getTransferEncoding();
 
 
    *hash<auto> getHeaders();
 
 
    add(MultiPartAlternativeMessage mpa);
 
};
 
 
class Attachment : public Part {
 
public:
    // no public members
    
 
 
    constructor(string name, string mime, data part_data, string enc = EncBase64, *hash<auto> hdr) ;
 
 
    add(MultiPartMixedMessage mpm);
 
};
};