Email/Methods

Email/Methods

Source:

Methods for sending emails, retrying failed emails and verifying email configuration. Run these methods using Meteor.call()

Example

Meteor.call("emails/retryFailed", email._id, (err)

Methods

(static) email/retryFailed(jobId) → {Boolean}

Retry a failed or cancelled email job

Source:
Parameters:
Name Type Description
jobId String

a sendEmail job ID

Returns:
  • returns true if job is successfully restarted
Type
Boolean

(static) email/saveSettings(settings) → {Boolean}

Save new email configuration

Source:
Parameters:
Name Type Description
settings Object

mail provider settings

Returns:
  • returns true if update succeeds
Type
Boolean

(static) email/verifySettings(settings) → {Boolean}

Verify the current email configuration

Source:
Parameters:
Name Type Description
settings Object

optional settings object (otherwise uses settings in database)

Returns:
  • returns true if SMTP connection succeeds
Type
Boolean