Email SDK Methods

Collect and remove email addresses through your app or website.

OneSignal's Mobile and Web SDKs provide methods for adding and removing email addresses (aka email subscriptions) from a user record.

These methods require OneSignal Mobile SDKs 5.0.0+ and Web SDK 160000+.

Adding an email subscription

📘

Use Identity Verification

If you have a backend server, we strongly recommend using Identity Verification with your users. Your backend can generate an Email Authentication Token and send it to your app.

Add a new email subscription to the current user.

OneSignal.getUser().addEmail("[email protected]")
OneSignal.User.addEmail("[email protected]")
[OneSignal.User addEmail:@"[email protected]"];
OneSignal.User.addEmail("[email protected]")
OneSignal.User.addEmail("[email protected]");
OneSignal.User.AddEmail("[email protected]");
OneSignal.User.addEmail("[email protected]");
OneSignal.User.addEmail("[email protected]");
window.plugins.OneSignal.User.addEmail("[email protected]");

Removing an email subscription

Remove an email subscription from the current user. Returns false if the given email doesn't exist on the user within the SDK, and no request will be made.

OneSignal.getUser().removeEmail("[email protected]")
OneSignal.User.removeEmail("[email protected]")
OneSignal.User.removeEmail("[email protected]")
[OneSignal.User removeEmail:@"[email protected]"];
OneSignal.User.removeEmail("[email protected]");
OneSignal.User.RemoveEmail("[email protected]");
OneSignal.User.removeEmail("[email protected]");
OneSignal.User.removeEmail("[email protected]");
window.plugins.OneSignal.User.removeEmail("[email protected]");