CocoaPods trunk is moving to be read-only. Read more on the blog, there are 15 months to go.

GoMailerPushSDK 1.3.0

GoMailerPushSDK 1.3.0

Maintained by Go Mailer Team.



 
Depends on:
Firebase/Core~> 10.25.0
Firebase/Messaging~> 10.25.0
 

  • By
  • Go Mailer Team

Go Mailer SDK

A cross-platform mobile SDK for customer engagement messaging that enables businesses to receive push notifications from the Go-Mailer platform in their mobile apps.

Features

  • Cross-Platform Support: iOS, Android, Flutter, and React Native
  • Push Notification Registration: Registers device and user with Go-Mailer backend
  • Notification Handling: Receives and displays push notifications sent from the Go-Mailer platform
  • Analytics: Tracks notification delivery, opens, and user events
  • Security: End-to-end encryption for message delivery

How It Works

  1. SDK Integration: Businesses integrate the Go-Mailer SDK into their mobile apps.
  2. Device Registration: The SDK registers the device and user with the Go-Mailer backend.
  3. Message Sending: Businesses use the Go-Mailer web platform to send messages to their users. The Go-Mailer backend delivers these as push notifications to registered devices.
  4. Notification Handling: The SDK receives and displays notifications, and can report analytics/events back to the Go-Mailer backend.

Supported Platforms

  • iOS: Native Swift/Objective-C SDK
  • Android: Native Kotlin/Java SDK
  • Flutter: Dart plugin for Flutter apps
  • React Native: JavaScript/TypeScript wrapper

Quick Start

iOS (Swift)

import GoMailer

// Initialize the SDK
GoMailer.initialize(apiKey: "your-api-key")

// Register for push notifications
GoMailer.registerForPushNotifications()

// Set the current user
let user = GoMailerUser(email: "user-email")
GoMailer.setUser(user)

Android (Kotlin)

import com.gomailer.GoMailer

// Initialize the SDK
GoMailer.initialize(context, "your-api-key")

// Register for push notifications
GoMailer.registerForPushNotifications()

// Set the current user
val user = GoMailerUser(email = "user-email")
GoMailer.setUser(user)

Flutter (Dart)

import 'package:go_mailer/go_mailer.dart';

// Initialize the SDK
await GoMailer.initialize(apiKey: 'your-api-key');

// Register for push notifications
await GoMailer.registerForPushNotifications();

// Set the current user
final user = GoMailerUser(email: 'user-email');
await GoMailer.setUser(user);

React Native (JavaScript)

import GoMailer from 'go-mailer';

// Initialize the SDK
await GoMailer.initialize({ apiKey: 'your-api-key' });

// Register for push notifications
await GoMailer.registerForPushNotifications();

// Set the current user
await GoMailer.setUser({ email: 'user-email' });

Installation

iOS

# Using CocoaPods
pod 'GoMailer'

# Using Swift Package Manager
dependencies: [
    .package(url: "https://github.com/your-org/go-mailer-ios.git", from: "1.0.0")
]

Android

// Add to build.gradle
implementation 'com.gomailer:go-mailer:1.0.0'

Flutter

# Add to pubspec.yaml
dependencies:
  go_mailer: ^1.0.0

React Native

npm install go-mailer
# or
yarn add go-mailer

Configuration

  • API Keys: Get your API key from the Go-Mailer dashboard and initialize the SDK with it.
  • Push Notification Setup: Follow platform-specific setup guides for push notification certificates and configuration.

Documentation

License

MIT License - see LICENSE for details.