Mail

announce:
  # 
  mail:

    # Enable or disable this announcer.
    # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    # Defaults to `NEVER`.
    #  
    active: ALWAYS

    # Additional properties used when evaluating templates.
    #  
    extraProperties:
      # Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`.
      foo: bar

    # The e-mail transport.
    # Supported values are: [SMTP, SMTPS].
    # Defaults to SMTP.
    # 
    transport: SMTP

    # The mime-type of the message to be sent.
    # Supported values are: [TEXT, HTML].
    # Defaults to TEXT.
    # 
    mimeType: TEXT

    # The port where the mail server listens to incoming messages.
    # 
    port: 25

    # Whether authentication is required or not.
    # If set to `true` then both `username` and `password` must be set.
    # Defaults to `false`.
    # 
    auth: true

    # The address of the SMTP server, e.g. 'smtp.gmail.com'.
    # 
    host: smtp.gmail.com

    # The username required for authentication.
    #  Only if auth = `true`.
    username: duke

    # The password associated with the given username.
    #  Only if auth = `true`. 
    password: __USE_ENVIRONMENT_VARIABLE__

    # The message sender, i.e, `duke@jreleaser.org`.
    # 
    from: duke@jreleaser.org

    # The message recipient(s).
    # Multiple addresses may be specified as a comma-separated list.
    # 
    to: announce@acme.com

    # The CC recipient(s).
    # Multiple addresses may be specified as a comma-separated list.
    # 
    cc: additional@acme.com

    # The BCC recipient(s).
    # Multiple addresses may be specified as a comma-separated list.
    # 
    bcc: hidden@acme.com

    # The messages' subject.
    # Review the available Name Templates.
    #  
    subject: '{{projectNameCapitalized}} {{projectVersion}} released!'

    # The announcement message.
    # Review the available Name Templates.
    #  
    message: |
      We just launched {{projectNameCapitalized}} {{projectVersion}}!
      {{changelog}}

    # Path to a template file that contains the message.
    # Review the available Name Templates.
    # Defaults to `src/jreleaser/templates/mail.tpl`.
    # 
    messageTemplate: path/to/template/mail.tpl

    # Additional mail properties to be configured.
    # Use this field to set properties such as `mail.smtp.starttls.enable`.
    # 
    properties:
      'mail.smtp.starttls.enable': true

