EmailScheduler/MailCore.framework/Versions/A/Headers/MCOMessageHeader.h

102 lines
3.2 KiB
C
Raw Normal View History

2014-09-13 17:13:32 -05:00
//
// MCOMessageHeader.h
// mailcore2
//
// Created by DINH Viêt Hoà on 3/10/13.
// Copyright (c) 2013 MailCore. All rights reserved.
//
#ifndef MAILCORE_MCOMESSAGEHEADER_H
#define MAILCORE_MCOMESSAGEHEADER_H
#import <Foundation/Foundation.h>
/** This class implements common fields of a message header.*/
@class MCOAddress;
@interface MCOMessageHeader : NSObject <NSCopying, NSCoding>
/** Message-ID field.*/
@property (nonatomic, copy) NSString * messageID;
/** Message-ID auto-generated flag.*/
@property (nonatomic, readonly, getter=isMessageIDAutoGenerated) BOOL messageIDAutoGenerated;
/** References field. It's an array of message-ids.*/
@property (nonatomic, copy) NSArray * /* NSString */ references;
/** In-Reply-To field. It's an array of message-ids.*/
@property (nonatomic, copy) NSArray * /* NSString */ inReplyTo;
/** Date field: sent date of the message.*/
@property (nonatomic, strong) NSDate * date;
/** Received date: received date of the message.*/
@property (nonatomic, strong) NSDate * receivedDate;
/** Sender field.*/
@property (nonatomic, copy) MCOAddress * sender;
/** From field: address of the sender of the message.*/
@property (nonatomic, copy) MCOAddress * from;
/** To field: recipient of the message. It's an array of MCOAddress.*/
@property (nonatomic, copy) NSArray * /* MCOAddress */ to;
/** Cc field: cc recipient of the message. It's an array of MCOAddress.*/
@property (nonatomic, copy) NSArray * /* MCOAddress */ cc;
/** Bcc field: bcc recipient of the message. It's an array of MCOAddress.*/
@property (nonatomic, copy) NSArray * /* MCOAddress */ bcc;
/** Reply-To field. It's an array of MCOAddress.*/
@property (nonatomic, copy) NSArray * /* MCOAddress */ replyTo;
/** Subject of the message.*/
@property (nonatomic, copy) NSString * subject;
/** Email user agent name: X-Mailer header.*/
@property (nonatomic, copy) NSString * userAgent;
/** Returns a header created from RFC 822 data.*/
+ (MCOMessageHeader *) headerWithData:(NSData *)data;
/** Initialize a header with RFC 822 data.*/
- (id) initWithData:(NSData *)data;
/** Adds a custom header.*/
- (void) setExtraHeaderValue:(NSString *)value forName:(NSString *)name;
/** Remove a given custom header.*/
- (void) removeExtraHeaderForName:(NSString *)name;
/** Returns the value of a given custom header.*/
- (NSString *) extraHeaderValueForName:(NSString *)name;
/** Returns an array with the names of all custom headers.*/
- (NSArray * /* NSString */) allExtraHeadersNames;
/** Extracted subject (also remove square brackets).*/
- (NSString *) extractedSubject;
/** Extracted subject (don't remove square brackets).*/
- (NSString *) partialExtractedSubject;
/** Fill the header using the given RFC 822 data.*/
- (void) importHeadersData:(NSData *)data;
/** Returns a header that can be used as a base for a reply message.*/
- (MCOMessageHeader *) replyHeaderWithExcludedRecipients:(NSArray *)excludedRecipients;
/** Returns a header that can be used as a base for a reply all message.*/
- (MCOMessageHeader *) replyAllHeaderWithExcludedRecipients:(NSArray *)excludedRecipients;
/** Returns a header that can be used as a base for a forward message.*/
- (MCOMessageHeader *) forwardHeader;
@end
#endif