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

Options

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

  EMAIL_ADDRESS              The email address to send the application email to
  --name|-n                  The name of the 'to' email account holder         
  --company|-c               The name of the company you are applying to       
  --url|-u                   The url of the job ad                             
  --email-template-subject   Template for the subject of the email             
  --email-template-text      Template for the text version of the email        
  --email-template-html      Template for the HTML version of the email        
  --email-from-name          From name                                         
  --email-from-address       From address                                      
  --email-smtp-server        SMTP server domain                                
  --email-smtp-port          SMTP server port                                  
  --email-smtp-username      SMTP server username                              
  --email-smtp-password-file SMTP server password file                         
  --email-smtp-password      SMTP server password                              

Environment variables

  SMOS_JOBHUNT_NAME NAME                            The name of the 'to' email account holder  
  SMOS_JOBHUNT_COMPANY COMPANY                      The name of the company you are applying to
  SMOS_JOBHUNT_URL URL                              The url of the job ad                      
  SMOS_JOBHUNT_EMAIL_TEMPLATE_SUBJECT FILE_PATH     Template for the subject of the email      
  SMOS_JOBHUNT_EMAIL_TEMPLATE_TEXT FILE_PATH        Template for the text version of the email 
  SMOS_JOBHUNT_EMAIL_TEMPLATE_HTML FILE_PATH        Template for the HTML version of the email 
  SMOS_JOBHUNT_EMAIL_FROM_NAME NAME                 From name                                  
  SMOS_JOBHUNT_EMAIL_FROM_ADDRESS EMAIL_ADDRESS     From address                               
  SMOS_JOBHUNT_EMAIL_SMTP_SERVER DOMAIN             SMTP server domain                         
  SMOS_JOBHUNT_EMAIL_SMTP_PORT PORT                 SMTP server port                           
  SMOS_JOBHUNT_EMAIL_SMTP_USERNAME USERNAME         SMTP server username                       
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE FILE_PATH   SMTP server password file                  
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD PASSWORD         SMTP server password                       

Configuration values

  Template for the subject of the email
  jobhunt.email.template.subject:
    # or null
    <string>
  Template for the text version of the email
  jobhunt.email.template.text:
    # or null
    <string>
  Template for the HTML version of the email
  jobhunt.email.template.html:
    # or null
    <string>
  From name
  jobhunt.email.from.name:
    # or null
    <string>
  From address
  jobhunt.email.from.address:
    # or null
    <string>
  SMTP server domain
  jobhunt.email.smtp.server:
    # or null
    <string>
  SMTP server port
  jobhunt.email.smtp.port:
    # or null
    <integer> # 16 bit unsigned integer
  SMTP server username
  jobhunt.email.smtp.username:
    # or null
    <string>
  SMTP server password file
  jobhunt.email.smtp.password-file:
    # or null
    <string>
  SMTP server password
  jobhunt.email.smtp.password:
    # or null
    <string>

Combined settings

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

Initiate an application process by sending an email

Available settings:
  Show this help text
  switch: -h|--help

  The email address to send the application email to
  argument: EMAIL_ADDRESS

  The name of the 'to' email account holder
  option: --name|-n NAME
  env: SMOS_JOBHUNT_NAME NAME

  The name of the company you are applying to
  option: --company|-c COMPANY
  env: SMOS_JOBHUNT_COMPANY COMPANY

  The url of the job ad
  option: --url|-u URL
  env: SMOS_JOBHUNT_URL URL

  Template for the subject of the email
  option: --email-template-subject FILE_PATH
  env: SMOS_JOBHUNT_EMAIL_TEMPLATE_SUBJECT FILE_PATH
  config:
    jobhunt.email.template.subject: # or null
      <string>

  Template for the text version of the email
  option: --email-template-text FILE_PATH
  env: SMOS_JOBHUNT_EMAIL_TEMPLATE_TEXT FILE_PATH
  config:
    jobhunt.email.template.text: # or null
      <string>

  Template for the HTML version of the email
  option: --email-template-html FILE_PATH
  env: SMOS_JOBHUNT_EMAIL_TEMPLATE_HTML FILE_PATH
  config:
    jobhunt.email.template.html: # or null
      <string>

  From name
  option: --email-from-name NAME
  env: SMOS_JOBHUNT_EMAIL_FROM_NAME NAME
  config:
    jobhunt.email.from.name: # or null
      <string>

  From address
  option: --email-from-address EMAIL_ADDRESS
  env: SMOS_JOBHUNT_EMAIL_FROM_ADDRESS EMAIL_ADDRESS
  config:
    jobhunt.email.from.address: # or null
      <string>

  SMTP server domain
  option: --email-smtp-server DOMAIN
  env: SMOS_JOBHUNT_EMAIL_SMTP_SERVER DOMAIN
  config:
    jobhunt.email.smtp.server: # or null
      <string>

  SMTP server port
  option: --email-smtp-port PORT
  env: SMOS_JOBHUNT_EMAIL_SMTP_PORT PORT
  config:
    jobhunt.email.smtp.port: # or null
      <integer> # 16 bit unsigned integer

  SMTP server username
  option: --email-smtp-username USERNAME
  env: SMOS_JOBHUNT_EMAIL_SMTP_USERNAME USERNAME
  config:
    jobhunt.email.smtp.username: # or null
      <string>

  SMTP server password file
  option: --email-smtp-password-file FILE_PATH
  env: SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE FILE_PATH
  config:
    jobhunt.email.smtp.password-file: # or null
      <string>

  SMTP server password
  option: --email-smtp-password PASSWORD
  env: SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD PASSWORD
  config:
    jobhunt.email.smtp.password: # or null
      <string>