# 
[announce.mail]

  # Enable or disable this announcer.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  #  
  active = "ALWAYS"

  # Additional properties used when evaluating templates.
  #  
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`.

  # The e-mail transport.
  # Supported values are: [SMTP, SMTPS].
  # Defaults to SMTP.
  # 
  transport = "SMTP"

  # The mime-type of the message to be sent.
  # Supported values are: [TEXT, HTML].
  # Defaults to TEXT.
  # 
  mimeType = "TEXT"

  # The port where the mail server listens to incoming messages.
  # 
  port = "25"

  # Whether authentication is required or not.
  # If set to `true` then both `username` and `password` must be set.
  # Defaults to `false`.
  # 
  auth = true

  # The address of the SMTP server, e.g. 'smtp.gmail.com'.
  # 
  host = "smtp.gmail.com"

  # The username required for authentication.
  #  Only if auth = `true`.
  username = "duke"

  # The password associated with the given username.
  #  Only if auth = `true`. 
  password = "__USE_ENVIRONMENT_VARIABLE__"

  # The message sender, i.e, `duke@jreleaser.org`.
  # 
  from = "duke@jreleaser.org"

  # The message recipient(s).
  # Multiple addresses may be specified as a comma-separated list.
  # 
  to = "announce@acme.com"

  # The CC recipient(s).
  # Multiple addresses may be specified as a comma-separated list.
  # 
  cc = "additional@acme.com"

  # The BCC recipient(s).
  # Multiple addresses may be specified as a comma-separated list.
  # 
  bcc = "hidden@acme.com"

  # The messages' subject.
  # Review the available Name Templates.
  #  
  subject = "{{projectNameCapitalized}} {{projectVersion}} released!"

  # The announcement message.
  # Review the available Name Templates.
  #  
  message = """
    We just launched {{projectNameCapitalized}} {{projectVersion}}!
    {{changelog}}"""

  # Path to a template file that contains the message.
  # Review the available Name Templates.
  # Defaults to `src/jreleaser/templates/mail.tpl`.
  # 
  messageTemplate = "path/to/template/mail.tpl"

  # Additional mail properties to be configured.
  # Use this field to set properties such as `mail.smtp.starttls.enable`.
  # 
  properties."mail.smtp.starttls.enable" = "true"

{
  announce: {
    // 
    "mail": {

      // Enable or disable this announcer.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `NEVER`.
      //  
      "active": "ALWAYS",

      // Additional properties used when evaluating templates.
      //  
      "extraProperties": {
        // Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`.
        "foo": "bar"
      },

      // The e-mail transport.
      // Supported values are: [SMTP, SMTPS].
      // Defaults to SMTP.
      // 
      "transport": "SMTP",

      // The mime-type of the message to be sent.
      // Supported values are: [TEXT, HTML].
      // Defaults to TEXT.
      // 
      'mimeType': "TEXT",

      // The port where the mail server listens to incoming messages.
      // 
      "port": 25,

      // Whether authentication is required or not.
      // If set to `true` then both `username` and `password` must be set.
      // Defaults to `false`.
      // 
      "auth": true,

      // The address of the SMTP server, e.g. 'smtp.gmail.com'.
      // 
      "host": "smtp.gmail.com",

      // The username required for authentication.
      //  Only if auth = `true`.
      "username": "duke",

      // The password associated with the given username.
      //  Only if auth = `true`. 
      "password": "__USE_ENVIRONMENT_VARIABLE__",

      // The message sender, i.e, `duke@jreleaser.org`.
      // 
      "from": "duke@jreleaser.org",

      // The message recipient(s).
      // Multiple addresses may be specified as a comma-separated list.
      // 
      "to": "announce@acme.com",

      // The CC recipient(s).
      // Multiple addresses may be specified as a comma-separated list.
      // 
      "cc": "additional@acme.com",

      // The BCC recipient(s).
      // Multiple addresses may be specified as a comma-separated list.
      // 
      "bcc": "hidden@acme.com",

      // The messages' subject.
      // Review the available Name Templates.
      //  
      "subject": "{{projectNameCapitalized}} {{projectVersion}} released!",

      // The announcement message.
      // Review the available Name Templates.
      //  
      "message": "We just launched {{projectNameCapitalized}} {{projectVersion}}!\\n{{changelog}}",

      // Path to a template file that contains the message.
      // Review the available Name Templates.
      // Defaults to `src/jreleaser/templates/mail.tpl`.
      // 
      "messageTemplate": "path/to/template/mail.tpl"

      // Additional mail properties to be configured.
      // Use this field to set properties such as `mail.smtp.starttls.enable`.
      // 
      "properties": {
        "mail.smtp.starttls.enable": true
      }
    }
  }
}

