pEpObjCAdapter/PEPMessage.h
author Dirk Zimmermann <dirk@pep-project.org>
Wed, 17 May 2017 09:27:57 +0200
changeset 187 1f630a05e444
child 198 55e448e712a6
permissions -rw-r--r--
IOSAD-15 more renames
     1 //
     2 //  MCOAbstractMessage+PEPMessage.h
     3 //  pEpiOSAdapter
     4 //
     5 //  Created by Volker Birk on 09.07.15.
     6 //  Copyright (c) 2015 p≡p. All rights reserved.
     7 //
     8 
     9 #import <Foundation/Foundation.h>
    10 
    11 #include "message_api.h"
    12 
    13 NSArray * _Nonnull PEP_arrayFromStringlist(stringlist_t * _Nonnull sl);
    14 stringlist_t * _Nullable PEP_arrayToStringlist(NSArray * _Nullable array);
    15 
    16 pEp_identity * _Nullable PEP_identityDictToStruct(NSDictionary * _Nullable dict);
    17 NSDictionary * _Nonnull PEP_identityDictFromStruct(pEp_identity * _Nullable ident);
    18 
    19 message * _Nullable PEP_messageDictToStruct(NSDictionary * _Nullable dict);
    20 NSDictionary * _Nonnull PEP_messageDictFromStruct(message * _Nullable msg);
    21 
    22 #pragma mark -- Constants
    23 
    24 /** The name of the user */
    25 extern NSString *const _Nonnull kPepUsername;
    26 
    27 /** Email address of the contact */
    28 extern NSString *const _Nonnull kPepAddress;
    29 
    30 /**
    31  A user ID, used by pEp to map multiple identities to a single user.
    32  This should be a stable ID (e.g. derived from the address book if possible).
    33  pEp identities set up with mySelf() get a special user ID.
    34  */
    35 extern NSString *const _Nonnull kPepUserID;
    36 
    37 /** The fingerprint for the key for this contact. */
    38 extern NSString *const _Nonnull kPepFingerprint;
    39 
    40 /** NSNumber denoting a boolean, true if that identity was setup with mySelf() */
    41 extern NSString *const _Nonnull kPepIsMe;
    42 
    43 /** In an email, the identity this email is from */
    44 extern NSString *const _Nonnull kPepFrom;
    45 
    46 /** In an email, the `NSArray` of to recipients */
    47 extern NSString *const _Nonnull kPepTo;
    48 
    49 /** In an email, the `NSArray` of CC recipients */
    50 extern NSString *const _Nonnull kPepCC;
    51 
    52 /** In an email, the `NSArray` of BCC recipients */
    53 extern NSString *const _Nonnull kPepBCC;
    54 
    55 /** The subject of an email */
    56 extern NSString *const _Nonnull kPepShortMessage;
    57 
    58 /** The text message of an email */
    59 extern NSString *const _Nonnull kPepLongMessage;
    60 
    61 /** HTML message part, if any */
    62 extern NSString *const _Nonnull kPepLongMessageFormatted;
    63 
    64 /** NSNumber denoting a boolean. True if that message is supposed to be sent. */
    65 extern NSString *const _Nonnull kPepOutgoing;
    66 
    67 /** Sent date of the message (NSDate) */
    68 extern NSString *const _Nonnull kPepSent;
    69 
    70 /** Received date of the message (NSDate) */
    71 extern NSString *const _Nonnull kPepReceived;
    72 
    73 /** The message ID */
    74 extern NSString *const _Nonnull kPepID;
    75 
    76 extern NSString *const _Nonnull kPepReceivedBy;
    77 extern NSString *const _Nonnull kPepReplyTo;
    78 extern NSString *const _Nonnull kPepInReplyTo;
    79 extern NSString *const _Nonnull kPepReferences;
    80 extern NSString *const _Nonnull kPepKeywords;
    81 extern NSString *const _Nonnull kPepOptFields;
    82 
    83 /** NSArray of attachment dicts */
    84 extern NSString *const _Nonnull kPepAttachments;
    85 
    86 /** The binary NSData representing the content of an attachment */
    87 extern NSString *const _Nonnull kPepMimeData;
    88 
    89 /** The NSString filename of an attachment, if any */
    90 extern NSString *const _Nonnull kPepMimeFilename;
    91 
    92 /** The mime type of an attachment */
    93 extern NSString *const _Nonnull kPepMimeType;
    94 
    95 /** The content ID of an attachment */
    96 extern NSString *const _Nonnull kPepContentID;
    97 
    98 /** The pEp internal communication type */
    99 extern NSString *const _Nonnull kPepCommType;
   100 
   101 /** The raw message created by pEp (NSData) */
   102 extern NSString *const _Nonnull kPepRawMessage;
   103 
   104 /** NSError parameters will use this domain */
   105 extern NSString *const _Nonnull PEPSessionErrorDomain;
   106 
   107 /** Optional field "X-pEp-Version" */
   108 extern NSString *const _Nonnull kXpEpVersion;
   109 
   110 /** Optional field "X-EncStatus" */
   111 extern NSString *const _Nonnull kXEncStatus;
   112 
   113 /** Optional field "X-KeyList" */
   114 extern NSString *const _Nonnull kXKeylist;