Inherits from NSObject
Declared in MCOSMTPSession.h
MCOSMTPSession.mm

Overview

This class is used to create an SMTP connection and send messages

After calling a method that returns an operation you must call start: on the instance to begin the operation.

Tasks

Other Methods

Operations

Properties

OAuth2Token

This is the OAuth2 token.

@property (nonatomic, copy) NSString *OAuth2Token

Declared In

MCOSMTPSession.h

authType

This is the authentication type to use to connect. MCOAuthTypeSASLNone means that it uses the clear-text is used (and is the default).

@property (nonatomic, assign) MCOAuthType authType

Discussion

Warning: Important: Over an encrypted connection like TLS, the password will still be secure

Declared In

MCOSMTPSession.h

checkCertificateEnabled

When set to YES, the connection will fail if the certificate is incorrect.

@property (nonatomic, assign, getter=isCheckCertificateEnabled) BOOL checkCertificateEnabled

Declared In

MCOSMTPSession.h

connectionLogger

Sets logger callback. The network traffic will be sent to this block.

@property (nonatomic, copy) MCOConnectionLogger connectionLogger

Discussion

[session setConnectionLogger:^(void * connectionID, MCOConnectionLogType type, NSData * data) { }];

Declared In

MCOSMTPSession.h

connectionType

This is the encryption type to use. See MCOConnectionType for more information.

@property (nonatomic, assign) MCOConnectionType connectionType

Declared In

MCOSMTPSession.h

dispatchQueue

This property provides some hints to MCOSMTPSession about where it’s called from. It will make MCOSMTPSession safe. It will also set all the callbacks of operations to run on this given queue. Defaults to the main queue. This property should be used only if there’s performance issue using MCOSMTPSession in the main thread.

@property (nonatomic, retain) dispatch_queue_t dispatchQueue

Declared In

MCOSMTPSession.h

hostname

This is the hostname of the SMTP server to connect to.

@property (nonatomic, copy) NSString *hostname

Declared In

MCOSMTPSession.h

operationQueueRunning

The value will be YES when asynchronous operations are running, else it will return NO.

@property (nonatomic, assign, readonly, getter=isOperationQueueRunning) BOOL operationQueueRunning

Declared In

MCOSMTPSession.h

operationQueueRunningChangeBlock

Sets operation running callback. It will be called when operations start or stop running.

@property (nonatomic, copy) MCOOperationQueueRunningChangeBlock operationQueueRunningChangeBlock

Discussion

[session setOperationQueueRunningChangeBlock:^{ if ([session isOperationQueueRunning]) { } else { } }];

Declared In

MCOSMTPSession.h

password

This is the password of the account.

@property (nonatomic, copy) NSString *password

Declared In

MCOSMTPSession.h

port

This is the port of the SMTP server to connect to.

@property (nonatomic, assign) unsigned int port

Declared In

MCOSMTPSession.h

timeout

This is the timeout of the connection.

@property (nonatomic, assign) NSTimeInterval timeout

Declared In

MCOSMTPSession.h

useHeloIPEnabled

If set to YES, when sending the EHLO or HELO command, use IP address instead of hostname. Default is NO.

@property (nonatomic, assign, getter=isUseHeloIPEnabled) BOOL useHeloIPEnabled

Declared In

MCOSMTPSession.h

username

This is the username of the account.

@property (nonatomic, copy) NSString *username

Declared In

MCOSMTPSession.h

Instance Methods

cancelAllOperations

Cancel all operations

- (void)cancelAllOperations

Declared In

MCOSMTPSession.h

checkAccountOperationWithFrom:

Returns an operation that will check whether the SMTP account is valid.

- (MCOSMTPOperation *)checkAccountOperationWithFrom:(MCOAddress *)from

Discussion

 MCOSMTPOperation * op = [session checkAccountOperationWithFrom:[MCOAddress addressWithMailbox:@"hoa@etpan.org"]];
 [op start:^(NSError * error) {
 }];

Declared In

MCOSMTPSession.h

loginOperation

Returns an operation that will perform a login.

- (MCOSMTPOperation *)loginOperation

Discussion

MCOSMTPOperation * op = [session loginOperation]; [op start:^(NSError * error) { }];

Declared In

MCOSMTPSession.h

noopOperation

Returns an operation that will perform a No-Op.

- (MCOSMTPOperation *)noopOperation

Discussion

MCOSMTPOperation * op = [session noopOperation]; [op start:^(NSError * error) { }];

Declared In

MCOSMTPSession.h

sendOperationWithData:

Returns an operation that will send the given message through SMTP. It will use the recipient set in the message data (To, Cc and Bcc). It will also filter out Bcc from the content of the message.

- (MCOSMTPSendOperation *)sendOperationWithData:(NSData *)messageData

Discussion

Generate RFC 822 data using MCOMessageBuilder

 MCOSMTPOperation * op = [session sendOperationWithData:rfc822Data];
 [op start:^(NSError * error) {
 }];

Declared In

MCOSMTPSession.h

sendOperationWithData:from:recipients:

Returns an operation that will send the given message through SMTP. It will use the sender and recipient set from the parameters. It will also filter out Bcc from the content of the message.

- (MCOSMTPSendOperation *)sendOperationWithData:(NSData *)messageData from:(MCOAddress *)from recipients:(NSArray *)recipients

Discussion

Generate RFC 822 data using MCOMessageBuilder

MCOSMTPOperation * op = [session sendOperationWithData:rfc822Data from:[MCOAddress addressWithMailbox:@“hoa@etpan.org”] recipients:[NSArray arrayWithObject:[MCOAddress addressWithMailbox:@“laura@etpan.org”]]]; [op start:^(NSError * error) { }];

Declared In

MCOSMTPSession.h