Smos Logo Smos

A comprehensive self-management system

Email command

Documentation about the smos-jobhunt email command, for initiating an application project by sending an email

Run the smos-jobhunt email command to send an application email and keep track of the project.

Example invocation:

smos-jobhunt email syd@cs-syd.eu --name "Tom Sydney Kerckhove" --company "CS SYD" --url "https://cs-syd.eu"

In order for this to work, you need to configure a few things.

  1. Configure your SMTP server so that smos-jobhunt can send emails.
  2. Configure your email templates so that smos-jobhunt can compose an email for you.
    1. Subject template
    2. Plain text body template
    3. HTML body template

Reference

Arguments

Usage: smos-jobhunt email EMAIL_ADDRESS [-n|--name NAME] [-c|--company COMPANY] 
                          [-u|--url URL] [--email-subject-template FILEPATH] 
                          [--email-text-template FILEPATH] 
                          [--email-html-template FILEPATH] 
                          [--email-from-name NAME] 
                          [--email-from-address EMAIL_ADDRESS] 
                          [--smtp-server DOMAIN] [--smtp-port PORT] 
                          [--smtp-username USERNAME] [--smtp-password PASSWORD] 
                          [--smtp-password-file FILEPATH]

  Initiate an application process by sending an email

Available options:
  EMAIL_ADDRESS            The email address to send the application email to
  -n,--name NAME           The name of the 'to' email account holder
  -c,--company COMPANY     The name of the company you are applying to
  -u,--url URL             The url of the job ad
  --email-subject-template FILEPATH
                           Template for the subject of the email
  --email-text-template FILEPATH
                           Template for the text version of the email
  --email-html-template FILEPATH
                           Template for the HTML version of the email
  --email-from-name NAME   From name
  --email-from-address EMAIL_ADDRESS
                           From address
  --smtp-server DOMAIN     SMTP server domain
  --smtp-port PORT         SMTP server port
  --smtp-username USERNAME SMTP server username
  --smtp-password PASSWORD SMTP server password
  --smtp-password-file FILEPATH
                           SMTP server password file
  -h,--help                Show this help text

Global options:
  --config-file FILE_PATH  The config file to use
  --log-level ARG          The log level to use, options:
                           ["Debug","Info","Warn","Error"]
  --workflow-dir DIRECTORY_PATH
                           The workflow directory to use
  --archive-dir DIRECTORY_PATH
                           The archive directory to use
  --projects-dir DIRECTORY_PATH
                           The projects directory to use
  --archived-projects-dir DIRECTORY_PATHPATH
                           The archived projects directory to use
  -d,--directory DIRECTORY The directory to put jobhunt projects in
  -g,--goal GOAL           The goal for initialised projects
  -w,--waiting-threshhold TIME
                           The waiting threshold initialised projects

Environment

Available environment variables:

  SMOS_JOBHUNT_EMAIL_FROM_ADDRESS
                         Email from address
  SMOS_JOBHUNT_EMAIL_FROM_NAME
                         Email from name
  SMOS_JOBHUNT_EMAIL_HTML_TEMPLATE
                         HTML version of the email template
                         file
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD
                         SMTP Password
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE
                         SMTP Password file
  SMOS_JOBHUNT_EMAIL_SMTP_PORT
                         SMTP Server port
  SMOS_JOBHUNT_EMAIL_SMTP_SERVER
                         SMTP Server domain
  SMOS_JOBHUNT_EMAIL_SMTP_USERNAME
                         SMTP Username
  SMOS_JOBHUNT_EMAIL_SUBJECT_TEMPLATE
                         Subject of the email template file
  SMOS_JOBHUNT_EMAIL_TEXT_TEMPLATE
                         Text version of the email template
                         file

Configuration

# Configuration
workflow-dir: # optional
  # The workflow directory
  # or null
  <string>
archive-dir: # optional
  # The archive directory
  # or null
  <string>
projects-dir: # optional
  # The projects directory
  # or null
  <string>
archived-projects-dir: # optional
  # The archived projects directory
  # or null
  <string>
email: # optional
  # The email configuration
  # or null
  # EmailConfiguration
  from-name: # optional
    # The from name for sending email
    # or null
    <string>
  from-address: # optional
    # The from address for sending email
    # or null
    <string>
  smtp: # optional
    # The from address for sending email
    # or null
    # SMTPConfiguration
    server: # required
      # The smtp server
      # or null
      <string>
    port: # optional
      # The smtp server port
      # or null
      <number> # between 0 and 65535
    username: # optional
      # The username to authenticate with the smtp server
      # or null
      <string>
    password: # optional
      # The password to authenticate with the smtp server
      # or null
      <string>
    password-file: # optional
      # Path to a file with the password to authenticate with the smtp server
      # or null
      <string>
jobhunt: # optional
  # The jobhunt tool configuration
  # or null
  # JobHuntConfiguration
  log-level: # optional
    # Minimal severity of log messages
    # or null
    def: LogLevel
    # The log level to use, options:
    # ["Debug","Info","Warn","Error"]
    <string>
  directory: # optional
    # Directory, relative to the projects dir, or absolute
    # or null
    <string>
  goal: # optional
    # The goal property for initialised projects
    # or null
    def: PropertyValue
    <string>
  waiting-threshold: # optional
    # The waiting threshold for initialised projects
    # or null
    def: Time
    # any of
    [ # Time string, for example:
      #  2s
      #  2 seconds
      #  3m
      #  3 minutes
      #  4h
      #  4 hours
      #  5d
      #  5 days
      #  6w
      #  6 weeks
      #  7mo
      #  7 months
      #  8y
      #  8 years
      <string>
    , # Interpreted as a number of days
      <number> # between 0 and 18446744073709551615
    ]
  email: # optional
    # The configuration for the email command
    # or null
    # SendEmailConfiguration 
    email-subject-template: # optional
      # Template file for the subject of the email
      # or null
      <string>
    email-text-template: # optional
      # Template file for the text version of the email
      # or null
      <string>
    email-html-template: # optional
      # Template file for the text version of the email
      # or null
      <string>