Objective-C

Fetch a Text IMAP Attachment as a String

Demonstrates the Chilkat Imap.FetchAttachmentString method, which returns one text attachment decoded to a string. The first argument is the Email, the second is the zero-based attachment index, and the third is the charset used to decode the bytes. This example returns the first attachment as a UTF-8 string.

Background: This is the convenient form when you simply want a small text attachment's content inline as a string. Only use it for attachments known to be text; decoding binary content through a charset can alter or corrupt the bytes. For binary data use FetchAttachmentBd, and for large text a StringBuilder (via FetchAttachmentSb) avoids an extra copy.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoImap.h>
#import <CkoEmail.h>
#import <NSString.h>

BOOL success = NO;

//  Demonstrates the Imap.FetchAttachmentString method, which downloads one text attachment and
//  returns it decoded to a string.  The 1st argument is the Email, the 2nd is the zero-based
//  attachment index, and the 3rd is the charset used to decode the bytes.
//  
//  The message is fetched headers-only, then the attachment is downloaded on demand.

CkoImap *imap = [[CkoImap alloc] init];

imap.Ssl = YES;
imap.Port = [NSNumber numberWithInt:993];

success = [imap Connect: @"imap.example.com"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap Login: @"user@example.com" password: @"myPassword"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap SelectMailbox: @"Inbox"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

//  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
//  metadata describing the attachments is present, so the attachment info methods still work.
BOOL headersOnly = YES;
BOOL useUid = NO;
int seqNum = 1;
CkoEmail *email = [[CkoEmail alloc] init];
success = [imap FetchEmail: headersOnly msgId: seqNum bUid: useUid email: email];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

int numAttach = [[imap GetMailNumAttach: email] intValue];
if (numAttach > 0) {
    //  FetchAttachmentString returns a string, so assign it to a string variable.
    NSString *attachText = [imap FetchAttachmentString: email attachIndex: [NSNumber numberWithInt: 0] charset: @"utf-8"];
    if (imap.LastMethodSuccess == NO) {
        NSLog(@"%@",imap.LastErrorText);
        return;
    }

    NSLog(@"%@",attachText);
}

success = [imap Disconnect];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}