Все в вашем коде выглядит правильно, поэтому, если Mail не позволит вам вставить его, это означает, что Mail не поддерживает вставку этого типа.
Редактировать: попробуйте с NSDictionary:
UIPasteboard *gpBoard = [UIPasteboard generalPasteboard];
NSData *data = [NSData dataWithContentsOfFile:filePath];
NSDictionary *item = [NSDictionary dictionaryWithObjectsAndKeys:
data, (NSString *)kUTTypeVCard,
nil];
gpBoard.items = [NSArray arrayWithObjects:item, nil];