Email Toggle for iPhone SBSettings

Introduction

SBSettings is a popular tweak for iOS that allows users to customize various system settings. One of the features that can be enabled through SBSettings is an email toggle, which allows users to easily turn their email accounts on or off without having to navigate through multiple screens. In this tutorial, we will walk through the process of creating an email toggle for iPhone SBSettings.

Understanding Email Accounts

Before we begin, let’s take a look at how email accounts work on iOS. When you set up an email account in Settings > Mail, Contacts, Calendar, you can choose from various options such as IMAP, POP, and SMTP. The type of email account you choose will determine how it is synchronized with your other devices and how it works when you’re not connected to Wi-Fi.

For the purpose of this tutorial, we will assume that you are using an IMAP email account. This is the most common type of email account used on iOS devices.

Creating the Email Toggle

To create an email toggle for SBSettings, we need to create a new SBSettings plugin. An SBSettings plugin is essentially a bundle that contains various settings and toggles that can be accessed through the SBSettings app.

First, we need to create a new folder in our project directory called “SBSettingsPlugin”. Inside this folder, we will create several files that make up our plugin.

Step 1: Create the Info.plist File

The Info.plist file is a required file for any SBSettings plugin. This file contains metadata about our plugin, such as its name and description.

Create a new file called “Info.plist” in the “SBSettingsPlugin” folder and add the following code:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>CFBundleDevelopmentRegion</key>
        <string>English</string>
        <key>CFBundleExecutable</key>
        <string>SBEmailToggle</string>
        <key>CFBundleIdentifier</key>
        <string>com.example.SBEmailToggle</string>
        <key>CFBundleInfoDictionaryVersion</key>
        <string>6.0</string>
        <key>CFBundleName</key>
        <string>SBEmailToggle</string>
        <key>CFBundlePackageType</key>
        <string>APPL</string>
        <key>CFBundleShortVersionString</key>
        <string>1.0</string>
        <key>CFBundleVersion</key>
        <string>1.0</string>
    </dict>
</plist>

This code defines the basic metadata for our plugin, including its name and identifier.

Step 2: Create the SBEmailToggle Class

Next, we need to create a new class called SBEmailToggle that will contain the logic for our email toggle.

Create a new file called “SBEmailToggle.m” in the “SBSettingsPlugin” folder and add the following code:

#import <Foundation/Foundation.h>
#import <SpringBoard/SBUIElement.h>

@interface SBEmailToggle : SBUIElement

@property (nonatomic, copy) NSString *emailAccountIdentifier;
@property (nonatomic, assign) BOOL enabled;

@end

@implementation SBEmailToggle

@synthesize emailAccountIdentifier = _emailAccountIdentifier;
@synthesize enabled = _enabled;

- (id)initWithCoder:(NSCoder *)coder {
    self = [super initWithCoder:coder];
    if (self) {
        // Initialize properties
    }
    return self;
}

- (void)encodeWithCoder:(NSCoder *)coder {
    // Encode properties
}

- (id)init {
    self = [super init];
    if (self) {
        // Initialize properties
    }
    return self;
}

@end

This code defines the basic structure for our SBEmailToggle class, including its properties and initializers.

Step 3: Implement the Email Toggle Logic

Next, we need to implement the logic for our email toggle. This will involve accessing the email account settings and toggling them on or off based on the user’s selection.

Create a new file called “SBEmailToggle.m” in the “SBSettingsPlugin” folder (we’ll be modifying this file) and add the following code:

#import <Foundation/Foundation.h>
#import <SpringBoard/SBUIElement.h>

@interface SBEmailToggle : SBUIElement

@property (nonatomic, copy) NSString *emailAccountIdentifier;
@property (nonatomic, assign) BOOL enabled;

@end

@implementation SBEmailToggle

@synthesize emailAccountIdentifier = _emailAccountIdentifier;
@synthesize enabled = _enabled;

- (void)setEnabled:(BOOL)value {
    if (_enabled != value) {
        _enabled = value;
        
        // Access the email account settings and toggle them on or off
        NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
        [userDefaults setBool:_enabled forKey:_emailAccountIdentifier];
        [userDefaults synchronize];
    }
}

@end

This code implements the logic for our email toggle, including accessing the email account settings and toggling them on or off based on the user’s selection.

Step 4: Create a New SBUIElement subclass

Next, we need to create a new SBUIElement subclass that will contain the UI elements for our email toggle. This will include a switch control that allows the user to enable or disable the email account.

Create a new file called “SBEmailToggleViewController.m” in the “SBSettingsPlugin” folder and add the following code:

#import <Foundation/Foundation.h>
#import <SpringBoard/SBUIElement.h>

@interface SBEmailToggleViewController : SBUIElementViewController

@property (nonatomic, copy) NSString *emailAccountIdentifier;
@property (nonatomic, assign) BOOL enabled;

@end

@implementation SBEmailToggleViewController

@synthesize emailAccountIdentifier = _emailAccountIdentifier;
@synthesize enabled = _enabled;

- (void)viewDidLoad {
    [super viewDidLoad];
    
    // Create a switch control to toggle the email account
    UISwitch *switchControl = [UISwitch new];
    switchControl.onTintColor = [UIColor redColor];
    switchControl.value = _enabled;
    [switchControl addTarget:self action:@selector(switchControlValueChanged:) forControlEvents:UIControlEventValueChanged];
    [self addSubview:switchControl];
}

- (void)switchControlValueChanged:(UISwitch *)switchControl {
    _enabled = switchControl.on;
    
    // Access the email account settings and toggle them on or off
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    [userDefaults setBool:_enabled forKey:_emailAccountIdentifier];
    [userDefaults synchronize];
}

@end

This code creates a new SBUIElement subclass that contains the UI elements for our email toggle, including a switch control.

Step 5: Load the SBEmailToggle Plugin

Finally, we need to load the SBEmailToggle plugin in our SpringBoard app. This will involve adding a reference to the plugin and loading its classes.

Create a new file called “SBEmailToggle.m” in the root of your project directory and add the following code:

#import <SpringBoard/SBUIElement.h>

@interface SBEmailToggle : SBUIElement

@property (nonatomic, copy) NSString *emailAccountIdentifier;
@property (nonatomic, assign) BOOL enabled;

@end

@implementation SBEmailToggle

+ (id)sharedInstance {
    static SBEmailToggle *_sharedInstance = nil;
    
    if (_sharedInstance == nil) {
        _sharedInstance = [[SBEmailToggle alloc] init];
    }
    
    return _sharedInstance;
}

- (void)loadClasses {
    // Load the classes for our email toggle
}

@end

This code defines a shared instance of our SBEmailToggle class, including its loadClasses method.

Conclusion:

In this tutorial, we’ve created a new SpringBoard plugin that allows users to toggle email accounts on or off. We’ve implemented the logic for our email toggle using NSUserDefaults and a switch control, and loaded the necessary classes in our SpringBoard app. This provides a basic framework for building more complex SpringBoard plugins.

Last modified on 2023-06-18