BRIMAPAccount

Objective-C

@interface BRIMAPAccount : BREmailAccount

Swift

class BRIMAPAccount : BREmailAccount

This class represents an IMAP account that should be instantiated with the user’s credentials prior to beginning IMAP setup in BREReceiptManager

Show on GitHub


                    
                    
                    -initWithProvider:email:password:

The first step in linking a user’s IMAP account is instantiating this class with the user’s credentials.

Declaration

Objective-C

- (nonnull instancetype)initWithProvider:(BREReceiptProvider)provider
                                   email:(nonnull NSString *)email
                                password:(nonnull NSString *)password;

Swift

init(provider: BREReceiptProvider, email: String, password: String)

Parameters

`provider`	The provider for this IMAP account
`email`	The email address for this IMAP account
`password`	The password for this IMAP account (Note: this is the user’s regular password - an “app password” will be created automatically during setup

Show on GitHub


                    
                    
                    -configureCustomHost:port:useTLS:

If the IMAP provider is not Gmail, AOL, or Yahoo, use this method to specify the provider’s configuration

Declaration

Objective-C

- (void)configureCustomHost:(nonnull NSString *)host
                       port:(NSInteger)port
                     useTLS:(BOOL)useTLS;

Swift

func configureCustomHost(_ host: String, port: Int, useTLS: Bool)

Parameters

`host`	The provider’s IMAP host name
`port`	The provider’s IMAP port
`useTLS`	Whether the provider uses TLS (virtually all providers do)

Show on GitHub