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