<jreleaser>
  <!--
    
  -->
  <announce>
    <!--
      
    -->
    <mail>
      <!--
        Enable or disable this announcer.
        Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        Defaults to `NEVER`.
         
      -->
      <active>ALWAYS</active>

      <!--
        Additional properties used when evaluating templates.
         
      -->
      <extraProperties>
        <!--
          Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`.
        -->
        <foo>bar</foo>
      </extraProperties>

      <!--
        The e-mail transport.
        Supported values are: [SMTP, SMTPS].
        Defaults to SMTP.
        
      -->
      <transport>SMTP</transport>

      <!--
        The mime-type of the message to be sent.
        Supported values are: [TEXT, HTML].
        Defaults to TEXT.
        
      -->
      <mimeType>TEXT</mimeType>

      <!--
        The port where the mail server listens to incoming messages.
        
      -->
      <port>25</port>

      <!--
        Whether authentication is required or not.
        If set to `true` then both `username` and `password` must be set.
        Defaults to `false`.
        
      -->
      <auth>true</auth>

      <!--
        The address of the SMTP server, e.g. 'smtp.gmail.com'.
        
      -->
      <host>smtp.gmail.com</host>

      <!--
        The username required for authentication.
         Only if auth = `true`.
      -->
      <username>duke</username>

      <!--
        The password associated with the given username.
         Only if auth = `true`. 
      -->
      <password>__USE_ENVIRONMENT_VARIABLE__</password>

      <!--
        The message sender, i.e, `duke@jreleaser.org`.
        
      -->
      <from>duke@jreleaser.org</from>

      <!--
        The message recipient(s).
        Multiple addresses may be specified as a comma-separated list.
        
      -->
      <to>announce@acme.com</to>

      <!--
        The CC recipient(s).
        Multiple addresses may be specified as a comma-separated list.
        
      -->
      <cc>additional@acme.com</cc>

      <!--
        The BCC recipient(s).
        Multiple addresses may be specified as a comma-separated list.
        
      -->
      <bcc>hidden@acme.com</bcc>

      <!--
        The messages' subject.
        Review the available Name Templates.
         
      -->
      <subject>{{projectNameCapitalized}} {{projectVersion}} released!</subject>

      <!--
        The announcement message.
        Review the available Name Templates.
         
      -->
      <message>
        We just launched {{projectNameCapitalized}} {{projectVersion}}!
        {{changelog}}
      </message>

      <!--
        Path to a template file that contains the message.
        Review the available Name Templates.
        Defaults to `src/jreleaser/templates/mail.tpl`.
        
      -->
      <messageTemplate>path/to/template/mail.tpl</messageTemplate>

      <!--
        Additional mail properties to be configured.
        Use this field to set properties such as `mail.smtp.starttls.enable`.
        
      -->
      <properties>
        <mail.smtp.starttls.enable>true</mail.smtp.starttls.enable>
      </properties>
    </mail>
  </announce>
</jreleaser>

jreleaser {
  announce {
    // 
    mail {

      // Enable or disable this announcer.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `NEVER`.
      //  
      active = 'ALWAYS'

      // Additional properties used when evaluating templates.
      // Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`.
      //  
      extraProperties.put('foo', 'bar')

      // The e-mail transport.
      // Supported values are = [SMTP, SMTPS].
      // Defaults to SMTP.
      // 
      transport = 'SMTP'

      // The mime-type of the message to be sent.
      // Supported values are = [TEXT, HTML].
      // Defaults to TEXT.
      // 
      mimeType = 'TEXT'

      // The port where the mail server listens to incoming messages.
      // 
      port = 25

      // Whether authentication is required or not.
      // If set to `true` then both `username` and `password` must be set.
      // Defaults to `false`.
      // 
      auth = true

      // The address of the SMTP server, e.g. 'smtp.gmail.com'.
      // 
      host = 'smtp.gmail.com'

      // The username required for authentication.
      //  Only if auth = `true`.
      username: 'duke'

      // The password associated with the given username.
      //  Only if auth = `true`.v 
      password = '__USE_ENVIRONMENT_VARIABLE__'

      // The message sender, i.e, `duke@jreleaser.org`.
      // 
      from = 'duke@jreleaser.org'

      // The message recipient(s).
      // Multiple addresses may be specified as a comma-separated list.
      // 
      to = 'announce@acme.com'

      // The CC recipient(s).
      // Multiple addresses may be specified as a comma-separated list.
      // 
      cc = 'additional@acme.com'

      // The BCC recipient(s).
      // Multiple addresses may be specified as a comma-separated list.
      // 
      bcc = 'hidden@acme.com'

      // The messages' subject.
      // Review the available Name Templates.
      //  
      subject = '{{projectNameCapitalized}} {{projectVersion}} released!'

      // The announcement message.
      // Review the available Name Templates.
      //  
      message = '''
        We just launched {{projectNameCapitalized}} {{projectVersion}}!
        {{changelog}}'''

      // Path to a template file that contains the message.
      // Review the available Name Templates.
      // Defaults to `src/jreleaser/templates/mail.tpl`.
      // 
      messageTemplate = 'path/to/template/mail.tpl'

      // Additional mail properties to be configured.
      // Use this field to set properties such as `mail.smtp.starttls.enable`.
      // 
      properties.put('mail.smtp.starttls.enable', 'true')
    }
  }
}