go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/gae/service/mail/interface.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package mail
    16  
    17  import (
    18  	"context"
    19  )
    20  
    21  // RawInterface is the interface for all of the mail methods.
    22  //
    23  // These replicate the methods found here:
    24  // https://godoc.org/google.golang.org/appengine/mail
    25  type RawInterface interface {
    26  	Send(msg *Message) error
    27  	SendToAdmins(msg *Message) error
    28  
    29  	GetTestable() Testable
    30  }
    31  
    32  // Send sends an e-mail message.
    33  func Send(c context.Context, msg *Message) error {
    34  	return Raw(c).Send(msg)
    35  }
    36  
    37  // SendToAdmins sends an e-mail message to application administrators.
    38  func SendToAdmins(c context.Context, msg *Message) error {
    39  	return Raw(c).SendToAdmins(msg)
    40  }
    41  
    42  // GetTestable returns a testable extension interface, or nil if one is not
    43  // available.
    44  func GetTestable(c context.Context) Testable {
    45  	return Raw(c).GetTestable()
    46  }